Code::Blocks - User contributions [en]

Developer documentation

2013-10-04T16:48:16Z

Biplab: Edited refresh interval

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
{{Layout_box2|1=
'''Code repository''' 
* Web-interface by ViewVC: http://sourceforge.net/p/codeblocks/code/log/
* Subversion URL: <nowiki>svn://svn.code.sf.net/p/codeblocks/code/trunk</nowiki> or <nowiki>http://svn.code.sf.net/p/codeblocks/code/trunk</nowiki>

'''Mirror''' (Read-only; refreshed every 10 minutes.)
* Subversion URL: <nowiki>svn://cb.biplab.in/codeblocks/trunk</nowiki> 
* Web-interface: http://cb.biplab.in/websvn/
* Git URL: git://cb.biplab.in/codeblocks.git
* Web-interface:http://cb.biplab.in/cgit/
}}

'''Articles for Code::Blocks developers.'''

* '''Documentation'''
:[https://www.codeblocks.org/manual.shtml User's manual] in various formats and languages.
:Also see http://developer.berlios.de/projects/codeblocks/ (under the downloads section).
:Checkout the SDK documentation at http://developer.berlios.de/project/showfiles.php?group_id=5358 as CHM file(s).

* Compile the complete Code::Blocks from sources on '''[[Installing Code::Blocks from source on Windows|Windows]]''' and '''[[Installing Code::Blocks from source on Linux|Linux]]'''

* '''[[Compile Code::Blocks plugins based on a nightly]]''' without the need to compile wxWidgets or the Code::Blocks core.

* '''[http://launchpad.net/products/codeblocks/ Translation]'''
:Code::Blocks uses Launchpad to coordinate translation efforts.

* '''[[Coding style]]'''
:The source code formatting style used in the Code::Blocks' source.

* '''[[Creating a custom lexer for Code::Blocks editor]]'''
:How to add support for new syntax lighting schemes.

* '''[[Creating a patch to submit to BerliOS (Patch Tracker)]]'''
:Creating a diff file and then submitting it to the patch tracker.

* '''[[Unicode Standards]]'''
:Information about unicode standards and how unicode is handled in Code::Blocks' source code.

* '''[[Various development tips]]'''
:List of various development tips for Code::Blocks.

* '''[[Scripting Code::Blocks]]'''
:Information about scripting Code::Blocks with [http://www.squirrel-lang.org/ Squirrel].

* '''[[A short overview about Code::Blocks architecture]]'''
:Information about the architecture of Code::Blocks.

* '''[[Code::Blocks SDK events]]'''
:Information about the Code::Blocks SDK events and how to work with them.

* '''[[File formats description]]'''
:Description of the format of each file Code::Blocks produces.

* '''[[Version control]]'''
:Tips and trick for working with our version control system.

== Plug-In development ==

* [[Creating a simple "Hello World" plugin]]
* [[Creating a Plug-in which modifies CB's Menus]]
* [[Creating a plugin that actually does something]]
* [[Linking the plugin to a Nightly Build]]
* [[Managing Plug-in Resources]]

* [[Research on doing a Plug-in for embedded help in CB]]

* [[wxSmith extensions]]
* [[Code::Completion Rewrite]] and [[Code Completion plugin]] and [[Code Completion Design]]

== Scripting ==

Using scripting to extend Code::Blocks' functionality

* [[Wizard scripts|Creating a new project wizard]]

== Debugging C::B ==

When C::B crashed, it will generate a call-stack file "codeblocks.RPT", at the crash point, this is a text file, you can open it, if your C::B contains the debug information, it will have file and line information about each call. If it is a stripped version, but you have the debug version of C::B, you can try to run the [/index.php/topic,13129.msg88254.html#msg88254 Debugging made easier], this is a address2line UI interface works under Windows.

Installing a supported compiler

2008-03-21T16:32:49Z

Biplab: /* Configuring Code::Blocks to use the Intel C++ Compiler */

[[Category:User Documentation]]
When you launch Code::Blocks for the first time, it will scan the system for any supported compilers (it takes virtually no time). After this scan completes, Code::Blocks will have been configured for the found compiler(s). Code::Blocks will also be configured even for compilers that were not found (default installation settings will be used for each of those compilers).

For more info on how to download and install each of the above compilers, please read on.

==Windows==
Currently supported compilers, at the time of this writing are:
* [http://www.mingw.org MinGW GCC C/C++ Free Compiler, including G77 (Fortran)]
* [http://mspgcc.sourceforge.net/ MSP430 GCC C/C++]
* [http://www.hightec-rt.com/ TriCore GCC C/C++]
* [http://www.hightec-rt.com/ PowerPC GCC C/C++]
* [http://msdn.microsoft.com/visualc/vctoolkit2003 Microsoft's Visual C++ Free Toolkit 2003]
* [http://www.borland.com/products/downloads/download_cbuilder.html Borland's C/C++ Free Compiler 5.5]
* [http://www.digitalmars.com/ Digital Mars Free C/C++ Compiler]
* [http://store.scitechsoft.com/product_info.php?products_id=37/ OpenWatcom Free C/C++ Compiler]
* [http://sdcc.sourceforge.net/ Small Device Free C Compiler (SDCC)]
* [http://www.intel.com/cd/software/products/asmo-na/eng/compilers/index.htm Intel C/C++ Compiler]

=== Downloading the GNU GCC compiler & GDB debugger ===

Go to MinGW's [http://www.mingw.org/download.shtml downloads] page and download the file named <code>MinGW-x.y.z.exe</code>, where x, y and z are version numbers. At the time of this writing, this file is <code>MinGW-3.1.0-1.exe</code>. If you consider yourself lucky, you might also try <code>MinGW-3.2.0-rc-3.exe</code>. It's not a stable release yet, but it works and lacks some bugs the older version has.
These setup files contain everything needed to compile and debug windows programs.

=== Downloading the Microsoft Visual C++ Free Toolkit 2003 ===

====This no longer works as discribed since the Toolkit was removed in favor of the 2005 release.====

Go to this [http://msdn.microsoft.com/visualc/vctoolkit2003 MSDN site] and click on the link labeled "Download the Visual C++ Toolkit 2003". This will download the setup file.

NOTE: ''This download is not sufficient for building windows programs. You will also have to download and install the [http://www.microsoft.com/msdownload/platformsdk/instmsi.htm Microsoft Platform SDK]''...

=== Downloading the Borland C++ Compiler 5.5 ===

NOTE: ''At some point, you will be asked to register with Borland and fill out a survey. Registration is free.''

Go to [http://www.borland.com/products/downloads/download_cbuilder.html# Borland's downloads] and click on the link labeled "Compiler". After you accept the license agreement, you will be provided with download links to the setup file.

=== Downloading the Digital Mars C/C++ Free Compiler ===

Go to [http://www.digitalmars.com/download/dmcpp.html DigitalMars]. Accept the license agreement and you'll be redirected to a page containing download links.

In that page, download:
*The '''Digital Mars C/C++ Compiler''' (<tt>dm8**c.zip</tt>)
*The '''Basic Utilities''' (<tt>bup.zip</tt>)
*The '''STLport''' library (<tt>stlport.zip</tt>)

Open <tt>dm\bin\sc.ini</tt> in a text editor, and replace the line
INCLUDE="%@P%\..\include";"%@P%\..\mfc\include";%INCLUDE%
with
INCLUDE="%@P%\..\stlport\stlport";"%@P%\..\include";"%@P%\..\mfc\include";%INCLUDE%

=== Configuring Code::Blocks to use the Intel C++ Compiler ===

'''Configuring Intel C/C++ Compiler on Windows (Applicable to Code::Blocks 8.02 and onwards)'''

Please note that on Windows platform, Intel C/C++ compiler requires ''MS compiler[http://www.microsoft.com/express/download/offline.aspx]'' to be present in your system in order to function properly. It will not compile any C++ program without it. You should also note that ''Windows SDK[http://www.microsoft.com/downloads/details.aspx?FamilyID=e6e1c3df-a74f-4207-8586-711ebe331cdc&DisplayLang=en]'' shall be installed in order to compile Windows app.

Code::Blocks (C::B) is now able to detect (from svn revision 4967 onwards) Intel C/C++ compiler and it'll then automatically setup the MSVC compiler so that the Intel compiler works as intended. However if you wish to manually install the Intel C/C++ compiler, then follow the following steps.

* Go to '''Settings > Compilers and debuggers''' and then select '''Intel C/C++ compiler'''.
* Click on the '''Toolchain executables''' tab. Point to the installation directory, e.g. <tt>C:\Program Files\Intel\Compiler\C++\10.1.020\IA32</tt> , inside the ''Compiler's installation directory'' textbox.
* Click on the '''Additional Paths''' tab and fill in the directories pointing to MSVC bin directory and the Windows SDK directory. It may look like-
C:\Program Files\Microsoft Visual Studio 8\VC\bin
C:\Program Files\Microsoft Visual Studio 8\Common7\IDE
C:\Program Files\Microsoft SDKs\Windows\v6.0\bin
* Click on the '''Search directories''' tab and add the include directories containing headers offered by Intel C/C++ compiler, MSVC compiler and the Windows SDK headers to '''Compiler''' and '''Resource compiler'''. It may look like-
C:\Program Files\Intel\Compiler\C++\10.1.020\IA32\include
C:\Program Files\Microsoft Visual Studio 8\VC\include
C:\Program Files\Microsoft SDKs\Windows\v6.0\Include
* Click on the '''Linker''' tab under '''Search directories''' tab and add the directories containing libraries offered by Intel C/C++ compiler, MSVC compiler and the Windows SDK. It may look like-
C:\Program Files\Intel\Compiler\C++\10.1.020\IA32\lib
C:\Program Files\Microsoft Visual Studio 8\VC\lib
C:\Program Files\Microsoft SDKs\Windows\v6.0\Lib

Click on the '''OK''' button to save the settings. Now you should be able to use Intel C/C++ compilers on Windows with C::B.

Note: The directories specified above may be different on your PC.

'''Note: this info is for 1.0RC1 and previous versions, now C::B has direct support for Intel C++.'''

After various user requests, we decided to post here the info to support the Intel Compiler on CodeBlocks. This should be easy, since the Intel Compiler can emulate the MSVC++ compiler.

* change MS Toolkit linker from <tt>cl.exe</tt> to <tt>icl.exe</tt>
* add <tt>(installation path to the Intel C++)\Ia32\Bin</tt> to the '''Programs > Extra paths'''
* add <tt>-D_USE_INTEL_COMPILER</tt> to '''Compiler options'''
* add <tt>(installation path to the Intel C++)\Ia32\Include</tt> and <tt>\lib</tt> to the '''Global compiler options > Directories'''
* add some options like <tt>/QaxK</tt> to the '''Compiler options''' (icl -help)

==Linux==
Currently supported compilers, at the time of this writing are:
* [http://gcc.gnu.org/ GNU GCC C/C++ Free Compiler]
* [http://sdcc.sourceforge.net/ Small Device Free C Compiler (SDCC)]
* [http://www.intel.com/cd/software/products/asmo-na/eng/compilers/index.htm Intel C/C++ Compiler]

=== Downloading the GNU GCC compiler & GDB debugger ===

Under Linux you'll, most probably, already have everything that is needed in order to compile. All major Linux distributions (RedHat, Debian, SuSE, Mandriva, Gentoo, ArchLinux, etc) come with GCC & GDB preinstalled. To make sure you have have gcc installed, go to your terminal and type 'gcc -v'. In case you have GCC installed, you will get GCC's compile options and version number.

==Mac OS X==
The Mac OS X port efforts has began recently, but it should be a matter of time until these compilers will be supported:
* [http://gcc.gnu.org/ GNU GCC]
* [http://www.intel.com/cd/software/products/asmo-na/eng/compilers/index.htm Intel Compiler beta (not yet released to public)]
* [http://sdcc.sourceforge.net/ Small Device C Compiler (SDCC)]

=== Downloading the GNU GCC compiler & GDB debugger ===

Under Mac you'll need to install Xcode Tools from http://developer.apple.com/tools/

This will install Apple versions of:

http://www.gnu.org/software/gcc/
http://www.gnu.org/software/gdb/
http://www.gnu.org/software/make/

== Compiler-neutral setup steps ==

Now that you have downloaded the setup file of the compiler of your choice, launch its installation by double-clicking on the setup file. The actual installation process is really simple. Just press "Next" all the way and you 're done.

If you installed the compiler on its default installation directory, there is nothing more to configure. Launch Code::Blocks and you 're all set :)

If that is not the case, launch Code::Blocks. If it is the first time you launch it, the compiler auto-detection will be launched.
If your compiler was not auto-detected, go to "Settings->Compiler and Debugger->Global Compiler settings->Toolchain executables", select the compiler you installed and press "Auto-detect".
If you get a message saying that the compiler was auto-detected, congratulations!
If not, then press the button with the three dots next to the "Auto-detect" button and select the installation directory of your compiler manually.

NOTE: ''The compiler's installation directory is exactly this: the installation directory. Not the "bin" subdirectory nor any other.''

Installing a supported compiler

2008-03-21T16:32:01Z

Biplab: Configuring CodeBlocks to use the Intel C++ Compiler

Installing a supported compiler

2008-03-21T09:31:04Z

Biplab: /* Configuring CodeBlocks to use the Intel C++ Compiler */

[[Category:User Documentation]]
When you launch Code::Blocks for the first time, it will scan the system for any supported compilers (it takes virtually no time). After this scan completes, Code::Blocks will have been configured for the found compiler(s). Code::Blocks will also be configured even for compilers that were not found (default installation settings will be used for each of those compilers).

For more info on how to download and install each of the above compilers, please read on.

==Windows==
Currently supported compilers, at the time of this writing are:
* [http://www.mingw.org MinGW GCC C/C++ Free Compiler, including G77 (Fortran)]
* [http://mspgcc.sourceforge.net/ MSP430 GCC C/C++]
* [http://www.hightec-rt.com/ TriCore GCC C/C++]
* [http://www.hightec-rt.com/ PowerPC GCC C/C++]
* [http://msdn.microsoft.com/visualc/vctoolkit2003 Microsoft's Visual C++ Free Toolkit 2003]
* [http://www.borland.com/products/downloads/download_cbuilder.html Borland's C/C++ Free Compiler 5.5]
* [http://www.digitalmars.com/ Digital Mars Free C/C++ Compiler]
* [http://store.scitechsoft.com/product_info.php?products_id=37/ OpenWatcom Free C/C++ Compiler]
* [http://sdcc.sourceforge.net/ Small Device Free C Compiler (SDCC)]
* [http://www.intel.com/cd/software/products/asmo-na/eng/compilers/index.htm Intel C/C++ Compiler]

=== Downloading the GNU GCC compiler & GDB debugger ===

Go to MinGW's [http://www.mingw.org/download.shtml downloads] page and download the file named <code>MinGW-x.y.z.exe</code>, where x, y and z are version numbers. At the time of this writing, this file is <code>MinGW-3.1.0-1.exe</code>. If you consider yourself lucky, you might also try <code>MinGW-3.2.0-rc-3.exe</code>. It's not a stable release yet, but it works and lacks some bugs the older version has.
These setup files contain everything needed to compile and debug windows programs.

=== Downloading the Microsoft Visual C++ Free Toolkit 2003 ===

====This no longer works as discribed since the Toolkit was removed in favor of the 2005 release.====

Go to this [http://msdn.microsoft.com/visualc/vctoolkit2003 MSDN site] and click on the link labeled "Download the Visual C++ Toolkit 2003". This will download the setup file.

NOTE: ''This download is not sufficient for building windows programs. You will also have to download and install the [http://www.microsoft.com/msdownload/platformsdk/instmsi.htm Microsoft Platform SDK]''...

=== Downloading the Borland C++ Compiler 5.5 ===

NOTE: ''At some point, you will be asked to register with Borland and fill out a survey. Registration is free.''

Go to [http://www.borland.com/products/downloads/download_cbuilder.html# Borland's downloads] and click on the link labeled "Compiler". After you accept the license agreement, you will be provided with download links to the setup file.

=== Downloading the Digital Mars C/C++ Free Compiler ===

Go to [http://www.digitalmars.com/download/dmcpp.html DigitalMars]. Accept the license agreement and you'll be redirected to a page containing download links.

In that page, download:
*The '''Digital Mars C/C++ Compiler''' (<tt>dm8**c.zip</tt>)
*The '''Basic Utilities''' (<tt>bup.zip</tt>)
*The '''STLport''' library (<tt>stlport.zip</tt>)

Open <tt>dm\bin\sc.ini</tt> in a text editor, and replace the line
INCLUDE="%@P%\..\include";"%@P%\..\mfc\include";%INCLUDE%
with
INCLUDE="%@P%\..\stlport\stlport";"%@P%\..\include";"%@P%\..\mfc\include";%INCLUDE%

=== Configuring CodeBlocks to use the Intel C++ Compiler ===
''Note: this info is for 1.0RC1 and previous versions, now C::B haves direct support for Intel C++.''

After various user requests, we decided to post here the info to support the Intel Compiler on CodeBlocks. This should be easy, since the Intel Compiler can emulate the MSVC++ compiler.

* change MS Toolkit linker from <tt>cl.exe</tt> to <tt>icl.exe</tt>
* add <tt>(installation path to the Intel C++)\Ia32\Bin</tt> to the '''Programs > Extra paths'''
* add <tt>-D_USE_INTEL_COMPILER</tt> to '''Compiler options'''
* add <tt>(installation path to the Intel C++)\Ia32\Include</tt> and <tt>\lib</tt> to the '''Global compiler options > Directories'''
* add some options like <tt>/QaxK</tt> to the '''Compiler options''' (icl -help)

==Linux==
Currently supported compilers, at the time of this writing are:
* [http://gcc.gnu.org/ GNU GCC C/C++ Free Compiler]
* [http://sdcc.sourceforge.net/ Small Device Free C Compiler (SDCC)]
* [http://www.intel.com/cd/software/products/asmo-na/eng/compilers/index.htm Intel C/C++ Compiler]

=== Downloading the GNU GCC compiler & GDB debugger ===

Under Linux you'll, most probably, already have everything that is needed in order to compile. All major Linux distributions (RedHat, Debian, SuSE, Mandriva, Gentoo, ArchLinux, etc) come with GCC & GDB preinstalled. To make sure you have have gcc installed, go to your terminal and type 'gcc -v'. In case you have GCC installed, you will get GCC's compile options and version number.

==Mac OS X==
The Mac OS X port efforts has began recently, but it should be a matter of time until these compilers will be supported:
* [http://gcc.gnu.org/ GNU GCC]
* [http://www.intel.com/cd/software/products/asmo-na/eng/compilers/index.htm Intel Compiler beta (not yet released to public)]
* [http://sdcc.sourceforge.net/ Small Device C Compiler (SDCC)]

=== Downloading the GNU GCC compiler & GDB debugger ===

Under Mac you'll need to install Xcode Tools from http://developer.apple.com/tools/

This will install Apple versions of:

http://www.gnu.org/software/gcc/
http://www.gnu.org/software/gdb/
http://www.gnu.org/software/make/

== Compiler-neutral setup steps ==

Now that you have downloaded the setup file of the compiler of your choice, launch its installation by double-clicking on the setup file. The actual installation process is really simple. Just press "Next" all the way and you 're done.

If you installed the compiler on its default installation directory, there is nothing more to configure. Launch Code::Blocks and you 're all set :)

If that is not the case, launch Code::Blocks. If it is the first time you launch it, the compiler auto-detection will be launched.
If your compiler was not auto-detected, go to "Settings->Compiler and Debugger->Global Compiler settings->Toolchain executables", select the compiler you installed and press "Auto-detect".
If you get a message saying that the compiler was auto-detected, congratulations!
If not, then press the button with the three dots next to the "Auto-detect" button and select the installation directory of your compiler manually.

NOTE: ''The compiler's installation directory is exactly this: the installation directory. Not the "bin" subdirectory nor any other.''

Wizard Scripting Commands

2007-05-02T03:45:22Z

Biplab: Added description of new ListBox functions

[[Category:Scripting Code::Blocks]]
In this page, all the wizards-related script commands are listed and explained.

Before we start, remember that in every wizard script there is a global variable defined named ''Wizard''. This is the object that all the following commands are known under.

= Adding wizard pages =
The script writer creates a wizard by adding various pre-defined and/or custom pages to the wizard object. The order the pages are added define the order in which they will appear (almost).

The script has the chance to interfere with the wizards operation any time the user presses "Next" or "Back" on the wizard dialog. For more on this, please read [[Wizard Page Events]].

''NOTE: The following commands only make sense inside the BeginWizard() script function.''

{{Function_Description_2args|1=
== AddInfoPage(pageId,intro_msg) ==

Add an informational page. It contains an informational text. It also contains a checkbox labelled "Skip".

Usually used for the first page to be displayed by the wizard and it explains in a few words what this wizard will do.

[[Image:Intro_panel.png]]
|3=pageId
|4=wxString
|5=The page's ID.
|6=info_msg
|7=wxString
|8=The info text
}}

{{Function_Description_1args|1=
== AddFilePathPage(showHeaderGuard) ==

Add a page that allows for the selection of a file. This file might not exist. Usually used by wizards of type ''wizFiles'' for the selection of the output files.

It also contains a ''header guard'' text box which can be visible or not. Usually used when the file in question is a C/C++ header, in which case you might want to allow the user to customize the ''header guard'' word. Note that if this is visible it is also auto-updated to match the selected filename. The auto-update takes the filename part (no path), capitalizes it and replaces any non-character or non-digit to an underscore.

[[Image:File_path_panel.png]]
|3=showHeaderGuard
|4=bool
|5=If true, a ''header guard'' text box will be visible
}}

{{Function_Description_1args|1=
== AddProjectPathPage() ==

Add a page that allows the user to customize the new project. Usually used by wizards of type ''wizProject''.

This page contains text boxes to set the project title, filename and base directory.

[[Image:Project_path_panel.png]]
}}

{{Function_Description_4args|1=
== AddCompilerPage(compilerID, validCompilerIDs, allowCompilerChange, allowConfigChange) ==

Perhaps the most used pre-defined wizard page. It contains a compiler selection list and a couple of well-known pre-defined build targets: Debug and Release.

The compilers' list can contain all supported compilers or a script-defined list. It can also be selected whether compiler selection will be enabled or not.

Finally, the build targets related settings can be either visible or not. If they 're visible, they allow the user to customize per-target the target's name, working directory and objects output (intermediate) directory.

[[Image:Compiler_panel.png]]
| 3=compilerID | 4=wxString | 5=The preselected compiler ID for the list. If this string is empty, the globally default compiler will be selected.
| 6=validCompilerIDs | 7=wxString | 8=A semicolon separated list of valid compiler IDs to include in the list. If you want all available compilers to be listed, use <code>_T("*")</code>. If you want only GCC-based or MSVC-based compilers to appear in the list, use <code>_T("gcc*;msv*")</code>.
| 9=allowCompilerChange | 10=bool | 11=If true, the user will be able to change the compiler selection. If false, the selection will be read-only.
| 12=allowConfigChange | 13=bool | 14=If true, the settings for the two pre-defined build targets (Debug/Release) will be shown and available for the user to customize. If false, they will not be visible.
}}

{{Function_Description_6args|1=
== AddBuildTargetPage(targetName, isDebug, showCompiler, compilerID, validCompilerIDs, allowCompilerChange) ==

Adds a page for creating a new build target. This page allows the user to enter a name for the new build target, set its working directory, set its objects output (intermediate) directory and, optionally, a compiler selection list.

It also contains a checkbox to denote whether this target should have debugging symbols enabled or not.

The compilers' list can contain all supported compilers or a script-defined list. It can also be selected whether compiler selection will be enabled or not.

[[Image:Build_target_panel.png]]
| 3=targetName | 4=wxString | 5=The new target's name.
| 6=isDebug | 7=bool | 8=If true, the "Enable debugging symbols" check box will be checked.
| 9=showCompiler | 10=bool | 11=If true, the compiler selection list will be visible.
| 12=compilerID | 13=wxString | 14=The preselected compiler ID for the list. If this string is empty, the globally default compiler will be selected.
| 15=validCompilerIDs | 16=wxString | 17=A semicolon separated list of valid compiler IDs to include in the list. If you want all available compilers to be listed, use <code>_T("*")</code>. If you want only GCC-based or MSVC-based compilers to appear in the list, use <code>_T("gcc*;msv*")</code>.
| 18=allowCompilerChange | 19=bool | 20=If true, the user will be able to change the compiler selection. If false, the selection will be read-only.
}}

{{Function_Description_4args|1=
== AddGenericSingleChoiceListPage(pageId, descr, choices, defChoice) ==
Adds a page that contains a script-defined list and the user can select one single value from it.

[[Image:Generic_single_choice_list.png]]
| 3=pageId | 4=wxString | 5=The page's ID.
| 6=descr | 7=wxString | 8=The description displayed at the top of the page.
| 9=choices | 10=wxString | 11=Semicolon separated list of the available selections.
| 12=defChoice | 13=int | 14=The pre-selected choice. This is used only the first time this page is displayed. The user's selection is stored in the Code::Blocks configuration file and remembered for subsequent uses of this page.
}}

{{Function_Description_4args|1=
== AddGenericSelectPathPage(pageId, descr, label, defValue) ==
Adds a page that allows the user to select a folder from the filesystem.

[[Image:Generic_select_path.png]]
| 3=pageId | 4=wxString | 5=The page's ID.
| 6=descr | 7=wxString | 8=The description displayed at the top of the page.
| 9=label | 10=wxString | 11=The label above the text box (e.g. "Location of Foo:").
| 12=defValue | 13=wxString | 14=The pre-selected path. This is used only the first time this page is displayed. The user's selection is stored in the Code::Blocks configuration file and remembered for subsequent uses of this page.
}}

{{Function_Description_1args|1=
== AddPage(pageId) ==

Adds a custom page from XRC resource.

The wizard allows the script to add custom pages from XRC. Each such page must actually be a wxPanel inside the XRC. This wxPanel's name is then used as the ''pageID'' parameter. Note that all custom page panels are placed in wizard.xrc.
|3=pageId
|4=wxString
|5=The page's ID. This must match the wxPanel's name in the XRC resource.
}}

= Operating on GUI controls =
The wizard allows scripts to operate on the controls currently visible (i.e. on the current page the user is viewing).
By "operate on" I mean get and set their values.
This is especially useful for custom XRC pages (else what would they be good for?) and a couple of the pre-defined pages.

In this section, the script commands that allows the script to operate on page controls are explained by control type.

== Text controls (wxTextCtrl) ==

{{Function_Description_2args|1=
=== SetTextControlValue(control_name, value) ===
Sets the value of the text control identified by <code>control_name</code>.
|3=control_name
|4=wxString
|5=The control's name
|6=value
|7=wxString
|8=The new value
}}

{{Function_Description_1args|1=
=== GetTextControlValue(control_name) ===
Gets the value of the text control identified by <code>control_name</code>.
|2=The control's current value (wxString).
|3=control_name
|4=wxString
|5=The control's name
}}

== Checkbox controls (wxCheckBox) ==

{{Function_Description_2args|1=
=== CheckCheckbox(control_name, value) ===
Checks or unchecks the checkbox identified by <code>control_name</code>.
|3=control_name
|4=wxString
|5=The control's name
|6=value
|7=bool
|8=Check if true, uncheck if false
}}

{{Function_Description_1args|1=
=== IsCheckboxChecked(control_name) ===
Gets the check-state of the checkbox identified by <code>control_name</code>.
|2=The control's current check-state (bool).
|3=control_name
|4=wxString
|5=The control's name
}}

== Combobox controls (wxComboBox) ==

{{Function_Description_2args|1=
=== SetComboboxSelection(control_name, value) ===
Sets the selected item in the combobox identified by <code>control_name</code>.
|3=control_name
|4=wxString
|5=The control's name
|6=value
|7=int
|8=The item's index. Use -1 for no selection
}}

{{Function_Description_1args|1=
=== GetComboboxSelection(control_name) ===
Gets the selected item in the combobox identified by <code>control_name</code>.
|2=The control's currently selected index (int).
|3=control_name
|4=wxString
|5=The control's name
}}

{{Function_Description_1args|1=
=== GetComboboxStringSelection(control_name) ===
Gets the selected item's string in the combobox identified by <code>control_name</code>.
|2=The control's currently selected item's string (wxString).
|3=control_name
|4=wxString
|5=The control's name
}}

{{Function_Description_1args|1=
=== GetCompilerFromCombobox(control_name) ===
Assuming you have used FillComboboxWithCompilers() (below) to fill the combobox, this returns the selected compiler's ID.
|2=The control's currently selected item's string (wxString).
|3=control_name
|4=wxString
|5=The control's name
}}

{{Function_Description_1args|1=
=== FillComboboxWithCompilers(control_name) ===
Fills the combobox with a list of compilers.
|3=control_name
|4=wxString
|5=The control's name
}}

== Radiobox controls (wxRadioBox) ==

{{Function_Description_2args|1=
=== SetRadioboxSelection(control_name, value) ===
Sets the selected item in the radiobox identified by <code>control_name</code>.
|3=control_name
|4=wxString
|5=The control's name
|6=value
|7=int
|8=The item's index. Use -1 for no selection
}}

{{Function_Description_1args|1=
=== GetRadioboxSelection(control_name) ===
Gets the selected item in the radiobox identified by <code>control_name</code>.
|2=The control's currently selected index (int).
|3=control_name
|4=wxString
|5=The control's name
}}

== Listbox controls (wxListBox) ==

{{Function_Description_2args|1=
=== SetListboxSelection(control_name, value) ===
Sets the selected item in the listbox identified by <code>control_name</code>.
|3=control_name
|4=wxString
|5=The control's name
|6=value
|7=int
|8=The item's index. Use -1 for no selection
}}

{{Function_Description_1args|1=
=== GetListboxSelection(control_name) ===
Gets the selected item in the listbox identified by <code>control_name</code>.
|2=The control's currently selected index (int).
|3=control_name
|4=wxString
|5=The control's name
}}

{{Function_Description_1args|1=
=== GetListboxSelections(control_name) ===
Gets the selected items in the listbox identified by <code>control_name</code> to a wxString. The selections are separated ';' and returned as a single string. Use <code>GetArrayFromString()</code> functions to separate them. Please note that the ListBox should be created with <code>wxLB_MULTIPLE</code> or <code>wxLB_EXTENDED</code> window style.
|2=The control's selections (wxString).
|3=control_name
|4=wxString
|5=The control's name
}}

{{Function_Description_1args|1=
=== GetListboxStringSelections(control_name) ===
Gets the ''content strings'' of the selected items in the listbox identified by <code>control_name</code> to a wxString. The selections are separated ';' and returned as a single string. Use <code>GetArrayFromString()</code> functions to separate them. Please note that the ListBox should be created with <code>wxLB_MULTIPLE</code> or <code>wxLB_EXTENDED</code> window style.
|2=The control's selections (wxString).
|3=control_name
|4=wxString
|5=The control's name
}}

== All controls (common functions) ==

{{Function_Description_2args|1=
=== EnableWindow(control_name, value) ===
Enables/disables the window (control) identified by <code>control_name</code>.
|3=control_name
|4=wxString
|5=The window's (control) name
|6=value
|7=bool
|8=Enable if true, disable if false
}}

(to be continued)

[[User:Mandrav|Mandrav]] 11:28, 9 July 2006 (EDT)

Main Page

2007-03-03T15:23:35Z

Biplab: Changed home page of OpenWatcom to http://www.openwatcom.org

__NOEDITSECTION__ __NOTOC__
{{Layout_box1|1=
[[Image:cb_splash.png|left]]
'''Welcome to the official Wiki for Code::Blocks''' 
[https://www.codeblocks.org Code::Blocks] is an open-source, cross-platform [[wikipedia:Integrated Development Environment|IDE]]. Using a plugin architecture, its capabilities and features are defined by the provided plugins. 
Currently, [https://www.codeblocks.org Code::Blocks] is oriented towards C/C++.
The Code::Blocks team does not take responsibility for the content nor accuracy of these pages.

Wiki Editors: In order to login to edit pages, you must create an account on the [/ forums]. Use the same username and password for the wiki. Read the [[Help:Contents|Help]] for editing guidelines. Look in the [[CodeBlocks:Community_Portal|community portal]] for things to do.

}}

{|width="100%" background-color="transparent"
|width="60%" valign="top"|

{{Layout_box3|1=
=== [[Installing Code::Blocks]] ===
}}

{{Layout_box2|1=
=== [[Code::Blocks Documentation|Documentation]] ===
}}

{{Layout_box3|1=
=== Supported compilers ===
* [http://gcc.gnu.org/ GNU GCC (incl. G77)] (Linux)
* [http://www.mingw.org MinGW GCC (incl. G77)] (Win32)
* [http://developer.apple.com/tools/ Apple GCC (Xcode)] (Mac OS X)

* [http://xona.com/2004/06/29.html Microsoft Visual C++ Toolkit 2003] (Win32)
* [http://msdn.microsoft.com/vstudio/express/visualc/download/ Microsoft Visual C++ 2005] (Win32)
* [http://www.borland.com/products/downloads/download_cbuilder.html Borland's C++ Compiler 5.5] (Win32)
* [http://www.digitalmars.com/ DigitalMars C/C++] (Win32)
* [http://openwatcom.org/index.php/Main_Page/ OpenWatcom] (Win32)
* [http://www.intel.com/cd/software/products/asmo-na/eng/compilers/219754.htm Intel C++ compiler] (Win32)
* [http://sdcc.sourceforge.net/ Small Device C Compiler (SDCC)]
* [http://www.digitalmars.com/d/dcompiler.html Digital Mars D] (Win32, Linux)
* [http://dgcc.sourceforge.net/ GDC D Compiler]
}}
|width="40%" valign="top"|

{{Layout_box4|1=
=== Downloads ===
* [/index.php?board=20.0 Nightly builds] (updated each night)
* Last official release: [https://www.codeblocks.org/downloads.shtml 1.0rc2]
}}
{{Layout_box2|1=
=== Developers ===
[[Image:Chk.png]][[Roadmap]]
* [[Developer documentation]]
* [http://developer.berlios.de/projects/codeblocks/ Project page at BerliOS]
* '''Bugs''': [http://developer.berlios.de/bugs/?group_id=5358 Browse] or [http://developer.berlios.de/bugs/?func=addbug&group_id=5358 submit new]
* '''Features''': [http://developer.berlios.de/feature/?group_id=5358 Browse] or [http://developer.berlios.de/feature/?func=addfeature&group_id=5358 submit new]
* '''Patches''': [http://developer.berlios.de/patch/?group_id=5358 Browse] or [http://developer.berlios.de/patch/?func=addpatch&group_id=5358 submit new]
}}
{{Layout_box2|1=
=== Other resources ===
* [https://www.codeblocks.org Main website]
* [ Community forums]
}}
|}

<center>[https://www.codeblocks.org/about.shtml The Code::Blocks team]</center>

<center>[[Special:Allpages|Index]]</center>

Scripting commands

2007-02-04T09:16:02Z

Biplab:

[[Category:Scripting Code::Blocks]]
Scripting is no good if all you can do is use the scripting language's built-in commands only. The host application (Code::Blocks) needs to expose parts of its internals to scripts, so scripts can use and control the host.

Code::Blocks has exposed a very large chunk of its SDK to scripts. This makes scripting in Code::Blocks nearly as powerful as native code (C++).

In this page all the exported constants, functions and classes are documented as a quick reference. For detailed documentation on each function/class, refer to the Code::Blocks SDK documentation.

''NOTE: Please remember that [http://www.squirrel-lang.org Squirrel] is typeless. Data types mentioned below are only used for documentation purposes.''

''NOTE: Please keep in mind that if a function has default parameters in C++ (which can be ommitted), you still have to type them for scripts (for e.g. exposed wxWidgets functionality). This means you *have* to use e.g. wxFileName.GetFullPath(wxPATH_NATIVE) instead of e.g only wxFileName.GetFullPath().

== Application object ==
The application object is accessed through the variable named '''<tt>App</tt>'''. Currently it has no bound functions...

== Global functions ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || Log || wxString || logs to the application log
|-

|-
| void || LogDebug || wxString || logs to the debug log
|-

|-
| void || LogWarning || wxString || logs a warning
|-

|-
| void || LogError || wxString || logs an error
|-

|-
| int || Message || wxString,wxString,int || arg1=msg, arg2=caption, arg3=buttons; see API docs for cbMessageBox()
|-

|-
| void || ShowMessage || wxString ||
|-

|-
| void || ShowWarning || wxString ||
|-

|-
| void || ShowError || wxString ||
|-

|-
| void || ShowInfo || wxString ||
|-

|-
| wxString || ReplaceMacros || wxString,bool ||
|-

|-
| ScriptingManager* || GetScriptingManager || ||
|-

|-
| ProjectManager* || GetProjectManager || ||
|-

|-
| EditorManager* || GetEditorManager || ||
|-

|-
| ConfigManager* || GetConfigManager || ||
|-

|-
| UserVariableManager* || GetUserVariableManager || ||
|-

|-
| CompilerFactory* || GetCompilerFactory || ||
|-

|-
| wxString || GetFolder || int || see API docs for ConfigManager::GetFolder()
|-

|-
| wxString || LocateDataFile|| wxString, int || see API docs for ConfigManager::LocateDataFile()
|-

|-
| bool || InstallPlugin || wxString,bool, bool || Install a binary plugin
|-

|-
| void || Include || wxString || similar to C/C++ ''<tt>#include "name"</tt>''
|-

|-
| bool || IsNull || void* ||
|-

|-
| wxString || _T || const char* || basically this is the wxString constructor
|-

|-
| bool || wxLaunchDefaultBrowser || wxString ||
|-

|-
| wxColour || wxGetColourFromUser || [wxColour] ||
|-

|-
| long || wxGetNumberFromUser || wxString,wxString,wxString ||
|-

|-
| wxString || wxGetPasswordFromUser || wxString,wxString,wxString ||
|-

|-
| wxString || wxGetTextFromUser || wxString,wxString,wxString ||
|-

|}

== ScriptingManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || RegisterScriptMenu || wxString, wxString || registers the script file (arg1) under a menu item (arg2).
e.g. <tt>GetScriptingManager().RegisterScriptMenu(_T("sample.script"), _T("Scripts/Sample script"))</tt>;
|-

|}

Notes about the <tt>RegisterScriptMenu</tt> function: 
* The second argument (menu item) is a string containing the full menu path to create the menu item. The path separator is a slash (/). For example, the string "Settings/Sample menu/Sample item" would create the menu path "Settings->Sample menu->Sample item".
* When each part of the path is evaluated, it is checked whether it starts with a number followed by a colon (:). If so then this is considered to be a menu index in the parent menu and the menu is inserted at that index instead of being appended to the menu. The number and colon are removed from the string.
* If the menu item starts with a dash (-), then a separator line is prepended in the menu before the menu item (e.g. "Scripts/'''-'''Sample script").
* For your convenience, all menu items created using this function have one extra functionality: if you keep the SHIFT key pressed while clicking on any of these "script menu items", instead of running the attached script, Code::Blocks will open it in the editor for you to view/edit :).
* Have a look at the [[Startup script#Example|startup script example]].

== ConfigManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| int || Read || int,int ||
|-

|-
| bool || Read || bool,bool ||
|-

|-
| float || Read || float,float ||
|-

|-
| wxString || Read || wxString,wxString ||
|-

|-
| void || Write || int,int ||
|-

|-
| void || Write || bool,bool ||
|-

|-
| void || Write || float,float ||
|-

|-
| void || Write || wxString,wxString[,bool] ||
|-

|}

== ProjectManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetDefaultPath || ||
|-

|-
| void || SetDefaultPath || wxString ||
|-

|-
| cbProject* || GetActiveProject || ||
|-

|-
| void || SetProject || cbProject* ||
|-

|-
| bool || LoadWorkspace || wxString ||
|-

|-
| bool || SaveWorkspace || ||
|-

|-
| bool || SaveWorkspaceAs || wxString ||
|-

|-
| bool || CloseWorkspace || ||
|-

|-
| cbProject* || IsOpen || wxString ||
|-

|-
| cbProject* || LoadProject || wxString,bool ||
|-

|-
| bool || SaveProject || cbProject* ||
|-

|-
| bool || SaveProjectAs || cbProject* ||
|-

|-
| bool || SaveActiveProject || ||
|-

|-
| bool || SaveActiveProjectAs || ||
|-

|-
| bool || SaveAllProjects || ||
|-

|-
| bool || CloseProject || cbProject*,bool,bool ||
|-

|-
| bool || CloseActiveProject || bool ||
|-

|-
| bool || CloseAllProjects || bool ||
|-

|-
| cbProject* || NewProject || wxString ||
|-

|-
| int || AddFileToProject || wxString,cbProject*,int ||
|-

|-
| int || AskForBuildTargetIndex || cbProject* ||
|-

|-
| void || RebuildTree || ||
|-

|}

== EditorManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || Configure || ||
|-

|-
| cbEditor* || New || wxString ||
|-

|-
| cbEditor* || Open || wxString ||
|-

|-
| cbEditor* || IsBuiltinOpen || wxString ||
|-

|-
| cbEditor* || GetBuiltinEditor || wxString|int ||
|-

|-
| cbEditor* || GetBuiltinActiveEditor || ||
|-

|-
| EditorBase* || GetActiveEditor || ||
|-

|-
| void || ActivateNext || ||
|-

|-
| void || ActivatePrevious || ||
|-

|-
| bool || SwapActiveHeaderSource || ||
|-

|-
| bool || CloseActive || bool ||
|-

|-
| bool || Close || wxString|int,bool ||
|-

|-
| bool || CloseAll || bool ||
|-

|-
| bool || Save || wxString|int ||
|-

|-
| bool || SaveActive || ||
|-

|-
| bool || SaveAs || int ||
|-

|-
| bool || SaveActiveAs || ||
|-

|-
| bool || SaveAll || ||
|-

|-
| int || ShowFindDialog || bool,bool ||
|-

|}

== UserVariableManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || Exists || wxString ||
|-

|}

== IO namespace ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || DirectoryExists || wxString ||
|-

|-
| wxString || SelectDirectory || wxString,wxString,bool ||
|-

|-
| bool || '''CreateDirectory''' || wxString,int || arg1=dir, arg2=permissions
|-

|-
| bool || '''RemoveDirectory''' || wxString ||
|-

|-
| bool || '''CopyFile''' || wxString,wxString,bool || src,dest,overwrite
|-

|-
| bool || '''RenameFile''' || wxString,wxString || old,new
|-

|-
| bool || '''RemoveFile''' || wxString ||
|-

|-
| bool || FileExists || wxString ||
|-

|-
| wxString || SelectFile || wxString,wxString,wxString ||
|-

|-
| bool || '''WriteFileContents''' || wxString,wxString || filename,contents
|-

|-
| int || '''Execute''' || wxString ||
|-

|-
| wxString || '''ExecuteAndGetOutput''' || wxString ||
|-

|}

'''Notes:'''
The namespaces are accesses by prepending it's name (e.g. "IO.") to the scripting function, e.g. "IO.DirectoryExists(...)". "::" is only used when declaring the members of the namespace.
The functions in bold are going through the scripts security layer so there is no guarantee calling them will succeed. You should always examine the return value...
There exists one constant too, named ''allowInsecureScripts'', which allow you to test whether Code::Blocks was compiled with the functions going through the security layer.

== CompilerFactory ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || IsValidCompilerID || wxString ||
|-

|-
| int || GetCompilerIndex || wxString ||
|-

|-
| wxString || GetDefaultCompilerID || ||
|-

|-
| bool || CompilerInheritsFrom || ||
|-

|}

== wxString ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || operator+ || ||
|-

|-
| bool || operator< || ||
|-

|-
| bool || operator<= || ||
|-

|-
| bool || operator>= || ||
|-

|-
| bool || operator> || ||
|-

|-
| int || Find || wxString ||
|-

|-
| bool || Matches || wxString ||
|-

|-
| void || AddChar || char ||
|-

|-
| char || GetChar || int ||
|-

|-
| bool || IsEmpty || ||
|-

|-
| int || Length || ||
|-

|-
| int || length || || same as Length()
|-

|-
| int || len || || same as Length()
|-

|-
| int || size || || same as Length()
|-

|-
| wxString || Lower || ||
|-

|-
| wxString || LowerCase || || same as Lower()
|-

|-
| void || MakeLower || ||
|-

|-
| wxString || Upper || ||
|-

|-
| wxString || UpperCase || || same as Upper()
|-

|-
| void || MakeUpper || ||
|-

|-
| wxString || Mid || int,int ||
|-

|-
| void || Remove || int,int ||
|-

|-
| void || RemoveLast || ||
|-

|-
| int || Replace || wxString,wxString[,bool] ||
|-

|-
| wxString || Right || int ||
|-

|-
| wxString || AfterFirst || char ||
|-

|-
| wxString || AfterLast || char ||
|-

|-
| wxString || BeforeFirst || char ||
|-

|-
| wxString || BeforeLast || char ||
|-
|}
''NOTE: Is instantiated in a script using: local my_wxstring = ::wxString();

== wxArrayString ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || Add || wxString, size_t || arg1=string, arg2=number of copies to add
|-

|-
| void || Clear || ||
|-

|-
| int || GetCount || ||
|-

|-
| wxString || Item || int ||
|-

|}
''NOTE: Is instantiated in a script using: local my_wxarraystring = ::wxArrayString();

== wxColour ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| byte || Red || ||
|-

|-
| byte || Green || ||
|-

|-
| byte || Blue || ||
|-

|-
| void || Set || byte,byte,byte ||
|-

|}
''NOTE: Is instantiated in a script using: local my_wxcolour = ::wxColour();

== ProjectFile ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || AddBuildTarget || wxString ||
|-

|-
| void || RenameBuildTarget || wxString,wxString ||
|-

|-
| void || RemoveBuildTarget || wxString ||
|-

|-
| wxString || GetBaseName || ||
|-

|-
| wxString || GetObjName || ||
|-

|-
| void || SetObjName || wxString ||
|-

|-
| cbProject* || GetParentProject || ||
|-

|-
| wxFileName || file || || (variable)
|-

|-
| wxString || relativeFilename || || (variable)
|-

|-
| wxString || relativeToCommonTopLevelPath || || (variable)
|-

|-
| bool || compile || || (variable)
|-

|-
| bool || link || || (variable)
|-

|-
| int || weight || || (variable)
|-

|-
| wxString || compilerVar || || (variable)
|-

|}

== CompileOptionsBase ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || SetLinkerOptions || wxArrayString ||
|-

|-
| void || SetLinkLibs || wxArrayString ||
|-

|-
| void || SetCompilerOptions || wxArrayString ||
|-

|-
| void || SetIncludeDirs || wxArrayString ||
|-

|-
| void || SetResourceIncludeDirs || wxArrayString ||
|-

|-
| void || SetLibDirs || wxArrayString ||
|-

|-
| void || SetCommandsBeforeBuild || wxArrayString ||
|-

|-
| void || SetCommandsAfterBuild || wxArrayString ||
|-

|-
| wxArrayString || GetLinkerOptions || ||
|-

|-
| wxArrayString || GetLinkLibs || ||
|-

|-
| wxArrayString || GetCompilerOptions || ||
|-

|-
| wxArrayString || GetIncludeDirs || ||
|-

|-
| wxArrayString || GetResourceIncludeDirs || ||
|-

|-
| wxArrayString || GetLibDirs || ||
|-

|-
| wxArrayString || GetCommandsBeforeBuild || ||
|-

|-
| wxArrayString || GetCommandsAfterBuild || ||
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| void || AddLinkerOption || wxString ||
|-

|-
| void || AddLinkLib || wxString ||
|-

|-
| void || AddCompilerOption || wxString ||
|-

|-
| void || AddIncludeDir || wxString ||
|-

|-
| void || AddResourceIncludeDir || wxString ||
|-

|-
| void || AddLibDir || wxString ||
|-

|-
| void || AddCommandsBeforeBuild || wxString ||
|-

|-
| void || AddCommandsAfterBuild || wxString ||
|-

|-
| void || RemoveLinkerOption || wxString ||
|-

|-
| void || RemoveLinkLib || wxString ||
|-

|-
| void || RemoveCompilerOption || wxString ||
|-

|-
| void || RemoveIncludeDir || wxString ||
|-

|-
| void || RemoveResourceIncludeDir || wxString ||
|-

|-
| void || RemoveLibDir || wxString ||
|-

|-
| void || RemoveCommandsBeforeBuild || wxString ||
|-

|-
| void || RemoveCommandsAfterBuild || wxString ||
|-

|-
| bool || GetAlwaysRunPostBuildSteps || ||
|-

|-
| void || SetAlwaysRunPostBuildSteps || bool ||
|-

|-
| bool || SetVar || wxString,wxString,bool ||
|-

|-
| wxString || GetVar || wxString ||
|-

|-
| bool || UnsetVar || wxString ||
|-

|-
| void || UnsetAllVars || ||
|-

|}

== CompileTargetBase ==
Extends CompileOptionsBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetFilename || ||
|-

|-
| wxString || GetTitle || ||
|-

|-
| void || SetTitle || wxString ||
|-

|-
| void || SetOutputFilename || wxString ||
|-

|-
| void || SetWorkingDir || wxString ||
|-

|-
| void || SetObjectOutput || wxString ||
|-

|-
| void || SetDepsOutput || wxString ||
|-

|-
| OptionsRelation || GetOptionRelation || OptionsRelationType ||
|-

|-
| void || SetOptionRelation || OptionsRelationType,OptionsRelation ||
|-

|-
| wxString || GetWorkingDir || ||
|-

|-
| wxString || GetObjectOutput || ||
|-

|-
| wxString || GetDepsOutput || ||
|-

|-
| wxString || GetOutputFilename || ||
|-

|-
| wxString || SuggestOutputFilename || ||
|-

|-
| wxString || GetExecutableFilename || ||
|-

|-
| wxString || GetDynamicLibFilename || ||
|-

|-
| wxString || GetDynamicLibDefFilename || ||
|-

|-
| wxString || GetStaticLibFilename || ||
|-

|-
| wxString || GetBasePath || ||
|-

|-
| void || SetTargetType || TargetType ||
|-

|-
| TargetType || GetTargetType || ||
|-

|-
| wxString || GetExecutionParameters || ||
|-

|-
| void || SetExecutionParameters || wxString ||
|-

|-
| wxString || GetHostApplication || ||
|-

|-
| void || SetHostApplication || wxString ||
|-

|-
| void || SetCompilerID || wxString ||
|-

|-
| wxString || GetCompilerID || ||
|-

|}

== ProjectBuildTarget ==
Extends CompileTargetBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| cbProject* || GetParentProject || ||
|-

|-
| wxString || GetFullTitle || ||
|-

|-
| wxString || GetExternalDeps || ||
|-

|-
| void || SetExternalDeps || wxString ||
|-

|-
| void || SetAdditionalOutputFiles || wxString ||
|-

|-
| wxString || GetAdditionalOutputFiles || ||
|-

|-
| bool || GetIncludeInTargetAll || ||
|-

|-
| void || SetIncludeInTargetAll || bool ||
|-

|-
| bool || GetCreateDefFile || ||
|-

|-
| void || SetCreateDefFile || bool ||
|-

|-
| bool || GetCreateStaticLib || ||
|-

|-
| void || SetCreateStaticLib || bool ||
|-

|-
| bool || GetUseConsoleRunner || ||
|-

|-
| void || SetUseConsoleRunner || bool ||
|-

|}

== cbProject ==
Extends CompileTargetBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| wxString || GetMakefile || ||
|-

|-
| void || SetMakefile || wxString ||
|-

|-
| bool || IsMakefileCustom || ||
|-

|-
| void || SetMakefileCustom || bool ||
|-

|-
| bool || CloseAllFiles || bool ||
|-

|-
| bool || SaveAllFiles || ||
|-

|-
| bool || Save || ||
|-

|-
| bool || SaveLayout || ||
|-

|-
| bool || LoadLayout || ||
|-

|-
| bool || ShowOptions || || Display the project options dialog
|-

|-
| wxString || GetCommonTopLevelPath || ||
|-

|-
| int || GetFilesCount || || Returns number of files in the project
|-

|-
| ProjectFile* || GetFile || int ||
|-

|-
| ProjectFile* || GetFileByFilename || wxString,bool,bool || See API docs for cbProject::GetFileByName
|-

|-
| bool || RemoveFile || int ||
|-

|-
| ProjectFile* || AddFile || wxString|int,wxString,bool,bool,int || See API docs for cbProject::AddFile
|-

|-
| int || GetBuildTargetsCount || ||
|-

|-
| ProjectBuildTarget* || GetBuildTarget || wxString|int ||
|-

|-
| ProjectBuildTarget* || AddBuildTarget || wxString ||
|-

|-
| bool || RenameBuildTarget || wxString|int,wxString ||
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || wxString|int,wxString ||
|-

|-
| bool || RemoveBuildTarget || wxString|int ||
|-

|-
| bool || ExportTargetAsProject || wxString|int ||
|-

|-
| void || SetActiveBuildTarget || int ||
|-

|-
| int || GetActiveBuildTarget || ||
|-

|-
| int || SelectTarget || int,bool ||
|-

|-
| ProjectBuildTarget* || GetCurrentlyCompilingTarget || ||
|-

|-
| void || SetCurrentlyCompilingTarget || ProjectBuildTarget* ||
|-

|-
| PCHMode || GetModeForPCH || ||
|-

|-
| void || SetModeForPCH || PCHMode ||
|-

|}

== EditorBase ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetFilename || ||
|-

|-
| void || SetFilename || wxString ||
|-

|-
| wxString || GetShortName || ||
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| wxString || GetTitle || ||
|-

|-
| void || SetTitle || wxString ||
|-

|-
| void || Activate || ||
|-

|-
| bool || Close || ||
|-

|-
| bool || Save || ||
|-

|-
| bool || IsBuiltinEditor || ||
|-

|-
| bool || ThereAreOthers || ||
|-

|-
| void || GotoLine || int,bool ||
|-

|-
| void || ToggleBreakpoint || int,bool ||
|-

|-
| bool || HasBreakpoint || int ||
|-

|-
| void || GotoNextBreakpoint || ||
|-

|-
| void || GotoPreviousBreakpoint || ||
|-

|-
| void || ToggleBookmark || int,bool ||
|-

|-
| bool || HasBookmark || int ||
|-

|-
| void || GotoNextBookmark || ||
|-

|-
| void || GotoPreviousBookmark || ||
|-

|-
| void || Undo || ||
|-

|-
| void || Redo || ||
|-

|-
| void || Cut || ||
|-

|-
| void || Copy || ||
|-

|-
| void || Paste || ||
|-

|-
| bool || CanUndo || ||
|-

|-
| bool || CanRedo || ||
|-

|-
| bool || CanPaste || ||
|-

|-
| bool || HasSelection || ||
|-

|}

== cbEditor ==
Extends EditorBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || SetEditorTitle || wxString ||
|-

|-
| ProjectFile* || GetProjectFile || ||
|-

|-
| bool || SaveAs || ||
|-

|-
| void || FoldAll || ||
|-

|-
| void || UnfoldAll || ||
|-

|-
| void || ToggleAllFolds || ||
|-

|-
| void || FoldBlockFromLine || int ||
|-

|-
| void || UnfoldBlockFromLine || int ||
|-

|-
| void || ToggleFoldBlockFromLine || int ||
|-

|-
| int || GetLineIndentInSpaces || int ||
|-

|-
| wxString || GetLineIndentString || int ||
|-

|-
| void || Touch || ||
|-

|-
| bool || Reload || bool ||
|-

|-
| void || Print || bool,PrintColourMode,bool ||
|-

|-
| void || AutoComplete || ||
|-

|-
| bool || AddBreakpoint || int,bool ||
|-

|-
| bool || RemoveBreakpoint || int,bool ||
|-

|-
| void || SetText || wxString || this is not present in cbEditor; included to help scripts edit text
|-

|-
| wxString || GetText || || this is not present in cbEditor; included to help scripts edit text
|-

|}

== Constants ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"

|- style="background: #ececec; border: 0px solid gray"
!Constant
!Type
!Remarks
|-

|-
| PLATFORM || int || this defines the platform Code::Blocks is currently running on. It is equal to only one of the following PLATFORM_* constants
|-

|-
| PLATFORM_MSW || int || All Windows platforms
|-

|-
| PLATFORM_GTK || int || All GTK platforms (Linux, BSD, Solaris, Darwin, etc.)
|-

|-
| PLATFORM_MAC || int || All Mac platforms
|-

|-
| PLATFORM_OS2 || int || OS/2 platform
|-

|-
| PLATFORM_X11 || int || All X11 platforms
|-

|-
| PLATFORM_UNKNOWN || int || Unknown platform. Please inform us if PLATFORM == PLATFORM_UNKNOWN so we can make this platform known too ;)
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Message dialog flags'''
|-

|-
| wxOK || int || Flag for Message() 's third argument (flags).
|-

|-
| wxYES_NO || int || -"-
|-

|-
| wxCANCEL || int || -"-
|-

|-
| wxICON_QUESTION || int || -"-
|-

|-
| wxICON_INFORMATION || int || -"-
|-

|-
| wxICON_WARNING || int || -"-
|-

|-
| wxICON_ERROR || int || -"-
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Message dialog return values'''
|-

|-
| wxID_OK || int ||
|-

|-
| wxID_YES || int ||
|-

|-
| wxID_NO || int ||
|-

|-
| wxID_CANCEL || int ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum OptionsRelationType'''
|-

|-
| ortCompilerOptions || enum ||
|-

|-
| ortLinkerOptions || enum ||
|-

|-
| ortIncludeDirs || enum ||
|-

|-
| ortLibDirs || enum ||
|-

|-
| ortResDirs || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum OptionsRelation'''
|-

|-
| orUseParentOptionsOnly || enum ||
|-

|-
| orUseTargetOptionsOnly || enum ||
|-

|-
| orPrependToParentOptions || enum ||
|-

|-
| orAppendToParentOptions || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum TargetType'''
|-

|-
| ttExecutable || enum ||
|-

|-
| ttConsoleOnly || enum ||
|-

|-
| ttStaticLib || enum ||
|-

|-
| ttDynamicLib || enum ||
|-

|-
| ttCommandsOnly || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum MakeCommand'''
|-

|-
| mcClean || enum ||
|-

|-
| mcDistClean || enum ||
|-

|-
| mcBuild || enum ||
|-

|-
| mcCompileFile || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PCHMode'''
|-

|-
| pchSourceDir || enum ||
|-

|-
| pchObjectDir || enum ||
|-

|-
| pchSourceFile || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PrintScope'''
|-

|-
| psSelection || enum ||
|-

|-
| psActiveEditor || enum ||
|-

|-
| psAllOpenEditors || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PrintColourMode'''
|-

|-
| pcmBlackAndWhite || enum ||
|-

|-
| pcmColourOnWhite || enum ||
|-

|-
| pcmInvertColours || enum ||
|-

|-
| pcmAsIs || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum TemplateOutputType'''
|-

|-
| wizProject || enum || TemplateOutputType::totProject
|-

|-
| wizTarget || enum || TemplateOutputType::totTarget
|-

|-
| wizFiles || enum || TemplateOutputType::totFiles
|-

|-
| wizCustom || enum || TemplateOutputType::totCustom
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Other constants'''
|-

|-
| wxFILE_SEP_PATH || wxString || Path separator. "\" for windows, "/" for all other platforms
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''File extensions (e.g. "cbp")'''
|-

|-
| EXT_WORKSPACE || wxString ||
|-

|-
| EXT_CODEBLOCKS || wxString ||
|-

|-
| EXT_DEVCPP || wxString ||
|-

|-
| EXT_MSVC6 || wxString ||
|-

|-
| EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| EXT_MSVC7 || wxString ||
|-

|-
| EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| EXT_D || wxString ||
|-

|-
| EXT_F || wxString ||
|-

|-
| EXT_F77 || wxString ||
|-

|-
| EXT_F95 || wxString ||
|-

|-
| EXT_CPP || wxString ||
|-

|-
| EXT_C || wxString ||
|-

|-
| EXT_CC || wxString ||
|-

|-
| EXT_CXX || wxString ||
|-

|-
| EXT_HPP || wxString ||
|-

|-
| EXT_H || wxString ||
|-

|-
| EXT_HH || wxString ||
|-

|-
| EXT_HXX || wxString ||
|-

|-
| EXT_OBJECT || wxString ||
|-

|-
| EXT_XRCRESOURCE || wxString ||
|-

|-
| EXT_STATICLIB || wxString ||
|-

|-
| EXT_DYNAMICLIB || wxString ||
|-

|-
| EXT_EXECUTABLE || wxString ||
|-

|-
| EXT_RESOURCE || wxString ||
|-

|-
| EXT_RESOURCEBIN || wxString ||
|-

|-
| EXT_XML || wxString ||
|-

|-
| EXT_SCRIPT || wxString ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''File extensions with leading dot (e.g. ".cbp")'''
|-

|-
| DOT_EXT_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_CODEBLOCKS || wxString ||
|-

|-
| DOT_EXT_DEVCPP || wxString ||
|-

|-
| DOT_EXT_MSVC6 || wxString ||
|-

|-
| DOT_EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_MSVC7 || wxString ||
|-

|-
| DOT_EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_D || wxString ||
|-

|-
| DOT_EXT_F || wxString ||
|-

|-
| DOT_EXT_F77 || wxString ||
|-

|-
| DOT_EXT_F95 || wxString ||
|-

|-
| DOT_EXT_CPP || wxString ||
|-

|-
| DOT_EXT_C || wxString ||
|-

|-
| DOT_EXT_CC || wxString ||
|-

|-
| DOT_EXT_CXX || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_H || wxString ||
|-

|-
| DOT_EXT_HH || wxString ||
|-

|-
| DOT_EXT_HXX || wxString ||
|-

|-
| DOT_EXT_OBJECT || wxString ||
|-

|-
| DOT_EXT_XRCRESOURCE || wxString ||
|-

|-
| DOT_EXT_STATICLIB || wxString ||
|-

|-
| DOT_EXT_DYNAMICLIB || wxString ||
|-

|-
| DOT_EXT_EXECUTABLE || wxString ||
|-

|-
| DOT_EXT_RESOURCE || wxString ||
|-

|-
| DOT_EXT_RESOURCEBIN || wxString ||
|-

|-
| DOT_EXT_XML || wxString ||
|-

|-
| DOT_EXT_SCRIPT || wxString ||
|-

|}

== See also ==

* [[Scripting Code::Blocks|Scripting index]]