Code::Blocks - User contributions [en]

Announcement for plugins/patches

2025-05-27T07:59:32Z

LETARTARE: wxTranslatePluginForCB scripted plugin => obsolete

[[Category:Code::Blocks Plugins]]
=== HowTo announce a new plugin/patch or similar ===

''Please read carefully:''

This WiKi section is to announce:
* a new plugin that is '''not''' within the contrib folder of the SVN repository
* a patch that is '''not''' a bugfix or similar and/or will '''not''' be applied to the SVN repository (e.g. because it's very specific)
* a new lexer/template that is '''not''' completed or approved and/or will '''not''' be added to the SVN

If a plugin/patch/lexer/template is moved to the repository don't forget to remove it from here! This section is intended to '''collect''' the information about available plugins/patches/lexerers/templates in one place. So the announcement should be short and clear. It should (however) include at least the following content:
* Name of the plugin/patch/lexer/template and purpose 
* Version (state) and date of last update (or release in the first place) 
* Link to a thread (to be created) in the developers (plugin) forum for discussion of features, bugs, wishlist etc. 
* A link where the '''most up-to-date''' version can be downloaded (e.g. in the forum). 
The best way may be to copy the section from the '''template''' plugin/patch/lexer/template and update it with your information. This will ensure consistency in the best way! Read the article [[How to add another announcement]] to read how to change the WiKi accordingly.

=== Patch announcements ===

So far there are no new patches.

* [[Template for patch announcement]] (Read this before posting a new patch!)

=== Plugin announcements ===

These are the user-contributed plugins:

* [[Replace in Files]] (MortenMacFly)
* [[Tab versus Space]] (MortenMacFly)
* [[Edit Project]] (Killerbot)
* [[Matching Brace]] (Killerbot)
* [[Library Finder]] (byo)
* [[Environment Variables Editor]] (MortenMacFly)
* [[ThreadSearch]] (Dje)
* [[Code Snippets plugin]] (Artoj/Pecan)
* [[Interpreted Languages plugin]] (dmoore) ** OBSOLETE **
* [[Shell Extensions plugin]] (dmoore)
* [[Python plugin]] (dmoore)
* [[FindBrokenFiles scripted plugin]] (MortenMacFly)
* [[wxTranslatePluginForCB scripted plugin]] (LETARTARE) ** OBSOLETE **
* [[AddOnForQt plugin]] (LETARTARE)
* [[AutoVersioning]] (JGM)
* [[DragScroll plugin]]
* [[BrowseTracker plugin]]
* [[FortranProject plugin]]
* [[CbCollector plugin]] (LETARTARE)
* [[cbDiff plugin]]
* [[Project Exporter]]
* [[GitBlocks]] (tomolt)

* [https://forums.codeblocks.org/index.php/topic,13723.msg92518.html#msg92518 Bazaar] Bazaar version control (via Tools menu)
* [http://code.google.com/p/blackdoc/ BlackDoc] Derive project documentation in "BlackDoc" format
* [https://forums.codeblocks.org/index.php/topic,10901.0.html cbNSIS] Frontend for NSIS (Nullsoft installer system)
* [http://code.google.com/p/cbtortoisesvn CBTortoiseSVN] (SVN version control, working partially)
* [https://forums.codeblocks.org/index.php/topic,14184.0.html cbvcs] "Generic" version control, working partially
* [https://github.com/Lalaland/ClangComplete ClangComplete] Code-completion plugin using Clang (also see: [https://forums.codeblocks.org/index.php/topic,18785.0.html here] and [https://forums.codeblocks.org/index.php/topic,20623.0.html here])
* [https://forums.codeblocks.org/index.php/topic,14339.0.html CodePaste] Pase code on platforms like Pastebin
* [https://forums.codeblocks.org/index.php/topic,15915.0.html CompileOnDemand] Compile a file automatically if it has changed
* [https://forums.codeblocks.org/index.php/topic,8568.0.html ColorCoder] Frontend to setup/compute colour code to be used in source code
* [https://forums.codeblocks.org/index.php/topic,16885.0.html CDB Debugger] Integration with the CDB debugger
* [https://forums.codeblocks.org/index.php/topic,16512.0.html EditorConfig] Use cross IDE coding styles (also see http://editorconfig.org/)
* (Other) [https://forums.codeblocks.org/index.php/topic,16517.0.html EditorConfig]
* [https://github.com/ywx/FormatFortranIndentPlugin FormatFortranIndent] Indent Fortran code correctly - best with [[Fortran Project plugin|FortranProject plugin]]
* [https://forums.codeblocks.org/index.php/topic,13348.0.html InnoSetup] Frontend for InnoSetup installer system
* [https://forums.codeblocks.org/index.php/topic,16470.0.html ListToolbox] Parse, manipulate, and format lists of text
* [https://forums.codeblocks.org/index.php/topic,16935.0.html PythonCodeCompletion] Code completion for Python
* [https://forums.codeblocks.org/index.php/topic,16635.0.html PythonDebugger] Integrated Python debugging
* [https://forums.codeblocks.org/index.php/topic,16249.0.html Semantic highlight] (In progress)
* [https://forums.codeblocks.org/index.php/topic,7063.0.html SVNInside] (SVN version control, working, but partially crashing C::B)
* [http://sourceforge.net/projects/xpmeditor/ XPM Editor] Graphical editor inside C::B
* [https://github.com/earlgrey-bis/cb-OpenFilesListPlus OpenFilesListPlus] Enhanced version of OpenFilesList plugin

* [[Template for plugin announcement]] (Read this before posting a new plugin!)

=== Lexer/Templates announcements ===

* [[d_source File wizard]]

* [[Template for lexer/template announcement]] (Read this before posting a new lexer/template!)

AddOnForQt plugin

2025-05-23T16:20:02Z

LETARTARE: new version 4.1.5

* Name: AddOnForQt
* Author: LETARTARE
* Purpose: Plugin to compile C++ QT applications with 'Code::Blocks'
* Version: 4.1.5; State: release
* Last update: 23. May. 2025
* Forum thread for discussion: https://forums.codeblocks.org/index.php/topic,20000.60.html
* Link for download: [[https://sourceforge.net/projects/addonqtforcb/]]
*Notes: Please have a look in the forum before using this plugin. Any support is welcome.

 
...back to [[Announcement for plugins/patches]]:

AddOnForQt plugin

2025-05-20T14:47:36Z

LETARTARE: New site adresse and new version

* Name: AddOnForQt
* Author: LETARTARE
* Purpose: Plugin to compile C++ QT applications with 'Code::Blocks'
* Version: 4.1.4; State: release
* Last update: 16. May. 2025
* Forum thread for discussion: https://forums.codeblocks.org/index.php/topic,20000.60.html
* Link for download: [[https://sourceforge.net/projects/addonqtforcb/]]
*Notes: Please have a look in the forum before using this plugin. Any support is welcome.

 
...back to [[Announcement for plugins/patches]]:

AddOnForQt plugin

2025-05-20T14:45:06Z

LETARTARE: New version 4.1.4

* Name: AddOnForQt
* Author: LETARTARE
* Purpose: Plugin to compile C++ QT applications with 'Code::Blocks'
* Version: 4.1.4; State: release
* Last update: 16. May. 2025
* Forum thread for discussion: https://forums.codeblocks.org/index.php/topic,20000.60.html
* Link for download: [[https://sourceforge.net/projects/addonforqt/]]
*Notes: Please have a look in the forum before using this plugin. Any support is welcome.

 
...back to [[Announcement for plugins/patches]]:

AddOnForQt plugin

2025-05-18T13:42:05Z

LETARTARE: New site adresse and new version

* Name: AddOnForQt
* Author: LETARTARE
* Purpose: Plugin to compile C++ QT applications with 'Code::Blocks'
* Version: 4.0.0; State: release
* Last update: 12. January. 2025
* Forum thread for discussion: https://forums.codeblocks.org/index.php/topic,20000.60.html
* Link for download: [[https://sourceforge.net/projects/addonforqt/]]
*Notes: Please have a look in the forum before using this plugin. Any support is welcome.

 
...back to [[Announcement for plugins/patches]]:

CbCollector plugin

2025-05-18T13:36:57Z

LETARTARE: New version 2.6.5

Name: Collector

* Author: LETARTARE
* Purpose: Plugin to translate applications (wxWidgets) with ‘Code::Blocks’
* Version: 2.6.5, State: release
* Last update: May 05. 2025
* Forum thread for discussion: https://forums.codeblocks.org/index.php/topic,24978.msg170230/topicseen.html#msg170230
* Link for download: [[https://sourceforge.net/projects/collectorforcb/]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.
* Notes : '''The change of site will allow an update to the latest version: PENDING'''

...back to Announcement for plugins/patches:

WxTranslatePluginForCB scripted plugin

2025-03-16T12:52:26Z

LETARTARE: The warning is in bold

* Name: wxTranslatePluginForCB
* Author: LETARTARE
* Purpose: The goal is to translate, in the local language, the development projects under 'Code::Blocks', only those using 'wxWidgets'.
:The extension script 'script\wxTranslate_plugin.script' to generate in directory 'trlocale' a file
::- 'name_projet.po' for a single project, or
::- 'name_projet_workspace.po' for cooperative project (workspace).
* Version: 0.4.5 ; State: alpha - '''beta''' - stable
* Last update: 28. Sept. 2013
* Forum thread for discussion: [/index.php/topic,18223.0.html]
* Link for download: [https://sourceforge.net/projects/wxtranslate/]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.
* '''ATTENTION : this plugin is obsolete''' !!
 
...back to [[Announcement for plugins/patches]]:

CbCollector plugin

2025-03-16T12:50:08Z

LETARTARE: Future changes highlighted in bold

Name: Collector

* Author: LETARTARE
* Purpose: Plugin to translate applications (wxWidgets) with ‘Code::Blocks’
* Version: 1.8.0, State: release
* Last update: January 05. 2025
* Forum thread for discussion: https://forums.codeblocks.org/index.php/topic,24978.msg170230/topicseen.html#msg170230
* Link for download: [[https://sourceforge.net/projects/collectorforcb/]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.
* Notes : '''The change of site will allow an update to the latest version: PENDING'''

...back to Announcement for plugins/patches:

CbCollector plugin

2025-03-16T11:08:42Z

LETARTARE: New versions pending

Name: Collector

* Author: LETARTARE
* Purpose: Plugin to translate applications (wxWidgets) with ‘Code::Blocks’
* Version: 1.8.0, State: release
* Last update: January 05. 2025
* Forum thread for discussion: https://forums.codeblocks.org/index.php/topic,24978.msg170230/topicseen.html#msg170230
* Link for download: [[https://sourceforge.net/projects/collectorforcb/]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.
* Notes : The change of site will allow an update to the latest version: PENDING

...back to Announcement for plugins/patches:

CbCollector plugin

2025-03-16T11:03:22Z

LETARTARE: Change site url

Name: Collector

* Author: LETARTARE
* Purpose: Plugin to translate applications (wxWidgets) with ‘Code::Blocks’
* Version: 2.4.0, State: release
* Last update: January 05. 2025
* Forum thread for discussion: https://forums.codeblocks.org/index.php/topic,24978.msg170230/topicseen.html#msg170230
* Link for download: [[https://sourceforge.net/projects/collectorforcb/]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.

...back to Announcement for plugins/patches:

CbCollector plugin

2025-01-17T08:50:59Z

LETARTARE: new version 2.4

Name: Collector

* Author: LETARTARE
* Purpose: Plugin to translate applications (wxWidgets) with ‘Code::Blocks’
* Version: 2.4.0, State: release
* Last update: January 05. 2025
* Forum thread for discussion: https://forums.codeblocks.org/index.php/topic,24978.msg170230/topicseen.html#msg170230
* Link for download: [[https://github.com/LETARTARE/CB_Collector.git]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.

...back to Announcement for plugins/patches:

AddOnForQt plugin

2025-01-17T08:45:58Z

LETARTARE: new version

* Name: AddOnForQt
* Author: LETARTARE
* Purpose: Plugin to compile C++ QT applications with 'Code::Blocks'
* Version: 4.0.0; State: release
* Last update: 12. January. 2025
* Forum thread for discussion: https://forums.codeblocks.org/index.php/topic,20000.60.html
* Link for download: [[https://github.com/LETARTARE/CB_AddOnForQt.git]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.

 
...back to [[Announcement for plugins/patches]]:

CbCollector plugin

2023-01-19T09:21:57Z

LETARTARE: verion

Name: Collector

* Author: LETARTARE
* Purpose: Plugin to translate applications (wxWidgets) with ‘Code::Blocks’
* Version: 1.8.0, State: release
* Last update: January 19. 2023
* Forum thread for discussion: https://forums.codeblocks.org/index.php/topic,24978.msg170230/topicseen.html#msg170230
* Link for download: [[https://github.com/LETARTARE/CB_Collector.git]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.

...back to Announcement for plugins/patches:

WxTranslatePluginForCB scripted plugin

2023-01-12T17:19:54Z

LETARTARE: Obsolete version

* Name: wxTranslatePluginForCB
* Author: LETARTARE
* Purpose: The goal is to translate, in the local language, the development projects under 'Code::Blocks', only those using 'wxWidgets'.
:The extension script 'script\wxTranslate_plugin.script' to generate in directory 'trlocale' a file
::- 'name_projet.po' for a single project, or
::- 'name_projet_workspace.po' for cooperative project (workspace).
* Version: 0.4.5 ; State: alpha - '''beta''' - stable
* Last update: 28. Sept. 2013
* Forum thread for discussion: [/index.php/topic,18223.0.html]
* Link for download: [https://sourceforge.net/projects/wxtranslate/]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.
* ATTENTION : this plugin is obsolete !!
 
...back to [[Announcement for plugins/patches]]:

CbCollector plugin

2023-01-12T17:04:48Z

LETARTARE: new version 1.7.9

Name: Collector

* Author: LETARTARE
* Purpose: Plugin to translate applications (wxWidgets) with ‘Code::Blocks’
* Version: 1.7.9, State: release
* Last update: January 12. 2023
* Forum thread for discussion: https://forums.codeblocks.org/index.php/topic,24978.msg170230/topicseen.html#msg170230
* Link for download: [[https://github.com/LETARTARE/CB_Collector.git]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.

...back to Announcement for plugins/patches:

AddOnForQt plugin

2023-01-12T17:03:34Z

LETARTARE: new version 3.5.1

* Name: AddOnForQt
* Author: LETARTARE
* Purpose: Plugin to compile C++ QT applications with 'Code::Blocks'
* Version: 3.5.1; State: release
* Last update: 12. January. 2023
* Forum thread for discussion: https://forums.codeblocks.org/index.php/topic,20000.60.html
* Link for download: [[https://github.com/LETARTARE/CB_AddOnForQt.git]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.

 
...back to [[Announcement for plugins/patches]]:

AddOnForQt plugin

2022-12-17T10:10:43Z

LETARTARE: version 3.5.0

* Name: AddOnForQt
* Author: LETARTARE
* Purpose: Plugin to compile C++ QT applications with 'Code::Blocks'
* Version: 3.5.0; State: release
* Last update: 17. December. 2022
* Forum thread for discussion: https://forums.codeblocks.org/index.php/topic,20000.60.html
* Link for download: [[https://github.com/LETARTARE/CB_AddOnForQt.git]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.

 
...back to [[Announcement for plugins/patches]]:

CbCollector plugin

2022-11-28T08:42:41Z

LETARTARE: new version

Name: Collector

* Author: LETARTARE
* Purpose: Plugin to translate applications (wxWidgets) with ‘Code::Blocks’
* Version: 1.7.2, State: release
* Last update: 31. May. 2022
* Forum thread for discussion: https://forums.codeblocks.org/index.php/topic,24978.msg170230/topicseen.html#msg170230
* Link for download: [[https://github.com/LETARTARE/CB_Collector.git]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.

...back to Announcement for plugins/patches:

Announcement for plugins/patches

2022-05-25T21:42:33Z

LETARTARE: Undo revision 9602 by LETARTARE (talk)

[[Category:Code::Blocks Plugins]]
=== HowTo announce a new plugin/patch or similar ===

''Please read carefully:''

This WiKi section is to announce:
* a new plugin that is '''not''' within the contrib folder of the SVN repository
* a patch that is '''not''' a bugfix or similar and/or will '''not''' be applied to the SVN repository (e.g. because it's very specific)
* a new lexer/template that is '''not''' completed or approved and/or will '''not''' be added to the SVN

If a plugin/patch/lexer/template is moved to the repository don't forget to remove it from here! This section is intended to '''collect''' the information about available plugins/patches/lexerers/templates in one place. So the announcement should be short and clear. It should (however) include at least the following content:
* Name of the plugin/patch/lexer/template and purpose 
* Version (state) and date of last update (or release in the first place) 
* Link to a thread (to be created) in the developers (plugin) forum for discussion of features, bugs, wishlist etc. 
* A link where the '''most up-to-date''' version can be downloaded (e.g. in the forum). 
The best way may be to copy the section from the '''template''' plugin/patch/lexer/template and update it with your information. This will ensure consistency in the best way! Read the article [[How to add another announcement]] to read how to change the WiKi accordingly.

=== Patch announcements ===

So far there are no new patches.

* [[Template for patch announcement]] (Read this before posting a new patch!)

=== Plugin announcements ===

These are the user-contributed plugins:

* [[Replace in Files]] (MortenMacFly)
* [[Tab versus Space]] (MortenMacFly)
* [[Edit Project]] (Killerbot)
* [[Matching Brace]] (Killerbot)
* [[Library Finder]] (byo)
* [[Environment Variables Editor]] (MortenMacFly)
* [[ThreadSearch]] (Dje)
* [[Code Snippets plugin]] (Artoj/Pecan)
* [[Interpreted Languages plugin]] (dmoore) ** OBSOLETE **
* [[Shell Extensions plugin]] (dmoore)
* [[Python plugin]] (dmoore)
* [[FindBrokenFiles scripted plugin]] (MortenMacFly)
* [[wxTranslatePluginForCB scripted plugin]] (LETARTARE)
* [[AddOnForQt plugin]] (LETARTARE)
* [[AutoVersioning]] (JGM)
* [[DragScroll plugin]]
* [[BrowseTracker plugin]]
* [[FortranProject plugin]]
* [[CbCollector plugin]] (LETARTARE)
* [[cbDiff plugin]]
* [[Project Exporter]]
* [[GitBlocks]] (tomolt)

* [https://forums.codeblocks.org/index.php/topic,13723.msg92518.html#msg92518 Bazaar] Bazaar version control (via Tools menu)
* [http://code.google.com/p/blackdoc/ BlackDoc] Derive project documentation in "BlackDoc" format
* [https://forums.codeblocks.org/index.php/topic,10901.0.html cbNSIS] Frontend for NSIS (Nullsoft installer system)
* [http://code.google.com/p/cbtortoisesvn CBTortoiseSVN] (SVN version control, working partially)
* [https://forums.codeblocks.org/index.php/topic,14184.0.html cbvcs] "Generic" version control, working partially
* [https://github.com/Lalaland/ClangComplete ClangComplete] Code-completion plugin using Clang (also see: [https://forums.codeblocks.org/index.php/topic,18785.0.html here] and [https://forums.codeblocks.org/index.php/topic,20623.0.html here])
* [https://forums.codeblocks.org/index.php/topic,14339.0.html CodePaste] Pase code on platforms like Pastebin
* [https://forums.codeblocks.org/index.php/topic,15915.0.html CompileOnDemand] Compile a file automatically if it has changed
* [https://forums.codeblocks.org/index.php/topic,8568.0.html ColorCoder] Frontend to setup/compute colour code to be used in source code
* [https://forums.codeblocks.org/index.php/topic,16885.0.html CDB Debugger] Integration with the CDB debugger
* [https://forums.codeblocks.org/index.php/topic,16512.0.html EditorConfig] Use cross IDE coding styles (also see http://editorconfig.org/)
* (Other) [https://forums.codeblocks.org/index.php/topic,16517.0.html EditorConfig]
* [https://github.com/ywx/FormatFortranIndentPlugin FormatFortranIndent] Indent Fortran code correctly - best with [[Fortran Project plugin|FortranProject plugin]]
* [https://forums.codeblocks.org/index.php/topic,13348.0.html InnoSetup] Frontend for InnoSetup installer system
* [https://forums.codeblocks.org/index.php/topic,16470.0.html ListToolbox] Parse, manipulate, and format lists of text
* [https://forums.codeblocks.org/index.php/topic,16935.0.html PythonCodeCompletion] Code completion for Python
* [https://forums.codeblocks.org/index.php/topic,16635.0.html PythonDebugger] Integrated Python debugging
* [https://forums.codeblocks.org/index.php/topic,16249.0.html Semantic highlight] (In progress)
* [https://forums.codeblocks.org/index.php/topic,7063.0.html SVNInside] (SVN version control, working, but partially crashing C::B)
* [http://sourceforge.net/projects/xpmeditor/ XPM Editor] Graphical editor inside C::B
* [https://github.com/earlgrey-bis/cb-OpenFilesListPlus OpenFilesListPlus] Enhanced version of OpenFilesList plugin

* [[Template for plugin announcement]] (Read this before posting a new plugin!)

=== Lexer/Templates announcements ===

* [[d_source File wizard]]

* [[Template for lexer/template announcement]] (Read this before posting a new lexer/template!)

Announcement for plugins/patches

2022-05-25T21:34:13Z

LETARTARE: /* update*/

[[Category:Code::Blocks Plugins]]
=== HowTo announce a new plugin/patch or similar ===

''Please read carefully:''

This WiKi section is to announce:
* a new plugin that is '''not''' within the contrib folder of the SVN repository
* a patch that is '''not''' a bugfix or similar and/or will '''not''' be applied to the SVN repository (e.g. because it's very specific)
* a new lexer/template that is '''not''' completed or approved and/or will '''not''' be added to the SVN

If a plugin/patch/lexer/template is moved to the repository don't forget to remove it from here! This section is intended to '''collect''' the information about available plugins/patches/lexerers/templates in one place. So the announcement should be short and clear. It should (however) include at least the following content:
* Name of the plugin/patch/lexer/template and purpose 
* Version (state) and date of last update (or release in the first place) 
* Link to a thread (to be created) in the developers (plugin) forum for discussion of features, bugs, wishlist etc. 
* A link where the '''most up-to-date''' version can be downloaded (e.g. in the forum). 
The best way may be to copy the section from the '''template''' plugin/patch/lexer/template and update it with your information. This will ensure consistency in the best way! Read the article [[How to add another announcement]] to read how to change the WiKi accordingly.

=== Patch announcements ===

So far there are no new patches.

* [[Template for patch announcement]] (Read this before posting a new patch!)

=== Plugin announcements ===

These are the user-contributed plugins:

* [[Replace in Files]] (MortenMacFly)
* [[Tab versus Space]] (MortenMacFly)
* [[Edit Project]] (Killerbot)
* [[Matching Brace]] (Killerbot)
* [[Library Finder]] (byo)
* [[Environment Variables Editor]] (MortenMacFly)
* [[ThreadSearch]] (Dje)
* [[Code Snippets plugin]] (Artoj/Pecan)
* [[Interpreted Languages plugin]] (dmoore) ** OBSOLETE **
* [[Shell Extensions plugin]] (dmoore)
* [[Python plugin]] (dmoore)
* [[FindBrokenFiles scripted plugin]] (MortenMacFly)
* [[wxTranslatePluginForCB scripted plugin]] (LETARTARE)
* [[AddOnForQt plugin]] (LETARTARE)
* [[Cb_Collector plugin]] (LETARTARE)
* [[AutoVersioning]] (JGM)
* [[DragScroll plugin]]
* [[BrowseTracker plugin]]
* [[FortranProject plugin]]
* [[cbDiff plugin]]
* [[Project Exporter]]
* [[GitBlocks]] (tomolt)

* [https://forums.codeblocks.org/index.php/topic,13723.msg92518.html#msg92518 Bazaar] Bazaar version control (via Tools menu)
* [http://code.google.com/p/blackdoc/ BlackDoc] Derive project documentation in "BlackDoc" format
* [https://forums.codeblocks.org/index.php/topic,10901.0.html cbNSIS] Frontend for NSIS (Nullsoft installer system)
* [http://code.google.com/p/cbtortoisesvn CBTortoiseSVN] (SVN version control, working partially)
* [https://forums.codeblocks.org/index.php/topic,14184.0.html cbvcs] "Generic" version control, working partially
* [https://github.com/Lalaland/ClangComplete ClangComplete] Code-completion plugin using Clang (also see: [https://forums.codeblocks.org/index.php/topic,18785.0.html here] and [https://forums.codeblocks.org/index.php/topic,20623.0.html here])
* [https://forums.codeblocks.org/index.php/topic,14339.0.html CodePaste] Pase code on platforms like Pastebin
* [https://forums.codeblocks.org/index.php/topic,15915.0.html CompileOnDemand] Compile a file automatically if it has changed
* [https://forums.codeblocks.org/index.php/topic,8568.0.html ColorCoder] Frontend to setup/compute colour code to be used in source code
* [https://forums.codeblocks.org/index.php/topic,16885.0.html CDB Debugger] Integration with the CDB debugger
* [https://forums.codeblocks.org/index.php/topic,16512.0.html EditorConfig] Use cross IDE coding styles (also see http://editorconfig.org/)
* (Other) [https://forums.codeblocks.org/index.php/topic,16517.0.html EditorConfig]
* [https://github.com/ywx/FormatFortranIndentPlugin FormatFortranIndent] Indent Fortran code correctly - best with [[Fortran Project plugin|FortranProject plugin]]
* [https://forums.codeblocks.org/index.php/topic,13348.0.html InnoSetup] Frontend for InnoSetup installer system
* [https://forums.codeblocks.org/index.php/topic,16470.0.html ListToolbox] Parse, manipulate, and format lists of text
* [https://forums.codeblocks.org/index.php/topic,16935.0.html PythonCodeCompletion] Code completion for Python
* [https://forums.codeblocks.org/index.php/topic,16635.0.html PythonDebugger] Integrated Python debugging
* [https://forums.codeblocks.org/index.php/topic,16249.0.html Semantic highlight] (In progress)
* [https://forums.codeblocks.org/index.php/topic,7063.0.html SVNInside] (SVN version control, working, but partially crashing C::B)
* [http://sourceforge.net/projects/xpmeditor/ XPM Editor] Graphical editor inside C::B
* [https://github.com/earlgrey-bis/cb-OpenFilesListPlus OpenFilesListPlus] Enhanced version of OpenFilesList plugin

* [[Template for plugin announcement]] (Read this before posting a new plugin!)

=== Lexer/Templates announcements ===

* [[d_source File wizard]]

* [[Template for lexer/template announcement]] (Read this before posting a new lexer/template!)

Code::Blocks SDK events

2022-05-25T12:53:41Z

LETARTARE: ccb* => cb*

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
[[Category:Plugin_development]]
During a Code::Blocks session, many things are happening: projects/files loading, closing, activating, saving, etc. These are interesting things that happen and various parts of Code::Blocks and its plugins are interested in them.
The Code::Blocks SDK provides functions that allow a part of the code to be "subscribed" to these events (i.e. be notified when they happen). This is what we'll look at in this article.

''Note: since mid-November 2007, loggers registration is handled with events too.''

''Note: The SDK version number is defined in 'cbplugin.h'''

=== Available events ===
There are many event constants defined for the interesting events that happens inside Code::Blocks. These constants are defined in
<tt>include/sdk_events.h</tt>
and listed at the bottom of this page.

Also note that there 4 different event categories:
* Logging system related (CodeBlocksLogEvent)
* View layout related (CodeBlocksLayoutEvent)
* Docking system related (CodeBlocksDockEvent)
* and everything else (CodeBlocksEvent)

=== Subscribing to events ===
Up until July 6th (2007) rev4233, Code::Blocks events were handled like other wxWidgets events: by declaring an event table in your class that should handle them and adding relevant event table entries.

But the event system changed radically on July 6th (2007) rev4234, in order to battle some shortcomings of the wxWidgets event system (at least for our usage). While designing the new system, great attention has been paid so that plugin writers have to do minimum changes to convert their code.

The class that handles all event registrations is the central class in Code::Blocks which you use if you want to do anything with the Code::Blocks SDK: <tt>Manager</tt>. Let's see by example how would a class (e.g. <tt>SomePlugin</tt>) subscribe for the cbEVT_EDITOR_SAVE event (fired when an editor's contents are saved):

// assuming an existing member function:
// void SomePlugin::OnEditorSaved(CodeBlocksEvent& event);

Manager::Get()->RegisterEventSink(cbEVT_EDITOR_SAVE, new cbEventFunctor<SomePlugin, CodeBlocksEvent>(this, &SomePlugin::OnEditorSaved));

Seems difficult? It isn't, if you realize what the second argument to <tt>Manager::RegisterEventSink</tt> does.

<tt>cbEventFunctor</tt> is a class that encapsulates a this-pointer call. It is like a C function pointer except that it works with class instances (i.e. a member-function pointer).
For obvious reasons it is a template class, taking two template arguments: the first is the class' name and the second is the type of the event the member function handles.

The constructor of <tt>cbEventFunctor</tt> takes two arguments: first is the class instance (we use the <tt>this</tt> pointer) and the second is the address of the member function.

And that's it. After using the above code, the defined function will be called-back on each editor saving :).

=== Unsubscribing from events ===
Usually there is no need to unsubscribe from event notifications. A plugin, for example, is automatically removed from all event notifications when it is detached (deactivated, unloaded, uninstalled).

But if you really think you need to unsubscribe from events, there is a function to do that:
<tt>Manager::Get()->RemoveAllEventSinksFor(void* owner)</tt>
As the sole argument, pass the instance that you registered the events in the first place.

Notice that this function will remove ''all event notifications'' for the specified instance. There is no way to remove event notifications selectively. It's an all-or-nothing deal...

=== When to register/unregister for event notifications? ===
In plugins, event notifications should be registered in
<tt>OnAttach()</tt>
As mentioned above, there is no need to unregister anything in
<tt>OnDetach()</tt>
because it is automatically done by Code::Blocks.

For code other than plugins, register whenever you think is better (depends on the actual code).

Also notice that Code::Blocks removes all registrations on shut down, so don't even think that we have memory leaks in that part ;).

=== Any examples? ===
If the example provided above is not enough, browse through the sources of the core/contrib Code::Blocks plugins.
A few of them register for events: just search the code for
<tt>RegisterEventSink</tt>
But it really is nothing difficult: just remove the event handlers from the class's event table and register with this new way.

Try using the [[DisplayEvents plugin]] if there is any difficulty determining which events to register.

=== List of Available Code::Blocks Events ===

==== List of SDK versions ====
[https://forums.codeblocks.org/index.php/topic,19981.msg136485.html#msg136485 SDK versions] with dates

==== Events that must be registered with RegisterEventSink (from 'sdk_events.cpp') ====
==> updated (May 03, 2021)

''app events''
* cbEVT_APP_STARTUP_DONE
* cbEVT_APP_START_SHUTDOWN
* cbEVT_APP_ACTIVATED (sdk 1.19.0)
* cbEVT_APP_DEACTIVATED (sdk 1.19.0)
* cbEVT_APP_CMDLINE

''plugin events'' (CodeBlocksEvent)
* cbEVT_PLUGIN_ATTACHED
* cbEVT_PLUGIN_RELEASED
* cbEVT_PLUGIN_INSTALLED : plugin manually loaded
* cbEVT_PLUGIN_UNINSTALLED : plugin manually unloaded
* cbEVT_PLUGIN_LOADING_COMPLETE (sdk 1.19.0)

''editor events'' (CodeBlocksEvent)
* cbEVT_EDITOR_CLOSE
* cbEVT_EDITOR_OPEN
* cbEVT_EDITOR_SWITCHED
* cbEVT_EDITOR_ACTIVATED
* cbEVT_EDITOR_DEACTIVATED
* cbEVT_EDITOR_BEFORE_SAVE (sdk 1.19.0)
* cbEVT_EDITOR_SAVE
* cbEVT_EDITOR_MODIFIED
* cbEVT_EDITOR_TOOLTIP
* cbEVT_EDITOR_TOOLTIP_CANCEL
* cbEVT_EDITOR_SPLIT
* cbEVT_EDITOR_UNSPLIT
* cbEVT_EDITOR_UPDATE_UI
* cbEVT_EDITOR_CC_DONE

''project events'' (CodeBlocksEvent)
* cbEVT_PROJECT_NEW (sdk 1.19.0)
* cbEVT_PROJECT_CLOSE
* cbEVT_PROJECT_OPEN
* cbEVT_PROJECT_SAVE
* cbEVT_PROJECT_ACTIVATE
* cbEVT_PROJECT_BEGIN_ADD_FILES
* cbEVT_PROJECT_END_ADD_FILES
* cbEVT_PROJECT_BEGIN_REMOVE_FILES
* cbEVT_PROJECT_END_REMOVE_FILES
* cbEVT_PROJECT_FILE_ADDED
* cbEVT_PROJECT_FILE_CHANGED
* cbEVT_PROJECT_FILE_REMOVED
* cbEVT_PROJECT_FILE_RENAMED (sdk 2.7.0)
* cbEVT_PROJECT_POPUP_MENU
* cbEVT_PROJECT_TARGETS_MODIFIED
* cbEVT_PROJECT_RENAMED
* cbEVT_PROJECT_OPTIONS_CHANGED (sdk 1.19.0)
* cbEVT_WORKSPACE_CHANGED
* cbEVT_WORKSPACE_LOADING_COMPLETE (sdk 1.19.0)
* cbEVT_WORKSPACE_CLOSING_BEGIN (sdk 1.19.0)
* cbEVT_WORKSPACE_CLOSING_COMPLETE (sdk 1.19.0)

''build targets events'' (CodeBlocksEvent) (sdk 1.19.0)
* cbEVT_BUILDTARGET_ADDED
* cbEVT_BUILDTARGET_REMOVED
* cbEVT_BUILDTARGET_RENAMED
* cbEVT_BUILDTARGET_SELECTED

''pipedprocess events'' (CodeBlocksEvent) (sdk 1.19.0)
* cbEVT_PIPEDPROCESS_STDOUT
* cbEVT_PIPEDPROCESS_STDERR
* cbEVT_PIPEDPROCESS_TERMINATED

''thread-pool events'' (CodeBlocksEvent) (sdk 1.19.0)
* cbEVT_THREADTASK_STARTED
* cbEVT_THREADTASK_ENDED
* cbEVT_THREADTASK_ALLDONE

''dockable windows'' (CodeBlocksDockEvent)
* cbEVT_ADD_DOCK_WINDOW: request app to add and manage a docked window
* cbEVT_REMOVE_DOCK_WINDOW: request app to stop managing a docked window
* cbEVT_SHOW_DOCK_WINDOW: request app to show a docked window
* cbEVT_HIDE_DOCK_WINDOW: request app to hide a docked window

''layout related events'' (CodeBlocksDockEvent)
* cbEVT_UPDATE_VIEW_LAYOUT (sdk 1.19.0) : force update current view layout
* cbEVT_QUERY_VIEW_LAYOUT : ask which is the current view layout
* cbEVT_SWITCH_VIEW_LAYOUT : request app to switch view layout
* cbEVT_SWITCHED_VIEW_LAYOUT : app notifies that a new layout has been applied
* cbEVT_DOCK_WINDOW_VISIBILITY : app notifies that a docked window has been hidden/show

''main menubar creation'' (CodeBlocksEvent)
* cbEVT_MENUBAR_CREATE_BEGIN: app notifies that the menubar is started being (re)created
* cbEVT_MENUBAR_CREATE_END: app notifies that the menubar (re)creation ended

''compiler-related events'' (CodeBlocksEvent)
* cbEVT_COMPILER_STARTED
* cbEVT_COMPILER_FINISHED
* cbEVT_COMPILER_SET_BUILD_OPTIONS (sdk 1.19.0)
* cbEVT_COMPILER_CLEAN_PROJECT_STARTED (sdk 1.19.0)
* cbEVT_CLEAN_WORKSPACE_STARTED (sdk 1.19.0)
* cbEVT_COMPILER_SETTING_CHANGED (sdk 1.19.0)
* cbEVT_COMPILE_FILE_REQUEST (sdk 1.19.0) : request app to compile a single file

''debugger-related events'' (CodeBlocksEvent)
* cbEVT_DEBUGGER_STARTED
* cbEVT_DEBUGGER_PAUSED
* cbEVT_DEBUGGER_FINISHED
* cbEVT_DEBUGGER_UPDATED (sdk 1.38.0)
* cbEVT_DEBUGGER_CURSOR_CHANGED
* cbEVT_DEBUGGER_CONTINUED (sdk 1.38.0)

''logging-system related events'' (CodeBlocksLogEvent)
* cbEVT_ADD_LOG_WINDOW: add a log window
* cbEVT_REMOVE_LOG_WINDOW: remove a log window
* cbEVT_HIDE_LOG_WINDOW (sdk 1.19.0) : hide a log window
* cbEVT_SWITCH_TO_LOG_WINDOW : switch to a log window (make it visible)
* cbEVT_GET_ACTIVE_LOG_WINDOW
* cbEVT_SHOW_LOG_MANAGER: show log manager
* cbEVT_HIDE_LOG_MANAGER: hide log manager
* cbEVT_LOCK_LOG_MANAGER: "lock" it (used with auto-hiding functionality)
* cbEVT_UNLOCK_LOG_MANAGER: "unlock" it (used with auto-hiding functionality)

''cbAUiNotebook related events'' (CodeBlocksLogEvent) (sdk 1.19.0)
* cbEVT_CBAUIBOOK_LEFT_DCLICK

''code-completion related events'' (CodeBlocksLogEvent) (sdk 1.19.0)
* cbEVT_COMPLETE_CODE
* cbEVT_SHOW_CALL_TIP

* cbEVT_SETTINGS_CHANGED

[[User:Mandrav|Mandrav]] 10:31, 23 November 2007 (UTC)

CbCollector plugin

2022-05-21T08:18:04Z

LETARTARE: update link adress

Name: Collector

* Author: LETARTARE
* Purpose: Plugin to translate applications (wxWidgets) with ‘Code::Blocks’
* Version: 1.6.0, State: release
* Last update: 21. May. 2022
* Forum thread for discussion: https://forums.codeblocks.org/index.php/topic,24978.msg170230/topicseen.html#msg170230
* Link for download: [[https://github.com/LETARTARE/CB_Collector.git]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.

...back to Announcement for plugins/patches:

CbCollector plugin

2022-05-21T08:11:50Z

LETARTARE: /* Cb_Collector announcements */

Name: Collector

* Author: LETARTARE
* Purpose: Plugin to translate applications (wxWidgets) with ‘Code::Blocks’
* Version: 1.6.0, State: release
* Last update: 21. May. 2022
* Forum thread for discussion: [https://forums.codeblocks.org/index.php/topic,24978.msg170230/topicseen.html#msg170230]]
* Link for download: [[https://github.com/LETARTARE/CB_Collector.git]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.

...back to Announcement for plugins/patches:

Announcement for plugins/patches

2022-05-21T08:04:59Z

LETARTARE: /* Cb_Collector announcements */

[[Category:Code::Blocks Plugins]]
=== HowTo announce a new plugin/patch or similar ===

''Please read carefully:''

This WiKi section is to announce:
* a new plugin that is '''not''' within the contrib folder of the SVN repository
* a patch that is '''not''' a bugfix or similar and/or will '''not''' be applied to the SVN repository (e.g. because it's very specific)
* a new lexer/template that is '''not''' completed or approved and/or will '''not''' be added to the SVN

If a plugin/patch/lexer/template is moved to the repository don't forget to remove it from here! This section is intended to '''collect''' the information about available plugins/patches/lexerers/templates in one place. So the announcement should be short and clear. It should (however) include at least the following content:
* Name of the plugin/patch/lexer/template and purpose 
* Version (state) and date of last update (or release in the first place) 
* Link to a thread (to be created) in the developers (plugin) forum for discussion of features, bugs, wishlist etc. 
* A link where the '''most up-to-date''' version can be downloaded (e.g. in the forum). 
The best way may be to copy the section from the '''template''' plugin/patch/lexer/template and update it with your information. This will ensure consistency in the best way! Read the article [[How to add another announcement]] to read how to change the WiKi accordingly.

=== Patch announcements ===

So far there are no new patches.

* [[Template for patch announcement]] (Read this before posting a new patch!)

=== Plugin announcements ===

These are the user-contributed plugins:

* [[Replace in Files]] (MortenMacFly)
* [[Tab versus Space]] (MortenMacFly)
* [[Edit Project]] (Killerbot)
* [[Matching Brace]] (Killerbot)
* [[Library Finder]] (byo)
* [[Environment Variables Editor]] (MortenMacFly)
* [[ThreadSearch]] (Dje)
* [[Code Snippets plugin]] (Artoj/Pecan)
* [[Interpreted Languages plugin]] (dmoore) ** OBSOLETE **
* [[Shell Extensions plugin]] (dmoore)
* [[Python plugin]] (dmoore)
* [[FindBrokenFiles scripted plugin]] (MortenMacFly)
* [[wxTranslatePluginForCB scripted plugin]] (LETARTARE)
* [[AddOnForQt plugin]] (LETARTARE)
* [[AutoVersioning]] (JGM)
* [[DragScroll plugin]]
* [[BrowseTracker plugin]]
* [[FortranProject plugin]]
* [[CbCollector plugin]] (LETARTARE)
* [[cbDiff plugin]]
* [[Project Exporter]]
* [[GitBlocks]] (tomolt)

* [https://forums.codeblocks.org/index.php/topic,13723.msg92518.html#msg92518 Bazaar] Bazaar version control (via Tools menu)
* [http://code.google.com/p/blackdoc/ BlackDoc] Derive project documentation in "BlackDoc" format
* [https://forums.codeblocks.org/index.php/topic,10901.0.html cbNSIS] Frontend for NSIS (Nullsoft installer system)
* [http://code.google.com/p/cbtortoisesvn CBTortoiseSVN] (SVN version control, working partially)
* [https://forums.codeblocks.org/index.php/topic,14184.0.html cbvcs] "Generic" version control, working partially
* [https://github.com/Lalaland/ClangComplete ClangComplete] Code-completion plugin using Clang (also see: [https://forums.codeblocks.org/index.php/topic,18785.0.html here] and [https://forums.codeblocks.org/index.php/topic,20623.0.html here])
* [https://forums.codeblocks.org/index.php/topic,14339.0.html CodePaste] Pase code on platforms like Pastebin
* [https://forums.codeblocks.org/index.php/topic,15915.0.html CompileOnDemand] Compile a file automatically if it has changed
* [https://forums.codeblocks.org/index.php/topic,8568.0.html ColorCoder] Frontend to setup/compute colour code to be used in source code
* [https://forums.codeblocks.org/index.php/topic,16885.0.html CDB Debugger] Integration with the CDB debugger
* [https://forums.codeblocks.org/index.php/topic,16512.0.html EditorConfig] Use cross IDE coding styles (also see http://editorconfig.org/)
* (Other) [https://forums.codeblocks.org/index.php/topic,16517.0.html EditorConfig]
* [https://github.com/ywx/FormatFortranIndentPlugin FormatFortranIndent] Indent Fortran code correctly - best with [[Fortran Project plugin|FortranProject plugin]]
* [https://forums.codeblocks.org/index.php/topic,13348.0.html InnoSetup] Frontend for InnoSetup installer system
* [https://forums.codeblocks.org/index.php/topic,16470.0.html ListToolbox] Parse, manipulate, and format lists of text
* [https://forums.codeblocks.org/index.php/topic,16935.0.html PythonCodeCompletion] Code completion for Python
* [https://forums.codeblocks.org/index.php/topic,16635.0.html PythonDebugger] Integrated Python debugging
* [https://forums.codeblocks.org/index.php/topic,16249.0.html Semantic highlight] (In progress)
* [https://forums.codeblocks.org/index.php/topic,7063.0.html SVNInside] (SVN version control, working, but partially crashing C::B)
* [http://sourceforge.net/projects/xpmeditor/ XPM Editor] Graphical editor inside C::B
* [https://github.com/earlgrey-bis/cb-OpenFilesListPlus OpenFilesListPlus] Enhanced version of OpenFilesList plugin

* [[Template for plugin announcement]] (Read this before posting a new plugin!)

=== Lexer/Templates announcements ===

* [[d_source File wizard]]

* [[Template for lexer/template announcement]] (Read this before posting a new lexer/template!)

CB AddOnForQt plugin

2022-02-22T15:45:01Z

LETARTARE: Suppression

AddOnForQt plugin

2022-02-22T15:40:15Z

LETARTARE: Created page with "* Name: AddOnForQt * Author: LETARTARE * Purpose: Plugin to compile C++ QT applications with 'Code::Blocks' * Version: 3.4; State: release * Last update: 17. December. 2021 *..."

* Name: AddOnForQt
* Author: LETARTARE
* Purpose: Plugin to compile C++ QT applications with 'Code::Blocks'
* Version: 3.4; State: release
* Last update: 17. December. 2021
* Forum thread for discussion: https://forums.codeblocks.org/index.php/topic,20000.60.html
* Link for download: [[https://github.com/LETARTARE/CB_AddOnForQt.git]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.

 
...back to [[Announcement for plugins/patches]]:

Announcement for plugins/patches

2022-02-22T15:35:40Z

LETARTARE: change title 'CB_AddOnForQt' => 'AddOnForQt plugin'

[[Category:Code::Blocks Plugins]]
=== HowTo announce a new plugin/patch or similar ===

''Please read carefully:''

This WiKi section is to announce:
* a new plugin that is '''not''' within the contrib folder of the SVN repository
* a patch that is '''not''' a bugfix or similar and/or will '''not''' be applied to the SVN repository (e.g. because it's very specific)
* a new lexer/template that is '''not''' completed or approved and/or will '''not''' be added to the SVN

If a plugin/patch/lexer/template is moved to the repository don't forget to remove it from here! This section is intended to '''collect''' the information about available plugins/patches/lexerers/templates in one place. So the announcement should be short and clear. It should (however) include at least the following content:
* Name of the plugin/patch/lexer/template and purpose 
* Version (state) and date of last update (or release in the first place) 
* Link to a thread (to be created) in the developers (plugin) forum for discussion of features, bugs, wishlist etc. 
* A link where the '''most up-to-date''' version can be downloaded (e.g. in the forum). 
The best way may be to copy the section from the '''template''' plugin/patch/lexer/template and update it with your information. This will ensure consistency in the best way! Read the article [[How to add another announcement]] to read how to change the WiKi accordingly.

=== Patch announcements ===

So far there are no new patches.

* [[Template for patch announcement]] (Read this before posting a new patch!)

=== Plugin announcements ===

These are the user-contributed plugins:

* [[Replace in Files]] (MortenMacFly)
* [[Tab versus Space]] (MortenMacFly)
* [[Edit Project]] (Killerbot)
* [[Matching Brace]] (Killerbot)
* [[Library Finder]] (byo)
* [[Environment Variables Editor]] (MortenMacFly)
* [[ThreadSearch]] (Dje)
* [[Code Snippets plugin]] (Artoj/Pecan)
* [[Interpreted Languages plugin]] (dmoore) ** OBSOLETE **
* [[Shell Extensions plugin]] (dmoore)
* [[Python plugin]] (dmoore)
* [[FindBrokenFiles scripted plugin]] (MortenMacFly)
* [[wxTranslatePluginForCB scripted plugin]] (LETARTARE)
* [[AddOnForQt plugin]] (LETARTARE)
* [[AutoVersioning]] (JGM)
* [[DragScroll plugin]]
* [[BrowseTracker plugin]]
* [[FortranProject plugin]]
* [[cbDiff plugin]]
* [[Project Exporter]]
* [[GitBlocks]] (tomolt)

* [https://forums.codeblocks.org/index.php/topic,13723.msg92518.html#msg92518 Bazaar] Bazaar version control (via Tools menu)
* [http://code.google.com/p/blackdoc/ BlackDoc] Derive project documentation in "BlackDoc" format
* [https://forums.codeblocks.org/index.php/topic,10901.0.html cbNSIS] Frontend for NSIS (Nullsoft installer system)
* [http://code.google.com/p/cbtortoisesvn CBTortoiseSVN] (SVN version control, working partially)
* [https://forums.codeblocks.org/index.php/topic,14184.0.html cbvcs] "Generic" version control, working partially
* [https://github.com/Lalaland/ClangComplete ClangComplete] Code-completion plugin using Clang (also see: [https://forums.codeblocks.org/index.php/topic,18785.0.html here] and [https://forums.codeblocks.org/index.php/topic,20623.0.html here])
* [https://forums.codeblocks.org/index.php/topic,14339.0.html CodePaste] Pase code on platforms like Pastebin
* [https://forums.codeblocks.org/index.php/topic,15915.0.html CompileOnDemand] Compile a file automatically if it has changed
* [https://forums.codeblocks.org/index.php/topic,8568.0.html ColorCoder] Frontend to setup/compute colour code to be used in source code
* [https://forums.codeblocks.org/index.php/topic,16885.0.html CDB Debugger] Integration with the CDB debugger
* [https://forums.codeblocks.org/index.php/topic,16512.0.html EditorConfig] Use cross IDE coding styles (also see http://editorconfig.org/)
* (Other) [https://forums.codeblocks.org/index.php/topic,16517.0.html EditorConfig]
* [https://github.com/ywx/FormatFortranIndentPlugin FormatFortranIndent] Indent Fortran code correctly - best with [[Fortran Project plugin|FortranProject plugin]]
* [https://forums.codeblocks.org/index.php/topic,13348.0.html InnoSetup] Frontend for InnoSetup installer system
* [https://forums.codeblocks.org/index.php/topic,16470.0.html ListToolbox] Parse, manipulate, and format lists of text
* [https://forums.codeblocks.org/index.php/topic,16935.0.html PythonCodeCompletion] Code completion for Python
* [https://forums.codeblocks.org/index.php/topic,16635.0.html PythonDebugger] Integrated Python debugging
* [https://forums.codeblocks.org/index.php/topic,16249.0.html Semantic highlight] (In progress)
* [https://forums.codeblocks.org/index.php/topic,7063.0.html SVNInside] (SVN version control, working, but partially crashing C::B)
* [http://sourceforge.net/projects/xpmeditor/ XPM Editor] Graphical editor inside C::B
* [https://github.com/earlgrey-bis/cb-OpenFilesListPlus OpenFilesListPlus] Enhanced version of OpenFilesList plugin

* [[Template for plugin announcement]] (Read this before posting a new plugin!)

=== Lexer/Templates announcements ===

* [[d_source File wizard]]

* [[Template for lexer/template announcement]] (Read this before posting a new lexer/template!)

CB AddOnForQt plugin

2022-02-22T15:32:51Z

LETARTARE: update date

CB AddOnForQt plugin

2022-02-22T15:31:47Z

LETARTARE: update title 'CB_AddOnForQt' => 'AddOnForQt'

* Name: AddOnForQt
* Author: LETARTARE
* Purpose: Plugin to compile C++ QT applications with 'Code::Blocks'
* Version: 3.4; State: release
* Last update: 01. January. 2020
* Forum thread for discussion: https://forums.codeblocks.org/index.php/topic,20000.60.html
* Link for download: [[https://github.com/LETARTARE/CB_AddOnForQt.git]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.

 
...back to [[Announcement for plugins/patches]]:

Announcement for plugins/patches

2022-02-22T15:27:55Z

LETARTARE: Delete obsolete plugin 'QtPregen'

[[Category:Code::Blocks Plugins]]
=== HowTo announce a new plugin/patch or similar ===

''Please read carefully:''

This WiKi section is to announce:
* a new plugin that is '''not''' within the contrib folder of the SVN repository
* a patch that is '''not''' a bugfix or similar and/or will '''not''' be applied to the SVN repository (e.g. because it's very specific)
* a new lexer/template that is '''not''' completed or approved and/or will '''not''' be added to the SVN

If a plugin/patch/lexer/template is moved to the repository don't forget to remove it from here! This section is intended to '''collect''' the information about available plugins/patches/lexerers/templates in one place. So the announcement should be short and clear. It should (however) include at least the following content:
* Name of the plugin/patch/lexer/template and purpose 
* Version (state) and date of last update (or release in the first place) 
* Link to a thread (to be created) in the developers (plugin) forum for discussion of features, bugs, wishlist etc. 
* A link where the '''most up-to-date''' version can be downloaded (e.g. in the forum). 
The best way may be to copy the section from the '''template''' plugin/patch/lexer/template and update it with your information. This will ensure consistency in the best way! Read the article [[How to add another announcement]] to read how to change the WiKi accordingly.

=== Patch announcements ===

So far there are no new patches.

* [[Template for patch announcement]] (Read this before posting a new patch!)

=== Plugin announcements ===

These are the user-contributed plugins:

* [[Replace in Files]] (MortenMacFly)
* [[Tab versus Space]] (MortenMacFly)
* [[Edit Project]] (Killerbot)
* [[Matching Brace]] (Killerbot)
* [[Library Finder]] (byo)
* [[Environment Variables Editor]] (MortenMacFly)
* [[ThreadSearch]] (Dje)
* [[Code Snippets plugin]] (Artoj/Pecan)
* [[Interpreted Languages plugin]] (dmoore) ** OBSOLETE **
* [[Shell Extensions plugin]] (dmoore)
* [[Python plugin]] (dmoore)
* [[FindBrokenFiles scripted plugin]] (MortenMacFly)
* [[wxTranslatePluginForCB scripted plugin]] (LETARTARE)
* [[CB_AddOnForQt plugin]] (LETARTARE)
* [[AutoVersioning]] (JGM)
* [[DragScroll plugin]]
* [[BrowseTracker plugin]]
* [[FortranProject plugin]]
* [[cbDiff plugin]]
* [[Project Exporter]]
* [[GitBlocks]] (tomolt)

* [https://forums.codeblocks.org/index.php/topic,13723.msg92518.html#msg92518 Bazaar] Bazaar version control (via Tools menu)
* [http://code.google.com/p/blackdoc/ BlackDoc] Derive project documentation in "BlackDoc" format
* [https://forums.codeblocks.org/index.php/topic,10901.0.html cbNSIS] Frontend for NSIS (Nullsoft installer system)
* [http://code.google.com/p/cbtortoisesvn CBTortoiseSVN] (SVN version control, working partially)
* [https://forums.codeblocks.org/index.php/topic,14184.0.html cbvcs] "Generic" version control, working partially
* [https://github.com/Lalaland/ClangComplete ClangComplete] Code-completion plugin using Clang (also see: [https://forums.codeblocks.org/index.php/topic,18785.0.html here] and [https://forums.codeblocks.org/index.php/topic,20623.0.html here])
* [https://forums.codeblocks.org/index.php/topic,14339.0.html CodePaste] Pase code on platforms like Pastebin
* [https://forums.codeblocks.org/index.php/topic,15915.0.html CompileOnDemand] Compile a file automatically if it has changed
* [https://forums.codeblocks.org/index.php/topic,8568.0.html ColorCoder] Frontend to setup/compute colour code to be used in source code
* [https://forums.codeblocks.org/index.php/topic,16885.0.html CDB Debugger] Integration with the CDB debugger
* [https://forums.codeblocks.org/index.php/topic,16512.0.html EditorConfig] Use cross IDE coding styles (also see http://editorconfig.org/)
* (Other) [https://forums.codeblocks.org/index.php/topic,16517.0.html EditorConfig]
* [https://github.com/ywx/FormatFortranIndentPlugin FormatFortranIndent] Indent Fortran code correctly - best with [[Fortran Project plugin|FortranProject plugin]]
* [https://forums.codeblocks.org/index.php/topic,13348.0.html InnoSetup] Frontend for InnoSetup installer system
* [https://forums.codeblocks.org/index.php/topic,16470.0.html ListToolbox] Parse, manipulate, and format lists of text
* [https://forums.codeblocks.org/index.php/topic,16935.0.html PythonCodeCompletion] Code completion for Python
* [https://forums.codeblocks.org/index.php/topic,16635.0.html PythonDebugger] Integrated Python debugging
* [https://forums.codeblocks.org/index.php/topic,16249.0.html Semantic highlight] (In progress)
* [https://forums.codeblocks.org/index.php/topic,7063.0.html SVNInside] (SVN version control, working, but partially crashing C::B)
* [http://sourceforge.net/projects/xpmeditor/ XPM Editor] Graphical editor inside C::B
* [https://github.com/earlgrey-bis/cb-OpenFilesListPlus OpenFilesListPlus] Enhanced version of OpenFilesList plugin

* [[Template for plugin announcement]] (Read this before posting a new plugin!)

=== Lexer/Templates announcements ===

* [[d_source File wizard]]

* [[Template for lexer/template announcement]] (Read this before posting a new lexer/template!)

CB AddOnForQt plugin

2022-01-27T10:06:46Z

LETARTARE: update link

* Name: CB_AddOnForQt
* Author: LETARTARE
* Purpose: Plugin to compile C++ QT applications with 'Code::Blocks'
* Version: 3.4; State: release
* Last update: 01. January. 2020
* Forum thread for discussion: https://forums.codeblocks.org/index.php/topic,20000.60.html
* Link for download: [[https://github.com/LETARTARE/CB_AddOnForQt.git]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.

 
...back to [[Announcement for plugins/patches]]:

CB AddOnForQt plugin

2022-01-27T10:02:23Z

LETARTARE: update version

* Name: CB_AddOnForQt
* Author: LETARTARE
* Purpose: Plugin to compile C++ QT applications with 'Code::Blocks'
* Version: 3.4; State: release
* Last update: 01. January. 2020
* Forum thread for discussion: [[/index.php/topic,20000.msg165730.html#msg165730]]
* Link for download: [[https://github.com/LETARTARE/CB_AddOnForQt.git]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.

 
...back to [[Announcement for plugins/patches]]:

Announcement for plugins/patches

2020-12-28T14:08:38Z

LETARTARE: update

[[Category:Code::Blocks Plugins]]
=== HowTo announce a new plugin/patch or similar ===

''Please read carefully:''

This WiKi section is to announce:
* a new plugin that is '''not''' within the contrib folder of the SVN repository
* a patch that is '''not''' a bugfix or similar and/or will '''not''' be applied to the SVN repository (e.g. because it's very specific)
* a new lexer/template that is '''not''' completed or approved and/or will '''not''' be added to the SVN

If a plugin/patch/lexer/template is moved to the repository don't forget to remove it from here! This section is intended to '''collect''' the information about available plugins/patches/lexerers/templates in one place. So the announcement should be short and clear. It should (however) include at least the following content:
* Name of the plugin/patch/lexer/template and purpose 
* Version (state) and date of last update (or release in the first place) 
* Link to a thread (to be created) in the developers (plugin) forum for discussion of features, bugs, wishlist etc. 
* A link where the '''most up-to-date''' version can be downloaded (e.g. in the forum). 
The best way may be to copy the section from the '''template''' plugin/patch/lexer/template and update it with your information. This will ensure consistency in the best way! Read the article [[How to add another announcement]] to read how to change the WiKi accordingly.

=== Patch announcements ===

So far there are no new patches.

* [[Template for patch announcement]] (Read this before posting a new patch!)

=== Plugin announcements ===

These are the user-contributed plugins:

* [[Replace in Files]] (MortenMacFly)
* [[Tab versus Space]] (MortenMacFly)
* [[Edit Project]] (Killerbot)
* [[Matching Brace]] (Killerbot)
* [[Library Finder]] (byo)
* [[Environment Variables Editor]] (MortenMacFly)
* [[ThreadSearch]] (Dje)
* [[Code Snippets plugin]] (Artoj/Pecan)
* [[Interpreted Languages plugin]] (dmoore) ** OBSOLETE **
* [[Shell Extensions plugin]] (dmoore)
* [[Python plugin]] (dmoore)
* [[FindBrokenFiles scripted plugin]] (MortenMacFly)
* [[wxTranslatePluginForCB scripted plugin]] (LETARTARE)
* [[QtPregenForCB plugin]] (LETARTARE)
* [[CB_AddOnForQt plugin]] (LETARTARE)
* [[AutoVersioning]] (JGM)
* [[DragScroll plugin]]
* [[BrowseTracker plugin]]
* [[FortranProject plugin]]
* [[cbDiff plugin]]
* [[Project Exporter]]
* [[GitBlocks]] (tomolt)

* [/index.php/topic,13723.msg92518.html#msg92518 Bazaar] Bazaar version control (via Tools menu)
* [http://code.google.com/p/blackdoc/ BlackDoc] Derive project documentation in "BlackDoc" format
* [/index.php/topic,10901.0.html cbNSIS] Frontend for NSIS (Nullsoft installer system)
* [http://code.google.com/p/cbtortoisesvn CBTortoiseSVN] (SVN version control, working partially)
* [/index.php/topic,14184.0.html cbvcs] "Generic" version control, working partially
* [https://github.com/Lalaland/ClangComplete ClangComplete] Code-completion plugin using Clang (also see: [/index.php/topic,18785.0.html here] and [/index.php/topic,20623.0.html here])
* [/index.php/topic,14339.0.html CodePaste] Pase code on platforms like Pastebin
* [/index.php/topic,15915.0.html CompileOnDemand] Compile a file automatically if it has changed
* [/index.php/topic,8568.0.html ColorCoder] Frontend to setup/compute colour code to be used in source code
* [/index.php/topic,16885.0.html CDB Debugger] Integration with the CDB debugger
* [/index.php/topic,16512.0.html EditorConfig] Use cross IDE coding styles (also see http://editorconfig.org/)
* (Other) [/index.php/topic,16517.0.html EditorConfig]
* [https://github.com/ywx/FormatFortranIndentPlugin FormatFortranIndent] Indent Fortran code correctly - best with [[Fortran Project plugin|FortranProject plugin]]
* [/index.php/topic,13348.0.html InnoSetup] Frontend for InnoSetup installer system
* [/index.php/topic,16470.0.html ListToolbox] Parse, manipulate, and format lists of text
* [/index.php/topic,16935.0.html PythonCodeCompletion] Code completion for Python
* [/index.php/topic,16635.0.html PythonDebugger] Integrated Python debugging
* [/index.php/topic,16249.0.html Semantic highlight] (In progress)
* [/index.php/topic,7063.0.html SVNInside] (SVN version control, working, but partially crashing C::B)
* [http://sourceforge.net/projects/xpmeditor/ XPM Editor] Graphical editor inside C::B
* [https://github.com/earlgrey-bis/cb-OpenFilesListPlus OpenFilesListPlus] Enhanced version of OpenFilesList plugin

* [[Template for plugin announcement]] (Read this before posting a new plugin!)

=== Lexer/Templates announcements ===

* [[d_source File wizard]]

* [[Template for lexer/template announcement]] (Read this before posting a new lexer/template!)

CB AddOnForQt plugin

2020-12-28T14:05:52Z

LETARTARE: adress forum

* Name: CB_AddOnForQt
* Author: LETARTARE
* Purpose: Plugin to compile C++ QT applications with 'Code::Blocks'
* Version: 3.3; State: release
* Last update: 01. January. 2020
* Forum thread for discussion: [[/index.php/topic,20000.msg165730.html#msg165730]]
* Link for download: [[https://github.com/LETARTARE/CB_AddOnForQt.git]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.

 
...back to [[Announcement for plugins/patches]]:

CB AddOnForQt plugin

2020-12-28T14:03:12Z

LETARTARE: new annonce

* Name: CB_AddOnForQy
* Author: LETARTARE
* Purpose: Plugin to compile C++ QT applications with 'Code::Blocks'
* Version: 3.3; State: release
* Last update: 01. January. 2020
* Forum thread for discussion: [[http:///index.php/topic,20000.0.html#new]]
* Link for download: [[https://github.com/LETARTARE/CB_AddOnForQt.git]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.

 
...back to [[Announcement for plugins/patches]]:

Announcement for plugins/patches

2020-12-28T13:58:19Z

LETARTARE: adress AddonFOrQt

[[Category:Code::Blocks Plugins]]
=== HowTo announce a new plugin/patch or similar ===

''Please read carefully:''

This WiKi section is to announce:
* a new plugin that is '''not''' within the contrib folder of the SVN repository
* a patch that is '''not''' a bugfix or similar and/or will '''not''' be applied to the SVN repository (e.g. because it's very specific)
* a new lexer/template that is '''not''' completed or approved and/or will '''not''' be added to the SVN

If a plugin/patch/lexer/template is moved to the repository don't forget to remove it from here! This section is intended to '''collect''' the information about available plugins/patches/lexerers/templates in one place. So the announcement should be short and clear. It should (however) include at least the following content:
* Name of the plugin/patch/lexer/template and purpose 
* Version (state) and date of last update (or release in the first place) 
* Link to a thread (to be created) in the developers (plugin) forum for discussion of features, bugs, wishlist etc. 
* A link where the '''most up-to-date''' version can be downloaded (e.g. in the forum). 
The best way may be to copy the section from the '''template''' plugin/patch/lexer/template and update it with your information. This will ensure consistency in the best way! Read the article [[How to add another announcement]] to read how to change the WiKi accordingly.

=== Patch announcements ===

So far there are no new patches.

* [[Template for patch announcement]] (Read this before posting a new patch!)

=== Plugin announcements ===

These are the user-contributed plugins:

* [[Replace in Files]] (MortenMacFly)
* [[Tab versus Space]] (MortenMacFly)
* [[Edit Project]] (Killerbot)
* [[Matching Brace]] (Killerbot)
* [[Library Finder]] (byo)
* [[Environment Variables Editor]] (MortenMacFly)
* [[ThreadSearch]] (Dje)
* [[Code Snippets plugin]] (Artoj/Pecan)
* [[Interpreted Languages plugin]] (dmoore) ** OBSOLETE **
* [[Shell Extensions plugin]] (dmoore)
* [[Python plugin]] (dmoore)
* [[FindBrokenFiles scripted plugin]] (MortenMacFly)
* [[wxTranslatePluginForCB scripted plugin]] (LETARTARE)
* [[QtPregenForCB plugin]] (LETARTARE)
* [[CB_AddOnForQt plugin]] [http://www.example.com titre du lien] (LETARTARE)
* [[AutoVersioning]] (JGM)
* [[DragScroll plugin]]
* [[BrowseTracker plugin]]
* [[FortranProject plugin]]
* [[cbDiff plugin]]
* [[Project Exporter]]
* [[GitBlocks]] (tomolt)

* [/index.php/topic,13723.msg92518.html#msg92518 Bazaar] Bazaar version control (via Tools menu)
* [http://code.google.com/p/blackdoc/ BlackDoc] Derive project documentation in "BlackDoc" format
* [/index.php/topic,10901.0.html cbNSIS] Frontend for NSIS (Nullsoft installer system)
* [http://code.google.com/p/cbtortoisesvn CBTortoiseSVN] (SVN version control, working partially)
* [/index.php/topic,14184.0.html cbvcs] "Generic" version control, working partially
* [https://github.com/Lalaland/ClangComplete ClangComplete] Code-completion plugin using Clang (also see: [/index.php/topic,18785.0.html here] and [/index.php/topic,20623.0.html here])
* [/index.php/topic,14339.0.html CodePaste] Pase code on platforms like Pastebin
* [/index.php/topic,15915.0.html CompileOnDemand] Compile a file automatically if it has changed
* [/index.php/topic,8568.0.html ColorCoder] Frontend to setup/compute colour code to be used in source code
* [/index.php/topic,16885.0.html CDB Debugger] Integration with the CDB debugger
* [/index.php/topic,16512.0.html EditorConfig] Use cross IDE coding styles (also see http://editorconfig.org/)
* (Other) [/index.php/topic,16517.0.html EditorConfig]
* [https://github.com/ywx/FormatFortranIndentPlugin FormatFortranIndent] Indent Fortran code correctly - best with [[Fortran Project plugin|FortranProject plugin]]
* [/index.php/topic,13348.0.html InnoSetup] Frontend for InnoSetup installer system
* [/index.php/topic,16470.0.html ListToolbox] Parse, manipulate, and format lists of text
* [/index.php/topic,16935.0.html PythonCodeCompletion] Code completion for Python
* [/index.php/topic,16635.0.html PythonDebugger] Integrated Python debugging
* [/index.php/topic,16249.0.html Semantic highlight] (In progress)
* [/index.php/topic,7063.0.html SVNInside] (SVN version control, working, but partially crashing C::B)
* [http://sourceforge.net/projects/xpmeditor/ XPM Editor] Graphical editor inside C::B
* [https://github.com/earlgrey-bis/cb-OpenFilesListPlus OpenFilesListPlus] Enhanced version of OpenFilesList plugin

* [[Template for plugin announcement]] (Read this before posting a new plugin!)

=== Lexer/Templates announcements ===

* [[d_source File wizard]]

* [[Template for lexer/template announcement]] (Read this before posting a new lexer/template!)

Announcement for plugins/patches

2020-12-28T13:56:12Z

LETARTARE: Add AddonFOrQt

[[Category:Code::Blocks Plugins]]
=== HowTo announce a new plugin/patch or similar ===

''Please read carefully:''

This WiKi section is to announce:
* a new plugin that is '''not''' within the contrib folder of the SVN repository
* a patch that is '''not''' a bugfix or similar and/or will '''not''' be applied to the SVN repository (e.g. because it's very specific)
* a new lexer/template that is '''not''' completed or approved and/or will '''not''' be added to the SVN

If a plugin/patch/lexer/template is moved to the repository don't forget to remove it from here! This section is intended to '''collect''' the information about available plugins/patches/lexerers/templates in one place. So the announcement should be short and clear. It should (however) include at least the following content:
* Name of the plugin/patch/lexer/template and purpose 
* Version (state) and date of last update (or release in the first place) 
* Link to a thread (to be created) in the developers (plugin) forum for discussion of features, bugs, wishlist etc. 
* A link where the '''most up-to-date''' version can be downloaded (e.g. in the forum). 
The best way may be to copy the section from the '''template''' plugin/patch/lexer/template and update it with your information. This will ensure consistency in the best way! Read the article [[How to add another announcement]] to read how to change the WiKi accordingly.

=== Patch announcements ===

So far there are no new patches.

* [[Template for patch announcement]] (Read this before posting a new patch!)

=== Plugin announcements ===

These are the user-contributed plugins:

* [[Replace in Files]] (MortenMacFly)
* [[Tab versus Space]] (MortenMacFly)
* [[Edit Project]] (Killerbot)
* [[Matching Brace]] (Killerbot)
* [[Library Finder]] (byo)
* [[Environment Variables Editor]] (MortenMacFly)
* [[ThreadSearch]] (Dje)
* [[Code Snippets plugin]] (Artoj/Pecan)
* [[Interpreted Languages plugin]] (dmoore) ** OBSOLETE **
* [[Shell Extensions plugin]] (dmoore)
* [[Python plugin]] (dmoore)
* [[FindBrokenFiles scripted plugin]] (MortenMacFly)
* [[wxTranslatePluginForCB scripted plugin]] (LETARTARE)
* [[QtPregenForCB plugin]] (LETARTARE)
* [[CB_AddOnForQt plugin]] (LETARTARE)
* [[AutoVersioning]] (JGM)
* [[DragScroll plugin]]
* [[BrowseTracker plugin]]
* [[FortranProject plugin]]
* [[cbDiff plugin]]
* [[Project Exporter]]
* [[GitBlocks]] (tomolt)

* [/index.php/topic,13723.msg92518.html#msg92518 Bazaar] Bazaar version control (via Tools menu)
* [http://code.google.com/p/blackdoc/ BlackDoc] Derive project documentation in "BlackDoc" format
* [/index.php/topic,10901.0.html cbNSIS] Frontend for NSIS (Nullsoft installer system)
* [http://code.google.com/p/cbtortoisesvn CBTortoiseSVN] (SVN version control, working partially)
* [/index.php/topic,14184.0.html cbvcs] "Generic" version control, working partially
* [https://github.com/Lalaland/ClangComplete ClangComplete] Code-completion plugin using Clang (also see: [/index.php/topic,18785.0.html here] and [/index.php/topic,20623.0.html here])
* [/index.php/topic,14339.0.html CodePaste] Pase code on platforms like Pastebin
* [/index.php/topic,15915.0.html CompileOnDemand] Compile a file automatically if it has changed
* [/index.php/topic,8568.0.html ColorCoder] Frontend to setup/compute colour code to be used in source code
* [/index.php/topic,16885.0.html CDB Debugger] Integration with the CDB debugger
* [/index.php/topic,16512.0.html EditorConfig] Use cross IDE coding styles (also see http://editorconfig.org/)
* (Other) [/index.php/topic,16517.0.html EditorConfig]
* [https://github.com/ywx/FormatFortranIndentPlugin FormatFortranIndent] Indent Fortran code correctly - best with [[Fortran Project plugin|FortranProject plugin]]
* [/index.php/topic,13348.0.html InnoSetup] Frontend for InnoSetup installer system
* [/index.php/topic,16470.0.html ListToolbox] Parse, manipulate, and format lists of text
* [/index.php/topic,16935.0.html PythonCodeCompletion] Code completion for Python
* [/index.php/topic,16635.0.html PythonDebugger] Integrated Python debugging
* [/index.php/topic,16249.0.html Semantic highlight] (In progress)
* [/index.php/topic,7063.0.html SVNInside] (SVN version control, working, but partially crashing C::B)
* [http://sourceforge.net/projects/xpmeditor/ XPM Editor] Graphical editor inside C::B
* [https://github.com/earlgrey-bis/cb-OpenFilesListPlus OpenFilesListPlus] Enhanced version of OpenFilesList plugin

* [[Template for plugin announcement]] (Read this before posting a new plugin!)

=== Lexer/Templates announcements ===

* [[d_source File wizard]]

* [[Template for lexer/template announcement]] (Read this before posting a new lexer/template!)

QtPregenForCB plugin

2020-12-28T13:52:48Z

LETARTARE:

* Name: QtPregenForCB
* Author: LETARTARE
* Purpose: Plugin to compile C++ QT applications with 'Code::Blocks'
* Version: 2.7.3; State: release
* Last update: 28. April. 2020
* Forum thread for discussion: [[/index.php/topic,20000.new.html#new]]
* Link for download: [[https://github.com/LETARTARE/QtPregenForCB]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.
* Remark : '''From January 01, 2020, 'Qtpregen' will be replaced by 'Addonforqt'''' [[https://github.com/LETARTARE/CB_AddonForQt.git]]
 
...back to [[Announcement for plugins/patches]]:

QtPregenForCB plugin

2020-12-28T13:51:49Z

LETARTARE: adress AddonFOrQt

* Name: QtPregenForCB
* Author: LETARTARE
* Purpose: Plugin to compile C++ QT applications with 'Code::Blocks'
* Version: 2.7.3; State: release
* Last update: 28. April. 2020
* Forum thread for discussion: [[/index.php/topic,20000.new.html#new]]
* Link for download: [[https://github.com/LETARTARE/QtPregenForCB]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.
* Remark : From January 01, 2020, 'Qtpregen' will be replaced by 'Addonforqt' [[https://github.com/LETARTARE/CB_AddonForQt.git]]
 
...back to [[Announcement for plugins/patches]]:

QtPregenForCB plugin

2020-12-28T13:47:56Z

LETARTARE: end of qtpregen

* Name: QtPregenForCB
* Author: LETARTARE
* Purpose: Plugin to compile C++ QT applications with 'Code::Blocks'
* Version: 2.7.3; State: release
* Last update: 28. April. 2020
* Forum thread for discussion: [[/index.php/topic,20000.new.html#new]]
* Link for download: [[https://github.com/LETARTARE/QtPregenForCB]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.
* Remark : From January 01, 2020, 'Qtpregen' will be replaced by 'Addonforqt'
 
...back to [[Announcement for plugins/patches]]:

QtPregenForCB plugin

2020-07-10T14:05:40Z

LETARTARE: new release

* Name: QtPregenForCB
* Author: LETARTARE
* Purpose: Plugin to compile C++ QT applications with 'Code::Blocks'
* Version: 2.7.3; State: release
* Last update: 28. April. 2020
* Forum thread for discussion: [[/index.php/topic,20000.new.html#new]]
* Link for download: [[https://github.com/LETARTARE/QtPregenForCB]]
* Notes: Please have a look in the forum before using this plugin. Any support is welcome.
 
...back to [[Announcement for plugins/patches]]:

Code::Blocks SDK events

2020-06-10T05:49:15Z

LETARTARE: /* Events that must be registered with RegisterEventSink (from 'sdk_events.cpp') */

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
[[Category:Plugin_development]]
During a Code::Blocks session, many things are happening: projects/files loading, closing, activating, saving, etc. These are interesting things that happen and various parts of Code::Blocks and its plugins are interested in them.
The Code::Blocks SDK provides functions that allow a part of the code to be "subscribed" to these events (i.e. be notified when they happen). This is what we'll look at in this article.

''Note: since mid-November 2007, loggers registration is handled with events too.''

''Note: The SDK version number is defined in 'cbplugin.h'''

=== Available events ===
There are many event constants defined for the interesting events that happens inside Code::Blocks. These constants are defined in
<tt>include/sdk_events.h</tt>
and listed at the bottom of this page.

Also note that there 4 different event categories:
* Logging system related (CodeBlocksLogEvent)
* View layout related (CodeBlocksLayoutEvent)
* Docking system related (CodeBlocksDockEvent)
* and everything else (CodeBlocksEvent)

=== Subscribing to events ===
Up until July 6th (2007) rev4233, Code::Blocks events were handled like other wxWidgets events: by declaring an event table in your class that should handle them and adding relevant event table entries.

But the event system changed radically on July 6th (2007) rev4234, in order to battle some shortcomings of the wxWidgets event system (at least for our usage). While designing the new system, great attention has been paid so that plugin writers have to do minimum changes to convert their code.

The class that handles all event registrations is the central class in Code::Blocks which you use if you want to do anything with the Code::Blocks SDK: <tt>Manager</tt>. Let's see by example how would a class (e.g. <tt>SomePlugin</tt>) subscribe for the cbEVT_EDITOR_SAVE event (fired when an editor's contents are saved):

// assuming an existing member function:
// void SomePlugin::OnEditorSaved(CodeBlocksEvent& event);

Manager::Get()->RegisterEventSink(cbEVT_EDITOR_SAVE, new cbEventFunctor<SomePlugin, CodeBlocksEvent>(this, &SomePlugin::OnEditorSaved));

Seems difficult? It isn't, if you realize what the second argument to <tt>Manager::RegisterEventSink</tt> does.

<tt>cbEventFunctor</tt> is a class that encapsulates a this-pointer call. It is like a C function pointer except that it works with class instances (i.e. a member-function pointer).
For obvious reasons it is a template class, taking two template arguments: the first is the class' name and the second is the type of the event the member function handles.

The constructor of <tt>cbEventFunctor</tt> takes two arguments: first is the class instance (we use the <tt>this</tt> pointer) and the second is the address of the member function.

And that's it. After using the above code, the defined function will be called-back on each editor saving :).

=== Unsubscribing from events ===
Usually there is no need to unsubscribe from event notifications. A plugin, for example, is automatically removed from all event notifications when it is detached (deactivated, unloaded, uninstalled).

But if you really think you need to unsubscribe from events, there is a function to do that:
<tt>Manager::Get()->RemoveAllEventSinksFor(void* owner)</tt>
As the sole argument, pass the instance that you registered the events in the first place.

Notice that this function will remove ''all event notifications'' for the specified instance. There is no way to remove event notifications selectively. It's an all-or-nothing deal...

=== When to register/unregister for event notifications? ===
In plugins, event notifications should be registered in
<tt>OnAttach()</tt>
As mentioned above, there is no need to unregister anything in
<tt>OnDetach()</tt>
because it is automatically done by Code::Blocks.

For code other than plugins, register whenever you think is better (depends on the actual code).

Also notice that Code::Blocks removes all registrations on shut down, so don't even think that we have memory leaks in that part ;).

=== Any examples? ===
If the example provided above is not enough, browse through the sources of the core/contrib Code::Blocks plugins.
A few of them register for events: just search the code for
<tt>RegisterEventSink</tt>
But it really is nothing difficult: just remove the event handlers from the class's event table and register with this new way.

Try using the [[DisplayEvents plugin]] if there is any difficulty determining which events to register.

=== List of Available Code::Blocks Events ===

==== List of SDK versions ====
[/index.php/topic,19981.msg136485.html#msg136485 Versions SDK]

==== Events that must be registered with RegisterEventSink (from 'sdk_events.cpp') ====
==> updated (January 01, 2018) since sdk 1.33.0 (Code::Blocks 17.12)

''app events''
* cbEVT_APP_STARTUP_DONE
* cbEVT_APP_START_SHUTDOWN
* cbEVT_APP_ACTIVATED (sdk 1.19.0)
* cbEVT_APP_DEACTIVATED (sdk 1.19.0)
* ccbEVT_APP_CMDLINE

''plugin events'' (CodeBlocksEvent)
* cbEVT_PLUGIN_ATTACHED
* cbEVT_PLUGIN_RELEASED
* cbEVT_PLUGIN_INSTALLED : plugin manually loaded
* cbEVT_PLUGIN_UNINSTALLED : plugin manually unloaded
* cbEVT_PLUGIN_LOADING_COMPLETE (sdk 1.19.0)

''editor events'' (CodeBlocksEvent)
* cbEVT_EDITOR_CLOSE
* cbEVT_EDITOR_OPEN
* cbEVT_EDITOR_SWITCHED
* cbEVT_EDITOR_ACTIVATED
* cbEVT_EDITOR_DEACTIVATED
* cbEVT_EDITOR_BEFORE_SAVE (sdk 1.19.0)
* cbEVT_EDITOR_SAVE
* cbEVT_EDITOR_MODIFIED
* cbEVT_EDITOR_TOOLTIP
* cbEVT_EDITOR_TOOLTIP_CANCEL
* cbEVT_EDITOR_SPLIT
* cbEVT_EDITOR_UNSPLIT
* cbEVT_EDITOR_UPDATE_UI
* cbEVT_EDITOR_CC_DONE

''project events'' (CodeBlocksEvent)
* cbEVT_PROJECT_NEW (sdk 1.19.0)
* cbEVT_PROJECT_CLOSE
* cbEVT_PROJECT_OPEN
* cbEVT_PROJECT_SAVE
* cbEVT_PROJECT_ACTIVATE
* cbEVT_PROJECT_BEGIN_ADD_FILES
* cbEVT_PROJECT_END_ADD_FILES
* cbEVT_PROJECT_BEGIN_REMOVE_FILES
* cbEVT_PROJECT_END_REMOVE_FILES
* cbEVT_PROJECT_FILE_ADDED
* cbEVT_PROJECT_FILE_REMOVED
* cbEVT_PROJECT_FILE_CHANGED
* cbEVT_PROJECT_POPUP_MENU
* cbEVT_PROJECT_TARGETS_MODIFIED
* cbEVT_PROJECT_RENAMED
* cbEVT_PROJECT_OPTIONS_CHANGED (sdk 1.19.0)
* cbEVT_WORKSPACE_CHANGED
* cbEVT_WORKSPACE_LOADING_COMPLETE (sdk 1.19.0)
* cbEVT_WORKSPACE_CLOSING_BEGIN (sdk 1.19.0)
* cbEVT_WORKSPACE_CLOSING_COMPLETE (sdk 1.19.0)

''build targets events'' (CodeBlocksEvent) (sdk 1.19.0)
* cbEVT_BUILDTARGET_ADDED
* cbEVT_BUILDTARGET_REMOVED
* cbEVT_BUILDTARGET_RENAMED
* cbEVT_BUILDTARGET_SELECTED

''pipedprocess events'' (CodeBlocksEvent) (sdk 1.19.0)
* cbEVT_PIPEDPROCESS_STDOUT
* cbEVT_PIPEDPROCESS_STDERR
* cbEVT_PIPEDPROCESS_TERMINATED

''thread-pool events'' (CodeBlocksEvent) (sdk 1.19.0)
* cbEVT_THREADTASK_STARTED
* cbEVT_THREADTASK_ENDED
* cbEVT_THREADTASK_ALLDONE

''dockable windows'' (CodeBlocksDockEvent)
* cbEVT_ADD_DOCK_WINDOW: request app to add and manage a docked window
* cbEVT_REMOVE_DOCK_WINDOW: request app to stop managing a docked window
* cbEVT_SHOW_DOCK_WINDOW: request app to show a docked window
* cbEVT_HIDE_DOCK_WINDOW: request app to hide a docked window

''layout related events'' (CodeBlocksDockEvent)
* cbEVT_UPDATE_VIEW_LAYOUT (sdk 1.19.0) : force update current view layout
* cbEVT_QUERY_VIEW_LAYOUT : ask which is the current view layout
* cbEVT_SWITCH_VIEW_LAYOUT : request app to switch view layout
* cbEVT_SWITCHED_VIEW_LAYOUT : app notifies that a new layout has been applied
* cbEVT_DOCK_WINDOW_VISIBILITY : app notifies that a docked window has been hidden/show

''main menubar creation'' (CodeBlocksEvent)
* cbEVT_MENUBAR_CREATE_BEGIN: app notifies that the menubar is started being (re)created
* cbEVT_MENUBAR_CREATE_END: app notifies that the menubar (re)creation ended

''compiler-related events'' (CodeBlocksEvent)
* cbEVT_COMPILER_STARTED
* cbEVT_COMPILER_FINISHED
* cbEVT_COMPILER_SET_BUILD_OPTIONS (sdk 1.19.0)
* cbEVT_COMPILER_CLEAN_PROJECT_STARTED (sdk 1.19.0)
* cbEVT_CLEAN_WORKSPACE_STARTED (sdk 1.19.0)
* cbEVT_COMPILER_SETTING_CHANGED (sdk 1.19.0)
* cbEVT_COMPILE_FILE_REQUEST (sdk 1.19.0) : request app to compile a single file

''debugger-related events'' (CodeBlocksEvent)
* cbEVT_DEBUGGER_STARTED
* cbEVT_DEBUGGER_PAUSED
* cbEVT_DEBUGGER_FINISHED
* cbEVT_DEBUGGER_UPDATED
* cbEVT_DEBUGGER_CURSOR_CHANGED
* cbEVT_DEBUGGER_CONTINUED (sdk 1.38.0)

''logging-system related events'' (CodeBlocksLogEvent)
* cbEVT_ADD_LOG_WINDOW: add a log window
* cbEVT_REMOVE_LOG_WINDOW: remove a log window
* cbEVT_HIDE_LOG_WINDOW (sdk 1.19.0) : hide a log window
* cbEVT_SWITCH_TO_LOG_WINDOW : switch to a log window (make it visible)
* cbEVT_GET_ACTIVE_LOG_WINDOW
* cbEVT_SHOW_LOG_MANAGER: show log manager
* cbEVT_HIDE_LOG_MANAGER: hide log manager
* cbEVT_LOCK_LOG_MANAGER: "lock" it (used with auto-hiding functionality)
* cbEVT_UNLOCK_LOG_MANAGER: "unlock" it (used with auto-hiding functionality)

''cbAUiNotebook related events'' (CodeBlocksLogEvent) (sdk 1.19.0)
* cbEVT_CBAUIBOOK_LEFT_DCLICK

''code-completion related events'' (CodeBlocksLogEvent) (sdk 1.19.0)
* cbEVT_COMPLETE_CODE
* cbEVT_SHOW_CALL_TIP

* cbEVT_SETTINGS_CHANGED

[[User:Mandrav|Mandrav]] 10:31, 23 November 2007 (UTC)

Global compiler variables

2019-07-29T08:07:07Z

LETARTARE: /* Constraints on custom member */

[[Category:User Documentation]]
== Synopsis ==
Working as a developer on a project which relies on 3rd party libraries involves a lot of unnecessary repetitive tasks, such as setting up build variables according to the local filesystem layout. In the case of project files, care must be taken to not accidentially commit a locally modified copy. If one does not pay attention, this can happen easily for example after changing a build flag to make a release build.

The concept of global compiler variables is an unique new solution for Code::Blocks which addresses this problem.
Global compiler variables allow you to set up a project once, and any number of developers using any number of different filesystem layouts will be able to compile and develop the project. No local layout information ever needs to be changed more than once.

== Names and Members ==
Global compiler variables in Code::Blocks are discriminated from [[per-project variables]] by a leading hash sign. Global compiler variables are structured; every variable consists of a ''name'' and an optional ''member''.
Names are freely definable, while some of the members are built into the IDE. Although you can choose anything for a variable name in principle, it is advisable to pick a known identifier for common packages. This way, the amount of information that the user needs to provide is minimised. The Code::Blocks team provides a [[Recommended global variables|list of recommended variables]] for known packages.

The member <tt>base</tt> resolves to the same value as the variable name uses without a member (alias).

The members <tt>include</tt> and <tt>lib</tt> are by default aliases for ''base''<tt>/include</tt> and ''base''<tt>/lib</tt>, respectively. However, a user can redefine them if another setup is desired.

It is generally recommended to use the syntax <tt>$(#variable.include)</tt> instead of <tt>$(#variable)/include</tt>, as it provides additional flexibility and is otherwise exactly identical in functionality (see [[Global_compiler_variables#Custom_Members_Mini-Tutorial|mini tutorial]]).

The members <tt>cflags</tt> and <tt>lflags</tt> are empty by default and can be used to provide the ability to feed the same consistent set of compiler/linker flags to all builds on one machine.
Beginning with revision 2664 (4 July 2006), Code::Blocks allows you to define custom variable members in addition to the builtin ones.

[[Image:Gcv_ui.png]]

== Constraints ==
*Both set and global compiler variable names may not be empty, must not contain white space, must start with a letter and must consist of alphanumeric characters. Cyrillic or Chinese letters are not alphanumeric characters. If Code::Blocks is given invalid character sequences as name, it may replace them without asking.
*Every variable requires its base to be defined. Everything else is optional, but the base is absolutely mandatory. If you don't define a variable's base, it will not be saved (no matter what other fields you have defined).
*You may not define a custom member that has the same name as a builtin member. Currently, the custom member will overwrite the builtin member, but in general, the behaviour for this case is undefined. If <tt>'libext'</tt> is a custom member we can only write <tt>$(#variable.libext)</tt> and not <tt>$(#variable)/libext</tt>.
*Variable and member values may contain arbitrary character sequences, subject to the following three constraints:
**You may not define a variable by a value that references the same variable or any of its members
**You may not define a member by a value that references the same member
**You may not define a member or variable by a value that references the same variable or member through a cyclic dependency.
Code::Blocks will detect the most obvious cases of recursive definitions (which may happen by accident), but it will not perform an excessive depth analysis of every possible abuse. If you enter crap, then crap is what you will get, you have been warned.

Examples: 
defining <tt>wx.include</tt> as <tt>$(#wx)/include</tt> is redundant, but perfectly legal 
defining <tt>wx.include</tt> as <tt>$(#wx.include)</tt> is illegal and will be detected by Code::Blocks 
defining <tt>wx.include</tt> as <tt>$(#cb.lib)</tt> which again is defined as <tt>$(#wx.include)</tt> will create an infinite loop

== Using Global Compiler Variables ==
All you need to do to start using global compiler variables is to put them in your project! Yes, it is really that easy.

When the IDE detects the presence of an unknown global variable, it will prompt you to enter its value. The value will be saved in your settings, so you never need to enter the information twice.

If you need to modify or delete a variable at a later time, you can do so from the settings menu.

Example:

[[Image:Globvarsdir.png]]

The above image shows both per-procect and global variables. <tt>WX_CFG</tt> is defined in the project, but <tt>WX</tt> is a global user variable.

== Variable Sets ==
Sometimes, you want to use different versions of the same library, or you develop two branches of the same program. Although it is still possible to get around with a global compiler variable, it can become tedious. For this purpose, Code::Blocks supports variable sets. A variable set is an independent collection of variables identified by a name (set names have the same constraints as variable names).

If you wish to switch to a different set of variables, you simply select a different set from the menu. Different sets are not required to have the same variables, and identical variables in different sets are not required to have the same values, or even the same custom members.

Another positive thing about sets is that if you have a dozen variables and you want to have a new set with one of these variables pointing to a different location, you are not required to re-enter all this redundant data again. You can simply create a clone of your current set, this will duplicate all of your variables.

Deleting a set also deletes all variables in that set (but not in another set). The "default" set is always present and cannot be deleted.

== Custom Members Mini-Tutorial ==
As stated above, writing <tt>$(#var.include)</tt> and <tt>$(#var)/include</tt> is exactly the same thing by default.
So why would you want to write something as unintuitive as <tt>$(#var.include)</tt>?

Let's take a standard Boost installation under Windows as an example. Generally, you would expect a fictional package <tt>ACME</tt> to have its include files under <tt>ACME/include</tt> and its libraries under <tt>ACME/lib</tt>. Optionally, it might place its headers into yet another subfolder called <tt>acme</tt>.
Thus, after adding the correct paths to the compiler and linker options, you would expect to <tt>#include <acme/acme.h></tt> and link to <tt>libacme.a</tt> (or whatever it happens to be).

Boost, however, installs headers into <tt>C:\Boost\include\boost-1_33_1\boost</tt> and its libraries under <tt>C:\Boost\lib</tt> by default. It seems impossible to get this under one hood without having to adjust everything on every new PC, especially if you have to work under Linux or some other OS, too.

This is where the true power of global user variables is unveiled. When defining the value of the <tt>#boost</tt> variable, you go one step further than usual. You define the member <tt>include</tt> as <tt>C:\Boost\include\boost-1_33_1\boost</tt> and the member <tt>lib</tt> as <tt>C:\Boost\lib</tt>, respectively.
Your projects using <tt>$(#boost.include)</tt> and <tt>$(#boost.lib)</tt> will magically work on every PC without any modifications. You don't need to know why, you don't want to know why.

==See also==
* [[Variable expansion]]

Global compiler variables

2019-07-29T08:01:04Z

LETARTARE: /* Constraints on custom memeber */

[[Category:User Documentation]]
== Synopsis ==
Working as a developer on a project which relies on 3rd party libraries involves a lot of unnecessary repetitive tasks, such as setting up build variables according to the local filesystem layout. In the case of project files, care must be taken to not accidentially commit a locally modified copy. If one does not pay attention, this can happen easily for example after changing a build flag to make a release build.

The concept of global compiler variables is an unique new solution for Code::Blocks which addresses this problem.
Global compiler variables allow you to set up a project once, and any number of developers using any number of different filesystem layouts will be able to compile and develop the project. No local layout information ever needs to be changed more than once.

== Names and Members ==
Global compiler variables in Code::Blocks are discriminated from [[per-project variables]] by a leading hash sign. Global compiler variables are structured; every variable consists of a ''name'' and an optional ''member''.
Names are freely definable, while some of the members are built into the IDE. Although you can choose anything for a variable name in principle, it is advisable to pick a known identifier for common packages. This way, the amount of information that the user needs to provide is minimised. The Code::Blocks team provides a [[Recommended global variables|list of recommended variables]] for known packages.

The member <tt>base</tt> resolves to the same value as the variable name uses without a member (alias).

The members <tt>include</tt> and <tt>lib</tt> are by default aliases for ''base''<tt>/include</tt> and ''base''<tt>/lib</tt>, respectively. However, a user can redefine them if another setup is desired.

It is generally recommended to use the syntax <tt>$(#variable.include)</tt> instead of <tt>$(#variable)/include</tt>, as it provides additional flexibility and is otherwise exactly identical in functionality (see [[Global_compiler_variables#Custom_Members_Mini-Tutorial|mini tutorial]]).

The members <tt>cflags</tt> and <tt>lflags</tt> are empty by default and can be used to provide the ability to feed the same consistent set of compiler/linker flags to all builds on one machine.
Beginning with revision 2664 (4 July 2006), Code::Blocks allows you to define custom variable members in addition to the builtin ones.

[[Image:Gcv_ui.png]]

== Constraints ==
*Both set and global compiler variable names may not be empty, must not contain white space, must start with a letter and must consist of alphanumeric characters. Cyrillic or Chinese letters are not alphanumeric characters. If Code::Blocks is given invalid character sequences as name, it may replace them without asking.
*Every variable requires its base to be defined. Everything else is optional, but the base is absolutely mandatory. If you don't define a variable's base, it will not be saved (no matter what other fields you have defined).
*You may not define a custom member that has the same name as a builtin member. Currently, the custom member will overwrite the builtin member, but in general, the behaviour for this case is undefined. If <tt>'libext'</tt> is a custom member we can only write <tt>$(#variable.libext)</tt> and not <tt>$(#variable)/.libext</tt>.
*Variable and member values may contain arbitrary character sequences, subject to the following three constraints:
**You may not define a variable by a value that references the same variable or any of its members
**You may not define a member by a value that references the same member
**You may not define a member or variable by a value that references the same variable or member through a cyclic dependency.
Code::Blocks will detect the most obvious cases of recursive definitions (which may happen by accident), but it will not perform an excessive depth analysis of every possible abuse. If you enter crap, then crap is what you will get, you have been warned.

Examples: 
defining <tt>wx.include</tt> as <tt>$(#wx)/include</tt> is redundant, but perfectly legal 
defining <tt>wx.include</tt> as <tt>$(#wx.include)</tt> is illegal and will be detected by Code::Blocks 
defining <tt>wx.include</tt> as <tt>$(#cb.lib)</tt> which again is defined as <tt>$(#wx.include)</tt> will create an infinite loop

== Using Global Compiler Variables ==
All you need to do to start using global compiler variables is to put them in your project! Yes, it is really that easy.

When the IDE detects the presence of an unknown global variable, it will prompt you to enter its value. The value will be saved in your settings, so you never need to enter the information twice.

If you need to modify or delete a variable at a later time, you can do so from the settings menu.

Example:

[[Image:Globvarsdir.png]]

The above image shows both per-procect and global variables. <tt>WX_CFG</tt> is defined in the project, but <tt>WX</tt> is a global user variable.

== Variable Sets ==
Sometimes, you want to use different versions of the same library, or you develop two branches of the same program. Although it is still possible to get around with a global compiler variable, it can become tedious. For this purpose, Code::Blocks supports variable sets. A variable set is an independent collection of variables identified by a name (set names have the same constraints as variable names).

If you wish to switch to a different set of variables, you simply select a different set from the menu. Different sets are not required to have the same variables, and identical variables in different sets are not required to have the same values, or even the same custom members.

Another positive thing about sets is that if you have a dozen variables and you want to have a new set with one of these variables pointing to a different location, you are not required to re-enter all this redundant data again. You can simply create a clone of your current set, this will duplicate all of your variables.

Deleting a set also deletes all variables in that set (but not in another set). The "default" set is always present and cannot be deleted.

== Custom Members Mini-Tutorial ==
As stated above, writing <tt>$(#var.include)</tt> and <tt>$(#var)/include</tt> is exactly the same thing by default.
So why would you want to write something as unintuitive as <tt>$(#var.include)</tt>?

Let's take a standard Boost installation under Windows as an example. Generally, you would expect a fictional package <tt>ACME</tt> to have its include files under <tt>ACME/include</tt> and its libraries under <tt>ACME/lib</tt>. Optionally, it might place its headers into yet another subfolder called <tt>acme</tt>.
Thus, after adding the correct paths to the compiler and linker options, you would expect to <tt>#include <acme/acme.h></tt> and link to <tt>libacme.a</tt> (or whatever it happens to be).

Boost, however, installs headers into <tt>C:\Boost\include\boost-1_33_1\boost</tt> and its libraries under <tt>C:\Boost\lib</tt> by default. It seems impossible to get this under one hood without having to adjust everything on every new PC, especially if you have to work under Linux or some other OS, too.

This is where the true power of global user variables is unveiled. When defining the value of the <tt>#boost</tt> variable, you go one step further than usual. You define the member <tt>include</tt> as <tt>C:\Boost\include\boost-1_33_1\boost</tt> and the member <tt>lib</tt> as <tt>C:\Boost\lib</tt>, respectively.
Your projects using <tt>$(#boost.include)</tt> and <tt>$(#boost.lib)</tt> will magically work on every PC without any modifications. You don't need to know why, you don't want to know why.

==See also==
* [[Variable expansion]]

Scripting commands

2019-06-11T10:12:08Z

LETARTARE: /* remark target name */

[[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().

''NOTE: Updated to '''12.11'''

== 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 || Does [[Variable_expansion|variable expansion]] on the input wxString
|-

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

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

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

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

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

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

|-
| wxArrayString || GetArrayFromString || wxString,wxString,bool ||
|-

|-
| wxString || GetStringFromArray || wxArrayString,wxString,bool ||
|-

|-
| wxString || EscapeSpaces || wxString ||
|-

|-
| wxString || UnixFilename || wxString, int || arg1=filename, arg2=wxPATH_NATIVE, wxPATH_WIN, ...
|-

|-
| FileType || FileTypeOf || wxString ||
|-

|-
| wxString || URLEncode || wxString ||
|-

|-
| void || NotifyMissingFile || wxString ||
|-

|-
| int || GetPlatformsFromString || wxString ||
|-

|-
| wxString || GetStringFromPlatforms || int,bool||
|-

|-
| void|| InfoWindow || wxString,wxString,int,int || pop-up box in the lower right, see infowindow.h
|-

|-
| 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
|-

|-
| int || ExecuteToolPlugin || wxString || Execute a tool plugin (found in Plugins menu)
|-

|-
| int || ConfigureToolPlugin || wxString || Configure a tool plugin (found in Plugins menu)
|-

|-
| void || CallMenu || wxString || Call a menu entry describing its path using slashes (e.g. "/Valgrind/Run Valgrind::MemCheck")
|-

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

|-
| int || Require || wxString ||arg=script_filename, return 0 if ok
|-

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

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

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

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

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

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

|-
| long || wxString_ToLong || wxString const ||
|-

|}

== 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 || const wxString, int || arg1=key, arg2=default_val
|-

|-
| bool || Read || const wxString, bool || arg1=key, arg2=default_val
|-

|-
| float || Read || const wxString, float || arg1=key, arg2=default_val
|-

|-
| wxString || Read || const wxString, const wxString || arg1=key, arg2=default_val
|-

|-
| void || Write || const wxString, int || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, bool || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, float || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, const wxString, bool ||arg1=key, arg2=value, arg3=ignore_value_empty
|-

|}

== ProjectManager ==
see API docs for 'ProjectManager::...' in 'include\projectmanager.h'

{| 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 in Prototype
!Remarks
|-

|-
| wxString || GetDefaultPath || ( ) ||
|-

|-
| void || SetDefaultPath || (const wxString& path) ||
|-

|-
| cbProject* || GetActiveProject || ( ) ||
|-

|-
| int || GetProjectCount || ( ) ||
|-

|-
| cbProject* || GetProject || (int) ||
|-

|-
| void || SetProject || (cbProject* project, bool refresh = true) ||
|-

|-
| bool || LoadWorkspace || (const wxString& filename = DEFAULT_WORKSPACE)||
|-

|-
| bool || SaveWorkspace || ( ) ||
|-

|-
| bool || SaveWorkspaceAs || (const wxString& filename) ||
|-

|-
| bool || CloseWorkspace || ( ) ||
|-

|-
| cbProject* || IsOpen || (const wxString& filename) ||
|-

|-
| cbProject* || LoadProject || (const wxString& filename, bool activateIt = true) ||
|-

|-
| bool || SaveProject || (cbProject* project) ||
|-

|-
| bool || SaveProjectAs || (cbProject* project) ||
|-

|-
| bool || SaveActiveProject || ( ) ||
|-

|-
| bool || SaveActiveProjectAs || ( ) ||
|-

|-
| bool || SaveAllProjects || ( ) ||
|-

|-
| bool || CloseProject || (cbProject* project, bool dontsave = false, bool refresh = true) ||
|-

|-
| bool || CloseActiveProject || (bool dontsave = false) ||
|-

|-
| bool || CloseAllProjects || (bool dontsave = false) ||
|-

|-
| cbProject* || NewProject || (const wxString& filename = wxEmptyString) ||
|-

|-
| int || AddFileToProject || (const wxString& filename, cbProject* project = 0L, int target = -1) ||
|-

|-
| int || AskForBuildTargetIndex || (cbProject* project = 0L) ||

|-
| void || RebuildTree || ( ) ||
|-

|-
| bool || AddProjectDependency || (cbProject* base, cbProject* dependsOn) ||
|-

|-
| void || RemoveProjectDependency || (cbProject* base, cbProject* doesNotDependOn) ||
|-

|-
| void || ClearProjectDependencies || (cbProject* base) ||
|-

|-
| void || RemoveProjectFromAllDependencies || (cbProject* base) ||
|-

|-
| ProjectsArray* || GetDependenciesForProject || (cbProject* base) ||
|-

|-
| void || ConfigureProjectDependencies || (cbProject* base = 0) ||
|-
|}

== 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 in Prototype
!Remarks
|-

|-
| void || Configure || ( ) ||
|-

|-
| cbEditor* || New || (const wxString& newFileName = wxEmptyString) ||
|-

|-
| cbEditor* || Open || (const wxString& filename) ||
|-

|-
| cbEditor* || IsBuiltinOpen || (const wxString& filename) ||
|-

|-
| cbEditor* || GetBuiltinEditor || (const wxString& filename)|(int index) ||
|-

|-
| cbEditor* || GetBuiltinActiveEditor || ( ) ||
|-

|-
| EditorBase* || GetActiveEditor || ( ) ||
|-

|-
| void || ActivateNext || ( ) ||
|-

|-
| void || ActivatePrevious || ( ) ||
|-

|-
| bool || SwapActiveHeaderSource || ( ) ||
|-

|-
| bool || CloseActive || (bool dontsave = false) ||
|-

|-
| bool || Close || (const wxString& filename,bool dontsave = false)|(int index,bool dontsave = false),(EditorBase* editor,bool dontsave = false) ||
|-

|-
| bool || CloseAll || (bool dontsave=false) ||
|-

|-
| bool || Save || (const wxString& filename)|(int index)||
|-

|-
| bool || SaveActive || ( ) ||
|-

|-
| bool || SaveAs || (int index) ||
|-

|-
| bool || SaveActiveAs || ( ) ||
|-

|-
| bool || SaveAll || ( ) ||
|-

|-
| int || ShowFindDialog || (bool replace, bool explicitly_find_in_files = false) ||
|-

|}

== 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 in Prototype
!Remarks
|-

|-
| bool || Exists || (const wxString& variable) ||
|-

|}

== 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 in Prototype
!Remarks
|-

|-
| bool || DirectoryExists || (const wxString& dir) || '''1)'''
|-

|-
| wxString || SelectDirectory || (const wxString& message, const wxString& initialPath, bool showCreateDirButton) ||
|-

|-
| bool || '''CreateDirectory''' || (const wxString& full_path, int perms) || arg1=dir, arg2=permissions '''1)'''
|-

|-
| bool || '''RemoveDirectory''' || (const wxString& src) || '''1)'''
|-

|-
| bool || '''CopyFile''' ||(const wxString& src, const wxString& dst, bool overwrite) || '''1)'''
|-

|-
| bool || '''RenameFile''' || (const wxString& src, const wxString& dst) || old,new '''1)'''
|-

|-
| bool || '''RemoveFile''' || (const wxString& src) || '''1)'''
|-

|-
| bool || FileExists || (const wxString& file) || '''1)'''
|-

|-
| wxString || SelectFile || (const wxString& title, const wxString& defaultFile, const wxString& filter) ||
|-

|-
| wxString || ReadFileContents || (const wxString& filename) || '''1)'''
|-

|-
| bool || '''WriteFileContents''' || (const wxString& filename, const wxString& contents) || filename,contents '''1)'''
|-

|-
| int || '''Execute''' || (const wxString& command) ||
|-

|-
| wxString || '''ExecuteAndGetOutput''' || (const wxString& command) ||
|-

|-
| wxString || '''ExecuteAndGetOutputAndError''' || (const wxString& command, bool prepend_error) ||if 'prepend_error' is true gives an error string
|-

|-
| wxString || GetCwd || ( ) ||
|-

|-
| void || SetCwd || (const wxString& dir) || directory (currently working directory)
|-

|}

'''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.

'''NOTE: 1)''' All paths/filenames are expanded via the ReplaceMacros function prior the function is called. So it is possible to copy the project output file with
<source lang="c">
IO.CopyFile(_T("$(TARGET_OUTPUT_FILE)"),_T("output_directory/output_file"),true);
</source>

== 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 in Prototype
!Remarks
|-

|-
| bool || IsValidCompilerID || (const wxString& id) ||
|-

|-
| int || GetCompilerIndex || (const wxString& id) ||
|-

|-
| wxString || GetDefaultCompilerID || ( ) ||
|-

|-
| wxString || GetCompilerVersionString || (const wxString& Id) ||
|-

|-
| bool || CompilerInheritsFrom || ( ) ||
|-

|-
| wxString || GetCompilerIDByName || (const wxString &name ) || Makes it possible to find the compiler id by its name. Available since rev 9823.
|-
|}

== 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
|-

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

|-
| wxString || _ || const char* || the same as _T, but should be used for translatable strings
|-

|-
| wxString || operator= || const wxString ||
|-

|-
| wxString || operator+ || const wxString ||
|-

|-
| wxString || operator+ || const int ||
|-

|-
| wxString || operator+= || const wxString ||
|-

|-
| wxString || operator+= || const int ||
|-

|-
| bool || operator< || const wxString || _T("abc") < _T("cba") -> true
|-

|-
| bool || operator<= || const wxString ||
|-

|-
| bool || operator>= || const wxString ||
|-

|-
| bool || operator> || const wxString ||
|-

|-
| int || Find || wxString || -1 if not found
|-

|-
| bool || Matches || wxString || not use '==' !!, returns true if the string contents matches a mask containing '*' and '?'
|-

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

|-
| char || GetChar || int || arg1=position
|-

|-
| 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 || arg1=position, arg2=long
|-

|-
| wxString || Remove || int, int || arg1=position, arg2=long
|-

|-
| void || RemoveLast || int || remove the last characters
|-

|-
| int || Replace || wxString, wxString,bool || arg3=true -> all occurrences else the first
|-

|-
| wxString || Right || int x || return the x last characters
|-

|-
| wxString || AfterFirst || char || not found -> _T("")
|-

|-
| wxString || AfterLast || char || not found -> all the character string
|-

|-
| wxString || BeforeFirst || char || not found -> all the character string
|-

|-
| wxString || BeforeLast || char || not found -> _T("")
|-
|}
''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 || ||
|-

|-
| int || Index || wxString || -1 If not found
|-

|-
| wxString || Item || int || not work with wx 2.9.x ?!
|-

|}
''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 || ||
|-

|-
| bool || IsOk || || ONLY if (wxVERSION_NUMBER < 2900)
|-

|-
| void || Set || byte, byte, byte, byte || red, green, blue, alpha : into [0..255]
|-

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

''EXAMPLE: local my_wxcolour = ::wxColour(); my_wxcolour.Set(0xFF, 0x00, 0x00, 0x55); ::print(my_wxcolour) -> [r=255, g=0, b=0]

== wxFileName ==
'''UNDER VERIFICATION'''

{| 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 || Assign || const wxFileName || creates the file name from an other wxFileName
|-

|-
| void || Assign || const wxString, wxPathFormat || arg1=full_path, arg2=wformat=xPATH_NATIVE ...
|-

|-
| void || AssignCwd || const wxString || arg1=volume
|-

|-
| void || AssignDir|| const wxString, wxPathFormat || arg1=name_dir, arg2=format=wxPATH_NATIVE ...
|-

|-
| void || AssignHomeDir || || sets this file name object to the home directory
|-

|-
| void || Clear || || reset all components to default, uninitialized state
|-

|-
| void || ClearExt || || removes the extension from the file name resulting in a file name with no trailing dot
|-

|-
| int || GetDirCount || || returns the number of directories in the file name.
|-

|-
| wxArrayString || GetDirs || || returns the directories in string array form
|-

|-
| wxString || GetExt || || returns the file name extension.

|-

|-
| wxString || GetFullName || || returns the full name (including extension but excluding directories).
|-

|-
| wxString || GetFullPath || wxPathFormat || arg=format=wxPATH_NATIVE ...
|-

|-
| wxString || GetLongPath || || return the long form of the path (returns identity on non-Windows platforms)

|-

|-
| wxString || GetName || || returns the name part of the filename (without extension)
|-

|-
| wxString || GetPath || int, wxPathFormat || arg1=flags=wxPATH_GET_VOLUME..., arg2=format=wxPATH_NATIVE ...
|-

|-
| wxString || GetShortPath || || return the short form of the path (returns identity on non-Windows platforms).

|-

|-
| wxString || GetVolume || || returns the string containing the volume for this file name
|-

|-
| bool || HasExt || || returns true if an extension is present.
|-

|-
| bool || HasName || || returns true if a name is present
|-

|-
| bool || HasVolume || || returns true if a volume specifier is present
|-

|-
| void || InsertDir||int, const wxString || arg1=before_dir, arg2=name_dir
|-

|-
| bool || IsAbsolute || wxPathFormat ||arg=format=wxPATH_NATIVE...
|-

|-
| bool || IsOk || || returns true if the filename is valid
|-

|-
| bool || IsRelative || wxPathFormat ||arg=format=wxPATH_NATIVE...
|-

|-
| bool || IsDir || || returns true if this object represents a directory
|-

|-
| bool || MakeAbsolute ||const wxString, wxPathFormat|| arg1=cwd=_T("") or ..., arg2=format=wxPATH_NATIVE or ...
|-

|-
| bool || MakeRelativeTo ||const wxString, wxPathFormat|| arg1=path_base, arg2=format=wxPATH_NATIVE or ...
|-

|-
| bool || Normalize ||int, const wxString, wxPathFormat||arg1=flags=wxPATH_NORM_ALL, arg2=cwd=_T(""),arg3=format=wxPATH_NATIVE or ...
|

|-
| void || PrependDir || const wxString ||arg=dir
|-

|-
| void || RemoveDir || int ||arg=pos RemoveLastDir
|-

|-
| void || RemoveLastDir || || removes last directory component from the path
|-

|-
| bool || SameAs || const wxFileName, wxPathFormat || arg1=filepath, arg2=format=wxPATH_NATIVE
|-

|-
| bool || SetCwd|| || changes the current working directory
|-

|-
| void || SetExt ||const wxString ||arg=extension
|-

|-
| void || SetEmptyExt || || sets the extension of the file name to be an empty extension
|-

|-
| void || SetFullName || wxString ||
|-

|-
| void || SetName || wxString ||
|-

|-
| void || SetVolume || wxString ||
|-

|}
''NOTE: Is instantiated in a script using: local my_filename = ::wxFileName()

== wxPoint ==
'''UNDER CONSTRUCTION'''

'' Instantiate integer points 2D

{| 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
|-

|-
| wxPoint || operator= || const wxPoint|| default assignment operator is ok
|-

|-
| bool || operator== ||const wxPoint||
|-

|-
| bool || operator!= || const wxPoint||
|-

|-
| int || x || ||
|-

|-
| int || y || ||
|-

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

''EXAMPLE: local my_wxpoint = ::wxPoint(); my_wxpoint.x = 5; my_wxpoint.y = 12; // not use ::print(my_wxpoint)

== wxSize ==
'''UNDER CONSTRUCTION'''

'' Instantiate integers values (X, Y)

{| 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
|-

|-
| wxSize || operator= || const wwSize|| default assignment operator is ok
|-

|-
| bool || operator== ||const wxSize||
|-

|-
| bool || operator!= || const wxSize||
|-

|-
| int || GetWidth || || return X
|-

|-
| int || GetHeight || || return Y
|-

|-
| void || SetWidth || int w|| X=w
|-

|-
| void || SetHeight || int h|| Y=h
|-

|-
| void || Set || int w, int h|| X=w, Y=h
|-

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

''EXAMPLE: local my_wxsize = ::wxSize(); my_wxsize.SetWidth(5); my_wxsize.SetHeight(12); // not use ::print(my_wxsize)

== 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 in Prototype
!Remarks
|-

|-
| void || AddBuildTarget || (const wxString& targetName)||
|-

|-
| void || RenameBuildTarget || (const wxString& oldTargetName, const wxString& newTargetName) ||
|-

|-
| void || RemoveBuildTarget || (const wxString& targetName)||
|-

|-
| wxString || GetBaseName || ( ) ||
|-

|-
| wxString || GetObjName || ( ) ||
|-

|-
| void || SetObjName || (const wxString& targetName) ||
|-

|-
| cbProject* || GetParentProject || ( ) ||
|-

|-
| wxString|| GetCustomBuildCommand|| (const wxString& compilerId) ||
|-

|-
| void || SetCustomBuildCommand || (const wxString& compilerId, const wxString& newBuildCommand) ||
|-

|-
| bool || GetUseCustomBuildCommand|| (const wxString& compilerId) ||
|-

|-
| void || SetUseCustomBuildCommand || (const wxString& compilerId, bool useCustomBuildCommand) ||
|-

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

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

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

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

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

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

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

|-
| wxArrayString || buildTargets || || (variable)
|-

|-
| const wxArrayString & || GetBuildTargets ||() const || r9252 : for use instead of the 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 in Prototype
!Remarks
|-

|-
| void || AddPlatform || (int platform) || windows,unix,mac
|-

|-
| void || RemovePlatform || (int platform) ||
|-

|-
| void || SetPlatforms || (int platform) ||
|-

|-
| int || GetPlatforms || ||
|-

|-
| bool || SupportsCurrentPlatform || ||
|-

|-
| void || SetLinkerOptions || (const wxArrayString& linkerOpts) ||
|-

|-
| void || SetLinkLibs || (const wxArrayString& linkLibs) ||
|-

|-
| void || SetCompilerOptions || (const wxArrayString& compilerOpts) ||
|-

|-
| void || SetIncludeDirs || (const wxArrayString& includeDirs) ||
|-

|-
| void || SetResourceIncludeDirs || (const wxString& option) ||
|-

|-
| void || SetLibDirs || (const wxArrayString& libDirs) ||
|-

|-
| void || SetCommandsBeforeBuild || (const wxArrayString& commands) ||
|-

|-
| void || SetCommandsAfterBuild || (const wxArrayString& commands) ||
|-

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

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

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

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

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

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

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

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

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

|-
| void || SetModified || (bool modified) ||
|-

|-
| void || AddLinkerOption || (const wxString& option) ||
|-

|-
| void || AddLinkLib || (const wxString& lib) ||
|-

|-
| void || AddCompilerOption || (const wxString& option)||
|-

|-
| void || AddIncludeDir || (const wxString& option) ||
|-

|-
| void || AddResourceIncludeDir || (const wxString& option) ||
|-

|-
| void || AddLibDir || (const wxString& option) ||
|-

|-
| void || AddCommandsBeforeBuild || (const wxString& command) ||
|-

|-
| void || AddCommandsAfterBuild || (const wxString& command) ||
|-

|-
| void || RemoveLinkerOption || (const wxString& option) ||
|-

|-
| void || RemoveLinkLib || (const wxString& lib) ||
|-

|-
| void || RemoveCompilerOption || (const wxString& option) ||
|-

|-
| void || RemoveIncludeDir || (const wxString& option) ||
|-

|-
| void || RemoveResourceIncludeDir || (const wxString& option) ||
|-

|-
| void || RemoveLibDir || (const wxString& option) ||
|-

|-
| void || RemoveCommandsBeforeBuild || (const wxString& command) ||
|-

|-
| void || RemoveCommandsAfterBuild || (const wxString& command) ||
|-

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

|-
| void || SetAlwaysRunPostBuildSteps || (bool always) ||
|-

|-
| void || SetBuildScripts || (const wxArrayString& scripts) ||
|-

|-
| wxArrayString || GetBuildScripts || ||
|-

|-
| void || AddBuildScript || (const wxString& script) ||
|-

|-
| void || RemoveBuildScript || (const wxString& script) ||
|-

|-
| bool || SetVar || (const wxString& key, const wxString& value, bool onlyIfExists = false) ||
|-

|-
| wxString || GetVar || (const wxString& key) ||
|-

|-
| bool || UnsetVar || (const wxString& key) ||
|-

|-
| 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
|-

|-
| void || SetTargetFilenameGenerationPolicy || enum prefix, enum extension|| tgfpPlatformDefault -> Generate filename based on running platform defaults. tgfpNone -> No automatic generation; let the user specify the full filename.
|-

|-
| wxString || GetFilename || || The full project name (*.cbp)
|-

|-
| wxString || GetTitle || || Target name
|-

|-
| 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 || ||
|-

|-
| wxString || GetMakeCommandFor || enum ||
|-

|-
| void || SetMakeCommandFor || enum,wxString ||
|-

|-
| bool || MakeCommandsModified || ||
|-

|}

== 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 || ||The full title, i.e. "projectname - targetname"
|-

|-
| wxString || GetExternalDeps || ||list of files whose target depends
|-

|-
| void || SetExternalDeps || wxString ||list of files whose target depends
|-

|-
| void || SetAdditionalOutputFiles || wxString ||a list of additional output files
|-

|-
| wxString || GetAdditionalOutputFiles || ||a list of additional output files
|-

|-
| bool || GetIncludeInTargetAll || || Deprecated, do not use at 'All'
|-

|-
| void || SetIncludeInTargetAll || bool || Deprecated, do not use at 'All'
|-

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

|-
| void || SetCreateDefFile || bool ||if the target creates a DEF imports file.
|-

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

|-
| void || SetCreateStaticLib || bool ||if an import library should be created
|-

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

|-
| void || SetUseConsoleRunner || bool ||for targets generating a console executable.
|-

|-
| ProjectFile* || GetFile || int || returns a file from the target
|-

|-
| int || GetFilesCount || || returns number of files of target
|-

|}

== 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 || name, is relative, is Unixfilename
|-

|-
| bool || RemoveFile || ProjectFile * ||
|-

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

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

|-
| int || GetBuildTargetsCount || || number targets
|-

|-
| ProjectBuildTarget* || GetBuildTarget || int || target index
|-

|-
| ProjectBuildTarget* || GetBuildTarget || wxString || target name, if '*' exists -> real target
|-

|-
| ProjectBuildTarget* || AddBuildTarget || wxString || target name
|-

|-
| bool || RenameBuildTarget || int, wxString || target index, new name
|-

|-
| bool || RenameBuildTarget || wxString, wxString || old name, new name
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || int, wxString || index, new name
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || wxString, wxString || target name, new name
|-

|-
| bool || RemoveBuildTarget || int || index
|-

|-
| bool || RemoveBuildTarget || wxString || target name
|-

|-
| bool || ExportTargetAsProject || int || target index
|-

|-
| bool || ExportTargetAsProject || wxString || target name
|-

|-
| bool || BuildTargetValid || wxString|bool ||
|-

|-
| wxString || GetFirstValidBuildTargetName || bool ||
|-

|-
| void || SetDefaultExecuteTarget || wxString ||
|-

|-
| wxString || GetDefaultExecuteTarget || wxString ||
|-

|-
| bool || SetActiveBuildTarget || wxString ||
|-

|-
| wxString || GetActiveBuildTarget || || active target name, might be a virtual target||
|-

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

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

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

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

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

|-
| void || SetExtendedObjectNamesGeneration || bool ||
|-

|-
| bool || GetExtendedObjectNamesGeneration || ||
|-

|-
| void || SetNotes || wxString ||
|-

|-
| wxString || GetNotes || ||
|-

|-
| void || SetShowNotesOnLoad || bool ||
|-

|-
| bool || GetShowNotesOnLoad || ||
|-

|-
| void || ShowNotes || bool,bool ||
|-

|-
| void || AddToExtensions || wxString ||
|-

|-
| bool || DefineVirtualBuildTarget || wxString,wxArrayString ||arg1=alias virtual target, arg2= array targets
|-

|-
| bool || HasVirtualBuildTarget|| wxSring ||arg=alias virtual target
|-

|-
| bool || RemoveVirtualBuildTarget|| wxString ||arg=alias virtual target, return true if removed
|-

|-
| wxArrayString || GetVirtualBuildTargets|| ||Get a list of all defined virtual build targets.
|-

|-
| wxArrayString || GetVirtualBuildTargetGroup || wxString ||arg=alias, Access a virtual build target's group of build targets.
|-

|-
| wxArrayString || GetExpandedVirtualBuildTargetGroup|| wxString ||arg=alias, Access a virtual build target's expanded group of build targets.
|-

|-
| bool || CanAddToVirtualBuildTarget || wxSring,wxString ||arg1=alias, arg2=name target to add,
Checks if a build target (virtual or real) can be added to a virtual build target, without causing a circular-reference.
|-

|-
| void || SetTitle || wxSring ||
|-
|}

== 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 || Save || ||
|-

|-
| 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;" | '''Plugin version'''
|-

|-
|PLUGIN_SDK_VERSION_MAJOR||int|| =1, it will change when the SDK interface breaks
|-

|-
|PLUGIN_SDK_VERSION_MINOR||int|| =13, it will change when the SDK interface breaks
|-

|-
|PLUGIN_SDK_VERSION_RELEASE||int|| =13, it will change when the SDK interface breaks
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Path separator for filenames'''
|-

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

|-
| 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 wxPathFormat'''
|-

|-
|wxPATH_NATIVE || enum ||
|-

|-
|wxPATH_UNIX || enum ||
|-

|-
|wxPATH_BEOS || enum ||
|-

|-
|wxPATH_MAC || enum ||
|-

|wxPATH_DOS || enum ||
|-

|-
|wxPATH_WIN || enum ||
|-

|-
|wxPATH_OS2 || enum ||
|-

|-
|wxPATH_VM3 || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''For wxFileName::GetPath()'''
|-

|-
|wxPATH_GET_VOLUME || enum || include the volume if applicable
|-

|-
|wxPATH_GET_SEPARATOR || enum || terminate the path with the separator
|-

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

|-
|wxPATH_NORM_ENV_VARS || enum || replace env vars with their values
|-

|-
|wxPATH_NORM_DOTS || enum || squeeze all .. and . and prepend cwd
|-

|-
|wxPATH_NORM_TILDE || enum || Unix only: replace ~ and ~user
|-

|-
|wxPATH_NORM_CASE || enum || if case insensitive => tolower
|-

|-
|wxPATH_NORM_ABSOLUTE || enum ||make the path absolute
|-

|-
|wxPATH_NORM_LONG || enum ||make the path the long form
|-

|-
|wxPATH_NORM_SHORTCUT|| enum || resolve the shortcut, if it is a shortcut
|-

|-
|wxPATH_NORM_ALL || enum || = 0x00ff & ~wxPATH_NORM_CASE
|-

|-
| 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 ||
|-

|-
| mcAskRebuildNeeded|| enum ||
|-

|-
|mcSilentBuild|| 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;" | '''enum SearchDirs'''
|-

|-
|sdHome|| enum || User's home directory
|-

|-
|sdBase|| enum || Code::Blocks' installation base
|-

|-
|sdTemp|| enum || System-wide temp folder
|-

|-
|sdPath || enum || All dirs in the PATH environment variable
|-

|-
|sdConfig || enum || Config folder
|-

|-
|sdCurrent|| enum || Current working folder
|-

|-
|sdPluginsUser|| enum || Plugins folder in user's dir
|-

|-
|sdScriptsUser|| enum || Scripts folder in user's dir
|-

|-
|sdDataUser|| enum || Data folder in user's dir
|-

|-
|sdAllUser || enum || Convenience value meaning "all sd*User values"
|-

|-
|sdPluginsGlobal|| enum || Plugins folder in base dir
|-

|-
|sdScriptsGlobal|| enum || Scripts folder in base dir
|-

|-
|sdDataGlobal || enum || Data folder in base dir
|-

|-
|sdAllGlobal || enum || Convenience value meaning "all sd*Global values"
|-

|-
|sdAllKnown|| enum || All known dirs (i.e. all of the above)
|-

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

|-
|spMac ||enum ||
|-

|-
|spUnix ||enum ||
|-

|-
|spWindows ||enum ||
|-

|-
|spAll ||enum ||
|

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

|-
|tgfpPlatformDefault ||enum || Generate filename based on running platform defaults.
|-

|-
|tgfpNone ||enum || No automatic generation; let the user specify the full filename
|-

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

|-
|mtProjectManager ||enum ||
|-

|-
|mtEditorManager ||enum ||
|-

|-
|mtLogManager||enum ||
|-

|-
|mtOpenFilesList||enum ||
|-

|-
|mtEditorTab||enum ||
|-

|-
|mtUnknown||enum ||
|-

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

|-
|ftdkUndefined||enum ||
|-

|-
|ftdkProject||enum ||
|-

|-
|ftdkFolder||enum ||
|-

|-
|ftdkFile||enum ||
|-

|-
|ftdkVirtualGroup||enum ||
|-

|-
|ftdkVirtualFolder||enum ||
|-

|-
| 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_MSVC7 || wxString ||
|-

|-
| EXT_MSVC10 || wxString ||
|-

|-
| EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| EXT_ASM || wxString ||
|-

|-
| EXT_D || wxString ||
|-

|-
| EXT_F || wxString ||
|-

|-
| EXT_F77 || wxString ||
|-

|-
| EXT_F90 || wxString ||
|-

|-
| EXT_F95 || wxString ||
|-

|-
| EXT_FOR || wxString ||
|-

|-
| EXT_FPP || wxString ||
|-

|-
| EXT_F03 || wxString ||
|-

|-
| EXT_F08 || wxString ||
|-

|-
| EXT_JAVA || wxString ||
|-

|-
| EXT_C || wxString ||
|-

|-
| EXT_CC || wxString ||
|-

|-
| EXT_CPP || wxString ||
|-

|-
| EXT_CXX || wxString ||
|-

|-
| EXT_CPLPL || wxString ||
|-

|-
| EXT_INL || wxString ||
|-

|-
| EXT_H || wxString ||
|-

|-
| EXT_HH || wxString ||
|-

|-
| EXT_HPP || wxString ||
|-

|-
| EXT_HXX || wxString ||
|-

|-
| EXT_HPLPL || wxString ||
|-

|-
| EXT_S || wxString ||
|-

|-
| EXT_SS || wxString ||
|-

|-
| EXT_S62 || wxString ||
|-

|-
| EXT_OBJECT || wxString ||
|-

|-
| EXT_XRCRESOURCE || wxString ||
|-

|-
| EXT_STATICLIB || wxString ||
|-

|-
| EXT_DYNAMICLIB || wxString ||
|-

|-
| EXT_EXECUTABLE || wxString ||
|-

|-
| EXT_NATIVE || 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_MSVC7 || wxString ||
|-

|-
| DOT_EXT_MSVC10 || wxString ||
|-

|-
| DOT_EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_D || wxString ||
|-

|-
| DOT_EXT_F || wxString ||
|-

|-
| DOT_EXT_F77 || wxString ||
|-

|-
| DOT_EXT_F90 || wxString ||
|-

|-
| DOT_EXT_F95 || wxString ||
|-

|-
| DOT_EXT_FOR || wxString ||
|-

|-
| DOT_EXT_FPP || wxString ||
|-

|-
| DOT_EXT_F03 || wxString ||
|-

|-
| DOT_EXT_F08 || wxString ||
|-

|-
| DOT_EXT_JAVA || wxString ||
|-

|-
| DOT_EXT_C || wxString ||
|-

|-
| DOT_EXT_CC || wxString ||
|-

|-
| DOT_EXT_CPP || wxString ||
|-

|-
| DOT_EXT_CXX || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_CPLPL || wxString ||
|-

|-
| DOT_EXT_H || wxString ||
|-

|-
| DOT_EXT_HH || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_HXX || wxString ||
|-

|-
| DOT_EXT_HPLPL || wxString ||
|-

|-
| DOT_EXT_S || wxString ||
|-

|-
| DOT_EXT_SS || wxString ||
|-

|-
| DOT_EXT_S62 || wxString ||
|-

|-
| DOT_EXT_OBJECT || wxString ||
|-

|-
| DOT_EXT_XRCRESOURCE || wxString ||
|-

|-
| DOT_EXT_STATICLIB || wxString ||
|-

|-
| DOT_EXT_DYNAMICLIB || wxString ||
|-

|-
| DOT_EXT_EXECUTABLE || wxString ||
|-

|-
| DOT_EXT_NATIVE || wxString ||
|-

|-
| DOT_EXT_RESOURCE || wxString ||
|-

|-
| DOT_EXT_RESOURCEBIN || wxString ||
|-

|-
| DOT_EXT_XML || wxString ||
|-

|-
| DOT_EXT_SCRIPT || wxString ||
|-

|}

== See also ==

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

Scripting commands

2019-06-11T10:07:16Z

LETARTARE: /* remark The full name project */

[[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().

''NOTE: Updated to '''12.11'''

== 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 || Does [[Variable_expansion|variable expansion]] on the input wxString
|-

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

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

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

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

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

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

|-
| wxArrayString || GetArrayFromString || wxString,wxString,bool ||
|-

|-
| wxString || GetStringFromArray || wxArrayString,wxString,bool ||
|-

|-
| wxString || EscapeSpaces || wxString ||
|-

|-
| wxString || UnixFilename || wxString, int || arg1=filename, arg2=wxPATH_NATIVE, wxPATH_WIN, ...
|-

|-
| FileType || FileTypeOf || wxString ||
|-

|-
| wxString || URLEncode || wxString ||
|-

|-
| void || NotifyMissingFile || wxString ||
|-

|-
| int || GetPlatformsFromString || wxString ||
|-

|-
| wxString || GetStringFromPlatforms || int,bool||
|-

|-
| void|| InfoWindow || wxString,wxString,int,int || pop-up box in the lower right, see infowindow.h
|-

|-
| 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
|-

|-
| int || ExecuteToolPlugin || wxString || Execute a tool plugin (found in Plugins menu)
|-

|-
| int || ConfigureToolPlugin || wxString || Configure a tool plugin (found in Plugins menu)
|-

|-
| void || CallMenu || wxString || Call a menu entry describing its path using slashes (e.g. "/Valgrind/Run Valgrind::MemCheck")
|-

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

|-
| int || Require || wxString ||arg=script_filename, return 0 if ok
|-

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

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

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

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

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

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

|-
| long || wxString_ToLong || wxString const ||
|-

|}

== 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 || const wxString, int || arg1=key, arg2=default_val
|-

|-
| bool || Read || const wxString, bool || arg1=key, arg2=default_val
|-

|-
| float || Read || const wxString, float || arg1=key, arg2=default_val
|-

|-
| wxString || Read || const wxString, const wxString || arg1=key, arg2=default_val
|-

|-
| void || Write || const wxString, int || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, bool || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, float || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, const wxString, bool ||arg1=key, arg2=value, arg3=ignore_value_empty
|-

|}

== ProjectManager ==
see API docs for 'ProjectManager::...' in 'include\projectmanager.h'

{| 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 in Prototype
!Remarks
|-

|-
| wxString || GetDefaultPath || ( ) ||
|-

|-
| void || SetDefaultPath || (const wxString& path) ||
|-

|-
| cbProject* || GetActiveProject || ( ) ||
|-

|-
| int || GetProjectCount || ( ) ||
|-

|-
| cbProject* || GetProject || (int) ||
|-

|-
| void || SetProject || (cbProject* project, bool refresh = true) ||
|-

|-
| bool || LoadWorkspace || (const wxString& filename = DEFAULT_WORKSPACE)||
|-

|-
| bool || SaveWorkspace || ( ) ||
|-

|-
| bool || SaveWorkspaceAs || (const wxString& filename) ||
|-

|-
| bool || CloseWorkspace || ( ) ||
|-

|-
| cbProject* || IsOpen || (const wxString& filename) ||
|-

|-
| cbProject* || LoadProject || (const wxString& filename, bool activateIt = true) ||
|-

|-
| bool || SaveProject || (cbProject* project) ||
|-

|-
| bool || SaveProjectAs || (cbProject* project) ||
|-

|-
| bool || SaveActiveProject || ( ) ||
|-

|-
| bool || SaveActiveProjectAs || ( ) ||
|-

|-
| bool || SaveAllProjects || ( ) ||
|-

|-
| bool || CloseProject || (cbProject* project, bool dontsave = false, bool refresh = true) ||
|-

|-
| bool || CloseActiveProject || (bool dontsave = false) ||
|-

|-
| bool || CloseAllProjects || (bool dontsave = false) ||
|-

|-
| cbProject* || NewProject || (const wxString& filename = wxEmptyString) ||
|-

|-
| int || AddFileToProject || (const wxString& filename, cbProject* project = 0L, int target = -1) ||
|-

|-
| int || AskForBuildTargetIndex || (cbProject* project = 0L) ||

|-
| void || RebuildTree || ( ) ||
|-

|-
| bool || AddProjectDependency || (cbProject* base, cbProject* dependsOn) ||
|-

|-
| void || RemoveProjectDependency || (cbProject* base, cbProject* doesNotDependOn) ||
|-

|-
| void || ClearProjectDependencies || (cbProject* base) ||
|-

|-
| void || RemoveProjectFromAllDependencies || (cbProject* base) ||
|-

|-
| ProjectsArray* || GetDependenciesForProject || (cbProject* base) ||
|-

|-
| void || ConfigureProjectDependencies || (cbProject* base = 0) ||
|-
|}

== 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 in Prototype
!Remarks
|-

|-
| void || Configure || ( ) ||
|-

|-
| cbEditor* || New || (const wxString& newFileName = wxEmptyString) ||
|-

|-
| cbEditor* || Open || (const wxString& filename) ||
|-

|-
| cbEditor* || IsBuiltinOpen || (const wxString& filename) ||
|-

|-
| cbEditor* || GetBuiltinEditor || (const wxString& filename)|(int index) ||
|-

|-
| cbEditor* || GetBuiltinActiveEditor || ( ) ||
|-

|-
| EditorBase* || GetActiveEditor || ( ) ||
|-

|-
| void || ActivateNext || ( ) ||
|-

|-
| void || ActivatePrevious || ( ) ||
|-

|-
| bool || SwapActiveHeaderSource || ( ) ||
|-

|-
| bool || CloseActive || (bool dontsave = false) ||
|-

|-
| bool || Close || (const wxString& filename,bool dontsave = false)|(int index,bool dontsave = false),(EditorBase* editor,bool dontsave = false) ||
|-

|-
| bool || CloseAll || (bool dontsave=false) ||
|-

|-
| bool || Save || (const wxString& filename)|(int index)||
|-

|-
| bool || SaveActive || ( ) ||
|-

|-
| bool || SaveAs || (int index) ||
|-

|-
| bool || SaveActiveAs || ( ) ||
|-

|-
| bool || SaveAll || ( ) ||
|-

|-
| int || ShowFindDialog || (bool replace, bool explicitly_find_in_files = false) ||
|-

|}

== 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 in Prototype
!Remarks
|-

|-
| bool || Exists || (const wxString& variable) ||
|-

|}

== 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 in Prototype
!Remarks
|-

|-
| bool || DirectoryExists || (const wxString& dir) || '''1)'''
|-

|-
| wxString || SelectDirectory || (const wxString& message, const wxString& initialPath, bool showCreateDirButton) ||
|-

|-
| bool || '''CreateDirectory''' || (const wxString& full_path, int perms) || arg1=dir, arg2=permissions '''1)'''
|-

|-
| bool || '''RemoveDirectory''' || (const wxString& src) || '''1)'''
|-

|-
| bool || '''CopyFile''' ||(const wxString& src, const wxString& dst, bool overwrite) || '''1)'''
|-

|-
| bool || '''RenameFile''' || (const wxString& src, const wxString& dst) || old,new '''1)'''
|-

|-
| bool || '''RemoveFile''' || (const wxString& src) || '''1)'''
|-

|-
| bool || FileExists || (const wxString& file) || '''1)'''
|-

|-
| wxString || SelectFile || (const wxString& title, const wxString& defaultFile, const wxString& filter) ||
|-

|-
| wxString || ReadFileContents || (const wxString& filename) || '''1)'''
|-

|-
| bool || '''WriteFileContents''' || (const wxString& filename, const wxString& contents) || filename,contents '''1)'''
|-

|-
| int || '''Execute''' || (const wxString& command) ||
|-

|-
| wxString || '''ExecuteAndGetOutput''' || (const wxString& command) ||
|-

|-
| wxString || '''ExecuteAndGetOutputAndError''' || (const wxString& command, bool prepend_error) ||if 'prepend_error' is true gives an error string
|-

|-
| wxString || GetCwd || ( ) ||
|-

|-
| void || SetCwd || (const wxString& dir) || directory (currently working directory)
|-

|}

'''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.

'''NOTE: 1)''' All paths/filenames are expanded via the ReplaceMacros function prior the function is called. So it is possible to copy the project output file with
<source lang="c">
IO.CopyFile(_T("$(TARGET_OUTPUT_FILE)"),_T("output_directory/output_file"),true);
</source>

== 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 in Prototype
!Remarks
|-

|-
| bool || IsValidCompilerID || (const wxString& id) ||
|-

|-
| int || GetCompilerIndex || (const wxString& id) ||
|-

|-
| wxString || GetDefaultCompilerID || ( ) ||
|-

|-
| wxString || GetCompilerVersionString || (const wxString& Id) ||
|-

|-
| bool || CompilerInheritsFrom || ( ) ||
|-

|-
| wxString || GetCompilerIDByName || (const wxString &name ) || Makes it possible to find the compiler id by its name. Available since rev 9823.
|-
|}

== 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
|-

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

|-
| wxString || _ || const char* || the same as _T, but should be used for translatable strings
|-

|-
| wxString || operator= || const wxString ||
|-

|-
| wxString || operator+ || const wxString ||
|-

|-
| wxString || operator+ || const int ||
|-

|-
| wxString || operator+= || const wxString ||
|-

|-
| wxString || operator+= || const int ||
|-

|-
| bool || operator< || const wxString || _T("abc") < _T("cba") -> true
|-

|-
| bool || operator<= || const wxString ||
|-

|-
| bool || operator>= || const wxString ||
|-

|-
| bool || operator> || const wxString ||
|-

|-
| int || Find || wxString || -1 if not found
|-

|-
| bool || Matches || wxString || not use '==' !!, returns true if the string contents matches a mask containing '*' and '?'
|-

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

|-
| char || GetChar || int || arg1=position
|-

|-
| 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 || arg1=position, arg2=long
|-

|-
| wxString || Remove || int, int || arg1=position, arg2=long
|-

|-
| void || RemoveLast || int || remove the last characters
|-

|-
| int || Replace || wxString, wxString,bool || arg3=true -> all occurrences else the first
|-

|-
| wxString || Right || int x || return the x last characters
|-

|-
| wxString || AfterFirst || char || not found -> _T("")
|-

|-
| wxString || AfterLast || char || not found -> all the character string
|-

|-
| wxString || BeforeFirst || char || not found -> all the character string
|-

|-
| wxString || BeforeLast || char || not found -> _T("")
|-
|}
''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 || ||
|-

|-
| int || Index || wxString || -1 If not found
|-

|-
| wxString || Item || int || not work with wx 2.9.x ?!
|-

|}
''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 || ||
|-

|-
| bool || IsOk || || ONLY if (wxVERSION_NUMBER < 2900)
|-

|-
| void || Set || byte, byte, byte, byte || red, green, blue, alpha : into [0..255]
|-

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

''EXAMPLE: local my_wxcolour = ::wxColour(); my_wxcolour.Set(0xFF, 0x00, 0x00, 0x55); ::print(my_wxcolour) -> [r=255, g=0, b=0]

== wxFileName ==
'''UNDER VERIFICATION'''

{| 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 || Assign || const wxFileName || creates the file name from an other wxFileName
|-

|-
| void || Assign || const wxString, wxPathFormat || arg1=full_path, arg2=wformat=xPATH_NATIVE ...
|-

|-
| void || AssignCwd || const wxString || arg1=volume
|-

|-
| void || AssignDir|| const wxString, wxPathFormat || arg1=name_dir, arg2=format=wxPATH_NATIVE ...
|-

|-
| void || AssignHomeDir || || sets this file name object to the home directory
|-

|-
| void || Clear || || reset all components to default, uninitialized state
|-

|-
| void || ClearExt || || removes the extension from the file name resulting in a file name with no trailing dot
|-

|-
| int || GetDirCount || || returns the number of directories in the file name.
|-

|-
| wxArrayString || GetDirs || || returns the directories in string array form
|-

|-
| wxString || GetExt || || returns the file name extension.

|-

|-
| wxString || GetFullName || || returns the full name (including extension but excluding directories).
|-

|-
| wxString || GetFullPath || wxPathFormat || arg=format=wxPATH_NATIVE ...
|-

|-
| wxString || GetLongPath || || return the long form of the path (returns identity on non-Windows platforms)

|-

|-
| wxString || GetName || || returns the name part of the filename (without extension)
|-

|-
| wxString || GetPath || int, wxPathFormat || arg1=flags=wxPATH_GET_VOLUME..., arg2=format=wxPATH_NATIVE ...
|-

|-
| wxString || GetShortPath || || return the short form of the path (returns identity on non-Windows platforms).

|-

|-
| wxString || GetVolume || || returns the string containing the volume for this file name
|-

|-
| bool || HasExt || || returns true if an extension is present.
|-

|-
| bool || HasName || || returns true if a name is present
|-

|-
| bool || HasVolume || || returns true if a volume specifier is present
|-

|-
| void || InsertDir||int, const wxString || arg1=before_dir, arg2=name_dir
|-

|-
| bool || IsAbsolute || wxPathFormat ||arg=format=wxPATH_NATIVE...
|-

|-
| bool || IsOk || || returns true if the filename is valid
|-

|-
| bool || IsRelative || wxPathFormat ||arg=format=wxPATH_NATIVE...
|-

|-
| bool || IsDir || || returns true if this object represents a directory
|-

|-
| bool || MakeAbsolute ||const wxString, wxPathFormat|| arg1=cwd=_T("") or ..., arg2=format=wxPATH_NATIVE or ...
|-

|-
| bool || MakeRelativeTo ||const wxString, wxPathFormat|| arg1=path_base, arg2=format=wxPATH_NATIVE or ...
|-

|-
| bool || Normalize ||int, const wxString, wxPathFormat||arg1=flags=wxPATH_NORM_ALL, arg2=cwd=_T(""),arg3=format=wxPATH_NATIVE or ...
|

|-
| void || PrependDir || const wxString ||arg=dir
|-

|-
| void || RemoveDir || int ||arg=pos RemoveLastDir
|-

|-
| void || RemoveLastDir || || removes last directory component from the path
|-

|-
| bool || SameAs || const wxFileName, wxPathFormat || arg1=filepath, arg2=format=wxPATH_NATIVE
|-

|-
| bool || SetCwd|| || changes the current working directory
|-

|-
| void || SetExt ||const wxString ||arg=extension
|-

|-
| void || SetEmptyExt || || sets the extension of the file name to be an empty extension
|-

|-
| void || SetFullName || wxString ||
|-

|-
| void || SetName || wxString ||
|-

|-
| void || SetVolume || wxString ||
|-

|}
''NOTE: Is instantiated in a script using: local my_filename = ::wxFileName()

== wxPoint ==
'''UNDER CONSTRUCTION'''

'' Instantiate integer points 2D

{| 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
|-

|-
| wxPoint || operator= || const wxPoint|| default assignment operator is ok
|-

|-
| bool || operator== ||const wxPoint||
|-

|-
| bool || operator!= || const wxPoint||
|-

|-
| int || x || ||
|-

|-
| int || y || ||
|-

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

''EXAMPLE: local my_wxpoint = ::wxPoint(); my_wxpoint.x = 5; my_wxpoint.y = 12; // not use ::print(my_wxpoint)

== wxSize ==
'''UNDER CONSTRUCTION'''

'' Instantiate integers values (X, Y)

{| 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
|-

|-
| wxSize || operator= || const wwSize|| default assignment operator is ok
|-

|-
| bool || operator== ||const wxSize||
|-

|-
| bool || operator!= || const wxSize||
|-

|-
| int || GetWidth || || return X
|-

|-
| int || GetHeight || || return Y
|-

|-
| void || SetWidth || int w|| X=w
|-

|-
| void || SetHeight || int h|| Y=h
|-

|-
| void || Set || int w, int h|| X=w, Y=h
|-

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

''EXAMPLE: local my_wxsize = ::wxSize(); my_wxsize.SetWidth(5); my_wxsize.SetHeight(12); // not use ::print(my_wxsize)

== 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 in Prototype
!Remarks
|-

|-
| void || AddBuildTarget || (const wxString& targetName)||
|-

|-
| void || RenameBuildTarget || (const wxString& oldTargetName, const wxString& newTargetName) ||
|-

|-
| void || RemoveBuildTarget || (const wxString& targetName)||
|-

|-
| wxString || GetBaseName || ( ) ||
|-

|-
| wxString || GetObjName || ( ) ||
|-

|-
| void || SetObjName || (const wxString& targetName) ||
|-

|-
| cbProject* || GetParentProject || ( ) ||
|-

|-
| wxString|| GetCustomBuildCommand|| (const wxString& compilerId) ||
|-

|-
| void || SetCustomBuildCommand || (const wxString& compilerId, const wxString& newBuildCommand) ||
|-

|-
| bool || GetUseCustomBuildCommand|| (const wxString& compilerId) ||
|-

|-
| void || SetUseCustomBuildCommand || (const wxString& compilerId, bool useCustomBuildCommand) ||
|-

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

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

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

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

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

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

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

|-
| wxArrayString || buildTargets || || (variable)
|-

|-
| const wxArrayString & || GetBuildTargets ||() const || r9252 : for use instead of the 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 in Prototype
!Remarks
|-

|-
| void || AddPlatform || (int platform) || windows,unix,mac
|-

|-
| void || RemovePlatform || (int platform) ||
|-

|-
| void || SetPlatforms || (int platform) ||
|-

|-
| int || GetPlatforms || ||
|-

|-
| bool || SupportsCurrentPlatform || ||
|-

|-
| void || SetLinkerOptions || (const wxArrayString& linkerOpts) ||
|-

|-
| void || SetLinkLibs || (const wxArrayString& linkLibs) ||
|-

|-
| void || SetCompilerOptions || (const wxArrayString& compilerOpts) ||
|-

|-
| void || SetIncludeDirs || (const wxArrayString& includeDirs) ||
|-

|-
| void || SetResourceIncludeDirs || (const wxString& option) ||
|-

|-
| void || SetLibDirs || (const wxArrayString& libDirs) ||
|-

|-
| void || SetCommandsBeforeBuild || (const wxArrayString& commands) ||
|-

|-
| void || SetCommandsAfterBuild || (const wxArrayString& commands) ||
|-

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

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

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

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

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

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

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

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

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

|-
| void || SetModified || (bool modified) ||
|-

|-
| void || AddLinkerOption || (const wxString& option) ||
|-

|-
| void || AddLinkLib || (const wxString& lib) ||
|-

|-
| void || AddCompilerOption || (const wxString& option)||
|-

|-
| void || AddIncludeDir || (const wxString& option) ||
|-

|-
| void || AddResourceIncludeDir || (const wxString& option) ||
|-

|-
| void || AddLibDir || (const wxString& option) ||
|-

|-
| void || AddCommandsBeforeBuild || (const wxString& command) ||
|-

|-
| void || AddCommandsAfterBuild || (const wxString& command) ||
|-

|-
| void || RemoveLinkerOption || (const wxString& option) ||
|-

|-
| void || RemoveLinkLib || (const wxString& lib) ||
|-

|-
| void || RemoveCompilerOption || (const wxString& option) ||
|-

|-
| void || RemoveIncludeDir || (const wxString& option) ||
|-

|-
| void || RemoveResourceIncludeDir || (const wxString& option) ||
|-

|-
| void || RemoveLibDir || (const wxString& option) ||
|-

|-
| void || RemoveCommandsBeforeBuild || (const wxString& command) ||
|-

|-
| void || RemoveCommandsAfterBuild || (const wxString& command) ||
|-

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

|-
| void || SetAlwaysRunPostBuildSteps || (bool always) ||
|-

|-
| void || SetBuildScripts || (const wxArrayString& scripts) ||
|-

|-
| wxArrayString || GetBuildScripts || ||
|-

|-
| void || AddBuildScript || (const wxString& script) ||
|-

|-
| void || RemoveBuildScript || (const wxString& script) ||
|-

|-
| bool || SetVar || (const wxString& key, const wxString& value, bool onlyIfExists = false) ||
|-

|-
| wxString || GetVar || (const wxString& key) ||
|-

|-
| bool || UnsetVar || (const wxString& key) ||
|-

|-
| 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
|-

|-
| void || SetTargetFilenameGenerationPolicy || enum prefix, enum extension|| tgfpPlatformDefault -> Generate filename based on running platform defaults. tgfpNone -> No automatic generation; let the user specify the full filename.
|-

|-
| wxString || GetFilename || || The full name project (*.cbp)
|-

|-
| 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 || ||
|-

|-
| wxString || GetMakeCommandFor || enum ||
|-

|-
| void || SetMakeCommandFor || enum,wxString ||
|-

|-
| bool || MakeCommandsModified || ||
|-

|}

== 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 || ||The full title, i.e. "projectname - targetname"
|-

|-
| wxString || GetExternalDeps || ||list of files whose target depends
|-

|-
| void || SetExternalDeps || wxString ||list of files whose target depends
|-

|-
| void || SetAdditionalOutputFiles || wxString ||a list of additional output files
|-

|-
| wxString || GetAdditionalOutputFiles || ||a list of additional output files
|-

|-
| bool || GetIncludeInTargetAll || || Deprecated, do not use at 'All'
|-

|-
| void || SetIncludeInTargetAll || bool || Deprecated, do not use at 'All'
|-

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

|-
| void || SetCreateDefFile || bool ||if the target creates a DEF imports file.
|-

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

|-
| void || SetCreateStaticLib || bool ||if an import library should be created
|-

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

|-
| void || SetUseConsoleRunner || bool ||for targets generating a console executable.
|-

|-
| ProjectFile* || GetFile || int || returns a file from the target
|-

|-
| int || GetFilesCount || || returns number of files of target
|-

|}

== 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 || name, is relative, is Unixfilename
|-

|-
| bool || RemoveFile || ProjectFile * ||
|-

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

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

|-
| int || GetBuildTargetsCount || || number targets
|-

|-
| ProjectBuildTarget* || GetBuildTarget || int || target index
|-

|-
| ProjectBuildTarget* || GetBuildTarget || wxString || target name, if '*' exists -> real target
|-

|-
| ProjectBuildTarget* || AddBuildTarget || wxString || target name
|-

|-
| bool || RenameBuildTarget || int, wxString || target index, new name
|-

|-
| bool || RenameBuildTarget || wxString, wxString || old name, new name
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || int, wxString || index, new name
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || wxString, wxString || target name, new name
|-

|-
| bool || RemoveBuildTarget || int || index
|-

|-
| bool || RemoveBuildTarget || wxString || target name
|-

|-
| bool || ExportTargetAsProject || int || target index
|-

|-
| bool || ExportTargetAsProject || wxString || target name
|-

|-
| bool || BuildTargetValid || wxString|bool ||
|-

|-
| wxString || GetFirstValidBuildTargetName || bool ||
|-

|-
| void || SetDefaultExecuteTarget || wxString ||
|-

|-
| wxString || GetDefaultExecuteTarget || wxString ||
|-

|-
| bool || SetActiveBuildTarget || wxString ||
|-

|-
| wxString || GetActiveBuildTarget || || active target name, might be a virtual target||
|-

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

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

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

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

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

|-
| void || SetExtendedObjectNamesGeneration || bool ||
|-

|-
| bool || GetExtendedObjectNamesGeneration || ||
|-

|-
| void || SetNotes || wxString ||
|-

|-
| wxString || GetNotes || ||
|-

|-
| void || SetShowNotesOnLoad || bool ||
|-

|-
| bool || GetShowNotesOnLoad || ||
|-

|-
| void || ShowNotes || bool,bool ||
|-

|-
| void || AddToExtensions || wxString ||
|-

|-
| bool || DefineVirtualBuildTarget || wxString,wxArrayString ||arg1=alias virtual target, arg2= array targets
|-

|-
| bool || HasVirtualBuildTarget|| wxSring ||arg=alias virtual target
|-

|-
| bool || RemoveVirtualBuildTarget|| wxString ||arg=alias virtual target, return true if removed
|-

|-
| wxArrayString || GetVirtualBuildTargets|| ||Get a list of all defined virtual build targets.
|-

|-
| wxArrayString || GetVirtualBuildTargetGroup || wxString ||arg=alias, Access a virtual build target's group of build targets.
|-

|-
| wxArrayString || GetExpandedVirtualBuildTargetGroup|| wxString ||arg=alias, Access a virtual build target's expanded group of build targets.
|-

|-
| bool || CanAddToVirtualBuildTarget || wxSring,wxString ||arg1=alias, arg2=name target to add,
Checks if a build target (virtual or real) can be added to a virtual build target, without causing a circular-reference.
|-

|-
| void || SetTitle || wxSring ||
|-
|}

== 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 || Save || ||
|-

|-
| 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;" | '''Plugin version'''
|-

|-
|PLUGIN_SDK_VERSION_MAJOR||int|| =1, it will change when the SDK interface breaks
|-

|-
|PLUGIN_SDK_VERSION_MINOR||int|| =13, it will change when the SDK interface breaks
|-

|-
|PLUGIN_SDK_VERSION_RELEASE||int|| =13, it will change when the SDK interface breaks
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Path separator for filenames'''
|-

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

|-
| 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 wxPathFormat'''
|-

|-
|wxPATH_NATIVE || enum ||
|-

|-
|wxPATH_UNIX || enum ||
|-

|-
|wxPATH_BEOS || enum ||
|-

|-
|wxPATH_MAC || enum ||
|-

|wxPATH_DOS || enum ||
|-

|-
|wxPATH_WIN || enum ||
|-

|-
|wxPATH_OS2 || enum ||
|-

|-
|wxPATH_VM3 || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''For wxFileName::GetPath()'''
|-

|-
|wxPATH_GET_VOLUME || enum || include the volume if applicable
|-

|-
|wxPATH_GET_SEPARATOR || enum || terminate the path with the separator
|-

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

|-
|wxPATH_NORM_ENV_VARS || enum || replace env vars with their values
|-

|-
|wxPATH_NORM_DOTS || enum || squeeze all .. and . and prepend cwd
|-

|-
|wxPATH_NORM_TILDE || enum || Unix only: replace ~ and ~user
|-

|-
|wxPATH_NORM_CASE || enum || if case insensitive => tolower
|-

|-
|wxPATH_NORM_ABSOLUTE || enum ||make the path absolute
|-

|-
|wxPATH_NORM_LONG || enum ||make the path the long form
|-

|-
|wxPATH_NORM_SHORTCUT|| enum || resolve the shortcut, if it is a shortcut
|-

|-
|wxPATH_NORM_ALL || enum || = 0x00ff & ~wxPATH_NORM_CASE
|-

|-
| 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 ||
|-

|-
| mcAskRebuildNeeded|| enum ||
|-

|-
|mcSilentBuild|| 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;" | '''enum SearchDirs'''
|-

|-
|sdHome|| enum || User's home directory
|-

|-
|sdBase|| enum || Code::Blocks' installation base
|-

|-
|sdTemp|| enum || System-wide temp folder
|-

|-
|sdPath || enum || All dirs in the PATH environment variable
|-

|-
|sdConfig || enum || Config folder
|-

|-
|sdCurrent|| enum || Current working folder
|-

|-
|sdPluginsUser|| enum || Plugins folder in user's dir
|-

|-
|sdScriptsUser|| enum || Scripts folder in user's dir
|-

|-
|sdDataUser|| enum || Data folder in user's dir
|-

|-
|sdAllUser || enum || Convenience value meaning "all sd*User values"
|-

|-
|sdPluginsGlobal|| enum || Plugins folder in base dir
|-

|-
|sdScriptsGlobal|| enum || Scripts folder in base dir
|-

|-
|sdDataGlobal || enum || Data folder in base dir
|-

|-
|sdAllGlobal || enum || Convenience value meaning "all sd*Global values"
|-

|-
|sdAllKnown|| enum || All known dirs (i.e. all of the above)
|-

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

|-
|spMac ||enum ||
|-

|-
|spUnix ||enum ||
|-

|-
|spWindows ||enum ||
|-

|-
|spAll ||enum ||
|

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

|-
|tgfpPlatformDefault ||enum || Generate filename based on running platform defaults.
|-

|-
|tgfpNone ||enum || No automatic generation; let the user specify the full filename
|-

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

|-
|mtProjectManager ||enum ||
|-

|-
|mtEditorManager ||enum ||
|-

|-
|mtLogManager||enum ||
|-

|-
|mtOpenFilesList||enum ||
|-

|-
|mtEditorTab||enum ||
|-

|-
|mtUnknown||enum ||
|-

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

|-
|ftdkUndefined||enum ||
|-

|-
|ftdkProject||enum ||
|-

|-
|ftdkFolder||enum ||
|-

|-
|ftdkFile||enum ||
|-

|-
|ftdkVirtualGroup||enum ||
|-

|-
|ftdkVirtualFolder||enum ||
|-

|-
| 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_MSVC7 || wxString ||
|-

|-
| EXT_MSVC10 || wxString ||
|-

|-
| EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| EXT_ASM || wxString ||
|-

|-
| EXT_D || wxString ||
|-

|-
| EXT_F || wxString ||
|-

|-
| EXT_F77 || wxString ||
|-

|-
| EXT_F90 || wxString ||
|-

|-
| EXT_F95 || wxString ||
|-

|-
| EXT_FOR || wxString ||
|-

|-
| EXT_FPP || wxString ||
|-

|-
| EXT_F03 || wxString ||
|-

|-
| EXT_F08 || wxString ||
|-

|-
| EXT_JAVA || wxString ||
|-

|-
| EXT_C || wxString ||
|-

|-
| EXT_CC || wxString ||
|-

|-
| EXT_CPP || wxString ||
|-

|-
| EXT_CXX || wxString ||
|-

|-
| EXT_CPLPL || wxString ||
|-

|-
| EXT_INL || wxString ||
|-

|-
| EXT_H || wxString ||
|-

|-
| EXT_HH || wxString ||
|-

|-
| EXT_HPP || wxString ||
|-

|-
| EXT_HXX || wxString ||
|-

|-
| EXT_HPLPL || wxString ||
|-

|-
| EXT_S || wxString ||
|-

|-
| EXT_SS || wxString ||
|-

|-
| EXT_S62 || wxString ||
|-

|-
| EXT_OBJECT || wxString ||
|-

|-
| EXT_XRCRESOURCE || wxString ||
|-

|-
| EXT_STATICLIB || wxString ||
|-

|-
| EXT_DYNAMICLIB || wxString ||
|-

|-
| EXT_EXECUTABLE || wxString ||
|-

|-
| EXT_NATIVE || 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_MSVC7 || wxString ||
|-

|-
| DOT_EXT_MSVC10 || wxString ||
|-

|-
| DOT_EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_D || wxString ||
|-

|-
| DOT_EXT_F || wxString ||
|-

|-
| DOT_EXT_F77 || wxString ||
|-

|-
| DOT_EXT_F90 || wxString ||
|-

|-
| DOT_EXT_F95 || wxString ||
|-

|-
| DOT_EXT_FOR || wxString ||
|-

|-
| DOT_EXT_FPP || wxString ||
|-

|-
| DOT_EXT_F03 || wxString ||
|-

|-
| DOT_EXT_F08 || wxString ||
|-

|-
| DOT_EXT_JAVA || wxString ||
|-

|-
| DOT_EXT_C || wxString ||
|-

|-
| DOT_EXT_CC || wxString ||
|-

|-
| DOT_EXT_CPP || wxString ||
|-

|-
| DOT_EXT_CXX || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_CPLPL || wxString ||
|-

|-
| DOT_EXT_H || wxString ||
|-

|-
| DOT_EXT_HH || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_HXX || wxString ||
|-

|-
| DOT_EXT_HPLPL || wxString ||
|-

|-
| DOT_EXT_S || wxString ||
|-

|-
| DOT_EXT_SS || wxString ||
|-

|-
| DOT_EXT_S62 || wxString ||
|-

|-
| DOT_EXT_OBJECT || wxString ||
|-

|-
| DOT_EXT_XRCRESOURCE || wxString ||
|-

|-
| DOT_EXT_STATICLIB || wxString ||
|-

|-
| DOT_EXT_DYNAMICLIB || wxString ||
|-

|-
| DOT_EXT_EXECUTABLE || wxString ||
|-

|-
| DOT_EXT_NATIVE || wxString ||
|-

|-
| DOT_EXT_RESOURCE || wxString ||
|-

|-
| DOT_EXT_RESOURCEBIN || wxString ||
|-

|-
| DOT_EXT_XML || wxString ||
|-

|-
| DOT_EXT_SCRIPT || wxString ||
|-

|}

== See also ==

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

Scripting commands

2019-06-10T00:21:31Z

LETARTARE: /* remark for GetBuildTarget()*/

[[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().

''NOTE: Updated to '''12.11'''

== 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 || Does [[Variable_expansion|variable expansion]] on the input wxString
|-

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

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

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

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

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

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

|-
| wxArrayString || GetArrayFromString || wxString,wxString,bool ||
|-

|-
| wxString || GetStringFromArray || wxArrayString,wxString,bool ||
|-

|-
| wxString || EscapeSpaces || wxString ||
|-

|-
| wxString || UnixFilename || wxString, int || arg1=filename, arg2=wxPATH_NATIVE, wxPATH_WIN, ...
|-

|-
| FileType || FileTypeOf || wxString ||
|-

|-
| wxString || URLEncode || wxString ||
|-

|-
| void || NotifyMissingFile || wxString ||
|-

|-
| int || GetPlatformsFromString || wxString ||
|-

|-
| wxString || GetStringFromPlatforms || int,bool||
|-

|-
| void|| InfoWindow || wxString,wxString,int,int || pop-up box in the lower right, see infowindow.h
|-

|-
| 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
|-

|-
| int || ExecuteToolPlugin || wxString || Execute a tool plugin (found in Plugins menu)
|-

|-
| int || ConfigureToolPlugin || wxString || Configure a tool plugin (found in Plugins menu)
|-

|-
| void || CallMenu || wxString || Call a menu entry describing its path using slashes (e.g. "/Valgrind/Run Valgrind::MemCheck")
|-

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

|-
| int || Require || wxString ||arg=script_filename, return 0 if ok
|-

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

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

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

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

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

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

|-
| long || wxString_ToLong || wxString const ||
|-

|}

== 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 || const wxString, int || arg1=key, arg2=default_val
|-

|-
| bool || Read || const wxString, bool || arg1=key, arg2=default_val
|-

|-
| float || Read || const wxString, float || arg1=key, arg2=default_val
|-

|-
| wxString || Read || const wxString, const wxString || arg1=key, arg2=default_val
|-

|-
| void || Write || const wxString, int || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, bool || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, float || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, const wxString, bool ||arg1=key, arg2=value, arg3=ignore_value_empty
|-

|}

== ProjectManager ==
see API docs for 'ProjectManager::...' in 'include\projectmanager.h'

{| 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 in Prototype
!Remarks
|-

|-
| wxString || GetDefaultPath || ( ) ||
|-

|-
| void || SetDefaultPath || (const wxString& path) ||
|-

|-
| cbProject* || GetActiveProject || ( ) ||
|-

|-
| int || GetProjectCount || ( ) ||
|-

|-
| cbProject* || GetProject || (int) ||
|-

|-
| void || SetProject || (cbProject* project, bool refresh = true) ||
|-

|-
| bool || LoadWorkspace || (const wxString& filename = DEFAULT_WORKSPACE)||
|-

|-
| bool || SaveWorkspace || ( ) ||
|-

|-
| bool || SaveWorkspaceAs || (const wxString& filename) ||
|-

|-
| bool || CloseWorkspace || ( ) ||
|-

|-
| cbProject* || IsOpen || (const wxString& filename) ||
|-

|-
| cbProject* || LoadProject || (const wxString& filename, bool activateIt = true) ||
|-

|-
| bool || SaveProject || (cbProject* project) ||
|-

|-
| bool || SaveProjectAs || (cbProject* project) ||
|-

|-
| bool || SaveActiveProject || ( ) ||
|-

|-
| bool || SaveActiveProjectAs || ( ) ||
|-

|-
| bool || SaveAllProjects || ( ) ||
|-

|-
| bool || CloseProject || (cbProject* project, bool dontsave = false, bool refresh = true) ||
|-

|-
| bool || CloseActiveProject || (bool dontsave = false) ||
|-

|-
| bool || CloseAllProjects || (bool dontsave = false) ||
|-

|-
| cbProject* || NewProject || (const wxString& filename = wxEmptyString) ||
|-

|-
| int || AddFileToProject || (const wxString& filename, cbProject* project = 0L, int target = -1) ||
|-

|-
| int || AskForBuildTargetIndex || (cbProject* project = 0L) ||

|-
| void || RebuildTree || ( ) ||
|-

|-
| bool || AddProjectDependency || (cbProject* base, cbProject* dependsOn) ||
|-

|-
| void || RemoveProjectDependency || (cbProject* base, cbProject* doesNotDependOn) ||
|-

|-
| void || ClearProjectDependencies || (cbProject* base) ||
|-

|-
| void || RemoveProjectFromAllDependencies || (cbProject* base) ||
|-

|-
| ProjectsArray* || GetDependenciesForProject || (cbProject* base) ||
|-

|-
| void || ConfigureProjectDependencies || (cbProject* base = 0) ||
|-
|}

== 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 in Prototype
!Remarks
|-

|-
| void || Configure || ( ) ||
|-

|-
| cbEditor* || New || (const wxString& newFileName = wxEmptyString) ||
|-

|-
| cbEditor* || Open || (const wxString& filename) ||
|-

|-
| cbEditor* || IsBuiltinOpen || (const wxString& filename) ||
|-

|-
| cbEditor* || GetBuiltinEditor || (const wxString& filename)|(int index) ||
|-

|-
| cbEditor* || GetBuiltinActiveEditor || ( ) ||
|-

|-
| EditorBase* || GetActiveEditor || ( ) ||
|-

|-
| void || ActivateNext || ( ) ||
|-

|-
| void || ActivatePrevious || ( ) ||
|-

|-
| bool || SwapActiveHeaderSource || ( ) ||
|-

|-
| bool || CloseActive || (bool dontsave = false) ||
|-

|-
| bool || Close || (const wxString& filename,bool dontsave = false)|(int index,bool dontsave = false),(EditorBase* editor,bool dontsave = false) ||
|-

|-
| bool || CloseAll || (bool dontsave=false) ||
|-

|-
| bool || Save || (const wxString& filename)|(int index)||
|-

|-
| bool || SaveActive || ( ) ||
|-

|-
| bool || SaveAs || (int index) ||
|-

|-
| bool || SaveActiveAs || ( ) ||
|-

|-
| bool || SaveAll || ( ) ||
|-

|-
| int || ShowFindDialog || (bool replace, bool explicitly_find_in_files = false) ||
|-

|}

== 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 in Prototype
!Remarks
|-

|-
| bool || Exists || (const wxString& variable) ||
|-

|}

== 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 in Prototype
!Remarks
|-

|-
| bool || DirectoryExists || (const wxString& dir) || '''1)'''
|-

|-
| wxString || SelectDirectory || (const wxString& message, const wxString& initialPath, bool showCreateDirButton) ||
|-

|-
| bool || '''CreateDirectory''' || (const wxString& full_path, int perms) || arg1=dir, arg2=permissions '''1)'''
|-

|-
| bool || '''RemoveDirectory''' || (const wxString& src) || '''1)'''
|-

|-
| bool || '''CopyFile''' ||(const wxString& src, const wxString& dst, bool overwrite) || '''1)'''
|-

|-
| bool || '''RenameFile''' || (const wxString& src, const wxString& dst) || old,new '''1)'''
|-

|-
| bool || '''RemoveFile''' || (const wxString& src) || '''1)'''
|-

|-
| bool || FileExists || (const wxString& file) || '''1)'''
|-

|-
| wxString || SelectFile || (const wxString& title, const wxString& defaultFile, const wxString& filter) ||
|-

|-
| wxString || ReadFileContents || (const wxString& filename) || '''1)'''
|-

|-
| bool || '''WriteFileContents''' || (const wxString& filename, const wxString& contents) || filename,contents '''1)'''
|-

|-
| int || '''Execute''' || (const wxString& command) ||
|-

|-
| wxString || '''ExecuteAndGetOutput''' || (const wxString& command) ||
|-

|-
| wxString || '''ExecuteAndGetOutputAndError''' || (const wxString& command, bool prepend_error) ||if 'prepend_error' is true gives an error string
|-

|-
| wxString || GetCwd || ( ) ||
|-

|-
| void || SetCwd || (const wxString& dir) || directory (currently working directory)
|-

|}

'''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.

'''NOTE: 1)''' All paths/filenames are expanded via the ReplaceMacros function prior the function is called. So it is possible to copy the project output file with
<source lang="c">
IO.CopyFile(_T("$(TARGET_OUTPUT_FILE)"),_T("output_directory/output_file"),true);
</source>

== 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 in Prototype
!Remarks
|-

|-
| bool || IsValidCompilerID || (const wxString& id) ||
|-

|-
| int || GetCompilerIndex || (const wxString& id) ||
|-

|-
| wxString || GetDefaultCompilerID || ( ) ||
|-

|-
| wxString || GetCompilerVersionString || (const wxString& Id) ||
|-

|-
| bool || CompilerInheritsFrom || ( ) ||
|-

|-
| wxString || GetCompilerIDByName || (const wxString &name ) || Makes it possible to find the compiler id by its name. Available since rev 9823.
|-
|}

== 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
|-

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

|-
| wxString || _ || const char* || the same as _T, but should be used for translatable strings
|-

|-
| wxString || operator= || const wxString ||
|-

|-
| wxString || operator+ || const wxString ||
|-

|-
| wxString || operator+ || const int ||
|-

|-
| wxString || operator+= || const wxString ||
|-

|-
| wxString || operator+= || const int ||
|-

|-
| bool || operator< || const wxString || _T("abc") < _T("cba") -> true
|-

|-
| bool || operator<= || const wxString ||
|-

|-
| bool || operator>= || const wxString ||
|-

|-
| bool || operator> || const wxString ||
|-

|-
| int || Find || wxString || -1 if not found
|-

|-
| bool || Matches || wxString || not use '==' !!, returns true if the string contents matches a mask containing '*' and '?'
|-

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

|-
| char || GetChar || int || arg1=position
|-

|-
| 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 || arg1=position, arg2=long
|-

|-
| wxString || Remove || int, int || arg1=position, arg2=long
|-

|-
| void || RemoveLast || int || remove the last characters
|-

|-
| int || Replace || wxString, wxString,bool || arg3=true -> all occurrences else the first
|-

|-
| wxString || Right || int x || return the x last characters
|-

|-
| wxString || AfterFirst || char || not found -> _T("")
|-

|-
| wxString || AfterLast || char || not found -> all the character string
|-

|-
| wxString || BeforeFirst || char || not found -> all the character string
|-

|-
| wxString || BeforeLast || char || not found -> _T("")
|-
|}
''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 || ||
|-

|-
| int || Index || wxString || -1 If not found
|-

|-
| wxString || Item || int || not work with wx 2.9.x ?!
|-

|}
''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 || ||
|-

|-
| bool || IsOk || || ONLY if (wxVERSION_NUMBER < 2900)
|-

|-
| void || Set || byte, byte, byte, byte || red, green, blue, alpha : into [0..255]
|-

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

''EXAMPLE: local my_wxcolour = ::wxColour(); my_wxcolour.Set(0xFF, 0x00, 0x00, 0x55); ::print(my_wxcolour) -> [r=255, g=0, b=0]

== wxFileName ==
'''UNDER VERIFICATION'''

{| 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 || Assign || const wxFileName || creates the file name from an other wxFileName
|-

|-
| void || Assign || const wxString, wxPathFormat || arg1=full_path, arg2=wformat=xPATH_NATIVE ...
|-

|-
| void || AssignCwd || const wxString || arg1=volume
|-

|-
| void || AssignDir|| const wxString, wxPathFormat || arg1=name_dir, arg2=format=wxPATH_NATIVE ...
|-

|-
| void || AssignHomeDir || || sets this file name object to the home directory
|-

|-
| void || Clear || || reset all components to default, uninitialized state
|-

|-
| void || ClearExt || || removes the extension from the file name resulting in a file name with no trailing dot
|-

|-
| int || GetDirCount || || returns the number of directories in the file name.
|-

|-
| wxArrayString || GetDirs || || returns the directories in string array form
|-

|-
| wxString || GetExt || || returns the file name extension.

|-

|-
| wxString || GetFullName || || returns the full name (including extension but excluding directories).
|-

|-
| wxString || GetFullPath || wxPathFormat || arg=format=wxPATH_NATIVE ...
|-

|-
| wxString || GetLongPath || || return the long form of the path (returns identity on non-Windows platforms)

|-

|-
| wxString || GetName || || returns the name part of the filename (without extension)
|-

|-
| wxString || GetPath || int, wxPathFormat || arg1=flags=wxPATH_GET_VOLUME..., arg2=format=wxPATH_NATIVE ...
|-

|-
| wxString || GetShortPath || || return the short form of the path (returns identity on non-Windows platforms).

|-

|-
| wxString || GetVolume || || returns the string containing the volume for this file name
|-

|-
| bool || HasExt || || returns true if an extension is present.
|-

|-
| bool || HasName || || returns true if a name is present
|-

|-
| bool || HasVolume || || returns true if a volume specifier is present
|-

|-
| void || InsertDir||int, const wxString || arg1=before_dir, arg2=name_dir
|-

|-
| bool || IsAbsolute || wxPathFormat ||arg=format=wxPATH_NATIVE...
|-

|-
| bool || IsOk || || returns true if the filename is valid
|-

|-
| bool || IsRelative || wxPathFormat ||arg=format=wxPATH_NATIVE...
|-

|-
| bool || IsDir || || returns true if this object represents a directory
|-

|-
| bool || MakeAbsolute ||const wxString, wxPathFormat|| arg1=cwd=_T("") or ..., arg2=format=wxPATH_NATIVE or ...
|-

|-
| bool || MakeRelativeTo ||const wxString, wxPathFormat|| arg1=path_base, arg2=format=wxPATH_NATIVE or ...
|-

|-
| bool || Normalize ||int, const wxString, wxPathFormat||arg1=flags=wxPATH_NORM_ALL, arg2=cwd=_T(""),arg3=format=wxPATH_NATIVE or ...
|

|-
| void || PrependDir || const wxString ||arg=dir
|-

|-
| void || RemoveDir || int ||arg=pos RemoveLastDir
|-

|-
| void || RemoveLastDir || || removes last directory component from the path
|-

|-
| bool || SameAs || const wxFileName, wxPathFormat || arg1=filepath, arg2=format=wxPATH_NATIVE
|-

|-
| bool || SetCwd|| || changes the current working directory
|-

|-
| void || SetExt ||const wxString ||arg=extension
|-

|-
| void || SetEmptyExt || || sets the extension of the file name to be an empty extension
|-

|-
| void || SetFullName || wxString ||
|-

|-
| void || SetName || wxString ||
|-

|-
| void || SetVolume || wxString ||
|-

|}
''NOTE: Is instantiated in a script using: local my_filename = ::wxFileName()

== wxPoint ==
'''UNDER CONSTRUCTION'''

'' Instantiate integer points 2D

{| 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
|-

|-
| wxPoint || operator= || const wxPoint|| default assignment operator is ok
|-

|-
| bool || operator== ||const wxPoint||
|-

|-
| bool || operator!= || const wxPoint||
|-

|-
| int || x || ||
|-

|-
| int || y || ||
|-

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

''EXAMPLE: local my_wxpoint = ::wxPoint(); my_wxpoint.x = 5; my_wxpoint.y = 12; // not use ::print(my_wxpoint)

== wxSize ==
'''UNDER CONSTRUCTION'''

'' Instantiate integers values (X, Y)

{| 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
|-

|-
| wxSize || operator= || const wwSize|| default assignment operator is ok
|-

|-
| bool || operator== ||const wxSize||
|-

|-
| bool || operator!= || const wxSize||
|-

|-
| int || GetWidth || || return X
|-

|-
| int || GetHeight || || return Y
|-

|-
| void || SetWidth || int w|| X=w
|-

|-
| void || SetHeight || int h|| Y=h
|-

|-
| void || Set || int w, int h|| X=w, Y=h
|-

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

''EXAMPLE: local my_wxsize = ::wxSize(); my_wxsize.SetWidth(5); my_wxsize.SetHeight(12); // not use ::print(my_wxsize)

== 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 in Prototype
!Remarks
|-

|-
| void || AddBuildTarget || (const wxString& targetName)||
|-

|-
| void || RenameBuildTarget || (const wxString& oldTargetName, const wxString& newTargetName) ||
|-

|-
| void || RemoveBuildTarget || (const wxString& targetName)||
|-

|-
| wxString || GetBaseName || ( ) ||
|-

|-
| wxString || GetObjName || ( ) ||
|-

|-
| void || SetObjName || (const wxString& targetName) ||
|-

|-
| cbProject* || GetParentProject || ( ) ||
|-

|-
| wxString|| GetCustomBuildCommand|| (const wxString& compilerId) ||
|-

|-
| void || SetCustomBuildCommand || (const wxString& compilerId, const wxString& newBuildCommand) ||
|-

|-
| bool || GetUseCustomBuildCommand|| (const wxString& compilerId) ||
|-

|-
| void || SetUseCustomBuildCommand || (const wxString& compilerId, bool useCustomBuildCommand) ||
|-

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

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

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

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

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

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

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

|-
| wxArrayString || buildTargets || || (variable)
|-

|-
| const wxArrayString & || GetBuildTargets ||() const || r9252 : for use instead of the 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 in Prototype
!Remarks
|-

|-
| void || AddPlatform || (int platform) || windows,unix,mac
|-

|-
| void || RemovePlatform || (int platform) ||
|-

|-
| void || SetPlatforms || (int platform) ||
|-

|-
| int || GetPlatforms || ||
|-

|-
| bool || SupportsCurrentPlatform || ||
|-

|-
| void || SetLinkerOptions || (const wxArrayString& linkerOpts) ||
|-

|-
| void || SetLinkLibs || (const wxArrayString& linkLibs) ||
|-

|-
| void || SetCompilerOptions || (const wxArrayString& compilerOpts) ||
|-

|-
| void || SetIncludeDirs || (const wxArrayString& includeDirs) ||
|-

|-
| void || SetResourceIncludeDirs || (const wxString& option) ||
|-

|-
| void || SetLibDirs || (const wxArrayString& libDirs) ||
|-

|-
| void || SetCommandsBeforeBuild || (const wxArrayString& commands) ||
|-

|-
| void || SetCommandsAfterBuild || (const wxArrayString& commands) ||
|-

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

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

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

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

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

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

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

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

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

|-
| void || SetModified || (bool modified) ||
|-

|-
| void || AddLinkerOption || (const wxString& option) ||
|-

|-
| void || AddLinkLib || (const wxString& lib) ||
|-

|-
| void || AddCompilerOption || (const wxString& option)||
|-

|-
| void || AddIncludeDir || (const wxString& option) ||
|-

|-
| void || AddResourceIncludeDir || (const wxString& option) ||
|-

|-
| void || AddLibDir || (const wxString& option) ||
|-

|-
| void || AddCommandsBeforeBuild || (const wxString& command) ||
|-

|-
| void || AddCommandsAfterBuild || (const wxString& command) ||
|-

|-
| void || RemoveLinkerOption || (const wxString& option) ||
|-

|-
| void || RemoveLinkLib || (const wxString& lib) ||
|-

|-
| void || RemoveCompilerOption || (const wxString& option) ||
|-

|-
| void || RemoveIncludeDir || (const wxString& option) ||
|-

|-
| void || RemoveResourceIncludeDir || (const wxString& option) ||
|-

|-
| void || RemoveLibDir || (const wxString& option) ||
|-

|-
| void || RemoveCommandsBeforeBuild || (const wxString& command) ||
|-

|-
| void || RemoveCommandsAfterBuild || (const wxString& command) ||
|-

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

|-
| void || SetAlwaysRunPostBuildSteps || (bool always) ||
|-

|-
| void || SetBuildScripts || (const wxArrayString& scripts) ||
|-

|-
| wxArrayString || GetBuildScripts || ||
|-

|-
| void || AddBuildScript || (const wxString& script) ||
|-

|-
| void || RemoveBuildScript || (const wxString& script) ||
|-

|-
| bool || SetVar || (const wxString& key, const wxString& value, bool onlyIfExists = false) ||
|-

|-
| wxString || GetVar || (const wxString& key) ||
|-

|-
| bool || UnsetVar || (const wxString& key) ||
|-

|-
| 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
|-

|-
| void || SetTargetFilenameGenerationPolicy || enum prefix, enum extension|| tgfpPlatformDefault -> Generate filename based on running platform defaults. tgfpNone -> No automatic generation; let the user specify the full filename.
|-

|-
| 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 || ||
|-

|-
| wxString || GetMakeCommandFor || enum ||
|-

|-
| void || SetMakeCommandFor || enum,wxString ||
|-

|-
| bool || MakeCommandsModified || ||
|-

|}

== 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 || ||The full title, i.e. "projectname - targetname"
|-

|-
| wxString || GetExternalDeps || ||list of files whose target depends
|-

|-
| void || SetExternalDeps || wxString ||list of files whose target depends
|-

|-
| void || SetAdditionalOutputFiles || wxString ||a list of additional output files
|-

|-
| wxString || GetAdditionalOutputFiles || ||a list of additional output files
|-

|-
| bool || GetIncludeInTargetAll || || Deprecated, do not use at 'All'
|-

|-
| void || SetIncludeInTargetAll || bool || Deprecated, do not use at 'All'
|-

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

|-
| void || SetCreateDefFile || bool ||if the target creates a DEF imports file.
|-

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

|-
| void || SetCreateStaticLib || bool ||if an import library should be created
|-

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

|-
| void || SetUseConsoleRunner || bool ||for targets generating a console executable.
|-

|-
| ProjectFile* || GetFile || int || returns a file from the target
|-

|-
| int || GetFilesCount || || returns number of files of target
|-

|}

== 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 || name, is relative, is Unixfilename
|-

|-
| bool || RemoveFile || ProjectFile * ||
|-

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

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

|-
| int || GetBuildTargetsCount || || number targets
|-

|-
| ProjectBuildTarget* || GetBuildTarget || int || target index
|-

|-
| ProjectBuildTarget* || GetBuildTarget || wxString || target name, if '*' exists -> real target
|-

|-
| ProjectBuildTarget* || AddBuildTarget || wxString || target name
|-

|-
| bool || RenameBuildTarget || int, wxString || target index, new name
|-

|-
| bool || RenameBuildTarget || wxString, wxString || old name, new name
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || int, wxString || index, new name
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || wxString, wxString || target name, new name
|-

|-
| bool || RemoveBuildTarget || int || index
|-

|-
| bool || RemoveBuildTarget || wxString || target name
|-

|-
| bool || ExportTargetAsProject || int || target index
|-

|-
| bool || ExportTargetAsProject || wxString || target name
|-

|-
| bool || BuildTargetValid || wxString|bool ||
|-

|-
| wxString || GetFirstValidBuildTargetName || bool ||
|-

|-
| void || SetDefaultExecuteTarget || wxString ||
|-

|-
| wxString || GetDefaultExecuteTarget || wxString ||
|-

|-
| bool || SetActiveBuildTarget || wxString ||
|-

|-
| wxString || GetActiveBuildTarget || || active target name, might be a virtual target||
|-

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

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

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

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

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

|-
| void || SetExtendedObjectNamesGeneration || bool ||
|-

|-
| bool || GetExtendedObjectNamesGeneration || ||
|-

|-
| void || SetNotes || wxString ||
|-

|-
| wxString || GetNotes || ||
|-

|-
| void || SetShowNotesOnLoad || bool ||
|-

|-
| bool || GetShowNotesOnLoad || ||
|-

|-
| void || ShowNotes || bool,bool ||
|-

|-
| void || AddToExtensions || wxString ||
|-

|-
| bool || DefineVirtualBuildTarget || wxString,wxArrayString ||arg1=alias virtual target, arg2= array targets
|-

|-
| bool || HasVirtualBuildTarget|| wxSring ||arg=alias virtual target
|-

|-
| bool || RemoveVirtualBuildTarget|| wxString ||arg=alias virtual target, return true if removed
|-

|-
| wxArrayString || GetVirtualBuildTargets|| ||Get a list of all defined virtual build targets.
|-

|-
| wxArrayString || GetVirtualBuildTargetGroup || wxString ||arg=alias, Access a virtual build target's group of build targets.
|-

|-
| wxArrayString || GetExpandedVirtualBuildTargetGroup|| wxString ||arg=alias, Access a virtual build target's expanded group of build targets.
|-

|-
| bool || CanAddToVirtualBuildTarget || wxSring,wxString ||arg1=alias, arg2=name target to add,
Checks if a build target (virtual or real) can be added to a virtual build target, without causing a circular-reference.
|-

|-
| void || SetTitle || wxSring ||
|-
|}

== 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 || Save || ||
|-

|-
| 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;" | '''Plugin version'''
|-

|-
|PLUGIN_SDK_VERSION_MAJOR||int|| =1, it will change when the SDK interface breaks
|-

|-
|PLUGIN_SDK_VERSION_MINOR||int|| =13, it will change when the SDK interface breaks
|-

|-
|PLUGIN_SDK_VERSION_RELEASE||int|| =13, it will change when the SDK interface breaks
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Path separator for filenames'''
|-

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

|-
| 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 wxPathFormat'''
|-

|-
|wxPATH_NATIVE || enum ||
|-

|-
|wxPATH_UNIX || enum ||
|-

|-
|wxPATH_BEOS || enum ||
|-

|-
|wxPATH_MAC || enum ||
|-

|wxPATH_DOS || enum ||
|-

|-
|wxPATH_WIN || enum ||
|-

|-
|wxPATH_OS2 || enum ||
|-

|-
|wxPATH_VM3 || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''For wxFileName::GetPath()'''
|-

|-
|wxPATH_GET_VOLUME || enum || include the volume if applicable
|-

|-
|wxPATH_GET_SEPARATOR || enum || terminate the path with the separator
|-

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

|-
|wxPATH_NORM_ENV_VARS || enum || replace env vars with their values
|-

|-
|wxPATH_NORM_DOTS || enum || squeeze all .. and . and prepend cwd
|-

|-
|wxPATH_NORM_TILDE || enum || Unix only: replace ~ and ~user
|-

|-
|wxPATH_NORM_CASE || enum || if case insensitive => tolower
|-

|-
|wxPATH_NORM_ABSOLUTE || enum ||make the path absolute
|-

|-
|wxPATH_NORM_LONG || enum ||make the path the long form
|-

|-
|wxPATH_NORM_SHORTCUT|| enum || resolve the shortcut, if it is a shortcut
|-

|-
|wxPATH_NORM_ALL || enum || = 0x00ff & ~wxPATH_NORM_CASE
|-

|-
| 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 ||
|-

|-
| mcAskRebuildNeeded|| enum ||
|-

|-
|mcSilentBuild|| 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;" | '''enum SearchDirs'''
|-

|-
|sdHome|| enum || User's home directory
|-

|-
|sdBase|| enum || Code::Blocks' installation base
|-

|-
|sdTemp|| enum || System-wide temp folder
|-

|-
|sdPath || enum || All dirs in the PATH environment variable
|-

|-
|sdConfig || enum || Config folder
|-

|-
|sdCurrent|| enum || Current working folder
|-

|-
|sdPluginsUser|| enum || Plugins folder in user's dir
|-

|-
|sdScriptsUser|| enum || Scripts folder in user's dir
|-

|-
|sdDataUser|| enum || Data folder in user's dir
|-

|-
|sdAllUser || enum || Convenience value meaning "all sd*User values"
|-

|-
|sdPluginsGlobal|| enum || Plugins folder in base dir
|-

|-
|sdScriptsGlobal|| enum || Scripts folder in base dir
|-

|-
|sdDataGlobal || enum || Data folder in base dir
|-

|-
|sdAllGlobal || enum || Convenience value meaning "all sd*Global values"
|-

|-
|sdAllKnown|| enum || All known dirs (i.e. all of the above)
|-

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

|-
|spMac ||enum ||
|-

|-
|spUnix ||enum ||
|-

|-
|spWindows ||enum ||
|-

|-
|spAll ||enum ||
|

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

|-
|tgfpPlatformDefault ||enum || Generate filename based on running platform defaults.
|-

|-
|tgfpNone ||enum || No automatic generation; let the user specify the full filename
|-

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

|-
|mtProjectManager ||enum ||
|-

|-
|mtEditorManager ||enum ||
|-

|-
|mtLogManager||enum ||
|-

|-
|mtOpenFilesList||enum ||
|-

|-
|mtEditorTab||enum ||
|-

|-
|mtUnknown||enum ||
|-

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

|-
|ftdkUndefined||enum ||
|-

|-
|ftdkProject||enum ||
|-

|-
|ftdkFolder||enum ||
|-

|-
|ftdkFile||enum ||
|-

|-
|ftdkVirtualGroup||enum ||
|-

|-
|ftdkVirtualFolder||enum ||
|-

|-
| 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_MSVC7 || wxString ||
|-

|-
| EXT_MSVC10 || wxString ||
|-

|-
| EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| EXT_ASM || wxString ||
|-

|-
| EXT_D || wxString ||
|-

|-
| EXT_F || wxString ||
|-

|-
| EXT_F77 || wxString ||
|-

|-
| EXT_F90 || wxString ||
|-

|-
| EXT_F95 || wxString ||
|-

|-
| EXT_FOR || wxString ||
|-

|-
| EXT_FPP || wxString ||
|-

|-
| EXT_F03 || wxString ||
|-

|-
| EXT_F08 || wxString ||
|-

|-
| EXT_JAVA || wxString ||
|-

|-
| EXT_C || wxString ||
|-

|-
| EXT_CC || wxString ||
|-

|-
| EXT_CPP || wxString ||
|-

|-
| EXT_CXX || wxString ||
|-

|-
| EXT_CPLPL || wxString ||
|-

|-
| EXT_INL || wxString ||
|-

|-
| EXT_H || wxString ||
|-

|-
| EXT_HH || wxString ||
|-

|-
| EXT_HPP || wxString ||
|-

|-
| EXT_HXX || wxString ||
|-

|-
| EXT_HPLPL || wxString ||
|-

|-
| EXT_S || wxString ||
|-

|-
| EXT_SS || wxString ||
|-

|-
| EXT_S62 || wxString ||
|-

|-
| EXT_OBJECT || wxString ||
|-

|-
| EXT_XRCRESOURCE || wxString ||
|-

|-
| EXT_STATICLIB || wxString ||
|-

|-
| EXT_DYNAMICLIB || wxString ||
|-

|-
| EXT_EXECUTABLE || wxString ||
|-

|-
| EXT_NATIVE || 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_MSVC7 || wxString ||
|-

|-
| DOT_EXT_MSVC10 || wxString ||
|-

|-
| DOT_EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_D || wxString ||
|-

|-
| DOT_EXT_F || wxString ||
|-

|-
| DOT_EXT_F77 || wxString ||
|-

|-
| DOT_EXT_F90 || wxString ||
|-

|-
| DOT_EXT_F95 || wxString ||
|-

|-
| DOT_EXT_FOR || wxString ||
|-

|-
| DOT_EXT_FPP || wxString ||
|-

|-
| DOT_EXT_F03 || wxString ||
|-

|-
| DOT_EXT_F08 || wxString ||
|-

|-
| DOT_EXT_JAVA || wxString ||
|-

|-
| DOT_EXT_C || wxString ||
|-

|-
| DOT_EXT_CC || wxString ||
|-

|-
| DOT_EXT_CPP || wxString ||
|-

|-
| DOT_EXT_CXX || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_CPLPL || wxString ||
|-

|-
| DOT_EXT_H || wxString ||
|-

|-
| DOT_EXT_HH || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_HXX || wxString ||
|-

|-
| DOT_EXT_HPLPL || wxString ||
|-

|-
| DOT_EXT_S || wxString ||
|-

|-
| DOT_EXT_SS || wxString ||
|-

|-
| DOT_EXT_S62 || wxString ||
|-

|-
| DOT_EXT_OBJECT || wxString ||
|-

|-
| DOT_EXT_XRCRESOURCE || wxString ||
|-

|-
| DOT_EXT_STATICLIB || wxString ||
|-

|-
| DOT_EXT_DYNAMICLIB || wxString ||
|-

|-
| DOT_EXT_EXECUTABLE || wxString ||
|-

|-
| DOT_EXT_NATIVE || wxString ||
|-

|-
| DOT_EXT_RESOURCE || wxString ||
|-

|-
| DOT_EXT_RESOURCEBIN || wxString ||
|-

|-
| DOT_EXT_XML || wxString ||
|-

|-
| DOT_EXT_SCRIPT || wxString ||
|-

|}

== See also ==

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

Scripting commands

2019-06-07T08:44:17Z

LETARTARE: /* remark for GetActiveBuildTarget()*/

[[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().

''NOTE: Updated to '''12.11'''

== 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 || Does [[Variable_expansion|variable expansion]] on the input wxString
|-

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

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

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

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

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

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

|-
| wxArrayString || GetArrayFromString || wxString,wxString,bool ||
|-

|-
| wxString || GetStringFromArray || wxArrayString,wxString,bool ||
|-

|-
| wxString || EscapeSpaces || wxString ||
|-

|-
| wxString || UnixFilename || wxString, int || arg1=filename, arg2=wxPATH_NATIVE, wxPATH_WIN, ...
|-

|-
| FileType || FileTypeOf || wxString ||
|-

|-
| wxString || URLEncode || wxString ||
|-

|-
| void || NotifyMissingFile || wxString ||
|-

|-
| int || GetPlatformsFromString || wxString ||
|-

|-
| wxString || GetStringFromPlatforms || int,bool||
|-

|-
| void|| InfoWindow || wxString,wxString,int,int || pop-up box in the lower right, see infowindow.h
|-

|-
| 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
|-

|-
| int || ExecuteToolPlugin || wxString || Execute a tool plugin (found in Plugins menu)
|-

|-
| int || ConfigureToolPlugin || wxString || Configure a tool plugin (found in Plugins menu)
|-

|-
| void || CallMenu || wxString || Call a menu entry describing its path using slashes (e.g. "/Valgrind/Run Valgrind::MemCheck")
|-

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

|-
| int || Require || wxString ||arg=script_filename, return 0 if ok
|-

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

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

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

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

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

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

|-
| long || wxString_ToLong || wxString const ||
|-

|}

== 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 || const wxString, int || arg1=key, arg2=default_val
|-

|-
| bool || Read || const wxString, bool || arg1=key, arg2=default_val
|-

|-
| float || Read || const wxString, float || arg1=key, arg2=default_val
|-

|-
| wxString || Read || const wxString, const wxString || arg1=key, arg2=default_val
|-

|-
| void || Write || const wxString, int || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, bool || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, float || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, const wxString, bool ||arg1=key, arg2=value, arg3=ignore_value_empty
|-

|}

== ProjectManager ==
see API docs for 'ProjectManager::...' in 'include\projectmanager.h'

{| 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 in Prototype
!Remarks
|-

|-
| wxString || GetDefaultPath || ( ) ||
|-

|-
| void || SetDefaultPath || (const wxString& path) ||
|-

|-
| cbProject* || GetActiveProject || ( ) ||
|-

|-
| int || GetProjectCount || ( ) ||
|-

|-
| cbProject* || GetProject || (int) ||
|-

|-
| void || SetProject || (cbProject* project, bool refresh = true) ||
|-

|-
| bool || LoadWorkspace || (const wxString& filename = DEFAULT_WORKSPACE)||
|-

|-
| bool || SaveWorkspace || ( ) ||
|-

|-
| bool || SaveWorkspaceAs || (const wxString& filename) ||
|-

|-
| bool || CloseWorkspace || ( ) ||
|-

|-
| cbProject* || IsOpen || (const wxString& filename) ||
|-

|-
| cbProject* || LoadProject || (const wxString& filename, bool activateIt = true) ||
|-

|-
| bool || SaveProject || (cbProject* project) ||
|-

|-
| bool || SaveProjectAs || (cbProject* project) ||
|-

|-
| bool || SaveActiveProject || ( ) ||
|-

|-
| bool || SaveActiveProjectAs || ( ) ||
|-

|-
| bool || SaveAllProjects || ( ) ||
|-

|-
| bool || CloseProject || (cbProject* project, bool dontsave = false, bool refresh = true) ||
|-

|-
| bool || CloseActiveProject || (bool dontsave = false) ||
|-

|-
| bool || CloseAllProjects || (bool dontsave = false) ||
|-

|-
| cbProject* || NewProject || (const wxString& filename = wxEmptyString) ||
|-

|-
| int || AddFileToProject || (const wxString& filename, cbProject* project = 0L, int target = -1) ||
|-

|-
| int || AskForBuildTargetIndex || (cbProject* project = 0L) ||

|-
| void || RebuildTree || ( ) ||
|-

|-
| bool || AddProjectDependency || (cbProject* base, cbProject* dependsOn) ||
|-

|-
| void || RemoveProjectDependency || (cbProject* base, cbProject* doesNotDependOn) ||
|-

|-
| void || ClearProjectDependencies || (cbProject* base) ||
|-

|-
| void || RemoveProjectFromAllDependencies || (cbProject* base) ||
|-

|-
| ProjectsArray* || GetDependenciesForProject || (cbProject* base) ||
|-

|-
| void || ConfigureProjectDependencies || (cbProject* base = 0) ||
|-
|}

== 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 in Prototype
!Remarks
|-

|-
| void || Configure || ( ) ||
|-

|-
| cbEditor* || New || (const wxString& newFileName = wxEmptyString) ||
|-

|-
| cbEditor* || Open || (const wxString& filename) ||
|-

|-
| cbEditor* || IsBuiltinOpen || (const wxString& filename) ||
|-

|-
| cbEditor* || GetBuiltinEditor || (const wxString& filename)|(int index) ||
|-

|-
| cbEditor* || GetBuiltinActiveEditor || ( ) ||
|-

|-
| EditorBase* || GetActiveEditor || ( ) ||
|-

|-
| void || ActivateNext || ( ) ||
|-

|-
| void || ActivatePrevious || ( ) ||
|-

|-
| bool || SwapActiveHeaderSource || ( ) ||
|-

|-
| bool || CloseActive || (bool dontsave = false) ||
|-

|-
| bool || Close || (const wxString& filename,bool dontsave = false)|(int index,bool dontsave = false),(EditorBase* editor,bool dontsave = false) ||
|-

|-
| bool || CloseAll || (bool dontsave=false) ||
|-

|-
| bool || Save || (const wxString& filename)|(int index)||
|-

|-
| bool || SaveActive || ( ) ||
|-

|-
| bool || SaveAs || (int index) ||
|-

|-
| bool || SaveActiveAs || ( ) ||
|-

|-
| bool || SaveAll || ( ) ||
|-

|-
| int || ShowFindDialog || (bool replace, bool explicitly_find_in_files = false) ||
|-

|}

== 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 in Prototype
!Remarks
|-

|-
| bool || Exists || (const wxString& variable) ||
|-

|}

== 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 in Prototype
!Remarks
|-

|-
| bool || DirectoryExists || (const wxString& dir) || '''1)'''
|-

|-
| wxString || SelectDirectory || (const wxString& message, const wxString& initialPath, bool showCreateDirButton) ||
|-

|-
| bool || '''CreateDirectory''' || (const wxString& full_path, int perms) || arg1=dir, arg2=permissions '''1)'''
|-

|-
| bool || '''RemoveDirectory''' || (const wxString& src) || '''1)'''
|-

|-
| bool || '''CopyFile''' ||(const wxString& src, const wxString& dst, bool overwrite) || '''1)'''
|-

|-
| bool || '''RenameFile''' || (const wxString& src, const wxString& dst) || old,new '''1)'''
|-

|-
| bool || '''RemoveFile''' || (const wxString& src) || '''1)'''
|-

|-
| bool || FileExists || (const wxString& file) || '''1)'''
|-

|-
| wxString || SelectFile || (const wxString& title, const wxString& defaultFile, const wxString& filter) ||
|-

|-
| wxString || ReadFileContents || (const wxString& filename) || '''1)'''
|-

|-
| bool || '''WriteFileContents''' || (const wxString& filename, const wxString& contents) || filename,contents '''1)'''
|-

|-
| int || '''Execute''' || (const wxString& command) ||
|-

|-
| wxString || '''ExecuteAndGetOutput''' || (const wxString& command) ||
|-

|-
| wxString || '''ExecuteAndGetOutputAndError''' || (const wxString& command, bool prepend_error) ||if 'prepend_error' is true gives an error string
|-

|-
| wxString || GetCwd || ( ) ||
|-

|-
| void || SetCwd || (const wxString& dir) || directory (currently working directory)
|-

|}

'''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.

'''NOTE: 1)''' All paths/filenames are expanded via the ReplaceMacros function prior the function is called. So it is possible to copy the project output file with
<source lang="c">
IO.CopyFile(_T("$(TARGET_OUTPUT_FILE)"),_T("output_directory/output_file"),true);
</source>

== 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 in Prototype
!Remarks
|-

|-
| bool || IsValidCompilerID || (const wxString& id) ||
|-

|-
| int || GetCompilerIndex || (const wxString& id) ||
|-

|-
| wxString || GetDefaultCompilerID || ( ) ||
|-

|-
| wxString || GetCompilerVersionString || (const wxString& Id) ||
|-

|-
| bool || CompilerInheritsFrom || ( ) ||
|-

|-
| wxString || GetCompilerIDByName || (const wxString &name ) || Makes it possible to find the compiler id by its name. Available since rev 9823.
|-
|}

== 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
|-

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

|-
| wxString || _ || const char* || the same as _T, but should be used for translatable strings
|-

|-
| wxString || operator= || const wxString ||
|-

|-
| wxString || operator+ || const wxString ||
|-

|-
| wxString || operator+ || const int ||
|-

|-
| wxString || operator+= || const wxString ||
|-

|-
| wxString || operator+= || const int ||
|-

|-
| bool || operator< || const wxString || _T("abc") < _T("cba") -> true
|-

|-
| bool || operator<= || const wxString ||
|-

|-
| bool || operator>= || const wxString ||
|-

|-
| bool || operator> || const wxString ||
|-

|-
| int || Find || wxString || -1 if not found
|-

|-
| bool || Matches || wxString || not use '==' !!, returns true if the string contents matches a mask containing '*' and '?'
|-

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

|-
| char || GetChar || int || arg1=position
|-

|-
| 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 || arg1=position, arg2=long
|-

|-
| wxString || Remove || int, int || arg1=position, arg2=long
|-

|-
| void || RemoveLast || int || remove the last characters
|-

|-
| int || Replace || wxString, wxString,bool || arg3=true -> all occurrences else the first
|-

|-
| wxString || Right || int x || return the x last characters
|-

|-
| wxString || AfterFirst || char || not found -> _T("")
|-

|-
| wxString || AfterLast || char || not found -> all the character string
|-

|-
| wxString || BeforeFirst || char || not found -> all the character string
|-

|-
| wxString || BeforeLast || char || not found -> _T("")
|-
|}
''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 || ||
|-

|-
| int || Index || wxString || -1 If not found
|-

|-
| wxString || Item || int || not work with wx 2.9.x ?!
|-

|}
''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 || ||
|-

|-
| bool || IsOk || || ONLY if (wxVERSION_NUMBER < 2900)
|-

|-
| void || Set || byte, byte, byte, byte || red, green, blue, alpha : into [0..255]
|-

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

''EXAMPLE: local my_wxcolour = ::wxColour(); my_wxcolour.Set(0xFF, 0x00, 0x00, 0x55); ::print(my_wxcolour) -> [r=255, g=0, b=0]

== wxFileName ==
'''UNDER VERIFICATION'''

{| 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 || Assign || const wxFileName || creates the file name from an other wxFileName
|-

|-
| void || Assign || const wxString, wxPathFormat || arg1=full_path, arg2=wformat=xPATH_NATIVE ...
|-

|-
| void || AssignCwd || const wxString || arg1=volume
|-

|-
| void || AssignDir|| const wxString, wxPathFormat || arg1=name_dir, arg2=format=wxPATH_NATIVE ...
|-

|-
| void || AssignHomeDir || || sets this file name object to the home directory
|-

|-
| void || Clear || || reset all components to default, uninitialized state
|-

|-
| void || ClearExt || || removes the extension from the file name resulting in a file name with no trailing dot
|-

|-
| int || GetDirCount || || returns the number of directories in the file name.
|-

|-
| wxArrayString || GetDirs || || returns the directories in string array form
|-

|-
| wxString || GetExt || || returns the file name extension.

|-

|-
| wxString || GetFullName || || returns the full name (including extension but excluding directories).
|-

|-
| wxString || GetFullPath || wxPathFormat || arg=format=wxPATH_NATIVE ...
|-

|-
| wxString || GetLongPath || || return the long form of the path (returns identity on non-Windows platforms)

|-

|-
| wxString || GetName || || returns the name part of the filename (without extension)
|-

|-
| wxString || GetPath || int, wxPathFormat || arg1=flags=wxPATH_GET_VOLUME..., arg2=format=wxPATH_NATIVE ...
|-

|-
| wxString || GetShortPath || || return the short form of the path (returns identity on non-Windows platforms).

|-

|-
| wxString || GetVolume || || returns the string containing the volume for this file name
|-

|-
| bool || HasExt || || returns true if an extension is present.
|-

|-
| bool || HasName || || returns true if a name is present
|-

|-
| bool || HasVolume || || returns true if a volume specifier is present
|-

|-
| void || InsertDir||int, const wxString || arg1=before_dir, arg2=name_dir
|-

|-
| bool || IsAbsolute || wxPathFormat ||arg=format=wxPATH_NATIVE...
|-

|-
| bool || IsOk || || returns true if the filename is valid
|-

|-
| bool || IsRelative || wxPathFormat ||arg=format=wxPATH_NATIVE...
|-

|-
| bool || IsDir || || returns true if this object represents a directory
|-

|-
| bool || MakeAbsolute ||const wxString, wxPathFormat|| arg1=cwd=_T("") or ..., arg2=format=wxPATH_NATIVE or ...
|-

|-
| bool || MakeRelativeTo ||const wxString, wxPathFormat|| arg1=path_base, arg2=format=wxPATH_NATIVE or ...
|-

|-
| bool || Normalize ||int, const wxString, wxPathFormat||arg1=flags=wxPATH_NORM_ALL, arg2=cwd=_T(""),arg3=format=wxPATH_NATIVE or ...
|

|-
| void || PrependDir || const wxString ||arg=dir
|-

|-
| void || RemoveDir || int ||arg=pos RemoveLastDir
|-

|-
| void || RemoveLastDir || || removes last directory component from the path
|-

|-
| bool || SameAs || const wxFileName, wxPathFormat || arg1=filepath, arg2=format=wxPATH_NATIVE
|-

|-
| bool || SetCwd|| || changes the current working directory
|-

|-
| void || SetExt ||const wxString ||arg=extension
|-

|-
| void || SetEmptyExt || || sets the extension of the file name to be an empty extension
|-

|-
| void || SetFullName || wxString ||
|-

|-
| void || SetName || wxString ||
|-

|-
| void || SetVolume || wxString ||
|-

|}
''NOTE: Is instantiated in a script using: local my_filename = ::wxFileName()

== wxPoint ==
'''UNDER CONSTRUCTION'''

'' Instantiate integer points 2D

{| 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
|-

|-
| wxPoint || operator= || const wxPoint|| default assignment operator is ok
|-

|-
| bool || operator== ||const wxPoint||
|-

|-
| bool || operator!= || const wxPoint||
|-

|-
| int || x || ||
|-

|-
| int || y || ||
|-

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

''EXAMPLE: local my_wxpoint = ::wxPoint(); my_wxpoint.x = 5; my_wxpoint.y = 12; // not use ::print(my_wxpoint)

== wxSize ==
'''UNDER CONSTRUCTION'''

'' Instantiate integers values (X, Y)

{| 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
|-

|-
| wxSize || operator= || const wwSize|| default assignment operator is ok
|-

|-
| bool || operator== ||const wxSize||
|-

|-
| bool || operator!= || const wxSize||
|-

|-
| int || GetWidth || || return X
|-

|-
| int || GetHeight || || return Y
|-

|-
| void || SetWidth || int w|| X=w
|-

|-
| void || SetHeight || int h|| Y=h
|-

|-
| void || Set || int w, int h|| X=w, Y=h
|-

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

''EXAMPLE: local my_wxsize = ::wxSize(); my_wxsize.SetWidth(5); my_wxsize.SetHeight(12); // not use ::print(my_wxsize)

== 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 in Prototype
!Remarks
|-

|-
| void || AddBuildTarget || (const wxString& targetName)||
|-

|-
| void || RenameBuildTarget || (const wxString& oldTargetName, const wxString& newTargetName) ||
|-

|-
| void || RemoveBuildTarget || (const wxString& targetName)||
|-

|-
| wxString || GetBaseName || ( ) ||
|-

|-
| wxString || GetObjName || ( ) ||
|-

|-
| void || SetObjName || (const wxString& targetName) ||
|-

|-
| cbProject* || GetParentProject || ( ) ||
|-

|-
| wxString|| GetCustomBuildCommand|| (const wxString& compilerId) ||
|-

|-
| void || SetCustomBuildCommand || (const wxString& compilerId, const wxString& newBuildCommand) ||
|-

|-
| bool || GetUseCustomBuildCommand|| (const wxString& compilerId) ||
|-

|-
| void || SetUseCustomBuildCommand || (const wxString& compilerId, bool useCustomBuildCommand) ||
|-

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

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

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

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

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

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

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

|-
| wxArrayString || buildTargets || || (variable)
|-

|-
| const wxArrayString & || GetBuildTargets ||() const || r9252 : for use instead of the 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 in Prototype
!Remarks
|-

|-
| void || AddPlatform || (int platform) || windows,unix,mac
|-

|-
| void || RemovePlatform || (int platform) ||
|-

|-
| void || SetPlatforms || (int platform) ||
|-

|-
| int || GetPlatforms || ||
|-

|-
| bool || SupportsCurrentPlatform || ||
|-

|-
| void || SetLinkerOptions || (const wxArrayString& linkerOpts) ||
|-

|-
| void || SetLinkLibs || (const wxArrayString& linkLibs) ||
|-

|-
| void || SetCompilerOptions || (const wxArrayString& compilerOpts) ||
|-

|-
| void || SetIncludeDirs || (const wxArrayString& includeDirs) ||
|-

|-
| void || SetResourceIncludeDirs || (const wxString& option) ||
|-

|-
| void || SetLibDirs || (const wxArrayString& libDirs) ||
|-

|-
| void || SetCommandsBeforeBuild || (const wxArrayString& commands) ||
|-

|-
| void || SetCommandsAfterBuild || (const wxArrayString& commands) ||
|-

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

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

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

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

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

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

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

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

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

|-
| void || SetModified || (bool modified) ||
|-

|-
| void || AddLinkerOption || (const wxString& option) ||
|-

|-
| void || AddLinkLib || (const wxString& lib) ||
|-

|-
| void || AddCompilerOption || (const wxString& option)||
|-

|-
| void || AddIncludeDir || (const wxString& option) ||
|-

|-
| void || AddResourceIncludeDir || (const wxString& option) ||
|-

|-
| void || AddLibDir || (const wxString& option) ||
|-

|-
| void || AddCommandsBeforeBuild || (const wxString& command) ||
|-

|-
| void || AddCommandsAfterBuild || (const wxString& command) ||
|-

|-
| void || RemoveLinkerOption || (const wxString& option) ||
|-

|-
| void || RemoveLinkLib || (const wxString& lib) ||
|-

|-
| void || RemoveCompilerOption || (const wxString& option) ||
|-

|-
| void || RemoveIncludeDir || (const wxString& option) ||
|-

|-
| void || RemoveResourceIncludeDir || (const wxString& option) ||
|-

|-
| void || RemoveLibDir || (const wxString& option) ||
|-

|-
| void || RemoveCommandsBeforeBuild || (const wxString& command) ||
|-

|-
| void || RemoveCommandsAfterBuild || (const wxString& command) ||
|-

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

|-
| void || SetAlwaysRunPostBuildSteps || (bool always) ||
|-

|-
| void || SetBuildScripts || (const wxArrayString& scripts) ||
|-

|-
| wxArrayString || GetBuildScripts || ||
|-

|-
| void || AddBuildScript || (const wxString& script) ||
|-

|-
| void || RemoveBuildScript || (const wxString& script) ||
|-

|-
| bool || SetVar || (const wxString& key, const wxString& value, bool onlyIfExists = false) ||
|-

|-
| wxString || GetVar || (const wxString& key) ||
|-

|-
| bool || UnsetVar || (const wxString& key) ||
|-

|-
| 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
|-

|-
| void || SetTargetFilenameGenerationPolicy || enum prefix, enum extension|| tgfpPlatformDefault -> Generate filename based on running platform defaults. tgfpNone -> No automatic generation; let the user specify the full filename.
|-

|-
| 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 || ||
|-

|-
| wxString || GetMakeCommandFor || enum ||
|-

|-
| void || SetMakeCommandFor || enum,wxString ||
|-

|-
| bool || MakeCommandsModified || ||
|-

|}

== 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 || ||The full title, i.e. "projectname - targetname"
|-

|-
| wxString || GetExternalDeps || ||list of files whose target depends
|-

|-
| void || SetExternalDeps || wxString ||list of files whose target depends
|-

|-
| void || SetAdditionalOutputFiles || wxString ||a list of additional output files
|-

|-
| wxString || GetAdditionalOutputFiles || ||a list of additional output files
|-

|-
| bool || GetIncludeInTargetAll || || Deprecated, do not use at 'All'
|-

|-
| void || SetIncludeInTargetAll || bool || Deprecated, do not use at 'All'
|-

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

|-
| void || SetCreateDefFile || bool ||if the target creates a DEF imports file.
|-

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

|-
| void || SetCreateStaticLib || bool ||if an import library should be created
|-

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

|-
| void || SetUseConsoleRunner || bool ||for targets generating a console executable.
|-

|-
| ProjectFile* || GetFile || int || returns a file from the target
|-

|-
| int || GetFilesCount || || returns number of files of target
|-

|}

== 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 || name, is relative, is Unixfilename
|-

|-
| bool || RemoveFile || ProjectFile * ||
|-

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

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

|-
| int || GetBuildTargetsCount || || number targets
|-

|-
| ProjectBuildTarget* || GetBuildTarget || int || target index
|-

|-
| ProjectBuildTarget* || GetBuildTarget || wxString || target name, might be a virtual target.
|-

|-
| ProjectBuildTarget* || AddBuildTarget || wxString || target name
|-

|-
| bool || RenameBuildTarget || int, wxString || target index, new name
|-

|-
| bool || RenameBuildTarget || wxString, wxString || old name, new name
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || int, wxString || index, new name
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || wxString, wxString || target name, new name
|-

|-
| bool || RemoveBuildTarget || int || index
|-

|-
| bool || RemoveBuildTarget || wxString || target name
|-

|-
| bool || ExportTargetAsProject || int || target index
|-

|-
| bool || ExportTargetAsProject || wxString || target name
|-

|-
| bool || BuildTargetValid || wxString|bool ||
|-

|-
| wxString || GetFirstValidBuildTargetName || bool ||
|-

|-
| void || SetDefaultExecuteTarget || wxString ||
|-

|-
| wxString || GetDefaultExecuteTarget || wxString ||
|-

|-
| bool || SetActiveBuildTarget || wxString ||
|-

|-
| wxString || GetActiveBuildTarget || || active target name, might be a virtual target||
|-

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

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

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

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

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

|-
| void || SetExtendedObjectNamesGeneration || bool ||
|-

|-
| bool || GetExtendedObjectNamesGeneration || ||
|-

|-
| void || SetNotes || wxString ||
|-

|-
| wxString || GetNotes || ||
|-

|-
| void || SetShowNotesOnLoad || bool ||
|-

|-
| bool || GetShowNotesOnLoad || ||
|-

|-
| void || ShowNotes || bool,bool ||
|-

|-
| void || AddToExtensions || wxString ||
|-

|-
| bool || DefineVirtualBuildTarget || wxString,wxArrayString ||arg1=alias virtual target, arg2= array targets
|-

|-
| bool || HasVirtualBuildTarget|| wxSring ||arg=alias virtual target
|-

|-
| bool || RemoveVirtualBuildTarget|| wxString ||arg=alias virtual target, return true if removed
|-

|-
| wxArrayString || GetVirtualBuildTargets|| ||Get a list of all defined virtual build targets.
|-

|-
| wxArrayString || GetVirtualBuildTargetGroup || wxString ||arg=alias, Access a virtual build target's group of build targets.
|-

|-
| wxArrayString || GetExpandedVirtualBuildTargetGroup|| wxString ||arg=alias, Access a virtual build target's expanded group of build targets.
|-

|-
| bool || CanAddToVirtualBuildTarget || wxSring,wxString ||arg1=alias, arg2=name target to add,
Checks if a build target (virtual or real) can be added to a virtual build target, without causing a circular-reference.
|-

|-
| void || SetTitle || wxSring ||
|-
|}

== 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 || Save || ||
|-

|-
| 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;" | '''Plugin version'''
|-

|-
|PLUGIN_SDK_VERSION_MAJOR||int|| =1, it will change when the SDK interface breaks
|-

|-
|PLUGIN_SDK_VERSION_MINOR||int|| =13, it will change when the SDK interface breaks
|-

|-
|PLUGIN_SDK_VERSION_RELEASE||int|| =13, it will change when the SDK interface breaks
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Path separator for filenames'''
|-

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

|-
| 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 wxPathFormat'''
|-

|-
|wxPATH_NATIVE || enum ||
|-

|-
|wxPATH_UNIX || enum ||
|-

|-
|wxPATH_BEOS || enum ||
|-

|-
|wxPATH_MAC || enum ||
|-

|wxPATH_DOS || enum ||
|-

|-
|wxPATH_WIN || enum ||
|-

|-
|wxPATH_OS2 || enum ||
|-

|-
|wxPATH_VM3 || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''For wxFileName::GetPath()'''
|-

|-
|wxPATH_GET_VOLUME || enum || include the volume if applicable
|-

|-
|wxPATH_GET_SEPARATOR || enum || terminate the path with the separator
|-

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

|-
|wxPATH_NORM_ENV_VARS || enum || replace env vars with their values
|-

|-
|wxPATH_NORM_DOTS || enum || squeeze all .. and . and prepend cwd
|-

|-
|wxPATH_NORM_TILDE || enum || Unix only: replace ~ and ~user
|-

|-
|wxPATH_NORM_CASE || enum || if case insensitive => tolower
|-

|-
|wxPATH_NORM_ABSOLUTE || enum ||make the path absolute
|-

|-
|wxPATH_NORM_LONG || enum ||make the path the long form
|-

|-
|wxPATH_NORM_SHORTCUT|| enum || resolve the shortcut, if it is a shortcut
|-

|-
|wxPATH_NORM_ALL || enum || = 0x00ff & ~wxPATH_NORM_CASE
|-

|-
| 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 ||
|-

|-
| mcAskRebuildNeeded|| enum ||
|-

|-
|mcSilentBuild|| 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;" | '''enum SearchDirs'''
|-

|-
|sdHome|| enum || User's home directory
|-

|-
|sdBase|| enum || Code::Blocks' installation base
|-

|-
|sdTemp|| enum || System-wide temp folder
|-

|-
|sdPath || enum || All dirs in the PATH environment variable
|-

|-
|sdConfig || enum || Config folder
|-

|-
|sdCurrent|| enum || Current working folder
|-

|-
|sdPluginsUser|| enum || Plugins folder in user's dir
|-

|-
|sdScriptsUser|| enum || Scripts folder in user's dir
|-

|-
|sdDataUser|| enum || Data folder in user's dir
|-

|-
|sdAllUser || enum || Convenience value meaning "all sd*User values"
|-

|-
|sdPluginsGlobal|| enum || Plugins folder in base dir
|-

|-
|sdScriptsGlobal|| enum || Scripts folder in base dir
|-

|-
|sdDataGlobal || enum || Data folder in base dir
|-

|-
|sdAllGlobal || enum || Convenience value meaning "all sd*Global values"
|-

|-
|sdAllKnown|| enum || All known dirs (i.e. all of the above)
|-

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

|-
|spMac ||enum ||
|-

|-
|spUnix ||enum ||
|-

|-
|spWindows ||enum ||
|-

|-
|spAll ||enum ||
|

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

|-
|tgfpPlatformDefault ||enum || Generate filename based on running platform defaults.
|-

|-
|tgfpNone ||enum || No automatic generation; let the user specify the full filename
|-

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

|-
|mtProjectManager ||enum ||
|-

|-
|mtEditorManager ||enum ||
|-

|-
|mtLogManager||enum ||
|-

|-
|mtOpenFilesList||enum ||
|-

|-
|mtEditorTab||enum ||
|-

|-
|mtUnknown||enum ||
|-

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

|-
|ftdkUndefined||enum ||
|-

|-
|ftdkProject||enum ||
|-

|-
|ftdkFolder||enum ||
|-

|-
|ftdkFile||enum ||
|-

|-
|ftdkVirtualGroup||enum ||
|-

|-
|ftdkVirtualFolder||enum ||
|-

|-
| 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_MSVC7 || wxString ||
|-

|-
| EXT_MSVC10 || wxString ||
|-

|-
| EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| EXT_ASM || wxString ||
|-

|-
| EXT_D || wxString ||
|-

|-
| EXT_F || wxString ||
|-

|-
| EXT_F77 || wxString ||
|-

|-
| EXT_F90 || wxString ||
|-

|-
| EXT_F95 || wxString ||
|-

|-
| EXT_FOR || wxString ||
|-

|-
| EXT_FPP || wxString ||
|-

|-
| EXT_F03 || wxString ||
|-

|-
| EXT_F08 || wxString ||
|-

|-
| EXT_JAVA || wxString ||
|-

|-
| EXT_C || wxString ||
|-

|-
| EXT_CC || wxString ||
|-

|-
| EXT_CPP || wxString ||
|-

|-
| EXT_CXX || wxString ||
|-

|-
| EXT_CPLPL || wxString ||
|-

|-
| EXT_INL || wxString ||
|-

|-
| EXT_H || wxString ||
|-

|-
| EXT_HH || wxString ||
|-

|-
| EXT_HPP || wxString ||
|-

|-
| EXT_HXX || wxString ||
|-

|-
| EXT_HPLPL || wxString ||
|-

|-
| EXT_S || wxString ||
|-

|-
| EXT_SS || wxString ||
|-

|-
| EXT_S62 || wxString ||
|-

|-
| EXT_OBJECT || wxString ||
|-

|-
| EXT_XRCRESOURCE || wxString ||
|-

|-
| EXT_STATICLIB || wxString ||
|-

|-
| EXT_DYNAMICLIB || wxString ||
|-

|-
| EXT_EXECUTABLE || wxString ||
|-

|-
| EXT_NATIVE || 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_MSVC7 || wxString ||
|-

|-
| DOT_EXT_MSVC10 || wxString ||
|-

|-
| DOT_EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_D || wxString ||
|-

|-
| DOT_EXT_F || wxString ||
|-

|-
| DOT_EXT_F77 || wxString ||
|-

|-
| DOT_EXT_F90 || wxString ||
|-

|-
| DOT_EXT_F95 || wxString ||
|-

|-
| DOT_EXT_FOR || wxString ||
|-

|-
| DOT_EXT_FPP || wxString ||
|-

|-
| DOT_EXT_F03 || wxString ||
|-

|-
| DOT_EXT_F08 || wxString ||
|-

|-
| DOT_EXT_JAVA || wxString ||
|-

|-
| DOT_EXT_C || wxString ||
|-

|-
| DOT_EXT_CC || wxString ||
|-

|-
| DOT_EXT_CPP || wxString ||
|-

|-
| DOT_EXT_CXX || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_CPLPL || wxString ||
|-

|-
| DOT_EXT_H || wxString ||
|-

|-
| DOT_EXT_HH || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_HXX || wxString ||
|-

|-
| DOT_EXT_HPLPL || wxString ||
|-

|-
| DOT_EXT_S || wxString ||
|-

|-
| DOT_EXT_SS || wxString ||
|-

|-
| DOT_EXT_S62 || wxString ||
|-

|-
| DOT_EXT_OBJECT || wxString ||
|-

|-
| DOT_EXT_XRCRESOURCE || wxString ||
|-

|-
| DOT_EXT_STATICLIB || wxString ||
|-

|-
| DOT_EXT_DYNAMICLIB || wxString ||
|-

|-
| DOT_EXT_EXECUTABLE || wxString ||
|-

|-
| DOT_EXT_NATIVE || wxString ||
|-

|-
| DOT_EXT_RESOURCE || wxString ||
|-

|-
| DOT_EXT_RESOURCEBIN || wxString ||
|-

|-
| DOT_EXT_XML || wxString ||
|-

|-
| DOT_EXT_SCRIPT || wxString ||
|-

|}

== See also ==

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

Scripting commands

2019-06-07T08:42:37Z

LETARTARE: /* remark for GetActiveBuildTarget()*/

[[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().

''NOTE: Updated to '''12.11'''

== 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 || Does [[Variable_expansion|variable expansion]] on the input wxString
|-

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

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

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

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

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

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

|-
| wxArrayString || GetArrayFromString || wxString,wxString,bool ||
|-

|-
| wxString || GetStringFromArray || wxArrayString,wxString,bool ||
|-

|-
| wxString || EscapeSpaces || wxString ||
|-

|-
| wxString || UnixFilename || wxString, int || arg1=filename, arg2=wxPATH_NATIVE, wxPATH_WIN, ...
|-

|-
| FileType || FileTypeOf || wxString ||
|-

|-
| wxString || URLEncode || wxString ||
|-

|-
| void || NotifyMissingFile || wxString ||
|-

|-
| int || GetPlatformsFromString || wxString ||
|-

|-
| wxString || GetStringFromPlatforms || int,bool||
|-

|-
| void|| InfoWindow || wxString,wxString,int,int || pop-up box in the lower right, see infowindow.h
|-

|-
| 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
|-

|-
| int || ExecuteToolPlugin || wxString || Execute a tool plugin (found in Plugins menu)
|-

|-
| int || ConfigureToolPlugin || wxString || Configure a tool plugin (found in Plugins menu)
|-

|-
| void || CallMenu || wxString || Call a menu entry describing its path using slashes (e.g. "/Valgrind/Run Valgrind::MemCheck")
|-

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

|-
| int || Require || wxString ||arg=script_filename, return 0 if ok
|-

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

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

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

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

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

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

|-
| long || wxString_ToLong || wxString const ||
|-

|}

== 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 || const wxString, int || arg1=key, arg2=default_val
|-

|-
| bool || Read || const wxString, bool || arg1=key, arg2=default_val
|-

|-
| float || Read || const wxString, float || arg1=key, arg2=default_val
|-

|-
| wxString || Read || const wxString, const wxString || arg1=key, arg2=default_val
|-

|-
| void || Write || const wxString, int || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, bool || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, float || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, const wxString, bool ||arg1=key, arg2=value, arg3=ignore_value_empty
|-

|}

== ProjectManager ==
see API docs for 'ProjectManager::...' in 'include\projectmanager.h'

{| 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 in Prototype
!Remarks
|-

|-
| wxString || GetDefaultPath || ( ) ||
|-

|-
| void || SetDefaultPath || (const wxString& path) ||
|-

|-
| cbProject* || GetActiveProject || ( ) ||
|-

|-
| int || GetProjectCount || ( ) ||
|-

|-
| cbProject* || GetProject || (int) ||
|-

|-
| void || SetProject || (cbProject* project, bool refresh = true) ||
|-

|-
| bool || LoadWorkspace || (const wxString& filename = DEFAULT_WORKSPACE)||
|-

|-
| bool || SaveWorkspace || ( ) ||
|-

|-
| bool || SaveWorkspaceAs || (const wxString& filename) ||
|-

|-
| bool || CloseWorkspace || ( ) ||
|-

|-
| cbProject* || IsOpen || (const wxString& filename) ||
|-

|-
| cbProject* || LoadProject || (const wxString& filename, bool activateIt = true) ||
|-

|-
| bool || SaveProject || (cbProject* project) ||
|-

|-
| bool || SaveProjectAs || (cbProject* project) ||
|-

|-
| bool || SaveActiveProject || ( ) ||
|-

|-
| bool || SaveActiveProjectAs || ( ) ||
|-

|-
| bool || SaveAllProjects || ( ) ||
|-

|-
| bool || CloseProject || (cbProject* project, bool dontsave = false, bool refresh = true) ||
|-

|-
| bool || CloseActiveProject || (bool dontsave = false) ||
|-

|-
| bool || CloseAllProjects || (bool dontsave = false) ||
|-

|-
| cbProject* || NewProject || (const wxString& filename = wxEmptyString) ||
|-

|-
| int || AddFileToProject || (const wxString& filename, cbProject* project = 0L, int target = -1) ||
|-

|-
| int || AskForBuildTargetIndex || (cbProject* project = 0L) ||

|-
| void || RebuildTree || ( ) ||
|-

|-
| bool || AddProjectDependency || (cbProject* base, cbProject* dependsOn) ||
|-

|-
| void || RemoveProjectDependency || (cbProject* base, cbProject* doesNotDependOn) ||
|-

|-
| void || ClearProjectDependencies || (cbProject* base) ||
|-

|-
| void || RemoveProjectFromAllDependencies || (cbProject* base) ||
|-

|-
| ProjectsArray* || GetDependenciesForProject || (cbProject* base) ||
|-

|-
| void || ConfigureProjectDependencies || (cbProject* base = 0) ||
|-
|}

== 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 in Prototype
!Remarks
|-

|-
| void || Configure || ( ) ||
|-

|-
| cbEditor* || New || (const wxString& newFileName = wxEmptyString) ||
|-

|-
| cbEditor* || Open || (const wxString& filename) ||
|-

|-
| cbEditor* || IsBuiltinOpen || (const wxString& filename) ||
|-

|-
| cbEditor* || GetBuiltinEditor || (const wxString& filename)|(int index) ||
|-

|-
| cbEditor* || GetBuiltinActiveEditor || ( ) ||
|-

|-
| EditorBase* || GetActiveEditor || ( ) ||
|-

|-
| void || ActivateNext || ( ) ||
|-

|-
| void || ActivatePrevious || ( ) ||
|-

|-
| bool || SwapActiveHeaderSource || ( ) ||
|-

|-
| bool || CloseActive || (bool dontsave = false) ||
|-

|-
| bool || Close || (const wxString& filename,bool dontsave = false)|(int index,bool dontsave = false),(EditorBase* editor,bool dontsave = false) ||
|-

|-
| bool || CloseAll || (bool dontsave=false) ||
|-

|-
| bool || Save || (const wxString& filename)|(int index)||
|-

|-
| bool || SaveActive || ( ) ||
|-

|-
| bool || SaveAs || (int index) ||
|-

|-
| bool || SaveActiveAs || ( ) ||
|-

|-
| bool || SaveAll || ( ) ||
|-

|-
| int || ShowFindDialog || (bool replace, bool explicitly_find_in_files = false) ||
|-

|}

== 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 in Prototype
!Remarks
|-

|-
| bool || Exists || (const wxString& variable) ||
|-

|}

== 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 in Prototype
!Remarks
|-

|-
| bool || DirectoryExists || (const wxString& dir) || '''1)'''
|-

|-
| wxString || SelectDirectory || (const wxString& message, const wxString& initialPath, bool showCreateDirButton) ||
|-

|-
| bool || '''CreateDirectory''' || (const wxString& full_path, int perms) || arg1=dir, arg2=permissions '''1)'''
|-

|-
| bool || '''RemoveDirectory''' || (const wxString& src) || '''1)'''
|-

|-
| bool || '''CopyFile''' ||(const wxString& src, const wxString& dst, bool overwrite) || '''1)'''
|-

|-
| bool || '''RenameFile''' || (const wxString& src, const wxString& dst) || old,new '''1)'''
|-

|-
| bool || '''RemoveFile''' || (const wxString& src) || '''1)'''
|-

|-
| bool || FileExists || (const wxString& file) || '''1)'''
|-

|-
| wxString || SelectFile || (const wxString& title, const wxString& defaultFile, const wxString& filter) ||
|-

|-
| wxString || ReadFileContents || (const wxString& filename) || '''1)'''
|-

|-
| bool || '''WriteFileContents''' || (const wxString& filename, const wxString& contents) || filename,contents '''1)'''
|-

|-
| int || '''Execute''' || (const wxString& command) ||
|-

|-
| wxString || '''ExecuteAndGetOutput''' || (const wxString& command) ||
|-

|-
| wxString || '''ExecuteAndGetOutputAndError''' || (const wxString& command, bool prepend_error) ||if 'prepend_error' is true gives an error string
|-

|-
| wxString || GetCwd || ( ) ||
|-

|-
| void || SetCwd || (const wxString& dir) || directory (currently working directory)
|-

|}

'''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.

'''NOTE: 1)''' All paths/filenames are expanded via the ReplaceMacros function prior the function is called. So it is possible to copy the project output file with
<source lang="c">
IO.CopyFile(_T("$(TARGET_OUTPUT_FILE)"),_T("output_directory/output_file"),true);
</source>

== 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 in Prototype
!Remarks
|-

|-
| bool || IsValidCompilerID || (const wxString& id) ||
|-

|-
| int || GetCompilerIndex || (const wxString& id) ||
|-

|-
| wxString || GetDefaultCompilerID || ( ) ||
|-

|-
| wxString || GetCompilerVersionString || (const wxString& Id) ||
|-

|-
| bool || CompilerInheritsFrom || ( ) ||
|-

|-
| wxString || GetCompilerIDByName || (const wxString &name ) || Makes it possible to find the compiler id by its name. Available since rev 9823.
|-
|}

== 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
|-

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

|-
| wxString || _ || const char* || the same as _T, but should be used for translatable strings
|-

|-
| wxString || operator= || const wxString ||
|-

|-
| wxString || operator+ || const wxString ||
|-

|-
| wxString || operator+ || const int ||
|-

|-
| wxString || operator+= || const wxString ||
|-

|-
| wxString || operator+= || const int ||
|-

|-
| bool || operator< || const wxString || _T("abc") < _T("cba") -> true
|-

|-
| bool || operator<= || const wxString ||
|-

|-
| bool || operator>= || const wxString ||
|-

|-
| bool || operator> || const wxString ||
|-

|-
| int || Find || wxString || -1 if not found
|-

|-
| bool || Matches || wxString || not use '==' !!, returns true if the string contents matches a mask containing '*' and '?'
|-

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

|-
| char || GetChar || int || arg1=position
|-

|-
| 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 || arg1=position, arg2=long
|-

|-
| wxString || Remove || int, int || arg1=position, arg2=long
|-

|-
| void || RemoveLast || int || remove the last characters
|-

|-
| int || Replace || wxString, wxString,bool || arg3=true -> all occurrences else the first
|-

|-
| wxString || Right || int x || return the x last characters
|-

|-
| wxString || AfterFirst || char || not found -> _T("")
|-

|-
| wxString || AfterLast || char || not found -> all the character string
|-

|-
| wxString || BeforeFirst || char || not found -> all the character string
|-

|-
| wxString || BeforeLast || char || not found -> _T("")
|-
|}
''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 || ||
|-

|-
| int || Index || wxString || -1 If not found
|-

|-
| wxString || Item || int || not work with wx 2.9.x ?!
|-

|}
''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 || ||
|-

|-
| bool || IsOk || || ONLY if (wxVERSION_NUMBER < 2900)
|-

|-
| void || Set || byte, byte, byte, byte || red, green, blue, alpha : into [0..255]
|-

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

''EXAMPLE: local my_wxcolour = ::wxColour(); my_wxcolour.Set(0xFF, 0x00, 0x00, 0x55); ::print(my_wxcolour) -> [r=255, g=0, b=0]

== wxFileName ==
'''UNDER VERIFICATION'''

{| 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 || Assign || const wxFileName || creates the file name from an other wxFileName
|-

|-
| void || Assign || const wxString, wxPathFormat || arg1=full_path, arg2=wformat=xPATH_NATIVE ...
|-

|-
| void || AssignCwd || const wxString || arg1=volume
|-

|-
| void || AssignDir|| const wxString, wxPathFormat || arg1=name_dir, arg2=format=wxPATH_NATIVE ...
|-

|-
| void || AssignHomeDir || || sets this file name object to the home directory
|-

|-
| void || Clear || || reset all components to default, uninitialized state
|-

|-
| void || ClearExt || || removes the extension from the file name resulting in a file name with no trailing dot
|-

|-
| int || GetDirCount || || returns the number of directories in the file name.
|-

|-
| wxArrayString || GetDirs || || returns the directories in string array form
|-

|-
| wxString || GetExt || || returns the file name extension.

|-

|-
| wxString || GetFullName || || returns the full name (including extension but excluding directories).
|-

|-
| wxString || GetFullPath || wxPathFormat || arg=format=wxPATH_NATIVE ...
|-

|-
| wxString || GetLongPath || || return the long form of the path (returns identity on non-Windows platforms)

|-

|-
| wxString || GetName || || returns the name part of the filename (without extension)
|-

|-
| wxString || GetPath || int, wxPathFormat || arg1=flags=wxPATH_GET_VOLUME..., arg2=format=wxPATH_NATIVE ...
|-

|-
| wxString || GetShortPath || || return the short form of the path (returns identity on non-Windows platforms).

|-

|-
| wxString || GetVolume || || returns the string containing the volume for this file name
|-

|-
| bool || HasExt || || returns true if an extension is present.
|-

|-
| bool || HasName || || returns true if a name is present
|-

|-
| bool || HasVolume || || returns true if a volume specifier is present
|-

|-
| void || InsertDir||int, const wxString || arg1=before_dir, arg2=name_dir
|-

|-
| bool || IsAbsolute || wxPathFormat ||arg=format=wxPATH_NATIVE...
|-

|-
| bool || IsOk || || returns true if the filename is valid
|-

|-
| bool || IsRelative || wxPathFormat ||arg=format=wxPATH_NATIVE...
|-

|-
| bool || IsDir || || returns true if this object represents a directory
|-

|-
| bool || MakeAbsolute ||const wxString, wxPathFormat|| arg1=cwd=_T("") or ..., arg2=format=wxPATH_NATIVE or ...
|-

|-
| bool || MakeRelativeTo ||const wxString, wxPathFormat|| arg1=path_base, arg2=format=wxPATH_NATIVE or ...
|-

|-
| bool || Normalize ||int, const wxString, wxPathFormat||arg1=flags=wxPATH_NORM_ALL, arg2=cwd=_T(""),arg3=format=wxPATH_NATIVE or ...
|

|-
| void || PrependDir || const wxString ||arg=dir
|-

|-
| void || RemoveDir || int ||arg=pos RemoveLastDir
|-

|-
| void || RemoveLastDir || || removes last directory component from the path
|-

|-
| bool || SameAs || const wxFileName, wxPathFormat || arg1=filepath, arg2=format=wxPATH_NATIVE
|-

|-
| bool || SetCwd|| || changes the current working directory
|-

|-
| void || SetExt ||const wxString ||arg=extension
|-

|-
| void || SetEmptyExt || || sets the extension of the file name to be an empty extension
|-

|-
| void || SetFullName || wxString ||
|-

|-
| void || SetName || wxString ||
|-

|-
| void || SetVolume || wxString ||
|-

|}
''NOTE: Is instantiated in a script using: local my_filename = ::wxFileName()

== wxPoint ==
'''UNDER CONSTRUCTION'''

'' Instantiate integer points 2D

{| 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
|-

|-
| wxPoint || operator= || const wxPoint|| default assignment operator is ok
|-

|-
| bool || operator== ||const wxPoint||
|-

|-
| bool || operator!= || const wxPoint||
|-

|-
| int || x || ||
|-

|-
| int || y || ||
|-

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

''EXAMPLE: local my_wxpoint = ::wxPoint(); my_wxpoint.x = 5; my_wxpoint.y = 12; // not use ::print(my_wxpoint)

== wxSize ==
'''UNDER CONSTRUCTION'''

'' Instantiate integers values (X, Y)

{| 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
|-

|-
| wxSize || operator= || const wwSize|| default assignment operator is ok
|-

|-
| bool || operator== ||const wxSize||
|-

|-
| bool || operator!= || const wxSize||
|-

|-
| int || GetWidth || || return X
|-

|-
| int || GetHeight || || return Y
|-

|-
| void || SetWidth || int w|| X=w
|-

|-
| void || SetHeight || int h|| Y=h
|-

|-
| void || Set || int w, int h|| X=w, Y=h
|-

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

''EXAMPLE: local my_wxsize = ::wxSize(); my_wxsize.SetWidth(5); my_wxsize.SetHeight(12); // not use ::print(my_wxsize)

== 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 in Prototype
!Remarks
|-

|-
| void || AddBuildTarget || (const wxString& targetName)||
|-

|-
| void || RenameBuildTarget || (const wxString& oldTargetName, const wxString& newTargetName) ||
|-

|-
| void || RemoveBuildTarget || (const wxString& targetName)||
|-

|-
| wxString || GetBaseName || ( ) ||
|-

|-
| wxString || GetObjName || ( ) ||
|-

|-
| void || SetObjName || (const wxString& targetName) ||
|-

|-
| cbProject* || GetParentProject || ( ) ||
|-

|-
| wxString|| GetCustomBuildCommand|| (const wxString& compilerId) ||
|-

|-
| void || SetCustomBuildCommand || (const wxString& compilerId, const wxString& newBuildCommand) ||
|-

|-
| bool || GetUseCustomBuildCommand|| (const wxString& compilerId) ||
|-

|-
| void || SetUseCustomBuildCommand || (const wxString& compilerId, bool useCustomBuildCommand) ||
|-

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

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

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

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

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

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

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

|-
| wxArrayString || buildTargets || || (variable)
|-

|-
| const wxArrayString & || GetBuildTargets ||() const || r9252 : for use instead of the 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 in Prototype
!Remarks
|-

|-
| void || AddPlatform || (int platform) || windows,unix,mac
|-

|-
| void || RemovePlatform || (int platform) ||
|-

|-
| void || SetPlatforms || (int platform) ||
|-

|-
| int || GetPlatforms || ||
|-

|-
| bool || SupportsCurrentPlatform || ||
|-

|-
| void || SetLinkerOptions || (const wxArrayString& linkerOpts) ||
|-

|-
| void || SetLinkLibs || (const wxArrayString& linkLibs) ||
|-

|-
| void || SetCompilerOptions || (const wxArrayString& compilerOpts) ||
|-

|-
| void || SetIncludeDirs || (const wxArrayString& includeDirs) ||
|-

|-
| void || SetResourceIncludeDirs || (const wxString& option) ||
|-

|-
| void || SetLibDirs || (const wxArrayString& libDirs) ||
|-

|-
| void || SetCommandsBeforeBuild || (const wxArrayString& commands) ||
|-

|-
| void || SetCommandsAfterBuild || (const wxArrayString& commands) ||
|-

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

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

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

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

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

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

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

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

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

|-
| void || SetModified || (bool modified) ||
|-

|-
| void || AddLinkerOption || (const wxString& option) ||
|-

|-
| void || AddLinkLib || (const wxString& lib) ||
|-

|-
| void || AddCompilerOption || (const wxString& option)||
|-

|-
| void || AddIncludeDir || (const wxString& option) ||
|-

|-
| void || AddResourceIncludeDir || (const wxString& option) ||
|-

|-
| void || AddLibDir || (const wxString& option) ||
|-

|-
| void || AddCommandsBeforeBuild || (const wxString& command) ||
|-

|-
| void || AddCommandsAfterBuild || (const wxString& command) ||
|-

|-
| void || RemoveLinkerOption || (const wxString& option) ||
|-

|-
| void || RemoveLinkLib || (const wxString& lib) ||
|-

|-
| void || RemoveCompilerOption || (const wxString& option) ||
|-

|-
| void || RemoveIncludeDir || (const wxString& option) ||
|-

|-
| void || RemoveResourceIncludeDir || (const wxString& option) ||
|-

|-
| void || RemoveLibDir || (const wxString& option) ||
|-

|-
| void || RemoveCommandsBeforeBuild || (const wxString& command) ||
|-

|-
| void || RemoveCommandsAfterBuild || (const wxString& command) ||
|-

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

|-
| void || SetAlwaysRunPostBuildSteps || (bool always) ||
|-

|-
| void || SetBuildScripts || (const wxArrayString& scripts) ||
|-

|-
| wxArrayString || GetBuildScripts || ||
|-

|-
| void || AddBuildScript || (const wxString& script) ||
|-

|-
| void || RemoveBuildScript || (const wxString& script) ||
|-

|-
| bool || SetVar || (const wxString& key, const wxString& value, bool onlyIfExists = false) ||
|-

|-
| wxString || GetVar || (const wxString& key) ||
|-

|-
| bool || UnsetVar || (const wxString& key) ||
|-

|-
| 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
|-

|-
| void || SetTargetFilenameGenerationPolicy || enum prefix, enum extension|| tgfpPlatformDefault -> Generate filename based on running platform defaults. tgfpNone -> No automatic generation; let the user specify the full filename.
|-

|-
| 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 || ||
|-

|-
| wxString || GetMakeCommandFor || enum ||
|-

|-
| void || SetMakeCommandFor || enum,wxString ||
|-

|-
| bool || MakeCommandsModified || ||
|-

|}

== 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 || ||The full title, i.e. "projectname - targetname"
|-

|-
| wxString || GetExternalDeps || ||list of files whose target depends
|-

|-
| void || SetExternalDeps || wxString ||list of files whose target depends
|-

|-
| void || SetAdditionalOutputFiles || wxString ||a list of additional output files
|-

|-
| wxString || GetAdditionalOutputFiles || ||a list of additional output files
|-

|-
| bool || GetIncludeInTargetAll || || Deprecated, do not use at 'All'
|-

|-
| void || SetIncludeInTargetAll || bool || Deprecated, do not use at 'All'
|-

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

|-
| void || SetCreateDefFile || bool ||if the target creates a DEF imports file.
|-

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

|-
| void || SetCreateStaticLib || bool ||if an import library should be created
|-

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

|-
| void || SetUseConsoleRunner || bool ||for targets generating a console executable.
|-

|-
| ProjectFile* || GetFile || int || returns a file from the target
|-

|-
| int || GetFilesCount || || returns number of files of target
|-

|}

== 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 || name, is relative, is Unixfilename
|-

|-
| bool || RemoveFile || ProjectFile * ||
|-

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

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

|-
| int || GetBuildTargetsCount || || number targets
|-

|-
| ProjectBuildTarget* || GetBuildTarget || int || target index
|-

|-
| ProjectBuildTarget* || GetBuildTarget || wxString || target name, might be a virtual target.
|-

|-
| ProjectBuildTarget* || AddBuildTarget || wxString || target name
|-

|-
| bool || RenameBuildTarget || int, wxString || target index, new name
|-

|-
| bool || RenameBuildTarget || wxString, wxString || old name, new name
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || int, wxString || index, new name
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || wxString, wxString || target name, new name
|-

|-
| bool || RemoveBuildTarget || int || index
|-

|-
| bool || RemoveBuildTarget || wxString || target name
|-

|-
| bool || ExportTargetAsProject || int || target index
|-

|-
| bool || ExportTargetAsProject || wxString || target name
|-

|-
| bool || BuildTargetValid || wxString|bool ||
|-

|-
| wxString || GetFirstValidBuildTargetName || bool ||
|-

|-
| void || SetDefaultExecuteTarget || wxString ||
|-

|-
| wxString || GetDefaultExecuteTarget || wxString ||
|-

|-
| bool || SetActiveBuildTarget || wxString ||
|-

|-
| wxString || GetActiveBuildTarget || active target name, might be a virtual target||
|-

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

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

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

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

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

|-
| void || SetExtendedObjectNamesGeneration || bool ||
|-

|-
| bool || GetExtendedObjectNamesGeneration || ||
|-

|-
| void || SetNotes || wxString ||
|-

|-
| wxString || GetNotes || ||
|-

|-
| void || SetShowNotesOnLoad || bool ||
|-

|-
| bool || GetShowNotesOnLoad || ||
|-

|-
| void || ShowNotes || bool,bool ||
|-

|-
| void || AddToExtensions || wxString ||
|-

|-
| bool || DefineVirtualBuildTarget || wxString,wxArrayString ||arg1=alias virtual target, arg2= array targets
|-

|-
| bool || HasVirtualBuildTarget|| wxSring ||arg=alias virtual target
|-

|-
| bool || RemoveVirtualBuildTarget|| wxString ||arg=alias virtual target, return true if removed
|-

|-
| wxArrayString || GetVirtualBuildTargets|| ||Get a list of all defined virtual build targets.
|-

|-
| wxArrayString || GetVirtualBuildTargetGroup || wxString ||arg=alias, Access a virtual build target's group of build targets.
|-

|-
| wxArrayString || GetExpandedVirtualBuildTargetGroup|| wxString ||arg=alias, Access a virtual build target's expanded group of build targets.
|-

|-
| bool || CanAddToVirtualBuildTarget || wxSring,wxString ||arg1=alias, arg2=name target to add,
Checks if a build target (virtual or real) can be added to a virtual build target, without causing a circular-reference.
|-

|-
| void || SetTitle || wxSring ||
|-
|}

== 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 || Save || ||
|-

|-
| 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;" | '''Plugin version'''
|-

|-
|PLUGIN_SDK_VERSION_MAJOR||int|| =1, it will change when the SDK interface breaks
|-

|-
|PLUGIN_SDK_VERSION_MINOR||int|| =13, it will change when the SDK interface breaks
|-

|-
|PLUGIN_SDK_VERSION_RELEASE||int|| =13, it will change when the SDK interface breaks
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Path separator for filenames'''
|-

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

|-
| 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 wxPathFormat'''
|-

|-
|wxPATH_NATIVE || enum ||
|-

|-
|wxPATH_UNIX || enum ||
|-

|-
|wxPATH_BEOS || enum ||
|-

|-
|wxPATH_MAC || enum ||
|-

|wxPATH_DOS || enum ||
|-

|-
|wxPATH_WIN || enum ||
|-

|-
|wxPATH_OS2 || enum ||
|-

|-
|wxPATH_VM3 || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''For wxFileName::GetPath()'''
|-

|-
|wxPATH_GET_VOLUME || enum || include the volume if applicable
|-

|-
|wxPATH_GET_SEPARATOR || enum || terminate the path with the separator
|-

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

|-
|wxPATH_NORM_ENV_VARS || enum || replace env vars with their values
|-

|-
|wxPATH_NORM_DOTS || enum || squeeze all .. and . and prepend cwd
|-

|-
|wxPATH_NORM_TILDE || enum || Unix only: replace ~ and ~user
|-

|-
|wxPATH_NORM_CASE || enum || if case insensitive => tolower
|-

|-
|wxPATH_NORM_ABSOLUTE || enum ||make the path absolute
|-

|-
|wxPATH_NORM_LONG || enum ||make the path the long form
|-

|-
|wxPATH_NORM_SHORTCUT|| enum || resolve the shortcut, if it is a shortcut
|-

|-
|wxPATH_NORM_ALL || enum || = 0x00ff & ~wxPATH_NORM_CASE
|-

|-
| 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 ||
|-

|-
| mcAskRebuildNeeded|| enum ||
|-

|-
|mcSilentBuild|| 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;" | '''enum SearchDirs'''
|-

|-
|sdHome|| enum || User's home directory
|-

|-
|sdBase|| enum || Code::Blocks' installation base
|-

|-
|sdTemp|| enum || System-wide temp folder
|-

|-
|sdPath || enum || All dirs in the PATH environment variable
|-

|-
|sdConfig || enum || Config folder
|-

|-
|sdCurrent|| enum || Current working folder
|-

|-
|sdPluginsUser|| enum || Plugins folder in user's dir
|-

|-
|sdScriptsUser|| enum || Scripts folder in user's dir
|-

|-
|sdDataUser|| enum || Data folder in user's dir
|-

|-
|sdAllUser || enum || Convenience value meaning "all sd*User values"
|-

|-
|sdPluginsGlobal|| enum || Plugins folder in base dir
|-

|-
|sdScriptsGlobal|| enum || Scripts folder in base dir
|-

|-
|sdDataGlobal || enum || Data folder in base dir
|-

|-
|sdAllGlobal || enum || Convenience value meaning "all sd*Global values"
|-

|-
|sdAllKnown|| enum || All known dirs (i.e. all of the above)
|-

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

|-
|spMac ||enum ||
|-

|-
|spUnix ||enum ||
|-

|-
|spWindows ||enum ||
|-

|-
|spAll ||enum ||
|

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

|-
|tgfpPlatformDefault ||enum || Generate filename based on running platform defaults.
|-

|-
|tgfpNone ||enum || No automatic generation; let the user specify the full filename
|-

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

|-
|mtProjectManager ||enum ||
|-

|-
|mtEditorManager ||enum ||
|-

|-
|mtLogManager||enum ||
|-

|-
|mtOpenFilesList||enum ||
|-

|-
|mtEditorTab||enum ||
|-

|-
|mtUnknown||enum ||
|-

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

|-
|ftdkUndefined||enum ||
|-

|-
|ftdkProject||enum ||
|-

|-
|ftdkFolder||enum ||
|-

|-
|ftdkFile||enum ||
|-

|-
|ftdkVirtualGroup||enum ||
|-

|-
|ftdkVirtualFolder||enum ||
|-

|-
| 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_MSVC7 || wxString ||
|-

|-
| EXT_MSVC10 || wxString ||
|-

|-
| EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| EXT_ASM || wxString ||
|-

|-
| EXT_D || wxString ||
|-

|-
| EXT_F || wxString ||
|-

|-
| EXT_F77 || wxString ||
|-

|-
| EXT_F90 || wxString ||
|-

|-
| EXT_F95 || wxString ||
|-

|-
| EXT_FOR || wxString ||
|-

|-
| EXT_FPP || wxString ||
|-

|-
| EXT_F03 || wxString ||
|-

|-
| EXT_F08 || wxString ||
|-

|-
| EXT_JAVA || wxString ||
|-

|-
| EXT_C || wxString ||
|-

|-
| EXT_CC || wxString ||
|-

|-
| EXT_CPP || wxString ||
|-

|-
| EXT_CXX || wxString ||
|-

|-
| EXT_CPLPL || wxString ||
|-

|-
| EXT_INL || wxString ||
|-

|-
| EXT_H || wxString ||
|-

|-
| EXT_HH || wxString ||
|-

|-
| EXT_HPP || wxString ||
|-

|-
| EXT_HXX || wxString ||
|-

|-
| EXT_HPLPL || wxString ||
|-

|-
| EXT_S || wxString ||
|-

|-
| EXT_SS || wxString ||
|-

|-
| EXT_S62 || wxString ||
|-

|-
| EXT_OBJECT || wxString ||
|-

|-
| EXT_XRCRESOURCE || wxString ||
|-

|-
| EXT_STATICLIB || wxString ||
|-

|-
| EXT_DYNAMICLIB || wxString ||
|-

|-
| EXT_EXECUTABLE || wxString ||
|-

|-
| EXT_NATIVE || 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_MSVC7 || wxString ||
|-

|-
| DOT_EXT_MSVC10 || wxString ||
|-

|-
| DOT_EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_D || wxString ||
|-

|-
| DOT_EXT_F || wxString ||
|-

|-
| DOT_EXT_F77 || wxString ||
|-

|-
| DOT_EXT_F90 || wxString ||
|-

|-
| DOT_EXT_F95 || wxString ||
|-

|-
| DOT_EXT_FOR || wxString ||
|-

|-
| DOT_EXT_FPP || wxString ||
|-

|-
| DOT_EXT_F03 || wxString ||
|-

|-
| DOT_EXT_F08 || wxString ||
|-

|-
| DOT_EXT_JAVA || wxString ||
|-

|-
| DOT_EXT_C || wxString ||
|-

|-
| DOT_EXT_CC || wxString ||
|-

|-
| DOT_EXT_CPP || wxString ||
|-

|-
| DOT_EXT_CXX || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_CPLPL || wxString ||
|-

|-
| DOT_EXT_H || wxString ||
|-

|-
| DOT_EXT_HH || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_HXX || wxString ||
|-

|-
| DOT_EXT_HPLPL || wxString ||
|-

|-
| DOT_EXT_S || wxString ||
|-

|-
| DOT_EXT_SS || wxString ||
|-

|-
| DOT_EXT_S62 || wxString ||
|-

|-
| DOT_EXT_OBJECT || wxString ||
|-

|-
| DOT_EXT_XRCRESOURCE || wxString ||
|-

|-
| DOT_EXT_STATICLIB || wxString ||
|-

|-
| DOT_EXT_DYNAMICLIB || wxString ||
|-

|-
| DOT_EXT_EXECUTABLE || wxString ||
|-

|-
| DOT_EXT_NATIVE || wxString ||
|-

|-
| DOT_EXT_RESOURCE || wxString ||
|-

|-
| DOT_EXT_RESOURCEBIN || wxString ||
|-

|-
| DOT_EXT_XML || wxString ||
|-

|-
| DOT_EXT_SCRIPT || wxString ||
|-

|}

== See also ==

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

Scripting commands

2019-06-07T08:35:00Z

LETARTARE: /* remark for GetBuildTarget()*/

[[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().

''NOTE: Updated to '''12.11'''

== 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 || Does [[Variable_expansion|variable expansion]] on the input wxString
|-

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

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

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

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

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

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

|-
| wxArrayString || GetArrayFromString || wxString,wxString,bool ||
|-

|-
| wxString || GetStringFromArray || wxArrayString,wxString,bool ||
|-

|-
| wxString || EscapeSpaces || wxString ||
|-

|-
| wxString || UnixFilename || wxString, int || arg1=filename, arg2=wxPATH_NATIVE, wxPATH_WIN, ...
|-

|-
| FileType || FileTypeOf || wxString ||
|-

|-
| wxString || URLEncode || wxString ||
|-

|-
| void || NotifyMissingFile || wxString ||
|-

|-
| int || GetPlatformsFromString || wxString ||
|-

|-
| wxString || GetStringFromPlatforms || int,bool||
|-

|-
| void|| InfoWindow || wxString,wxString,int,int || pop-up box in the lower right, see infowindow.h
|-

|-
| 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
|-

|-
| int || ExecuteToolPlugin || wxString || Execute a tool plugin (found in Plugins menu)
|-

|-
| int || ConfigureToolPlugin || wxString || Configure a tool plugin (found in Plugins menu)
|-

|-
| void || CallMenu || wxString || Call a menu entry describing its path using slashes (e.g. "/Valgrind/Run Valgrind::MemCheck")
|-

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

|-
| int || Require || wxString ||arg=script_filename, return 0 if ok
|-

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

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

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

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

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

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

|-
| long || wxString_ToLong || wxString const ||
|-

|}

== 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 || const wxString, int || arg1=key, arg2=default_val
|-

|-
| bool || Read || const wxString, bool || arg1=key, arg2=default_val
|-

|-
| float || Read || const wxString, float || arg1=key, arg2=default_val
|-

|-
| wxString || Read || const wxString, const wxString || arg1=key, arg2=default_val
|-

|-
| void || Write || const wxString, int || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, bool || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, float || arg1=key, arg2=value
|-

|-
| void || Write || const wxString, const wxString, bool ||arg1=key, arg2=value, arg3=ignore_value_empty
|-

|}

== ProjectManager ==
see API docs for 'ProjectManager::...' in 'include\projectmanager.h'

{| 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 in Prototype
!Remarks
|-

|-
| wxString || GetDefaultPath || ( ) ||
|-

|-
| void || SetDefaultPath || (const wxString& path) ||
|-

|-
| cbProject* || GetActiveProject || ( ) ||
|-

|-
| int || GetProjectCount || ( ) ||
|-

|-
| cbProject* || GetProject || (int) ||
|-

|-
| void || SetProject || (cbProject* project, bool refresh = true) ||
|-

|-
| bool || LoadWorkspace || (const wxString& filename = DEFAULT_WORKSPACE)||
|-

|-
| bool || SaveWorkspace || ( ) ||
|-

|-
| bool || SaveWorkspaceAs || (const wxString& filename) ||
|-

|-
| bool || CloseWorkspace || ( ) ||
|-

|-
| cbProject* || IsOpen || (const wxString& filename) ||
|-

|-
| cbProject* || LoadProject || (const wxString& filename, bool activateIt = true) ||
|-

|-
| bool || SaveProject || (cbProject* project) ||
|-

|-
| bool || SaveProjectAs || (cbProject* project) ||
|-

|-
| bool || SaveActiveProject || ( ) ||
|-

|-
| bool || SaveActiveProjectAs || ( ) ||
|-

|-
| bool || SaveAllProjects || ( ) ||
|-

|-
| bool || CloseProject || (cbProject* project, bool dontsave = false, bool refresh = true) ||
|-

|-
| bool || CloseActiveProject || (bool dontsave = false) ||
|-

|-
| bool || CloseAllProjects || (bool dontsave = false) ||
|-

|-
| cbProject* || NewProject || (const wxString& filename = wxEmptyString) ||
|-

|-
| int || AddFileToProject || (const wxString& filename, cbProject* project = 0L, int target = -1) ||
|-

|-
| int || AskForBuildTargetIndex || (cbProject* project = 0L) ||

|-
| void || RebuildTree || ( ) ||
|-

|-
| bool || AddProjectDependency || (cbProject* base, cbProject* dependsOn) ||
|-

|-
| void || RemoveProjectDependency || (cbProject* base, cbProject* doesNotDependOn) ||
|-

|-
| void || ClearProjectDependencies || (cbProject* base) ||
|-

|-
| void || RemoveProjectFromAllDependencies || (cbProject* base) ||
|-

|-
| ProjectsArray* || GetDependenciesForProject || (cbProject* base) ||
|-

|-
| void || ConfigureProjectDependencies || (cbProject* base = 0) ||
|-
|}

== 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 in Prototype
!Remarks
|-

|-
| void || Configure || ( ) ||
|-

|-
| cbEditor* || New || (const wxString& newFileName = wxEmptyString) ||
|-

|-
| cbEditor* || Open || (const wxString& filename) ||
|-

|-
| cbEditor* || IsBuiltinOpen || (const wxString& filename) ||
|-

|-
| cbEditor* || GetBuiltinEditor || (const wxString& filename)|(int index) ||
|-

|-
| cbEditor* || GetBuiltinActiveEditor || ( ) ||
|-

|-
| EditorBase* || GetActiveEditor || ( ) ||
|-

|-
| void || ActivateNext || ( ) ||
|-

|-
| void || ActivatePrevious || ( ) ||
|-

|-
| bool || SwapActiveHeaderSource || ( ) ||
|-

|-
| bool || CloseActive || (bool dontsave = false) ||
|-

|-
| bool || Close || (const wxString& filename,bool dontsave = false)|(int index,bool dontsave = false),(EditorBase* editor,bool dontsave = false) ||
|-

|-
| bool || CloseAll || (bool dontsave=false) ||
|-

|-
| bool || Save || (const wxString& filename)|(int index)||
|-

|-
| bool || SaveActive || ( ) ||
|-

|-
| bool || SaveAs || (int index) ||
|-

|-
| bool || SaveActiveAs || ( ) ||
|-

|-
| bool || SaveAll || ( ) ||
|-

|-
| int || ShowFindDialog || (bool replace, bool explicitly_find_in_files = false) ||
|-

|}

== 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 in Prototype
!Remarks
|-

|-
| bool || Exists || (const wxString& variable) ||
|-

|}

== 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 in Prototype
!Remarks
|-

|-
| bool || DirectoryExists || (const wxString& dir) || '''1)'''
|-

|-
| wxString || SelectDirectory || (const wxString& message, const wxString& initialPath, bool showCreateDirButton) ||
|-

|-
| bool || '''CreateDirectory''' || (const wxString& full_path, int perms) || arg1=dir, arg2=permissions '''1)'''
|-

|-
| bool || '''RemoveDirectory''' || (const wxString& src) || '''1)'''
|-

|-
| bool || '''CopyFile''' ||(const wxString& src, const wxString& dst, bool overwrite) || '''1)'''
|-

|-
| bool || '''RenameFile''' || (const wxString& src, const wxString& dst) || old,new '''1)'''
|-

|-
| bool || '''RemoveFile''' || (const wxString& src) || '''1)'''
|-

|-
| bool || FileExists || (const wxString& file) || '''1)'''
|-

|-
| wxString || SelectFile || (const wxString& title, const wxString& defaultFile, const wxString& filter) ||
|-

|-
| wxString || ReadFileContents || (const wxString& filename) || '''1)'''
|-

|-
| bool || '''WriteFileContents''' || (const wxString& filename, const wxString& contents) || filename,contents '''1)'''
|-

|-
| int || '''Execute''' || (const wxString& command) ||
|-

|-
| wxString || '''ExecuteAndGetOutput''' || (const wxString& command) ||
|-

|-
| wxString || '''ExecuteAndGetOutputAndError''' || (const wxString& command, bool prepend_error) ||if 'prepend_error' is true gives an error string
|-

|-
| wxString || GetCwd || ( ) ||
|-

|-
| void || SetCwd || (const wxString& dir) || directory (currently working directory)
|-

|}

'''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.

'''NOTE: 1)''' All paths/filenames are expanded via the ReplaceMacros function prior the function is called. So it is possible to copy the project output file with
<source lang="c">
IO.CopyFile(_T("$(TARGET_OUTPUT_FILE)"),_T("output_directory/output_file"),true);
</source>

== 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 in Prototype
!Remarks
|-

|-
| bool || IsValidCompilerID || (const wxString& id) ||
|-

|-
| int || GetCompilerIndex || (const wxString& id) ||
|-

|-
| wxString || GetDefaultCompilerID || ( ) ||
|-

|-
| wxString || GetCompilerVersionString || (const wxString& Id) ||
|-

|-
| bool || CompilerInheritsFrom || ( ) ||
|-

|-
| wxString || GetCompilerIDByName || (const wxString &name ) || Makes it possible to find the compiler id by its name. Available since rev 9823.
|-
|}

== 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
|-

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

|-
| wxString || _ || const char* || the same as _T, but should be used for translatable strings
|-

|-
| wxString || operator= || const wxString ||
|-

|-
| wxString || operator+ || const wxString ||
|-

|-
| wxString || operator+ || const int ||
|-

|-
| wxString || operator+= || const wxString ||
|-

|-
| wxString || operator+= || const int ||
|-

|-
| bool || operator< || const wxString || _T("abc") < _T("cba") -> true
|-

|-
| bool || operator<= || const wxString ||
|-

|-
| bool || operator>= || const wxString ||
|-

|-
| bool || operator> || const wxString ||
|-

|-
| int || Find || wxString || -1 if not found
|-

|-
| bool || Matches || wxString || not use '==' !!, returns true if the string contents matches a mask containing '*' and '?'
|-

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

|-
| char || GetChar || int || arg1=position
|-

|-
| 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 || arg1=position, arg2=long
|-

|-
| wxString || Remove || int, int || arg1=position, arg2=long
|-

|-
| void || RemoveLast || int || remove the last characters
|-

|-
| int || Replace || wxString, wxString,bool || arg3=true -> all occurrences else the first
|-

|-
| wxString || Right || int x || return the x last characters
|-

|-
| wxString || AfterFirst || char || not found -> _T("")
|-

|-
| wxString || AfterLast || char || not found -> all the character string
|-

|-
| wxString || BeforeFirst || char || not found -> all the character string
|-

|-
| wxString || BeforeLast || char || not found -> _T("")
|-
|}
''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 || ||
|-

|-
| int || Index || wxString || -1 If not found
|-

|-
| wxString || Item || int || not work with wx 2.9.x ?!
|-

|}
''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 || ||
|-

|-
| bool || IsOk || || ONLY if (wxVERSION_NUMBER < 2900)
|-

|-
| void || Set || byte, byte, byte, byte || red, green, blue, alpha : into [0..255]
|-

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

''EXAMPLE: local my_wxcolour = ::wxColour(); my_wxcolour.Set(0xFF, 0x00, 0x00, 0x55); ::print(my_wxcolour) -> [r=255, g=0, b=0]

== wxFileName ==
'''UNDER VERIFICATION'''

{| 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 || Assign || const wxFileName || creates the file name from an other wxFileName
|-

|-
| void || Assign || const wxString, wxPathFormat || arg1=full_path, arg2=wformat=xPATH_NATIVE ...
|-

|-
| void || AssignCwd || const wxString || arg1=volume
|-

|-
| void || AssignDir|| const wxString, wxPathFormat || arg1=name_dir, arg2=format=wxPATH_NATIVE ...
|-

|-
| void || AssignHomeDir || || sets this file name object to the home directory
|-

|-
| void || Clear || || reset all components to default, uninitialized state
|-

|-
| void || ClearExt || || removes the extension from the file name resulting in a file name with no trailing dot
|-

|-
| int || GetDirCount || || returns the number of directories in the file name.
|-

|-
| wxArrayString || GetDirs || || returns the directories in string array form
|-

|-
| wxString || GetExt || || returns the file name extension.

|-

|-
| wxString || GetFullName || || returns the full name (including extension but excluding directories).
|-

|-
| wxString || GetFullPath || wxPathFormat || arg=format=wxPATH_NATIVE ...
|-

|-
| wxString || GetLongPath || || return the long form of the path (returns identity on non-Windows platforms)

|-

|-
| wxString || GetName || || returns the name part of the filename (without extension)
|-

|-
| wxString || GetPath || int, wxPathFormat || arg1=flags=wxPATH_GET_VOLUME..., arg2=format=wxPATH_NATIVE ...
|-

|-
| wxString || GetShortPath || || return the short form of the path (returns identity on non-Windows platforms).

|-

|-
| wxString || GetVolume || || returns the string containing the volume for this file name
|-

|-
| bool || HasExt || || returns true if an extension is present.
|-

|-
| bool || HasName || || returns true if a name is present
|-

|-
| bool || HasVolume || || returns true if a volume specifier is present
|-

|-
| void || InsertDir||int, const wxString || arg1=before_dir, arg2=name_dir
|-

|-
| bool || IsAbsolute || wxPathFormat ||arg=format=wxPATH_NATIVE...
|-

|-
| bool || IsOk || || returns true if the filename is valid
|-

|-
| bool || IsRelative || wxPathFormat ||arg=format=wxPATH_NATIVE...
|-

|-
| bool || IsDir || || returns true if this object represents a directory
|-

|-
| bool || MakeAbsolute ||const wxString, wxPathFormat|| arg1=cwd=_T("") or ..., arg2=format=wxPATH_NATIVE or ...
|-

|-
| bool || MakeRelativeTo ||const wxString, wxPathFormat|| arg1=path_base, arg2=format=wxPATH_NATIVE or ...
|-

|-
| bool || Normalize ||int, const wxString, wxPathFormat||arg1=flags=wxPATH_NORM_ALL, arg2=cwd=_T(""),arg3=format=wxPATH_NATIVE or ...
|

|-
| void || PrependDir || const wxString ||arg=dir
|-

|-
| void || RemoveDir || int ||arg=pos RemoveLastDir
|-

|-
| void || RemoveLastDir || || removes last directory component from the path
|-

|-
| bool || SameAs || const wxFileName, wxPathFormat || arg1=filepath, arg2=format=wxPATH_NATIVE
|-

|-
| bool || SetCwd|| || changes the current working directory
|-

|-
| void || SetExt ||const wxString ||arg=extension
|-

|-
| void || SetEmptyExt || || sets the extension of the file name to be an empty extension
|-

|-
| void || SetFullName || wxString ||
|-

|-
| void || SetName || wxString ||
|-

|-
| void || SetVolume || wxString ||
|-

|}
''NOTE: Is instantiated in a script using: local my_filename = ::wxFileName()

== wxPoint ==
'''UNDER CONSTRUCTION'''

'' Instantiate integer points 2D

{| 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
|-

|-
| wxPoint || operator= || const wxPoint|| default assignment operator is ok
|-

|-
| bool || operator== ||const wxPoint||
|-

|-
| bool || operator!= || const wxPoint||
|-

|-
| int || x || ||
|-

|-
| int || y || ||
|-

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

''EXAMPLE: local my_wxpoint = ::wxPoint(); my_wxpoint.x = 5; my_wxpoint.y = 12; // not use ::print(my_wxpoint)

== wxSize ==
'''UNDER CONSTRUCTION'''

'' Instantiate integers values (X, Y)

{| 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
|-

|-
| wxSize || operator= || const wwSize|| default assignment operator is ok
|-

|-
| bool || operator== ||const wxSize||
|-

|-
| bool || operator!= || const wxSize||
|-

|-
| int || GetWidth || || return X
|-

|-
| int || GetHeight || || return Y
|-

|-
| void || SetWidth || int w|| X=w
|-

|-
| void || SetHeight || int h|| Y=h
|-

|-
| void || Set || int w, int h|| X=w, Y=h
|-

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

''EXAMPLE: local my_wxsize = ::wxSize(); my_wxsize.SetWidth(5); my_wxsize.SetHeight(12); // not use ::print(my_wxsize)

== 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 in Prototype
!Remarks
|-

|-
| void || AddBuildTarget || (const wxString& targetName)||
|-

|-
| void || RenameBuildTarget || (const wxString& oldTargetName, const wxString& newTargetName) ||
|-

|-
| void || RemoveBuildTarget || (const wxString& targetName)||
|-

|-
| wxString || GetBaseName || ( ) ||
|-

|-
| wxString || GetObjName || ( ) ||
|-

|-
| void || SetObjName || (const wxString& targetName) ||
|-

|-
| cbProject* || GetParentProject || ( ) ||
|-

|-
| wxString|| GetCustomBuildCommand|| (const wxString& compilerId) ||
|-

|-
| void || SetCustomBuildCommand || (const wxString& compilerId, const wxString& newBuildCommand) ||
|-

|-
| bool || GetUseCustomBuildCommand|| (const wxString& compilerId) ||
|-

|-
| void || SetUseCustomBuildCommand || (const wxString& compilerId, bool useCustomBuildCommand) ||
|-

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

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

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

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

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

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

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

|-
| wxArrayString || buildTargets || || (variable)
|-

|-
| const wxArrayString & || GetBuildTargets ||() const || r9252 : for use instead of the 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 in Prototype
!Remarks
|-

|-
| void || AddPlatform || (int platform) || windows,unix,mac
|-

|-
| void || RemovePlatform || (int platform) ||
|-

|-
| void || SetPlatforms || (int platform) ||
|-

|-
| int || GetPlatforms || ||
|-

|-
| bool || SupportsCurrentPlatform || ||
|-

|-
| void || SetLinkerOptions || (const wxArrayString& linkerOpts) ||
|-

|-
| void || SetLinkLibs || (const wxArrayString& linkLibs) ||
|-

|-
| void || SetCompilerOptions || (const wxArrayString& compilerOpts) ||
|-

|-
| void || SetIncludeDirs || (const wxArrayString& includeDirs) ||
|-

|-
| void || SetResourceIncludeDirs || (const wxString& option) ||
|-

|-
| void || SetLibDirs || (const wxArrayString& libDirs) ||
|-

|-
| void || SetCommandsBeforeBuild || (const wxArrayString& commands) ||
|-

|-
| void || SetCommandsAfterBuild || (const wxArrayString& commands) ||
|-

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

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

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

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

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

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

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

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

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

|-
| void || SetModified || (bool modified) ||
|-

|-
| void || AddLinkerOption || (const wxString& option) ||
|-

|-
| void || AddLinkLib || (const wxString& lib) ||
|-

|-
| void || AddCompilerOption || (const wxString& option)||
|-

|-
| void || AddIncludeDir || (const wxString& option) ||
|-

|-
| void || AddResourceIncludeDir || (const wxString& option) ||
|-

|-
| void || AddLibDir || (const wxString& option) ||
|-

|-
| void || AddCommandsBeforeBuild || (const wxString& command) ||
|-

|-
| void || AddCommandsAfterBuild || (const wxString& command) ||
|-

|-
| void || RemoveLinkerOption || (const wxString& option) ||
|-

|-
| void || RemoveLinkLib || (const wxString& lib) ||
|-

|-
| void || RemoveCompilerOption || (const wxString& option) ||
|-

|-
| void || RemoveIncludeDir || (const wxString& option) ||
|-

|-
| void || RemoveResourceIncludeDir || (const wxString& option) ||
|-

|-
| void || RemoveLibDir || (const wxString& option) ||
|-

|-
| void || RemoveCommandsBeforeBuild || (const wxString& command) ||
|-

|-
| void || RemoveCommandsAfterBuild || (const wxString& command) ||
|-

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

|-
| void || SetAlwaysRunPostBuildSteps || (bool always) ||
|-

|-
| void || SetBuildScripts || (const wxArrayString& scripts) ||
|-

|-
| wxArrayString || GetBuildScripts || ||
|-

|-
| void || AddBuildScript || (const wxString& script) ||
|-

|-
| void || RemoveBuildScript || (const wxString& script) ||
|-

|-
| bool || SetVar || (const wxString& key, const wxString& value, bool onlyIfExists = false) ||
|-

|-
| wxString || GetVar || (const wxString& key) ||
|-

|-
| bool || UnsetVar || (const wxString& key) ||
|-

|-
| 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
|-

|-
| void || SetTargetFilenameGenerationPolicy || enum prefix, enum extension|| tgfpPlatformDefault -> Generate filename based on running platform defaults. tgfpNone -> No automatic generation; let the user specify the full filename.
|-

|-
| 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 || ||
|-

|-
| wxString || GetMakeCommandFor || enum ||
|-

|-
| void || SetMakeCommandFor || enum,wxString ||
|-

|-
| bool || MakeCommandsModified || ||
|-

|}

== 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 || ||The full title, i.e. "projectname - targetname"
|-

|-
| wxString || GetExternalDeps || ||list of files whose target depends
|-

|-
| void || SetExternalDeps || wxString ||list of files whose target depends
|-

|-
| void || SetAdditionalOutputFiles || wxString ||a list of additional output files
|-

|-
| wxString || GetAdditionalOutputFiles || ||a list of additional output files
|-

|-
| bool || GetIncludeInTargetAll || || Deprecated, do not use at 'All'
|-

|-
| void || SetIncludeInTargetAll || bool || Deprecated, do not use at 'All'
|-

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

|-
| void || SetCreateDefFile || bool ||if the target creates a DEF imports file.
|-

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

|-
| void || SetCreateStaticLib || bool ||if an import library should be created
|-

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

|-
| void || SetUseConsoleRunner || bool ||for targets generating a console executable.
|-

|-
| ProjectFile* || GetFile || int || returns a file from the target
|-

|-
| int || GetFilesCount || || returns number of files of target
|-

|}

== 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 || name, is relative, is Unixfilename
|-

|-
| bool || RemoveFile || ProjectFile * ||
|-

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

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

|-
| int || GetBuildTargetsCount || || number targets
|-

|-
| ProjectBuildTarget* || GetBuildTarget || int || target index
|-

|-
| ProjectBuildTarget* || GetBuildTarget || wxString || active target name || This might be a virtual target.
|-

|-
| ProjectBuildTarget* || AddBuildTarget || wxString || target name
|-

|-
| bool || RenameBuildTarget || int, wxString || target index, new name
|-

|-
| bool || RenameBuildTarget || wxString, wxString || old name, new name
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || int, wxString || index, new name
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || wxString, wxString || target name, new name
|-

|-
| bool || RemoveBuildTarget || int || index
|-

|-
| bool || RemoveBuildTarget || wxString || target name
|-

|-
| bool || ExportTargetAsProject || int || target index
|-

|-
| bool || ExportTargetAsProject || wxString || target name
|-

|-
| bool || BuildTargetValid || wxString|bool ||
|-

|-
| wxString || GetFirstValidBuildTargetName || bool ||
|-

|-
| void || SetDefaultExecuteTarget || wxString ||
|-

|-
| wxString || GetDefaultExecuteTarget || wxString ||
|-

|-
| bool || SetActiveBuildTarget || wxString ||
|-

|-
| wxString || GetActiveBuildTarget || ||
|-

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

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

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

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

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

|-
| void || SetExtendedObjectNamesGeneration || bool ||
|-

|-
| bool || GetExtendedObjectNamesGeneration || ||
|-

|-
| void || SetNotes || wxString ||
|-

|-
| wxString || GetNotes || ||
|-

|-
| void || SetShowNotesOnLoad || bool ||
|-

|-
| bool || GetShowNotesOnLoad || ||
|-

|-
| void || ShowNotes || bool,bool ||
|-

|-
| void || AddToExtensions || wxString ||
|-

|-
| bool || DefineVirtualBuildTarget || wxString,wxArrayString ||arg1=alias virtual target, arg2= array targets
|-

|-
| bool || HasVirtualBuildTarget|| wxSring ||arg=alias virtual target
|-

|-
| bool || RemoveVirtualBuildTarget|| wxString ||arg=alias virtual target, return true if removed
|-

|-
| wxArrayString || GetVirtualBuildTargets|| ||Get a list of all defined virtual build targets.
|-

|-
| wxArrayString || GetVirtualBuildTargetGroup || wxString ||arg=alias, Access a virtual build target's group of build targets.
|-

|-
| wxArrayString || GetExpandedVirtualBuildTargetGroup|| wxString ||arg=alias, Access a virtual build target's expanded group of build targets.
|-

|-
| bool || CanAddToVirtualBuildTarget || wxSring,wxString ||arg1=alias, arg2=name target to add,
Checks if a build target (virtual or real) can be added to a virtual build target, without causing a circular-reference.
|-

|-
| void || SetTitle || wxSring ||
|-
|}

== 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 || Save || ||
|-

|-
| 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;" | '''Plugin version'''
|-

|-
|PLUGIN_SDK_VERSION_MAJOR||int|| =1, it will change when the SDK interface breaks
|-

|-
|PLUGIN_SDK_VERSION_MINOR||int|| =13, it will change when the SDK interface breaks
|-

|-
|PLUGIN_SDK_VERSION_RELEASE||int|| =13, it will change when the SDK interface breaks
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Path separator for filenames'''
|-

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

|-
| 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 wxPathFormat'''
|-

|-
|wxPATH_NATIVE || enum ||
|-

|-
|wxPATH_UNIX || enum ||
|-

|-
|wxPATH_BEOS || enum ||
|-

|-
|wxPATH_MAC || enum ||
|-

|wxPATH_DOS || enum ||
|-

|-
|wxPATH_WIN || enum ||
|-

|-
|wxPATH_OS2 || enum ||
|-

|-
|wxPATH_VM3 || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''For wxFileName::GetPath()'''
|-

|-
|wxPATH_GET_VOLUME || enum || include the volume if applicable
|-

|-
|wxPATH_GET_SEPARATOR || enum || terminate the path with the separator
|-

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

|-
|wxPATH_NORM_ENV_VARS || enum || replace env vars with their values
|-

|-
|wxPATH_NORM_DOTS || enum || squeeze all .. and . and prepend cwd
|-

|-
|wxPATH_NORM_TILDE || enum || Unix only: replace ~ and ~user
|-

|-
|wxPATH_NORM_CASE || enum || if case insensitive => tolower
|-

|-
|wxPATH_NORM_ABSOLUTE || enum ||make the path absolute
|-

|-
|wxPATH_NORM_LONG || enum ||make the path the long form
|-

|-
|wxPATH_NORM_SHORTCUT|| enum || resolve the shortcut, if it is a shortcut
|-

|-
|wxPATH_NORM_ALL || enum || = 0x00ff & ~wxPATH_NORM_CASE
|-

|-
| 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 ||
|-

|-
| mcAskRebuildNeeded|| enum ||
|-

|-
|mcSilentBuild|| 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;" | '''enum SearchDirs'''
|-

|-
|sdHome|| enum || User's home directory
|-

|-
|sdBase|| enum || Code::Blocks' installation base
|-

|-
|sdTemp|| enum || System-wide temp folder
|-

|-
|sdPath || enum || All dirs in the PATH environment variable
|-

|-
|sdConfig || enum || Config folder
|-

|-
|sdCurrent|| enum || Current working folder
|-

|-
|sdPluginsUser|| enum || Plugins folder in user's dir
|-

|-
|sdScriptsUser|| enum || Scripts folder in user's dir
|-

|-
|sdDataUser|| enum || Data folder in user's dir
|-

|-
|sdAllUser || enum || Convenience value meaning "all sd*User values"
|-

|-
|sdPluginsGlobal|| enum || Plugins folder in base dir
|-

|-
|sdScriptsGlobal|| enum || Scripts folder in base dir
|-

|-
|sdDataGlobal || enum || Data folder in base dir
|-

|-
|sdAllGlobal || enum || Convenience value meaning "all sd*Global values"
|-

|-
|sdAllKnown|| enum || All known dirs (i.e. all of the above)
|-

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

|-
|spMac ||enum ||
|-

|-
|spUnix ||enum ||
|-

|-
|spWindows ||enum ||
|-

|-
|spAll ||enum ||
|

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

|-
|tgfpPlatformDefault ||enum || Generate filename based on running platform defaults.
|-

|-
|tgfpNone ||enum || No automatic generation; let the user specify the full filename
|-

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

|-
|mtProjectManager ||enum ||
|-

|-
|mtEditorManager ||enum ||
|-

|-
|mtLogManager||enum ||
|-

|-
|mtOpenFilesList||enum ||
|-

|-
|mtEditorTab||enum ||
|-

|-
|mtUnknown||enum ||
|-

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

|-
|ftdkUndefined||enum ||
|-

|-
|ftdkProject||enum ||
|-

|-
|ftdkFolder||enum ||
|-

|-
|ftdkFile||enum ||
|-

|-
|ftdkVirtualGroup||enum ||
|-

|-
|ftdkVirtualFolder||enum ||
|-

|-
| 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_MSVC7 || wxString ||
|-

|-
| EXT_MSVC10 || wxString ||
|-

|-
| EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| EXT_ASM || wxString ||
|-

|-
| EXT_D || wxString ||
|-

|-
| EXT_F || wxString ||
|-

|-
| EXT_F77 || wxString ||
|-

|-
| EXT_F90 || wxString ||
|-

|-
| EXT_F95 || wxString ||
|-

|-
| EXT_FOR || wxString ||
|-

|-
| EXT_FPP || wxString ||
|-

|-
| EXT_F03 || wxString ||
|-

|-
| EXT_F08 || wxString ||
|-

|-
| EXT_JAVA || wxString ||
|-

|-
| EXT_C || wxString ||
|-

|-
| EXT_CC || wxString ||
|-

|-
| EXT_CPP || wxString ||
|-

|-
| EXT_CXX || wxString ||
|-

|-
| EXT_CPLPL || wxString ||
|-

|-
| EXT_INL || wxString ||
|-

|-
| EXT_H || wxString ||
|-

|-
| EXT_HH || wxString ||
|-

|-
| EXT_HPP || wxString ||
|-

|-
| EXT_HXX || wxString ||
|-

|-
| EXT_HPLPL || wxString ||
|-

|-
| EXT_S || wxString ||
|-

|-
| EXT_SS || wxString ||
|-

|-
| EXT_S62 || wxString ||
|-

|-
| EXT_OBJECT || wxString ||
|-

|-
| EXT_XRCRESOURCE || wxString ||
|-

|-
| EXT_STATICLIB || wxString ||
|-

|-
| EXT_DYNAMICLIB || wxString ||
|-

|-
| EXT_EXECUTABLE || wxString ||
|-

|-
| EXT_NATIVE || 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_MSVC7 || wxString ||
|-

|-
| DOT_EXT_MSVC10 || wxString ||
|-

|-
| DOT_EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_D || wxString ||
|-

|-
| DOT_EXT_F || wxString ||
|-

|-
| DOT_EXT_F77 || wxString ||
|-

|-
| DOT_EXT_F90 || wxString ||
|-

|-
| DOT_EXT_F95 || wxString ||
|-

|-
| DOT_EXT_FOR || wxString ||
|-

|-
| DOT_EXT_FPP || wxString ||
|-

|-
| DOT_EXT_F03 || wxString ||
|-

|-
| DOT_EXT_F08 || wxString ||
|-

|-
| DOT_EXT_JAVA || wxString ||
|-

|-
| DOT_EXT_C || wxString ||
|-

|-
| DOT_EXT_CC || wxString ||
|-

|-
| DOT_EXT_CPP || wxString ||
|-

|-
| DOT_EXT_CXX || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_CPLPL || wxString ||
|-

|-
| DOT_EXT_H || wxString ||
|-

|-
| DOT_EXT_HH || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_HXX || wxString ||
|-

|-
| DOT_EXT_HPLPL || wxString ||
|-

|-
| DOT_EXT_S || wxString ||
|-

|-
| DOT_EXT_SS || wxString ||
|-

|-
| DOT_EXT_S62 || wxString ||
|-

|-
| DOT_EXT_OBJECT || wxString ||
|-

|-
| DOT_EXT_XRCRESOURCE || wxString ||
|-

|-
| DOT_EXT_STATICLIB || wxString ||
|-

|-
| DOT_EXT_DYNAMICLIB || wxString ||
|-

|-
| DOT_EXT_EXECUTABLE || wxString ||
|-

|-
| DOT_EXT_NATIVE || wxString ||
|-

|-
| DOT_EXT_RESOURCE || wxString ||
|-

|-
| DOT_EXT_RESOURCEBIN || wxString ||
|-

|-
| DOT_EXT_XML || wxString ||
|-

|-
| DOT_EXT_SCRIPT || wxString ||
|-

|}

== See also ==

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