Creating a simple "Hello World" plugin - Revision history

Trekker777: removed .htm from the http://www.wxwidgets.org/docs link

2014-09-24T19:50:44Z

removed .htm from the http://www.wxwidgets.org/docs link

LETARTARE: /* Compiler Options */

2013-09-08T17:10:58Z

Compiler Options

LETARTARE: /* Linker Options */ change version wxWidgets

2013-09-08T16:59:36Z

Linker Options: change version wxWidgets

Ollydbg: add some code and comments

2009-01-03T09:31:02Z

add some code and comments

Ollydbg: add output image

2009-01-03T09:06:00Z

add output image

Ollydbg: resize image to max 400*400 pixel to save space

2009-01-03T09:01:00Z

resize image to max 400*400 pixel to save space

Ollydbg: add screen shot of wizard0

2009-01-03T08:48:43Z

add screen shot of wizard0

Ganbito: /* Added linux -fPIC problem solution */

2008-11-24T22:38:05Z

Added linux -fPIC problem solution

KarlM: /* Adding Functionality */

2008-07-29T01:23:23Z

Adding Functionality

KarlM: /* Adding Functionality */

2008-07-29T01:21:28Z

Adding Functionality

@@ Line 133: / Line 133: @@
 ==Further Information==
-It is essential to learn how wxWidgets works if you seriously plan on working on plugins, since most of Code::Blocks depends on it, and you will find it easier to add and manipulate components if you have a firm grasp of its principles. More information on this can be found in the wxWidgets [http://www.wxwidgets.org/docs.htm documentation]. Another good place to learn from is the source code from the existing Code::Blocks plugins, which can be downloaded along with the rest of the Code::Blocks source code from the [https://www.codeblocks.org/downloads.shtml download page].
+It is essential to learn how wxWidgets works if you seriously plan on working on plugins, since most of Code::Blocks depends on it, and you will find it easier to add and manipulate components if you have a firm grasp of its principles. More information on this can be found in the wxWidgets [http://www.wxwidgets.org/docs documentation]. Another good place to learn from is the source code from the existing Code::Blocks plugins, which can be downloaded along with the rest of the Code::Blocks source code from the [https://www.codeblocks.org/downloads.shtml download page].
 Hopefully this tutorial has helped you work through a few fundamentals in terms of creating plugins, happy coding!

@@ Line 63: / Line 63: @@
 ===Compiler Options===
-The '''Compiler Options''' tab shows that several symbols have been defined when the plugin is compiled: ''__GNUWIN32__'', ''WXUSINGDLL'' and ''BUILDING_PLUGIN'' in this case (using windows). The first two are indicators to wxWidgets of the compiler and DLL options to use, and the last is an indicator to the Code::Blocks SDK headers that they are being used to build a plugin (which affects whether or not symbols are exported or imported for the DLL - see ''cbPlugin.h'' for example).
+The '''Compiler Options''' tab shows that several symbols have been defined when the plugin is compiled: ''HAVE_W32API_H'', ''WXUSINGDLL'' and ''BUILDING_PLUGIN'' in this case (using windows). The first two are indicators to wxWidgets of the compiler and DLL options to use, and the last is an indicator to the Code::Blocks SDK headers that they are being used to build a plugin (which affects whether or not symbols are exported or imported for the DLL - see ''cbPlugin.h'' for example).
 ====Linux====

@@ Line 59: / Line 59: @@
 ===Linker Options===
-If you click on the '''Linker Options''' tab at the top level in the Build Options dialog, you will see that the plugin is being linked to the Code::Blocks core library (codeblocks) and the wxWidgets library (wxmsw242 under windows ''NOTE: The plugin generator uses 2.4.2, if you're using a different version of wxWidgets then change this'').
+If you click on the '''Linker Options''' tab at the top level in the Build Options dialog, you will see that the plugin is being linked to the Code::Blocks core library (codeblocks) and the wxWidgets library (wxmsw28u under windows ''NOTE: With 12.11 lhe plugin generator uses 2.8.12, if you're using a different version of wxWidgets then change this'').
 ===Compiler Options===

@@ Line 85: / Line 85: @@
 ==Adding Functionality==
-The plugin wizard should have generated us helloworldplugin.h and helloworldplugin.cpp. The header file contains the class definition; what we're interested in, however, is the definition of the class methods in helloworldplugin.cpp. The plugin wizard has generated a constructor, a destructor and three methods. ''OnAttatch'' and ''OnRelease'' are methods called to inform the plugin when it is attached (the user has selected it and Code::Blocks has loaded it) or released (Code::Blocks no longer has a use for it or is shutting down). Since our plugin does not need to perform any actions on loading or shutting down, we can leave these as they are.
+The plugin wizard should have generated us helloworldplugin.h and helloworldplugin.cpp. The header file contains the class definition; what we're interested in, however, is the definition of the class methods in helloworldplugin.cpp. The plugin wizard has generated a constructor, a destructor and three methods. ''OnAttatch'' and ''OnRelease'' are methods called to inform the plugin when it is attached (the user has selected it and Code::Blocks has loaded it) or released (Code::Blocks no longer has a use for it or is shutting down). Since our plugin does not need to perform any actions on loading or shutting down, we can leave these as they are. There are comments generated by plugin wizard to explain the functionality. For example, in the header file, code is like below to explain Execute() in doxygen style:
 The ''Execute'' method, as mentioned earlier, is what we are really interested in. We are going to use the ''LogManager'' class to add a log message in the window beneath the editor. To do this we will need access to both the Manager class and the LogManager class. Manager is and internal Code::Blocks class which is used to keep track of internal information and the various task specific managers (like the LogManager and EditorManager - which is used to keep track of all the open files and their editors). LogManager is responsible for both normal output and debugging output (see ''logmanager.h'' for more details). Replace the generated Execute method with this new one:

@@ Line 108: / Line 108: @@
 (New)
-The time is right and we should compile the project. The next step is to install the plugin. Go to the '''Plugins->Manage plugins''' option. Hit the '''Install new''' button. The manager ask you where the plugin lies. Go to that folder and select the *.cbplugin file. Code::Blocks imports your plugin automatically. If this procedure was successful you can see your plugin in the ''Installed plugins'' list. To execute your plugin go to the '''Plugins''' menu and choose your plugin. That's all.
+The time is right and we should compile the project.
 (Old)

@@ Line 19: / Line 19: @@
 Select the '''File->New->Project''' option from the main menu bar and choose the Code::Blocks Plugin Wizard.
-[[Image:Hwplugin template.png]]
+[[Image:Hwplugin template.png|400x400px]]
 You will see a dialog box with some information but you can skip that after reading it. Now you will see the following dialog box:
-[[Image:Plugindevelop_2.jpg]]
+[[Image:Plugindevelop_2.jpg|400x400px]]
 In the first edit field write the title of your project. You can see that we denoted the project title as '''HelloWordPlugin'''. The other field are self-explanatory. If you click the Next button you will see the next plugin property dialog:
-[[Image:Plugindevelop_3.jpg]]
+[[Image:Plugindevelop_3.jpg|400x400px]]
 Let's denote the plugin name with '''HelloWorld'''. After clicking the next button a new dialog apears and you can edit a bunch of information about your plugin. In the next step you can choose which compiler you want to use for your plugin project.

@@ Line 17: / Line 17: @@
 ==Creating the Plugin Project==
-Select the '''File->New->Project''' option from the main menu bar and choose the Code::Blocks Plugin Wizard. You will see a dialog box with some information but you can skip that after reading it. Now you will see the following dialog box:
+Select the '''File->New->Project''' option from the main menu bar and choose the Code::Blocks Plugin Wizard.
 [[Image:Plugindevelop_2.jpg]]

@@ Line 47: / Line 47: @@
 Click '''Create''' and take note of the next dialog box's message about the SDK include and library directories, that's what we'll be dealing with next.
-==Letting the project know where to find the SDK==
+==Setting Build Options. Letting the project know where to find the SDK==
 Code::Blocks should have created a new project called "Custom Plugin". Before we can compile anything we need to make sure that the compiler knows where the sdk files are in order to include headers and link the libraries. If your compiler has not been setup to know where wxWidgets is yet then this must also be done (see the links in Prerequisites for more details).
@@ Line 60: / Line 60: @@
 The '''Compiler Options''' tab shows that several symbols have been defined when the plugin is compiled: ''__GNUWIN32__'', ''WXUSINGDLL'' and ''BUILDING_PLUGIN'' in this case (using windows). The first two are indicators to wxWidgets of the compiler and DLL options to use, and the last is an indicator to the Code::Blocks SDK headers that they are being used to build a plugin (which affects whether or not symbols are exported or imported for the DLL - see ''cbPlugin.h'' for example).
 ==Adding Functionality==

@@ Line 68: / Line 68: @@
 At the top of the file add:
-#include <logmanager.h>
+ #include <logmanager.h>
 Then later on:

@@ Line 67: / Line 67: @@
 The ''Execute'' method, as mentioned earlier, is what we are really interested in. We are going to use the ''LogManager'' class to add a log message in the window beneath the editor. To do this we will need access to both the Manager class and the LogManager class. Manager is and internal Code::Blocks class which is used to keep track of internal information and the various task specific managers (like the LogManager and EditorManager - which is used to keep track of all the open files and their editors). LogManager is responsible for both normal output and debugging output (see ''logmanager.h'' for more details). Replace the generated Execute method with this new one:
   int HelloWorldPlugin::Execute()
+  {
@@ Line 77: / Line 81: @@
 This new method uses the Manager's static Get method to return the singleton Manager object, then uses that to access the LogManager through the GetLogManager method. LogManager has a method called ''Log'' which appends a string to the bottom of the output log, so we use this to add the "Hello World!" message. The _() construct is part of wxWidgets' internationalisation utilities, and more information on it can be found in the wxWidgets [http://wiki.wxwidgets.org/wiki.pl?WxWidgets_Source_Oddities documentation].
-The first two lines check to see if the plugin has been attatched (in other words selected by the user in the '''Plugins->Manage plugins''' menu), and thus whether it should perform any action at all. Currently the return value of Execute is not used anywhere, but all the default plugins use -1 for failure and 0 for success.
+The first two lines check to see if the plugin has been attached (in other words selected by the user in the '''Plugins->Manage plugins''' menu), and thus whether it should perform any action at all. Currently the return value of Execute is not used anywhere, but all the default plugins use -1 for failure and 0 for success.
 ==Compile! (And test)==