Code::Blocks - User contributions [en]

TestPage1

2021-10-26T17:36:32Z

Mandrav: Created page with "Test page 1"

Test page 1

Main Page

2015-09-20T13:00:34Z

Mandrav: Reverted edits by DeannaVarnum708 (talk) to last revision by Mandrav

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

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

 
}}

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


<div style="background-color: #dfeefb; border: 1px dotted #010101; margin: 5px; padding: 5px;">
{|align="center" style="background:transparent" cellspacing="5"

|valign="top" align="center" colspan="2"|
=== How do I... ===

|-

|align="center"|
'''[[Installing_Code::Blocks|...install Code::Blocks?]]''' 

[[Installing_the_latest_official_version_of_Code::Blocks_on_Windows|Windows]] ·
[[Installing_Code::Blocks#Ubuntu|Ubuntu]] ·
[[Installing_Code::Blocks#Mac_OS_X|Mac OS X]] ·
[[Installing_Code::Blocks#Fedora|Fedora]] ·
[[Installing_Code::Blocks|more...]]


|align="center"|
'''[[Installing_a_supported_compiler|...set up a compiler in Code::Blocks?]]''' 

[[Installing_a_supported_compiler#MinGW.2FGCC|MinGW]] ·
[[Installing_a_supported_compiler#Microsoft_Visual_C.2B.2B|MS Visual C++]] ·
[[Installing_a_supported_compiler|more...]]


|-

|align="center"|
'''[[Creating a new project|...create a new project?]]''' 

[[Creating a new project#Changing file composition|Add files]] ·
[[Creating a new project#Modifying build options|Build options]] ·
[[Creating a new project#Virtual Targets|Virtual Targets]] ·
[[Creating a new project|more...]]


|align="center"|
'''[[Debugging_with_Code::Blocks|...debug my program?]]'''

|-

|align="center"|
'''[[FAQ-Settings#Q: How do I make Code::Blocks portable?|...make Code::Blocks portable?]]'''

|align="center"|
'''[[User_documentation#Third-party_libraries|...use a 3rd-party library?]]''' 

[[Using_wxWidgets|wxWidgets]] ·
[[Using_Boost|Boost]] ·
[[Using_SDL_with_Code::Blocks|SDL]] ·
[[User_documentation#Third-party_libraries|more...]]


|}
</div>

{{Layout_box3|1=
== Table of Contents ==
''Main article: [[Code::Blocks Documentation]]''

=== [[User documentation]] ===
:Articles for Code::Blocks users

=== [[FAQ]] ===
:Frequently Asked Questions

=== [[Feature List]] ===
:An index of Code::Blocks' useful features

=== [[Code::Blocks Plugins]] ===
:Plugins extend Code::Blocks' functionality

=== [[Off-site documentation]] ===
:Links to external documentation

=== [[Developer documentation]] ===
:Articles for developers of Code::Blocks itself
}}

|width="40%" valign="top"|

{{Layout_box4|1=
=== Download Code::Blocks ===
* Latest official release: [https://www.codeblocks.org/downloads/26 13.12]
* [/index.php?board=20.0 Nightly builds] (updated each night)
* [[Compiled_packages_of_Code::Blocks|Official and third-party binaries]] (for various distributions)
}}

{{Layout_box2|1=
=== Other resources ===
* [https://www.codeblocks.org Main website]
* [ Community forums]
* [irc://irc.freenode.net/codeblocks IRC channel] and [http://webchat.freenode.net/?channels=codeblocks IRC channel web access]
}}

{{Layout_box2|1=
=== Development ===
[[Image:Chk.png]][[Roadmap]]
* [[Developer documentation]]
* [http://sourceforge.net/projects/codeblocks/ Project page at Sourceforge]
* '''Bugs''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/search/?q=_type%3ABug_Report+or+_type%3AUndefined bugs] or browse [http://alpha0010.github.io/cb-history/bugs.html old bugs]
* '''Features''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/search/?q=_type%3AFeature_Request+or+_type%3AUndefined features] or browse [http://alpha0010.github.io/cb-history/features.html old features]
* '''Patches''': browse or submit [http://sourceforge.net/p/codeblocks/tickets/search/?q=_type%3APatch+or+_type%3AUndefined patches] or browse [http://alpha0010.github.io/cb-history/patches.html old patches]
}}

{{Layout_box3|1=
=== Supported compilers ===
* [http://gcc.gnu.org/ GNU GCC (incl. G77)] (Linux)
* [http://www.mingw.org MinGW GCC (incl. G77)] (Win32)
* [http://mspgcc.sourceforge.net MSP430 GCC] (Win32)
* [http://www.hightec-rt.com TriCore and PowerPC GCC] (Win32, Linux)
* [http://developer.apple.com/tools/ Apple GCC (Xcode)] (Mac OS X)

* [http://xona.com/2004/06/29.html Microsoft Visual C++ Toolkit 2003] (Win32)
* [http://msdn.microsoft.com/vstudio/express/visualc/download/ Microsoft Visual C++ 2005] (Win32)
* [http://edn.embarcadero.com/article/20633 Borland's C++ Compiler 5.5] (Win32)
* [http://www.digitalmars.com/ DigitalMars C/C++] (Win32)
* [http://openwatcom.org/index.php/Main_Page OpenWatcom] (Win32)
* [https://software.intel.com/en-us/c-compilers Intel C++ compiler] (Win32)
* [http://sdcc.sourceforge.net/ Small Device C Compiler (SDCC)]
* [http://dlang.org/ Digital Mars D]
* [http://dgcc.sourceforge.net/ GDC D Compiler]
* [https://github.com/ldc-developers/ldc/ LLVM D Compiler]
}}
|}

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

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

Main Page

2015-09-20T12:52:40Z

Mandrav: revert from spam

Main Page

2015-09-20T12:51:03Z

Mandrav: Reverted edits by LakeishaSmerd (talk) to last revision by DeannaVarnum708

During the course of a study, people were spoken with regarding the waffles producers they were actually and utilized asked about to illustrate their encounter. Taking a trip created by web site to web site trying to understand what each site needs to point out regarding a specific brand of waffle mold could be time consuming and also greater than a bit annoying. Our team have done away with the necessity for all that searching by doing our personal extensive analysis as well as by speaking with specialists in the food items market to deliver you info that aids you limit the choices and find the ideal waffle mold for your needs as well as choices. Our aim is to spare you time, power, disappointment as well as cash and that's just what our waffle manufacturer critique performs. If you have any inquiries concerning in which and how to use waffle cone makers ([http://likeablenewslet37.jimdo.com/2015/09/11/fat-s-chicken-and-waffles-open-for-business-at-mlk-and-cherry-chs-capitol-hill-seattle/ focuses]), you can call us at our own web-page. When your waffle is done baking, the countdown timer with practical electronic screen permits you recognize with a signal that cooking is actually done. This great waffle mold gives you Belgian waffles that are actually crunchy on the gentle and also outside and also tender on the in. Whether you prefer a typical style waffle or a more thick, Belgian type, any kind of one of these waffle makers could be actually merely exactly what you are actually seeking out. Waffles are a preferred breakfast food as well as sometimes individuals like them for pudding as well. Among the best necessary attributes of a waffle producer is how effectively its own nonstick finishing works. The manual for the Proctor Silex recommends greasing home plates before the first make use of only, as well as we located that our company certainly never should oil them for succeeding sets. Our team located the light sign on our best selection ample for letting our team learn when the waffles were carried out. This creates just one round, slim waffle at once (perhaps even smaller sized compared to our runner-up), thus this is merely an excellent selection for those which do not need to have a high-volume waffle mold. Between them, they have created many hundreds of waffles and additional waffled objects over the years as well as have used upwards of a dozen waffle creators.

Scripting commands

2010-01-30T22:42:08Z

Mandrav: Added CallMenu() documentation

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

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

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

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

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

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

== Global functions ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|-
| wxString || UnixFilename || wxString ||
|-

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

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

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

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

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

|-
| void|| Display || wxString,wxString,int,int ||
|-

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

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

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

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

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

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

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

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

|}

== ScriptingManager ==

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

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

|}

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

== ConfigManager ==

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

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

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

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

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

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

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

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

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

|}

== ProjectManager ==

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

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

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

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

|-
| 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),bool ||
|-

|}

== UserVariableManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments 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) ||
|-

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

== wxArrayString ==

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

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

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

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

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

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

== wxColour ==

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

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

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

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

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

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

== ProjectFile ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments 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)
|-

|}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}

== cbProject ==
Extends CompileTargetBase.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|-
| bool || HasVirtualBuildTarget|| wxSring ||
|-

|-
| bool || RemoveVirtualBuildTarget|| wxString ||
|-

|-
| wxArrayString || GetVirtualBuildTargets|| ||
|-

|-
| wxArrayString || GetVirtualBuildTargetGroup || wxString ||
|-

|-
| wxArrayString || GetExpandedVirtualBuildTargetGroup|| wxString ||
|-

|-
| bool || CanAddToVirtualBuildTarget || wxSring,wxString ||
|-

|-
| 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;" | '''Message dialog flags'''
|-

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

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

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

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

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

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

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

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

|-
| wxID_OK || int ||
|-

|-
| wxID_YES || int ||
|-

|-
| wxID_NO || int ||
|-

|-
| wxID_CANCEL || int ||
|-

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

|-
| ortCompilerOptions || enum ||
|-

|-
| ortLinkerOptions || enum ||
|-

|-
| ortIncludeDirs || enum ||
|-

|-
| ortLibDirs || enum ||
|-

|-
| ortResDirs || enum ||
|-

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

|-
| orUseParentOptionsOnly || enum ||
|-

|-
| orUseTargetOptionsOnly || enum ||
|-

|-
| orPrependToParentOptions || enum ||
|-

|-
| orAppendToParentOptions || enum ||
|-

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

|-
| ttExecutable || enum ||
|-

|-
| ttConsoleOnly || enum ||
|-

|-
| ttStaticLib || enum ||
|-

|-
| ttDynamicLib || enum ||
|-

|-
| ttCommandsOnly || enum ||
|-

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

|-
| mcClean || enum ||
|-

|-
| mcDistClean || enum ||
|-

|-
| mcBuild || enum ||
|-

|-
| mcCompileFile || enum ||
|-

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

|-
| pchSourceDir || enum ||
|-

|-
| pchObjectDir || enum ||
|-

|-
| pchSourceFile || enum ||
|-

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

|-
| psSelection || enum ||
|-

|-
| psActiveEditor || enum ||
|-

|-
| psAllOpenEditors || enum ||
|-

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

|-
| pcmBlackAndWhite || enum ||
|-

|-
| pcmColourOnWhite || enum ||
|-

|-
| pcmInvertColours || enum ||
|-

|-
| pcmAsIs || enum ||
|-

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

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

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

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

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

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

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

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

|-
| EXT_WORKSPACE || wxString ||
|-

|-
| EXT_CODEBLOCKS || wxString ||
|-

|-
| EXT_DEVCPP || wxString ||
|-

|-
| EXT_MSVC6 || wxString ||
|-

|-
| EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| EXT_MSVC7 || wxString ||
|-

|-
| EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| EXT_D || wxString ||
|-

|-
| EXT_F || wxString ||
|-

|-
| EXT_F77 || wxString ||
|-

|-
| EXT_F95 || wxString ||
|-

|-
| EXT_CPP || wxString ||
|-

|-
| EXT_C || wxString ||
|-

|-
| EXT_CC || wxString ||
|-

|-
| EXT_CXX || wxString ||
|-

|-
| EXT_HPP || wxString ||
|-

|-
| EXT_H || wxString ||
|-

|-
| EXT_HH || wxString ||
|-

|-
| EXT_HXX || wxString ||
|-

|-
| EXT_OBJECT || wxString ||
|-

|-
| EXT_XRCRESOURCE || wxString ||
|-

|-
| EXT_STATICLIB || wxString ||
|-

|-
| EXT_DYNAMICLIB || wxString ||
|-

|-
| EXT_EXECUTABLE || wxString ||
|-

|-
| EXT_RESOURCE || wxString ||
|-

|-
| EXT_RESOURCEBIN || wxString ||
|-

|-
| EXT_XML || wxString ||
|-

|-
| EXT_SCRIPT || wxString ||
|-

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

|-
| DOT_EXT_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_CODEBLOCKS || wxString ||
|-

|-
| DOT_EXT_DEVCPP || wxString ||
|-

|-
| DOT_EXT_MSVC6 || wxString ||
|-

|-
| DOT_EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_MSVC7 || wxString ||
|-

|-
| DOT_EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_D || wxString ||
|-

|-
| DOT_EXT_F || wxString ||
|-

|-
| DOT_EXT_F77 || wxString ||
|-

|-
| DOT_EXT_F95 || wxString ||
|-

|-
| DOT_EXT_CPP || wxString ||
|-

|-
| DOT_EXT_C || wxString ||
|-

|-
| DOT_EXT_CC || wxString ||
|-

|-
| DOT_EXT_CXX || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_H || wxString ||
|-

|-
| DOT_EXT_HH || wxString ||
|-

|-
| DOT_EXT_HXX || wxString ||
|-

|-
| DOT_EXT_OBJECT || wxString ||
|-

|-
| DOT_EXT_XRCRESOURCE || wxString ||
|-

|-
| DOT_EXT_STATICLIB || wxString ||
|-

|-
| DOT_EXT_DYNAMICLIB || wxString ||
|-

|-
| DOT_EXT_EXECUTABLE || wxString ||
|-

|-
| DOT_EXT_RESOURCE || wxString ||
|-

|-
| DOT_EXT_RESOURCEBIN || wxString ||
|-

|-
| DOT_EXT_XML || wxString ||
|-

|-
| DOT_EXT_SCRIPT || wxString ||
|-

|}

== See also ==

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

Scripting commands

2010-01-29T22:29:41Z

Mandrav: Added ExecuteToolPlugin() and ConfigureToolPlugin() documentation

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

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

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

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

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

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

== Global functions ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|-
| wxString || UnixFilename || wxString ||
|-

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

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

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

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

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

|-
| void|| Display || wxString,wxString,int,int ||
|-

|-
| 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 || Include || wxString || similar to C/C++ ''<tt>#include "name"</tt>''
|-

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

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

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

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

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

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

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

|}

== ScriptingManager ==

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

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

|}

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

== ConfigManager ==

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

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

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

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

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

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

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

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

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

|}

== ProjectManager ==

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

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

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

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

|-
| 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),bool ||
|-

|}

== UserVariableManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments 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) ||
|-

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

== wxArrayString ==

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

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

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

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

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

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

== wxColour ==

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

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

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

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

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

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

== ProjectFile ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments 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)
|-

|}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}

== cbProject ==
Extends CompileTargetBase.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|-
| bool || HasVirtualBuildTarget|| wxSring ||
|-

|-
| bool || RemoveVirtualBuildTarget|| wxString ||
|-

|-
| wxArrayString || GetVirtualBuildTargets|| ||
|-

|-
| wxArrayString || GetVirtualBuildTargetGroup || wxString ||
|-

|-
| wxArrayString || GetExpandedVirtualBuildTargetGroup|| wxString ||
|-

|-
| bool || CanAddToVirtualBuildTarget || wxSring,wxString ||
|-

|-
| 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;" | '''Message dialog flags'''
|-

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

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

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

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

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

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

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

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

|-
| wxID_OK || int ||
|-

|-
| wxID_YES || int ||
|-

|-
| wxID_NO || int ||
|-

|-
| wxID_CANCEL || int ||
|-

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

|-
| ortCompilerOptions || enum ||
|-

|-
| ortLinkerOptions || enum ||
|-

|-
| ortIncludeDirs || enum ||
|-

|-
| ortLibDirs || enum ||
|-

|-
| ortResDirs || enum ||
|-

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

|-
| orUseParentOptionsOnly || enum ||
|-

|-
| orUseTargetOptionsOnly || enum ||
|-

|-
| orPrependToParentOptions || enum ||
|-

|-
| orAppendToParentOptions || enum ||
|-

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

|-
| ttExecutable || enum ||
|-

|-
| ttConsoleOnly || enum ||
|-

|-
| ttStaticLib || enum ||
|-

|-
| ttDynamicLib || enum ||
|-

|-
| ttCommandsOnly || enum ||
|-

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

|-
| mcClean || enum ||
|-

|-
| mcDistClean || enum ||
|-

|-
| mcBuild || enum ||
|-

|-
| mcCompileFile || enum ||
|-

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

|-
| pchSourceDir || enum ||
|-

|-
| pchObjectDir || enum ||
|-

|-
| pchSourceFile || enum ||
|-

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

|-
| psSelection || enum ||
|-

|-
| psActiveEditor || enum ||
|-

|-
| psAllOpenEditors || enum ||
|-

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

|-
| pcmBlackAndWhite || enum ||
|-

|-
| pcmColourOnWhite || enum ||
|-

|-
| pcmInvertColours || enum ||
|-

|-
| pcmAsIs || enum ||
|-

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

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

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

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

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

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

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

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

|-
| EXT_WORKSPACE || wxString ||
|-

|-
| EXT_CODEBLOCKS || wxString ||
|-

|-
| EXT_DEVCPP || wxString ||
|-

|-
| EXT_MSVC6 || wxString ||
|-

|-
| EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| EXT_MSVC7 || wxString ||
|-

|-
| EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| EXT_D || wxString ||
|-

|-
| EXT_F || wxString ||
|-

|-
| EXT_F77 || wxString ||
|-

|-
| EXT_F95 || wxString ||
|-

|-
| EXT_CPP || wxString ||
|-

|-
| EXT_C || wxString ||
|-

|-
| EXT_CC || wxString ||
|-

|-
| EXT_CXX || wxString ||
|-

|-
| EXT_HPP || wxString ||
|-

|-
| EXT_H || wxString ||
|-

|-
| EXT_HH || wxString ||
|-

|-
| EXT_HXX || wxString ||
|-

|-
| EXT_OBJECT || wxString ||
|-

|-
| EXT_XRCRESOURCE || wxString ||
|-

|-
| EXT_STATICLIB || wxString ||
|-

|-
| EXT_DYNAMICLIB || wxString ||
|-

|-
| EXT_EXECUTABLE || wxString ||
|-

|-
| EXT_RESOURCE || wxString ||
|-

|-
| EXT_RESOURCEBIN || wxString ||
|-

|-
| EXT_XML || wxString ||
|-

|-
| EXT_SCRIPT || wxString ||
|-

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

|-
| DOT_EXT_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_CODEBLOCKS || wxString ||
|-

|-
| DOT_EXT_DEVCPP || wxString ||
|-

|-
| DOT_EXT_MSVC6 || wxString ||
|-

|-
| DOT_EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_MSVC7 || wxString ||
|-

|-
| DOT_EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_D || wxString ||
|-

|-
| DOT_EXT_F || wxString ||
|-

|-
| DOT_EXT_F77 || wxString ||
|-

|-
| DOT_EXT_F95 || wxString ||
|-

|-
| DOT_EXT_CPP || wxString ||
|-

|-
| DOT_EXT_C || wxString ||
|-

|-
| DOT_EXT_CC || wxString ||
|-

|-
| DOT_EXT_CXX || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_H || wxString ||
|-

|-
| DOT_EXT_HH || wxString ||
|-

|-
| DOT_EXT_HXX || wxString ||
|-

|-
| DOT_EXT_OBJECT || wxString ||
|-

|-
| DOT_EXT_XRCRESOURCE || wxString ||
|-

|-
| DOT_EXT_STATICLIB || wxString ||
|-

|-
| DOT_EXT_DYNAMICLIB || wxString ||
|-

|-
| DOT_EXT_EXECUTABLE || wxString ||
|-

|-
| DOT_EXT_RESOURCE || wxString ||
|-

|-
| DOT_EXT_RESOURCEBIN || wxString ||
|-

|-
| DOT_EXT_XML || wxString ||
|-

|-
| DOT_EXT_SCRIPT || wxString ||
|-

|}

== See also ==

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

User talk:Mariocup

2008-04-13T08:06:53Z

Mandrav: /* Interrupt and Resume Debugger */

= Editor Improvements =

==Resize editor window==
A double click on a tab of an opened file should enlarge the editor window, and put the Log & Others and the management panel (F2 and Alt+F2) in the background. If you double click again on the tab, the window will be resized to the original size and the panels are visible again.--[[User:Mariocup|Mariocup]] 11:38, 13 March 2008 (CET)

==Icons in the Management window==
If you want to switch the different views in the management window you have to scroll, the tabs (projects, symbols, Files etc.). It would be easier for the user to have different icons like (http://kile.sourceforge.net/showscreenshot.php?id=2) in the margin to switch between the views. If you select e.g. the project icon then the project view will appear. Clicking again on the same icon will collapse the project view.--[[User:Mariocup|Mariocup]] 11:38, 13 March 2008 (CET)

==Save copy as==
Sometimes user want to make a backup of files or want to save a copy at a different location. Therefore a menu save copy as could be useful.--[[User:Mariocup|Mariocup]] 11:38, 13 March 2008 (CET)

==Clipboard History==
Editors like vi or Jedit offer clipboards for copy and paste. The user can select in which register is put the content of the clipboard and can paste the content of one of the buffer/register.--[[User:Mariocup|Mariocup]] 11:38, 13 March 2008 (CET)

==Search Dialog==
The Thread Search dialogue should be added also to the normal search dialogue.--[[User:Mariocup|Mariocup]] 11:38, 13 March 2008 (CET)

==Scope for Search==
Add filter for searching with: Class/Struct, Union, Enumeration, Typedef, Function, Method, Variable, Namespace, Comments --[[User:Mariocup|Mariocup]] 11:38, 13 March 2008 (CET)

==Insert Class method Declaration/Implementation==
The context menu in the editor Insert/Class method declaration/implementation shows the list of classes etc. but lacks of the ability of filter mechanism while typing text text like it is available for Goto File or Goto Function.--[[User:Mariocup|Mariocup]]

==Window docking==
Docking/Undocking of windows in CB with split view (See patch of dmoore for detaching CB windows).--[[User:Mariocup|Mariocup]] 11:38, 13 March 2008 (CET)

==Incremental Search==
The search for a word will be highlighted within the text. All occurences should be highlighted.--[[User:Mariocup|Mariocup]] 11:38, 13 March 2008 (CET)

==Show value of defines==
For embedded developing often defines are used for bit masks. So it would be helpful if the user puts the cursor over a define and CB will hover the value of the define.--[[User:Mariocup|Mariocup]] 11:38, 13 March 2008 (CET)

==Wrap Mode==
If a text is wrapped in several lines (wrap mode) and the cursor is between these lines, then the Home-key will put the cursor in beginning of the first line instead of the start of the current line. This behaviour should be changed.--[[User:Mariocup|Mariocup]] 11:38, 13 March 2008 (CET)

==Convert Tab to spaces and vice versa==
If you mark a text in the editor and select the context menu, then tabs will converted to spaces within the selection.--[[User:Mariocup|Mariocup]] 11:38, 13 March 2008 (CET)

= Project Management =
== Setting Defines ==
For example if a source file contains different #ifdef constructs, sometimes the user wants to toggle setting or unsetting of a define. This could be done either with introducing a comment character in the compiler define dialogue or using a split view window, where one column could be for setting a define and a second column for unsetting a define. The status of a define could be move between the columns by an arrow.

== Assembler Options ==
If you select the properties->Advanced option of an assembler file and click "Use custom build command" then per default "$compiler $options $includes - c $file -o $object" should appear.

== Checkbox for Prebuilt and Postbuilt Steps ==
If you are using different postbuilt steps e.g. conversion of executable to a hex-file and followed by a build steps for flash programming it would be desirable either to have a a comment character for disabling postbuilt steps or introducing checkbox for selecting different post built steps.

== Environment per build target ==
E.g. you want to use different compiler version for two build targets. The compiler is parametrise in the toolchain executable as an environment variable GNUGCC that points to different MinGW compiler versions. This could be realised when configurations of environment variables could be assigned for each build target.

== File Explorer in CB ==
The file explorer (dmoore) and its shell extension can be used for flexible tasks like integrating Subversion support with gsvn or TortoiseSVN, diffing files etc. It should be integrated in Codeblocks.

== Block Select Mode ==
Currently CodeBlocks supports only the selection and copy in block mode (ALT) but cannot paste the content in this mode. This features is useful for changing the content of columns in an array.

== Aspell ==
Integrate Aspell as spell checker as CodeBlocks may be used as text editor too.

== Linker Settings ==
If you link different libraries that contain cylic references, then the linker will issue an error. To solve the problem you can surround the library list by

--start-group <liste libs> --end-group

Could be nice to have a checkbox in the Linker settings that will provide this command.

= Embedded =
Add new tabs in the project settings for setting a predefined list of assembler and linker options (like in the compiler tab).

== Extension Points for options ==
Add mechanism to lock inconsistent selection of compiler, assembler or linker options. E.g. if one march= is selected other march= should be disabled and issue a warning.

== Occlusion highlight ==
/index.php?topic=7768.msg58463;topicseen#new (Ceniza)

== Symbol-Browser ==
The scope of the search in the symbol browse should depend on the user selection Global Functions, Global Variables, Defines etc.

== Show Call Hierarchy ==
Show tree view of the called function and functions that were called before and after it.

== Debugger Console ==
Integrate a gdb Debugger Console in CodeBlocks.

== Hardware Breakpoint ==
For embedded programming it is required to add so called hardware breakpoints. To do that gdb settings set only-use-hw-breakpoints 1 are required. These breakpoint should have a different color. Additional it could be a nice feature to be able to disable and enable existing breakpoints.

== Interrupt and Resume Debugger ==
Add button for interrupting and resume in the Debugger.

- Isn't that already supported? (the "Stop" button first interrupts the process and on second-click stops it) - [[User:Mandrav|Mandrav]] 10:06, 13 April 2008 (CEST)

== Section Browser ==
In the gdb console the command "i file" will display the names of the output sections with start and end address. This information could be displayed in a tree view and by selecting the name of the output section you can navigate between sections. This could be useful to set breakpoint in different sections.

== Symbol View in Debugger ==
In some debuggers the symbols of an object (e.g. including startup code) are extracted and displayed in the symbol view. To get a clear view this view should provide a search dialogue and a filter mechanism for display the symbols.

== Mixed Mode ==
Provide a context menu to get a mixed mode (source code and assembler output) in debug mode. This should be possible for alle files within a project. In this view the user can set breakpoints in the assembler lines.

The display in mixed mode can be achived with the use of the GDB/MI interface (see gdb Manual gdb/mi Command Syntax):
Since gdb 6.1 the debugger can perform mi command with the use of interperter-exec command.

interpreter-exec mi "-data-disassemble -f main.cpp -l 2 -- 1"

The passing of --0 or --1 will provide information for mixed mode if it is parsed.

== Tabbed View ==
The windows of breakpoint, variables etc. should dockable in a tabbed view.

== Multiple Watch Windows ==
In complex application with many watches the windows becomes unclear, since that a search function in the watch window would be cool. In addition it is diserable to have multiple watch windows to group some variables in "categories". The name of the watch windows should be editable.

== Write Access to Register, Memory ==
Sometimes it is necessary to modify controller registers of values in the memory, therefore the memory and register view should provide a feature modify he content.

== Special Function Register ==
Architectures like PowerPC or TriCore have tousands of Special Functions Registers, which are not convenient to display them in the debugger. A browse dialogue for special funcions registers would simplify life.

== Multiple Debugger Instances ==
In embedded applications it is necessary to debug different projects (AVR, PowerPC etc.) simultaneously. For this reason the debugger mustn't be stopped when switching between projects.

== Memory Consumption ==
A bar/gauge view of the allocated memory in different output sections.

== Squirell Debug ==
Squirell scripts provide a simple mechanism to add functionality to CodeBlocks. The possibility to debug these scripts in CodeBlocks would be nice.

Wizard Page Events

2007-12-10T09:10:28Z

Mandrav: Documentation of OnClick()

[[Category:Scripting Code::Blocks]]
A script can handle various wizard events while the wizard is running. This page explains these events (and their uses) in detail.

== Page IDs ==
Every wizard page (pre-defined or custom) has a unique page ID. This ID is a wxString that identifies the page in scripts.

These are the valid pre-defined page IDs:

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Page || ID
|-
|Intro || "IntroPage"
|-
|File selection|| "FilePathPage"
|-
|Project settings|| "ProjectPathPage"
|-
|Compiler || "CompilerPage"
|-
|Build target || "BuildTargetPage"
|-
|Generic path ||
|-
|Generic single choice list ||
|}

You 'll notice that the two last pre-defined pages don't have an ID. This is because you can have more than one of them inside the same wizard and so the IDs wouldn't be unique anymore.

For these two pages, the ID is the first argument passed to their creation calls.
See [[Wizard Scripting Commands#AddGenericSelectPathPage(pageId, descr, label, defValue)|AddGenericSelectPathPage]] and [[Wizard Scripting Commands#AddGenericSingleChoiceListPage(pageId, descr, choices, defChoice)|AddGenericSingleChoiceListPage]] syntax.

You can give these two pages any ID you want but make sure it's unique. Besides the obvious reasons why it should be unique, the page ID is also used by various wizard pages to store per-page user selections inside the Code::Blocks configuration. So a duplicate ID will save under the same configuration key...

== Events ==
Now that we 've seen what page IDs are, we can talk about wizard script events.

To make a script handle a wizard event, you must create a script function with a special name to handle this event. All event functions must follow the same naming conventions:

* First is the event name
* An underscore follows
* And finally the page ID

Look in the events documentation below. Each event contains sample code.

=== OnEnter(forward) ===
Fired just before a page is displayed by the wizard. The script can initialize the page contents in this event.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return type || Value
|-
|void || -
|}

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Parameter || Type || Description
|-
|forward || bool || If true, the page entered after the user clicked "Next". If false, the user had clicked "Back".
|}

'''Sample:'''
function OnEnter_CompilerPage(forward)
{
// we only care to initialize if going forward
if (forward)
{
// do something?
}
}

=== OnLeave(forward) ===
Fired just before a page is changed to another. This is a very useful event because the script can assign the page contents to variables.

Inside this event, the script has the ability to abort the page change. So, for example, the script can check the values the user entered and abort the page from changing if it detects incorrect values.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return type || Value
|-
|bool || If this function returns true, the page is allowed to change. If it returns false, the change is aborted (the wizard stays in the same page).
|}

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Parameter || Type || Description
|-
|forward || bool || If true, the page entered after the user clicked "Next". If false, the user had clicked "Back".
|}

'''Sample:'''
function OnLeave_MyXRCPanel(forward)
{
// we only care to check validity if going forward
if (forward)
{
local userName = Wizard.GetTextControlValue("txtUserName");
if (userName.IsEmpty())
{
ShowWarning(_T("You must enter a username!"));
return false; // abort the page change
}
}
return true; // all is well
}

=== OnGetPrevPage() ===
In various times through the wizard's lifetime, it fires this event so that the wizard knows which page is "chained" before the current page.

Using this event, a script can dynamically alter the pages order (possibly based on user selections).

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return type || Value
|-
|wxString || The previous page's ID
|}

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Parameter || Type || Description
|-
| - || - || -
|}

''NOTE: if the script returns an empty (or non-existent) page ID, the wizard assumes this is the first page (i.e. no previous page).''

'''Sample:'''
// assume we have the following pages in the wizard:
// Intro
// Project settings
// Single choice list (1)
// Select path for libfoo (2)
// Compiler selection (3)
//
// and we want to skip the libfoo path selection (2) based on user
// selection in the single choice list (1)
//
// for this to work, we need to create two event functions:
// OnGetNextPage for the choice list (1) and
// OnGetPrevPage for the compiler selection (3) and
// so that we can "jump over" the libfoo path selection page (2)

// we need a global var to keep the user's selection
ChoiceSelection <- 0;

function OnGetNextPage_MyChoiceList()
{
ChoiceSelection = Wizard.GetListboxSelection(_T("lstSelection"));
if (ChoiceSelection == 2)
{
// based on user's selection, we must skip the libfoo path selection page
return _T("CompilerPage"));
}
// normally, libfoo path selection follows
return _T("LibFooPath");
}

function OnGetPrevPage_CompilerPage()
{
if (ChoiceSelection == 2)
{
// based on user's selection, we must skip the libfoo path selection page
return _T("MyChoiceList"));
}
// normally, libfoo path selection is before this page
return _T("LibFooPath");
}

=== OnGetNextPage() ===
In various times through the wizard's lifetime, it fires this event so that the wizard knows which page is "chained" after the current page.

Using this event, a script can dynamically alter the pages order (possibly based on user selections).

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return type || Value
|-
|wxString || The next page's ID
|}

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Parameter || Type || Description
|-
| - || - || -
|}

''NOTE: if the script returns an empty (or non-existent) page ID, the wizard assumes this is the last page (i.e. no next page).''

See the sample in [[Wizard Page Events#OnGetPrevPage()|OnGetPrevPage]].

=== OnClick() ===
Most basic control types call OnClick when they are clicked.

Using this event, a script can respond to user choices at the time they take place. For example, one could enable/disable some controls based on a checkbox's state, right when the user clicks the said checkbox.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return type || Value
|-
| - || -
|}

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Parameter || Type || Description
|-
| - || - || -
|}

'''Sample:'''
// assume we have the following controls on the page:
// chkOption (checkbox)
// txtText (text)

function OnClick_chkOption()
{
// enable/disable the text box based on the checkbox's state
Wizard.EnableWindow(_T("txtText"), Wizard.IsCheckboxChecked(_T("chkOption"));
}

[[User:Mandrav|Mandrav]] 09:10, 10 December 2007 (UTC)

Code::Blocks SDK events

2007-12-05T13:58:40Z

Mandrav: /* Events that must be registered with RegisterEventSink */

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
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.''

=== 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 3 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), 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), 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 cbFunctorBase<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 :).

'''Important note:''' For various reasons, cbEVT_PIPEDPROCESS* and cbEVT_THREADEDTASK* events should still be bound using the old way (i.e. by adding event table entries). If this is changed in the future, this article will be updated accordingly.

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

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

==== Events that must be registered with RegisterEventSink ====
''app events''
* cbEVT_APP_STARTUP_DONE
* cbEVT_APP_START_SHUTDOWN
* <strike>cbEVT_APP_UPDATE_TITLE</strike> (removed)

''plugin events'' (CodeBlocksEvent)
* cbEVT_PLUGIN_ATTACHED
* cbEVT_PLUGIN_RELEASED
* cbEVT_PLUGIN_INSTALLED
* cbEVT_PLUGIN_UNINSTALLED

''editor events'' (CodeBlocksEvent)
* cbEVT_EDITOR_CLOSE
* cbEVT_EDITOR_OPEN
* cbEVT_EDITOR_ACTIVATED
* cbEVT_EDITOR_DEACTIVATED
* cbEVT_EDITOR_SAVE
* cbEVT_EDITOR_MODIFIED
* cbEVT_EDITOR_TOOLTIP
* cbEVT_EDITOR_TOOLTIP_CANCEL
* cbEVT_EDITOR_BREAKPOINT_ADD
* cbEVT_EDITOR_BREAKPOINT_EDIT
* cbEVT_EDITOR_BREAKPOINT_DELETE
* cbEVT_EDITOR_UPDATE_UI

''project events'' (CodeBlocksEvent)
* 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_POPUP_MENU
* cbEVT_PROJECT_TARGETS_MODIFIED
* cbEVT_PROJECT_RENAMED
* cbEVT_WORKSPACE_CHANGED

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

''debugger-related events'' (CodeBlocksEvent)
* cbEVT_DEBUGGER_STARTED
* cbEVT_DEBUGGER_PAUSED
* cbEVT_DEBUGGER_FINISHED

''logging-system related events'' (CodeBlocksLogEvent)
* cbEVT_ADD_LOG_WINDOW: add a log window
* cbEVT_REMOVE_LOG_WINDOW: remove a log window
* cbEVT_SWITCH_TO_LOG_WINDOW: switch to a log window (make it visible)
* 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)

''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
* cbEVT_DOCK_WINDOW_VISIBILITY: app notifies that a docked window has been hidden/shown to actually find out its state use IsWindowReallyShown(event.pWindow);

''layout related events'' (CodeBlocksLayoutEvent)
* cbEVT_SWITCH_VIEW_LAYOUT: request app to switch view layout
* cbEVT_SWITCHED_VIEW_LAYOUT: app notifies that a new layout has been applied

==== Events processed on wxWidgets event tables and '''not''' registered using RegisterEventSink ====
''pipedprocess events'' (CodeBlocksEvent)
* cbEVT_PIPEDPROCESS_STDOUT
* cbEVT_PIPEDPROCESS_STDERR
* cbEVT_PIPEDPROCESS_TERMINATED

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

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

Code::Blocks SDK events

2007-11-23T10:31:26Z

Mandrav: Added logging-system events

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
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.''

=== 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 3 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), 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), 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 cbFunctorBase<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 :).

'''Important note:''' For various reasons, cbEVT_PIPEDPROCESS* and cbEVT_THREADEDTASK* events should still be bound using the old way (i.e. by adding event table entries). If this is changed in the future, this article will be updated accordingly.

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

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

==== Events that must be registered with RegisterEventSink ====
''app events''
* cbEVT_APP_STARTUP_DONE
* cbEVT_APP_START_SHUTDOWN
* cbEVT_APP_UPDATE_TITLE

''plugin events'' (CodeBlocksEvent)
* cbEVT_PLUGIN_ATTACHED
* cbEVT_PLUGIN_RELEASED
* cbEVT_PLUGIN_INSTALLED
* cbEVT_PLUGIN_UNINSTALLED

''editor events'' (CodeBlocksEvent)
* cbEVT_EDITOR_CLOSE
* cbEVT_EDITOR_OPEN
* cbEVT_EDITOR_ACTIVATED
* cbEVT_EDITOR_DEACTIVATED
* cbEVT_EDITOR_SAVE
* cbEVT_EDITOR_MODIFIED
* cbEVT_EDITOR_TOOLTIP
* cbEVT_EDITOR_TOOLTIP_CANCEL
* cbEVT_EDITOR_BREAKPOINT_ADD
* cbEVT_EDITOR_BREAKPOINT_EDIT
* cbEVT_EDITOR_BREAKPOINT_DELETE
* cbEVT_EDITOR_UPDATE_UI

''project events'' (CodeBlocksEvent)
* cbEVT_PROJECT_CLOSE
* cbEVT_PROJECT_OPEN
* cbEVT_PROJECT_SAVE
* cbEVT_PROJECT_ACTIVATE
* cbEVT_PROJECT_FILE_ADDED
* cbEVT_PROJECT_FILE_REMOVED
* cbEVT_PROJECT_POPUP_MENU
* cbEVT_PROJECT_TARGETS_MODIFIED
* cbEVT_PROJECT_RENAMED
* cbEVT_WORKSPACE_CHANGED

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

''debugger-related events'' (CodeBlocksEvent)
* cbEVT_DEBUGGER_STARTED
* cbEVT_DEBUGGER_PAUSED
* cbEVT_DEBUGGER_FINISHED

''logging-system related events'' (CodeBlocksLogEvent)
* cbEVT_ADD_LOG_WINDOW: add a log window
* cbEVT_REMOVE_LOG_WINDOW: remove a log window
* cbEVT_SWITCH_TO_LOG_WINDOW: switch to a log window (make it visible)
* 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)

''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
* cbEVT_DOCK_WINDOW_VISIBILITY: app notifies that a docked window has been hidden/shown to actually find out its state use IsWindowReallyShown(event.pWindow);

''layout related events'' (CodeBlocksLayoutEvent)
* cbEVT_SWITCH_VIEW_LAYOUT: request app to switch view layout
* cbEVT_SWITCHED_VIEW_LAYOUT: app notifies that a new layout has been applied

==== Events processed on wxWidgets event tables and '''not''' registered using RegisterEventSink ====
''pipedprocess events'' (CodeBlocksEvent)
* cbEVT_PIPEDPROCESS_STDOUT
* cbEVT_PIPEDPROCESS_STDERR
* cbEVT_PIPEDPROCESS_TERMINATED

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

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

Developer documentation

2007-11-23T10:19:54Z

Mandrav: Link to manuals

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
Articles for Code::Blocks developers.

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

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

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

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

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

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

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

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

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

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

* '''Documentation'''
:[https://www.codeblocks.org/manual.shtml User's manual] in various formats and languages.
:Also see http://developer.berlios.de/projects/codeblocks/ (under the downloads section).

== Plug-In development ==

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

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

* [[wxSmith extensions]]

== Scripting ==

Using scripting to extend Code::Blocks' functionality

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

Comparison of wxSmith features

2007-11-22T13:29:58Z

Mandrav: /* Features supported */ Updated supported features for wxSmith

[[Category:wxSmith Documentation]]
Here is a list of [[wxSmith]] features when compared to other [[wikipedia:WxWidgets|wxWidgets]] [[wikipedia:Rapid application development|RAD]] solutions.

Note that support for new features are added on a daily basis for some of these [[wikipedia:Rapid application development|RADs]].

Please update this list when something gets added.

==General information==
Basic general information about the [[wikipedia:Rapid application development|RADs]]: developer, license/price etc.
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 100%;"
|- style="background: #ececec; border: solid 1px gray;"
! style="width:12em" | [[wikipedia:Rapid application development|RAD]]
! Developer
! Cost ([[wikipedia:United States dollar|USD]])
! [[wikipedia:Open source|Open source]]
! [[wikipedia:Software licence|Software licence]]
|- style="border: solid 1px gray;"
! style="text-align: left; background: #ececec;" | [[wxSmith]]
| Bartlomiej Swiecki
| Free
| Yes
| [[wikipedia:GNU General Public License|GPL]]
|- style="border: solid 1px gray;"
! style="text-align: left; background: #ececec;" | [http://www.anthemion.co.uk/dialogblocks/ DialogBlocks]
| Julian Smart
| Free (trial), €66 (normal), €35 (student)
| No
| [[wikipedia:Proprietary software|Proprietary]]
|- style="border: solid 1px gray;"
! style="text-align: left; background: #ececec;" | [http://www.roebling.de/ wxDesigner]
| Robert Roebling
| Free (trial), €129 (normal), €29 (student)
| No
| [[wikipedia:Proprietary software|Proprietary]]
|- style="border: solid 1px gray;"
! style="text-align: left; background: #ececec;" | [http://wxformbuilder.org/ wxFormBuilder]
| José Antonio Hurtado, Juan Antonio Ortega, Ryan Mulder, Ryan Pusztai
| Free
| Yes
| [[wikipedia:GNU General Public License|GPL]]
|- style="border: solid 1px gray;"
! style="text-align: left; background: #ececec;" | [http://visualwx.altervista.org/ VisualWx]
| {{dunno}}
| Free
| No
| {{dunno}}
|- style="border: solid 1px gray;"
! style="text-align: left; background: #ececec;" | [http://wxdsgn.sf.net/ wxDevC++]
| Guru Kathiresan , Tony Reina, Malcolm Nealon, Joel Low
| Free
| Yes
| [[wikipedia:GNU General Public License|GPL]]
|- style="border: solid 1px gray;"
! style="text-align: left; background: #ececec;" | [http://twinforms.com/wxforms-home.htm wxForms]
| Guru Kathiresan
| Free (trial), $29.99
| No
| [[wikipedia:Proprietary software|Proprietary]]
|- style="background: #ececec; border: solid 1px gray;"
! [[wikipedia:Rapid application development|RAD]]
! Developer
! Cost ([[wikipedia:United States dollar|USD]])
! [[wikipedia:Open source|Open source]]
! [[wikipedia:Software licence|Software licence]]
|-
|}

==Widgets supported==
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 100%; table-layout: fixed;"
|- style="background: #ececec;"
! style="width: 12em" | Widget
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wxDevC++
! wxForms
|-
! style="text-align: left; background: #ececec;" | wxAuiNotebook
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxBitmapButton
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxBoxSizer
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxButton
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxCalendarCtrl
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxCheckBox
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxCheckListBox
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxChoice
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxChoicebook
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxColourDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxColourPicker
| {{dunno}}
| {{dunno}}
| {{dunno}}
| {{yes}}
| {{dunno}}
| {{dunno}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxComboBox
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxContextHelpButton
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxDatePickerCtrl
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxDialUpManager
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxDirDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxDirPicker
| {{dunno}}
| {{dunno}}
| {{dunno}}
| {{yes}}
| {{dunno}}
| {{dunno}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxDynamicSashWindow
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxFlexGridSizer
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxFileDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxFilePicker
| {{dunno}}
| {{dunno}}
| {{dunno}}
| {{yes}}
| {{dunno}}
| {{dunno}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxFindReplaceDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxFontDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxFontPicker
| {{dunno}}
| {{dunno}}
| {{dunno}}
| {{yes}}
| {{dunno}}
| {{dunno}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxGauge
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxGenericDirCtrl
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxGrid
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxGridBagSizer
| {{no}}
| {{yes}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxGridSizer
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxHtmlEasyPrinting
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxHtmlListBox
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxHtmlWindow
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxHyperLinkCtrl
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxListbook
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxListBox
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxListCtrl
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxListView
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxMediaCtrl
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxMenu
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxMessageDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxMultiChoiceDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxNotebook
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxOwnerDrawnComboBox
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxPanel
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxPasswordEntryDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxPrintDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxProgressDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxPropertySheetDialog
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxRadioBox
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxRadioButton
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxRichTextCtrl
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxSashLayoutWindow
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxSashWindow
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxScrollBar
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxScrolledWindow
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxSingleChoiceDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxSlider
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxSpacer
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxSpinButton
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxSpinCtrl
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxSplitterWindow
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxStaticBitmap
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxStaticBox
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxStaticBoxSizer
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxStaticLine
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxStaticText
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxStatusBar
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxStdDialogButtonSizer
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{no}}
| {{yes}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxTextCtrl
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxTextEntryDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxToggleButton
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxToolbar
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxTreebook
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxTreeCtrl
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxVListBox
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxVScrolledWindow
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxWindow (Foreign)
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxWizardPage
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|- style="background: #ececec;"
! Widget
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wx-DevC++
! wxForms
|-
|}

==Contrib widgets supported==
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 100%; table-layout: fixed;"
|- style="background: #ececec;"
! style="width: 12em" | Widget
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wxDevC++
! wxForms
|-
! style="text-align: left; background: #ececec;" | awxLed
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxEditableListBox
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxFlatNotebook
| {{yes}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxLEDNumberCtrl
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxPlotCtrl
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxPlotWindow
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxPropertyGrid
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxPropertyGridManager
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxScintilla
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxStyledTextCtrl
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxTreeListCtrl
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
|- style="background: #ececec;"
! Widget
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wxDevC++
! wxForms
|-
|}

==Languages supported==
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 100%; table-layout: fixed;"
|- style="background: #ececec;"
! style="width: 12em" | Feature
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wxDevC++
! wxForms
|-
! style="text-align: left; background: #ececec;" | C++ code output
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | Python code output
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Lua code output
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Ruby code output
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Perl code output
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | C# code output
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Basic code output
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|- style="background: #ececec;"
! Feature
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wxDevC++
! wxForms
|-
|}

==Features supported==
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 100%; table-layout: fixed;"
|- style="background: #ececec;"
! style="width: 12em" | Feature
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wxDevC++
! wxForms
|-
! style="text-align: left; background: #ececec;" | XRC input
| {{yes}}{{refun|XRCnotworks}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | XRC output
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | XRC code loading
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{dunno}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Validators{{refun|Validators}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | Conditional UI{{refun|ConditionalUI}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Event table and handler generation{{refun|EventTable}}
| {{yes}}
| {{yes}}
| {{partial}}
| {{yes}}
| {{partial}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | Bitmaps support{{refun|Bitmaps}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{partial}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | English descriptions{{refun|EnglishDesc}}
| {{no}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Easy access to window pointers{{refun|WindowPointers}}
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{dunno}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | Visually creating custom controls
| {{partial}}
| {{yes}}
| {{partial}}
| {{partial}}
| {{partial}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Template controls{{refun|TemplateControls}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Sizer design
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | Non-sizer design
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
|- style="background: #ececec;"
! Feature
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wxDevC++
! wxForms
|-
|}

*{{note|XRCnotworks}} Currently, only one dialog resource per XRC file is imported.

=== Features explained ===

==== {{note|Validators}}Validators ====

The aim of the validator concept is to make dialogs very much easier to write. A validator is an object that can be plugged into a control (such as a wxTextCtrl), and mediates between C++ data and the control, transferring the data in either direction and validating it. It also is able to intercept events generated by the control, providing filtering behaviour without the need to derive a new control class.

How to use validators in a RAD that supports this concept: Just add a variable, select the variable and a validator, and the data transfer between variable and control is done for you.

==== {{note|ConditionalUI}}Conditional UI ====

It's the ability to adapt the user interface to the UI guidelines of different platform.

Just mark elements as for one platform (or several), and preview the look for any given platform.

[[Image:Conditional ui.PNG|Example of how it looks on DialogBlocks]]

==== {{note|EventTable}}Event table and handler generation ====

The RAD generates the event tables and empty handlers (including UI update handlers) so you can immediately concentrate on writing code to make the dialog come to life.

It includes a choice of event types for each window, with function name editing.

'''DialogBlocks Event Handler'''

Here DialogBlocks haves the list of event handlers.

The most noticeable feature here is that if you do a double-click on a event, you're transported to the function associated in the code. It's very handy.

[[Image:Event handler dialogblocks.PNG|Event Tables in DialogBlocks]]

'''VisualWx Event Handler'''

Here VisualWx filters the events:
* Base wxWidgets Events
* Component Events
* Windows Events
* VisualWx Events
* Custom Events

[[Image:Event handler visualwx.PNG|Event Tables in VisualWx]]

==== {{note|Bitmaps}}Bitmap support ====

Bitmaps support means that you can import images into your project from a variety of formats and associate them with your static bitmap and bitmap button controls.

You can specify whether the bitmaps will converted into XPM format (the standard format for small bitmaps in wxWidgets) and whether the XPM image will be inserted as inline C++ code, or loaded from a file.

==== {{note|EnglishDesc}}English descriptions ====

English descriptions show a brief description of each element, to help you get used to sizers and also to make it easier to see at a glance the important aspects of your dialog element.

[[Image:Rad english descriptions.PNG|An example of DialogBlocks English descriptions]]

==== {{note|WindowPointers}}Easy access to window pointers ====

The ''easy access to window pointers'' concept means:

Give each window a variable name, and the RAD will add the name to the class declaration, and initialise it to the appropriate window in the implementation.

In XRC mode, the RAD can generate the code to find the window and assign it to the pointer variable.

==== {{note|TemplateControls}}Template controls ====

Template controls are sets of most common widgets together, like an Ok/Cancel pair buttons inside a sizer, being user-definable.

Comparison of wxSmith features

2007-11-22T13:25:42Z

Mandrav: /* Contrib widgets supported */ Updated wxFlatNoteBook support for wxSmith

[[Category:wxSmith Documentation]]
Here is a list of [[wxSmith]] features when compared to other [[wikipedia:WxWidgets|wxWidgets]] [[wikipedia:Rapid application development|RAD]] solutions.

Note that support for new features are added on a daily basis for some of these [[wikipedia:Rapid application development|RADs]].

Please update this list when something gets added.

==General information==
Basic general information about the [[wikipedia:Rapid application development|RADs]]: developer, license/price etc.
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 100%;"
|- style="background: #ececec; border: solid 1px gray;"
! style="width:12em" | [[wikipedia:Rapid application development|RAD]]
! Developer
! Cost ([[wikipedia:United States dollar|USD]])
! [[wikipedia:Open source|Open source]]
! [[wikipedia:Software licence|Software licence]]
|- style="border: solid 1px gray;"
! style="text-align: left; background: #ececec;" | [[wxSmith]]
| Bartlomiej Swiecki
| Free
| Yes
| [[wikipedia:GNU General Public License|GPL]]
|- style="border: solid 1px gray;"
! style="text-align: left; background: #ececec;" | [http://www.anthemion.co.uk/dialogblocks/ DialogBlocks]
| Julian Smart
| Free (trial), €66 (normal), €35 (student)
| No
| [[wikipedia:Proprietary software|Proprietary]]
|- style="border: solid 1px gray;"
! style="text-align: left; background: #ececec;" | [http://www.roebling.de/ wxDesigner]
| Robert Roebling
| Free (trial), €129 (normal), €29 (student)
| No
| [[wikipedia:Proprietary software|Proprietary]]
|- style="border: solid 1px gray;"
! style="text-align: left; background: #ececec;" | [http://wxformbuilder.org/ wxFormBuilder]
| José Antonio Hurtado, Juan Antonio Ortega, Ryan Mulder, Ryan Pusztai
| Free
| Yes
| [[wikipedia:GNU General Public License|GPL]]
|- style="border: solid 1px gray;"
! style="text-align: left; background: #ececec;" | [http://visualwx.altervista.org/ VisualWx]
| {{dunno}}
| Free
| No
| {{dunno}}
|- style="border: solid 1px gray;"
! style="text-align: left; background: #ececec;" | [http://wxdsgn.sf.net/ wxDevC++]
| Guru Kathiresan , Tony Reina, Malcolm Nealon, Joel Low
| Free
| Yes
| [[wikipedia:GNU General Public License|GPL]]
|- style="border: solid 1px gray;"
! style="text-align: left; background: #ececec;" | [http://twinforms.com/wxforms-home.htm wxForms]
| Guru Kathiresan
| Free (trial), $29.99
| No
| [[wikipedia:Proprietary software|Proprietary]]
|- style="background: #ececec; border: solid 1px gray;"
! [[wikipedia:Rapid application development|RAD]]
! Developer
! Cost ([[wikipedia:United States dollar|USD]])
! [[wikipedia:Open source|Open source]]
! [[wikipedia:Software licence|Software licence]]
|-
|}

==Widgets supported==
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 100%; table-layout: fixed;"
|- style="background: #ececec;"
! style="width: 12em" | Widget
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wxDevC++
! wxForms
|-
! style="text-align: left; background: #ececec;" | wxAuiNotebook
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxBitmapButton
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxBoxSizer
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxButton
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxCalendarCtrl
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxCheckBox
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxCheckListBox
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxChoice
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxChoicebook
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxColourDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxColourPicker
| {{dunno}}
| {{dunno}}
| {{dunno}}
| {{yes}}
| {{dunno}}
| {{dunno}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxComboBox
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxContextHelpButton
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxDatePickerCtrl
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxDialUpManager
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxDirDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxDirPicker
| {{dunno}}
| {{dunno}}
| {{dunno}}
| {{yes}}
| {{dunno}}
| {{dunno}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxDynamicSashWindow
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxFlexGridSizer
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxFileDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxFilePicker
| {{dunno}}
| {{dunno}}
| {{dunno}}
| {{yes}}
| {{dunno}}
| {{dunno}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxFindReplaceDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxFontDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxFontPicker
| {{dunno}}
| {{dunno}}
| {{dunno}}
| {{yes}}
| {{dunno}}
| {{dunno}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxGauge
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxGenericDirCtrl
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxGrid
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxGridBagSizer
| {{no}}
| {{yes}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxGridSizer
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxHtmlEasyPrinting
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxHtmlListBox
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxHtmlWindow
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxHyperLinkCtrl
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxListbook
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxListBox
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxListCtrl
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxListView
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxMediaCtrl
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxMenu
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxMessageDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxMultiChoiceDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxNotebook
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxOwnerDrawnComboBox
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxPanel
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxPasswordEntryDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxPrintDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxProgressDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxPropertySheetDialog
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxRadioBox
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxRadioButton
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxRichTextCtrl
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxSashLayoutWindow
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxSashWindow
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxScrollBar
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxScrolledWindow
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxSingleChoiceDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxSlider
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxSpacer
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxSpinButton
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxSpinCtrl
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxSplitterWindow
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxStaticBitmap
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxStaticBox
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxStaticBoxSizer
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxStaticLine
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxStaticText
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxStatusBar
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxStdDialogButtonSizer
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{no}}
| {{yes}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxTextCtrl
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxTextEntryDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxToggleButton
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxToolbar
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxTreebook
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxTreeCtrl
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxVListBox
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxVScrolledWindow
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxWindow (Foreign)
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxWizardPage
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|- style="background: #ececec;"
! Widget
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wx-DevC++
! wxForms
|-
|}

==Contrib widgets supported==
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 100%; table-layout: fixed;"
|- style="background: #ececec;"
! style="width: 12em" | Widget
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wxDevC++
! wxForms
|-
! style="text-align: left; background: #ececec;" | awxLed
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxEditableListBox
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxFlatNotebook
| {{yes}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxLEDNumberCtrl
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxPlotCtrl
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxPlotWindow
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxPropertyGrid
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxPropertyGridManager
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxScintilla
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxStyledTextCtrl
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxTreeListCtrl
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
|- style="background: #ececec;"
! Widget
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wxDevC++
! wxForms
|-
|}

==Languages supported==
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 100%; table-layout: fixed;"
|- style="background: #ececec;"
! style="width: 12em" | Feature
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wxDevC++
! wxForms
|-
! style="text-align: left; background: #ececec;" | C++ code output
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | Python code output
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Lua code output
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Ruby code output
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Perl code output
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | C# code output
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Basic code output
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|- style="background: #ececec;"
! Feature
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wxDevC++
! wxForms
|-
|}

==Features supported==
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 100%; table-layout: fixed;"
|- style="background: #ececec;"
! style="width: 12em" | Feature
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wxDevC++
! wxForms
|-
! style="text-align: left; background: #ececec;" | XRC input
| {{yes}}{{refun|XRCnotworks}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | XRC output
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | XRC code loading
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{dunno}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Validators{{refun|Validators}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | Conditional UI{{refun|ConditionalUI}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Event table and handler generation{{refun|EventTable}}
| {{partial}}
| {{yes}}
| {{partial}}
| {{yes}}
| {{partial}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | Bitmaps support{{refun|Bitmaps}}
| {{no}}
| {{yes}}
| {{yes}}
| {{partial}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | English descriptions{{refun|EnglishDesc}}
| {{no}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Easy access to window pointers{{refun|WindowPointers}}
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{dunno}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | Visually creating custom controls
| {{partial}}
| {{yes}}
| {{partial}}
| {{partial}}
| {{partial}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Template controls{{refun|TemplateControls}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Sizer design
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | Non-sizer design
| {{partial}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
|- style="background: #ececec;"
! Feature
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wxDevC++
! wxForms
|-
|}

*{{note|XRCnotworks}} Currently, only one dialog resource per XRC file is imported.

=== Features explained ===

==== {{note|Validators}}Validators ====

The aim of the validator concept is to make dialogs very much easier to write. A validator is an object that can be plugged into a control (such as a wxTextCtrl), and mediates between C++ data and the control, transferring the data in either direction and validating it. It also is able to intercept events generated by the control, providing filtering behaviour without the need to derive a new control class.

How to use validators in a RAD that supports this concept: Just add a variable, select the variable and a validator, and the data transfer between variable and control is done for you.

==== {{note|ConditionalUI}}Conditional UI ====

It's the ability to adapt the user interface to the UI guidelines of different platform.

Just mark elements as for one platform (or several), and preview the look for any given platform.

[[Image:Conditional ui.PNG|Example of how it looks on DialogBlocks]]

==== {{note|EventTable}}Event table and handler generation ====

The RAD generates the event tables and empty handlers (including UI update handlers) so you can immediately concentrate on writing code to make the dialog come to life.

It includes a choice of event types for each window, with function name editing.

'''DialogBlocks Event Handler'''

Here DialogBlocks haves the list of event handlers.

The most noticeable feature here is that if you do a double-click on a event, you're transported to the function associated in the code. It's very handy.

[[Image:Event handler dialogblocks.PNG|Event Tables in DialogBlocks]]

'''VisualWx Event Handler'''

Here VisualWx filters the events:
* Base wxWidgets Events
* Component Events
* Windows Events
* VisualWx Events
* Custom Events

[[Image:Event handler visualwx.PNG|Event Tables in VisualWx]]

==== {{note|Bitmaps}}Bitmap support ====

Bitmaps support means that you can import images into your project from a variety of formats and associate them with your static bitmap and bitmap button controls.

You can specify whether the bitmaps will converted into XPM format (the standard format for small bitmaps in wxWidgets) and whether the XPM image will be inserted as inline C++ code, or loaded from a file.

==== {{note|EnglishDesc}}English descriptions ====

English descriptions show a brief description of each element, to help you get used to sizers and also to make it easier to see at a glance the important aspects of your dialog element.

[[Image:Rad english descriptions.PNG|An example of DialogBlocks English descriptions]]

==== {{note|WindowPointers}}Easy access to window pointers ====

The ''easy access to window pointers'' concept means:

Give each window a variable name, and the RAD will add the name to the class declaration, and initialise it to the appropriate window in the implementation.

In XRC mode, the RAD can generate the code to find the window and assign it to the pointer variable.

==== {{note|TemplateControls}}Template controls ====

Template controls are sets of most common widgets together, like an Ok/Cancel pair buttons inside a sizer, being user-definable.

Comparison of wxSmith features

2007-11-22T13:24:30Z

Mandrav: /* Widgets supported */ Updated wxBitmapButton and wxGrid status for wxSmith

[[Category:wxSmith Documentation]]
Here is a list of [[wxSmith]] features when compared to other [[wikipedia:WxWidgets|wxWidgets]] [[wikipedia:Rapid application development|RAD]] solutions.

Note that support for new features are added on a daily basis for some of these [[wikipedia:Rapid application development|RADs]].

Please update this list when something gets added.

==General information==
Basic general information about the [[wikipedia:Rapid application development|RADs]]: developer, license/price etc.
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 100%;"
|- style="background: #ececec; border: solid 1px gray;"
! style="width:12em" | [[wikipedia:Rapid application development|RAD]]
! Developer
! Cost ([[wikipedia:United States dollar|USD]])
! [[wikipedia:Open source|Open source]]
! [[wikipedia:Software licence|Software licence]]
|- style="border: solid 1px gray;"
! style="text-align: left; background: #ececec;" | [[wxSmith]]
| Bartlomiej Swiecki
| Free
| Yes
| [[wikipedia:GNU General Public License|GPL]]
|- style="border: solid 1px gray;"
! style="text-align: left; background: #ececec;" | [http://www.anthemion.co.uk/dialogblocks/ DialogBlocks]
| Julian Smart
| Free (trial), €66 (normal), €35 (student)
| No
| [[wikipedia:Proprietary software|Proprietary]]
|- style="border: solid 1px gray;"
! style="text-align: left; background: #ececec;" | [http://www.roebling.de/ wxDesigner]
| Robert Roebling
| Free (trial), €129 (normal), €29 (student)
| No
| [[wikipedia:Proprietary software|Proprietary]]
|- style="border: solid 1px gray;"
! style="text-align: left; background: #ececec;" | [http://wxformbuilder.org/ wxFormBuilder]
| José Antonio Hurtado, Juan Antonio Ortega, Ryan Mulder, Ryan Pusztai
| Free
| Yes
| [[wikipedia:GNU General Public License|GPL]]
|- style="border: solid 1px gray;"
! style="text-align: left; background: #ececec;" | [http://visualwx.altervista.org/ VisualWx]
| {{dunno}}
| Free
| No
| {{dunno}}
|- style="border: solid 1px gray;"
! style="text-align: left; background: #ececec;" | [http://wxdsgn.sf.net/ wxDevC++]
| Guru Kathiresan , Tony Reina, Malcolm Nealon, Joel Low
| Free
| Yes
| [[wikipedia:GNU General Public License|GPL]]
|- style="border: solid 1px gray;"
! style="text-align: left; background: #ececec;" | [http://twinforms.com/wxforms-home.htm wxForms]
| Guru Kathiresan
| Free (trial), $29.99
| No
| [[wikipedia:Proprietary software|Proprietary]]
|- style="background: #ececec; border: solid 1px gray;"
! [[wikipedia:Rapid application development|RAD]]
! Developer
! Cost ([[wikipedia:United States dollar|USD]])
! [[wikipedia:Open source|Open source]]
! [[wikipedia:Software licence|Software licence]]
|-
|}

==Widgets supported==
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 100%; table-layout: fixed;"
|- style="background: #ececec;"
! style="width: 12em" | Widget
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wxDevC++
! wxForms
|-
! style="text-align: left; background: #ececec;" | wxAuiNotebook
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxBitmapButton
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxBoxSizer
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxButton
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxCalendarCtrl
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxCheckBox
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxCheckListBox
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxChoice
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxChoicebook
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxColourDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxColourPicker
| {{dunno}}
| {{dunno}}
| {{dunno}}
| {{yes}}
| {{dunno}}
| {{dunno}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxComboBox
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxContextHelpButton
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxDatePickerCtrl
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxDialUpManager
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxDirDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxDirPicker
| {{dunno}}
| {{dunno}}
| {{dunno}}
| {{yes}}
| {{dunno}}
| {{dunno}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxDynamicSashWindow
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxFlexGridSizer
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxFileDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxFilePicker
| {{dunno}}
| {{dunno}}
| {{dunno}}
| {{yes}}
| {{dunno}}
| {{dunno}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxFindReplaceDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxFontDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxFontPicker
| {{dunno}}
| {{dunno}}
| {{dunno}}
| {{yes}}
| {{dunno}}
| {{dunno}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxGauge
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxGenericDirCtrl
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxGrid
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxGridBagSizer
| {{no}}
| {{yes}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxGridSizer
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxHtmlEasyPrinting
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxHtmlListBox
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxHtmlWindow
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxHyperLinkCtrl
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxListbook
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxListBox
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxListCtrl
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxListView
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxMediaCtrl
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxMenu
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxMessageDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxMultiChoiceDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxNotebook
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxOwnerDrawnComboBox
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxPanel
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxPasswordEntryDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxPrintDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxProgressDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxPropertySheetDialog
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxRadioBox
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxRadioButton
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxRichTextCtrl
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxSashLayoutWindow
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxSashWindow
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxScrollBar
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxScrolledWindow
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxSingleChoiceDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxSlider
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxSpacer
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxSpinButton
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxSpinCtrl
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxSplitterWindow
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxStaticBitmap
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxStaticBox
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxStaticBoxSizer
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxStaticLine
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxStaticText
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxStatusBar
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxStdDialogButtonSizer
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{no}}
| {{yes}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxTextCtrl
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxTextEntryDialog
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxToggleButton
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxToolbar
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxTreebook
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxTreeCtrl
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | wxVListBox
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxVScrolledWindow
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxWindow (Foreign)
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxWizardPage
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|- style="background: #ececec;"
! Widget
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wx-DevC++
! wxForms
|-
|}

==Contrib widgets supported==
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 100%; table-layout: fixed;"
|- style="background: #ececec;"
! style="width: 12em" | Widget
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wxDevC++
! wxForms
|-
! style="text-align: left; background: #ececec;" | awxLed
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxEditableListBox
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxFlatNotebook
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxLEDNumberCtrl
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxPlotCtrl
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxPlotWindow
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxPropertyGrid
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxPropertyGridManager
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxScintilla
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxStyledTextCtrl
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | wxTreeListCtrl
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
|- style="background: #ececec;"
! Widget
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wxDevC++
! wxForms
|-
|}

==Languages supported==
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 100%; table-layout: fixed;"
|- style="background: #ececec;"
! style="width: 12em" | Feature
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wxDevC++
! wxForms
|-
! style="text-align: left; background: #ececec;" | C++ code output
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | Python code output
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Lua code output
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Ruby code output
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Perl code output
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | C# code output
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Basic code output
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|- style="background: #ececec;"
! Feature
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wxDevC++
! wxForms
|-
|}

==Features supported==
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 100%; table-layout: fixed;"
|- style="background: #ececec;"
! style="width: 12em" | Feature
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wxDevC++
! wxForms
|-
! style="text-align: left; background: #ececec;" | XRC input
| {{yes}}{{refun|XRCnotworks}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | XRC output
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | XRC code loading
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{dunno}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Validators{{refun|Validators}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | Conditional UI{{refun|ConditionalUI}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Event table and handler generation{{refun|EventTable}}
| {{partial}}
| {{yes}}
| {{partial}}
| {{yes}}
| {{partial}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | Bitmaps support{{refun|Bitmaps}}
| {{no}}
| {{yes}}
| {{yes}}
| {{partial}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | English descriptions{{refun|EnglishDesc}}
| {{no}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Easy access to window pointers{{refun|WindowPointers}}
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{dunno}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | Visually creating custom controls
| {{partial}}
| {{yes}}
| {{partial}}
| {{partial}}
| {{partial}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Template controls{{refun|TemplateControls}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{no}}
| {{no}}
|-
! style="text-align: left; background: #ececec;" | Sizer design
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|-
! style="text-align: left; background: #ececec;" | Non-sizer design
| {{partial}}
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
| {{yes}}
|- style="background: #ececec;"
! Feature
! wxSmith
! DialogBlocks
! wxDesigner
! wxFormBuilder
! VisualWx
! wxDevC++
! wxForms
|-
|}

*{{note|XRCnotworks}} Currently, only one dialog resource per XRC file is imported.

=== Features explained ===

==== {{note|Validators}}Validators ====

The aim of the validator concept is to make dialogs very much easier to write. A validator is an object that can be plugged into a control (such as a wxTextCtrl), and mediates between C++ data and the control, transferring the data in either direction and validating it. It also is able to intercept events generated by the control, providing filtering behaviour without the need to derive a new control class.

How to use validators in a RAD that supports this concept: Just add a variable, select the variable and a validator, and the data transfer between variable and control is done for you.

==== {{note|ConditionalUI}}Conditional UI ====

It's the ability to adapt the user interface to the UI guidelines of different platform.

Just mark elements as for one platform (or several), and preview the look for any given platform.

[[Image:Conditional ui.PNG|Example of how it looks on DialogBlocks]]

==== {{note|EventTable}}Event table and handler generation ====

The RAD generates the event tables and empty handlers (including UI update handlers) so you can immediately concentrate on writing code to make the dialog come to life.

It includes a choice of event types for each window, with function name editing.

'''DialogBlocks Event Handler'''

Here DialogBlocks haves the list of event handlers.

The most noticeable feature here is that if you do a double-click on a event, you're transported to the function associated in the code. It's very handy.

[[Image:Event handler dialogblocks.PNG|Event Tables in DialogBlocks]]

'''VisualWx Event Handler'''

Here VisualWx filters the events:
* Base wxWidgets Events
* Component Events
* Windows Events
* VisualWx Events
* Custom Events

[[Image:Event handler visualwx.PNG|Event Tables in VisualWx]]

==== {{note|Bitmaps}}Bitmap support ====

Bitmaps support means that you can import images into your project from a variety of formats and associate them with your static bitmap and bitmap button controls.

You can specify whether the bitmaps will converted into XPM format (the standard format for small bitmaps in wxWidgets) and whether the XPM image will be inserted as inline C++ code, or loaded from a file.

==== {{note|EnglishDesc}}English descriptions ====

English descriptions show a brief description of each element, to help you get used to sizers and also to make it easier to see at a glance the important aspects of your dialog element.

[[Image:Rad english descriptions.PNG|An example of DialogBlocks English descriptions]]

==== {{note|WindowPointers}}Easy access to window pointers ====

The ''easy access to window pointers'' concept means:

Give each window a variable name, and the RAD will add the name to the class declaration, and initialise it to the appropriate window in the implementation.

In XRC mode, the RAD can generate the code to find the window and assign it to the pointer variable.

==== {{note|TemplateControls}}Template controls ====

Template controls are sets of most common widgets together, like an Ok/Cancel pair buttons inside a sizer, being user-definable.

Adding support for non C/C++ files to the build system

2007-10-12T11:29:49Z

Mandrav: /* Known issues */

[[Category: User Documentation]]
== Intro ==

As you may already know, Code::Blocks is designed mainly for C/C++ development. This means that when it "sees" C/C++ files in your project it knows how to compile and link them to generate the resulting binary output.
What about other types of files though? You may want to compile java or python files but, unfortunately, Code::Blocks knows nothing about them...

And there's this other case: in real world projects, it's not unusual for some of the files belonging to a project to be auto-generated. This is done through the use of another program/script that possibly takes an input file and generates one (or more) files based on that input. Code::Blocks, unfortunately, can't handle them either...

Or can it?

The answer is: ....... (drum-rolling) ........ (ta-da) ......... '''It sure can!'''.

Code::Blocks has been recently updated so it can be configured to recognize non C/C++ files and act accordingly on them during the build process. This article will describe those changes and provide a simple but real world example of usage.

== How things used to worked... ==

In case you never had a look in advanced compiler options, you can find them by clicking ''<tt>Settings->Compiler and debugger->Other settings->Advanced options</tt>''.
In that dialog you will find the command line macros used to build files. For example, each file belonging to the project, that had its compile flag on, would be compiled with the macro named "Compile single file to object file" (''<tt>"$compiler $options $includes -c $file -o $object"</tt>'', for the curious).

While this provide enough room for customizing the build system's configuration, it clearly didn't allow for some more generic customization.

If you wanted to include in your project and compile a java file, you would have to set a custom build command for that particular file, ''only'' for that file (right-click file in tree and choose properties). This is not only cumbersome (imagine having to do this for 10 or 100 java files) but impractical too.

== ...and how things have evolved ==

The new functionality described in this article aims to remove the above problems and allow for more customization of the build system. So, what is different now?

<center>[[Image:AdvancedCompilerOptions.png|Advanced compiler options]]</center>

For starters, the command line macros are now paired with a list of source file extensions. So each command line macro (like the "Compile single file to object file") can now hold different macros ''depending on the source file extension''. This is the core of the new functionality: by adding a new command-extension pair, you effectively add support for these extension(s) to the build system!

Another thing that also got added was the ability to keep a list of files the custom command will generate (for each command-extension pair). These generated files are then automatically shown in the project tree, become part of the build process, etc. In other words, they are dynamically - and transparently - affecting the project. If you find this confusing, have a look at the provided example and things will clear up :).

== Let's see an example already ==

Here comes a real world example. I recently worked on a side project that required me to use [http://www.swig.org SWIG]. What the <tt>swig</tt> program does, in simple words, is take a special interface file (usually <tt>*.i</tt>) as input and, based on this input, it generates a C/C++ file to include in your project. This sounds like the perfect scenario to use as an example here :).

Here's what I did:

Command: '''Compile single file to object file'''
Extension: '''i'''
Macro: '''swig -c++ -lua $includes -o $file_dir/$file_name.cpp $file'''
Generated files: '''$file_dir/$file_name.cpp'''

What do the above mean?

For any file with extension '''i''', use the above macro to process (compile) it. Also lets Code::Blocks know that this macro will create a new file, named '''$file_dir/$file_name.cpp'''.

With this info at hand, Code::Blocks will now do the following auto-magically when you add any *.i file to a project:

* Add the generated file(s) also to the project (even if they don't yet exist).
* Will display the file under the new "Auto-generated" tree folder (if files categorization is enabled).
* Will know how to process (compile) the *.i files.
* Will also schedule all the generated files for processing (compiling) ''after'' the *.i file is processed.
* Will still track dependencies so when the *.i file is changed, its generated files will be re-generated too.

== Notes ==

* All default commands are paired to no extension. These are used as fallback if a matching extension isn't defined.

== Known issues ==
* Currently, only the ''$file*'' macros are supported in the generated files names ($file, $file_dir, $file_name and $file_ext).
* If you change any of the settings mentioned here in advanced compiler options, you '''must''' close and re-open your project so the changes will take effect. No message is displayed currently to note this.

[[User:Mandrav|Mandrav]] 11:29, 12 October 2007 (UTC)

Adding support for non C/C++ files to the build system

2007-10-12T11:29:00Z

Mandrav: /* Let's see an example already */

[[Category: User Documentation]]
== Intro ==

As you may already know, Code::Blocks is designed mainly for C/C++ development. This means that when it "sees" C/C++ files in your project it knows how to compile and link them to generate the resulting binary output.
What about other types of files though? You may want to compile java or python files but, unfortunately, Code::Blocks knows nothing about them...

And there's this other case: in real world projects, it's not unusual for some of the files belonging to a project to be auto-generated. This is done through the use of another program/script that possibly takes an input file and generates one (or more) files based on that input. Code::Blocks, unfortunately, can't handle them either...

Or can it?

The answer is: ....... (drum-rolling) ........ (ta-da) ......... '''It sure can!'''.

Code::Blocks has been recently updated so it can be configured to recognize non C/C++ files and act accordingly on them during the build process. This article will describe those changes and provide a simple but real world example of usage.

== How things used to worked... ==

In case you never had a look in advanced compiler options, you can find them by clicking ''<tt>Settings->Compiler and debugger->Other settings->Advanced options</tt>''.
In that dialog you will find the command line macros used to build files. For example, each file belonging to the project, that had its compile flag on, would be compiled with the macro named "Compile single file to object file" (''<tt>"$compiler $options $includes -c $file -o $object"</tt>'', for the curious).

While this provide enough room for customizing the build system's configuration, it clearly didn't allow for some more generic customization.

If you wanted to include in your project and compile a java file, you would have to set a custom build command for that particular file, ''only'' for that file (right-click file in tree and choose properties). This is not only cumbersome (imagine having to do this for 10 or 100 java files) but impractical too.

== ...and how things have evolved ==

The new functionality described in this article aims to remove the above problems and allow for more customization of the build system. So, what is different now?

<center>[[Image:AdvancedCompilerOptions.png|Advanced compiler options]]</center>

For starters, the command line macros are now paired with a list of source file extensions. So each command line macro (like the "Compile single file to object file") can now hold different macros ''depending on the source file extension''. This is the core of the new functionality: by adding a new command-extension pair, you effectively add support for these extension(s) to the build system!

Another thing that also got added was the ability to keep a list of files the custom command will generate (for each command-extension pair). These generated files are then automatically shown in the project tree, become part of the build process, etc. In other words, they are dynamically - and transparently - affecting the project. If you find this confusing, have a look at the provided example and things will clear up :).

== Let's see an example already ==

Here comes a real world example. I recently worked on a side project that required me to use [http://www.swig.org SWIG]. What the <tt>swig</tt> program does, in simple words, is take a special interface file (usually <tt>*.i</tt>) as input and, based on this input, it generates a C/C++ file to include in your project. This sounds like the perfect scenario to use as an example here :).

Here's what I did:

Command: '''Compile single file to object file'''
Extension: '''i'''
Macro: '''swig -c++ -lua $includes -o $file_dir/$file_name.cpp $file'''
Generated files: '''$file_dir/$file_name.cpp'''

What do the above mean?

For any file with extension '''i''', use the above macro to process (compile) it. Also lets Code::Blocks know that this macro will create a new file, named '''$file_dir/$file_name.cpp'''.

With this info at hand, Code::Blocks will now do the following auto-magically when you add any *.i file to a project:

* Add the generated file(s) also to the project (even if they don't yet exist).
* Will display the file under the new "Auto-generated" tree folder (if files categorization is enabled).
* Will know how to process (compile) the *.i files.
* Will also schedule all the generated files for processing (compiling) ''after'' the *.i file is processed.
* Will still track dependencies so when the *.i file is changed, its generated files will be re-generated too.

== Notes ==

* All default commands are paired to no extension. These are used as fallback if a matching extension isn't defined.

== Known issues ==
* Currently, only the ''$file'' and ''$file_basename'' macros are supported in the generated files names.
* If you change any of the settings mentioned here in advanced compiler options, you '''must''' close and re-open your project so the changes will take effect. No message is displayed currently to note this.

[[User:Mandrav|Mandrav]] 11:55, 22 September 2007 (UTC)

Adding support for non C/C++ files to the build system

2007-09-22T12:03:00Z

Mandrav: removed note at top

[[Category: User Documentation]]
== Intro ==

As you may already know, Code::Blocks is designed mainly for C/C++ development. This means that when it "sees" C/C++ files in your project it knows how to compile and link them to generate the resulting binary output.
What about other types of files though? You may want to compile java or python files but, unfortunately, Code::Blocks knows nothing about them...

And there's this other case: in real world projects, it's not unusual for some of the files belonging to a project to be auto-generated. This is done through the use of another program/script that possibly takes an input file and generates one (or more) files based on that input. Code::Blocks, unfortunately, can't handle them either...

Or can it?

The answer is: ....... (drum-rolling) ........ (ta-da) ......... '''It sure can!'''.

Code::Blocks has been recently updated so it can be configured to recognize non C/C++ files and act accordingly on them during the build process. This article will describe those changes and provide a simple but real world example of usage.

== How things used to worked... ==

In case you never had a look in advanced compiler options, you can find them by clicking ''<tt>Settings->Compiler and debugger->Other settings->Advanced options</tt>''.
In that dialog you will find the command line macros used to build files. For example, each file belonging to the project, that had its compile flag on, would be compiled with the macro named "Compile single file to object file" (''<tt>"$compiler $options $includes -c $file -o $object"</tt>'', for the curious).

While this provide enough room for customizing the build system's configuration, it clearly didn't allow for some more generic customization.

If you wanted to include in your project and compile a java file, you would have to set a custom build command for that particular file, ''only'' for that file (right-click file in tree and choose properties). This is not only cumbersome (imagine having to do this for 10 or 100 java files) but impractical too.

== ...and how things have evolved ==

The new functionality described in this article aims to remove the above problems and allow for more customization of the build system. So, what is different now?

<center>[[Image:AdvancedCompilerOptions.png|Advanced compiler options]]</center>

For starters, the command line macros are now paired with a list of source file extensions. So each command line macro (like the "Compile single file to object file") can now hold different macros ''depending on the source file extension''. This is the core of the new functionality: by adding a new command-extension pair, you effectively add support for these extension(s) to the build system!

Another thing that also got added was the ability to keep a list of files the custom command will generate (for each command-extension pair). These generated files are then automatically shown in the project tree, become part of the build process, etc. In other words, they are dynamically - and transparently - affecting the project. If you find this confusing, have a look at the provided example and things will clear up :).

== Let's see an example already ==

Here comes a real world example. I recently worked on a side project that required me to use [http://www.swig.org SWIG]. What the <tt>swig</tt> program does, in simple words, is take a special interface file (usually <tt>*.i</tt>) as input and, based on this input, it generates a C/C++ file to include in your project. This sounds like the perfect scenario to use as an example here :).

Here's what I did:

Command: '''Compile single file to object file'''
Extension: '''i'''
Macro: '''swig -c++ -lua $includes -o $file_basename.cpp $file'''
Generated files: '''$file_basename.cpp'''

What do the above mean?

For any file with extension '''i''', use the above macro to process (compile) it. Also lets Code::Blocks know that this macro will create a new file, named '''$file_basename.cpp'''. the file that is generating it.

With this info at hand, Code::Blocks will now do the following auto-magically when you add any *.i file to a project:

* Add the generated file(s) also to the project (even if they don't yet exist).
* Will display the file under the new "Auto-generated" tree folder (if files categorization is enabled).
* Will know how to process (compile) the *.i files.
* Will also schedule all the generated files for processing (compiling) ''after'' the *.i file is processed.
* Will still track dependencies so when the *.i file is changed, its generated files will be re-generated too.

== Notes ==

* All default commands are paired to no extension. These are used as fallback if a matching extension isn't defined.

== Known issues ==
* Currently, only the ''$file'' and ''$file_basename'' macros are supported in the generated files names.
* If you change any of the settings mentioned here in advanced compiler options, you '''must''' close and re-open your project so the changes will take effect. No message is displayed currently to note this.

[[User:Mandrav|Mandrav]] 11:55, 22 September 2007 (UTC)

Adding support for non C/C++ files to the build system

2007-09-22T11:55:55Z

Mandrav: Done

[[Category: User Documentation]]
This page is a work-in-progress and talks about a feature that is NOT yest available in Code::Blocks. This feature is nearing completion though so stay tuned :)

== Intro ==

As you may already know, Code::Blocks is designed mainly for C/C++ development. This means that when it "sees" C/C++ files in your project it knows how to compile and link them to generate the resulting binary output.
What about other types of files though? You may want to compile java or python files but, unfortunately, Code::Blocks knows nothing about them...

And there's this other case: in real world projects, it's not unusual for some of the files belonging to a project to be auto-generated. This is done through the use of another program/script that possibly takes an input file and generates one (or more) files based on that input. Code::Blocks, unfortunately, can't handle them either...

Or can it?

The answer is: ....... (drum-rolling) ........ (ta-da) ......... '''It sure can!'''.

Code::Blocks has been recently updated so it can be configured to recognize non C/C++ files and act accordingly on them during the build process. This article will describe those changes and provide a simple but real world example of usage.

== How things used to worked... ==

In case you never had a look in advanced compiler options, you can find them by clicking ''<tt>Settings->Compiler and debugger->Other settings->Advanced options</tt>''.
In that dialog you will find the command line macros used to build files. For example, each file belonging to the project, that had its compile flag on, would be compiled with the macro named "Compile single file to object file" (''<tt>"$compiler $options $includes -c $file -o $object"</tt>'', for the curious).

While this provide enough room for customizing the build system's configuration, it clearly didn't allow for some more generic customization.

If you wanted to include in your project and compile a java file, you would have to set a custom build command for that particular file, ''only'' for that file (right-click file in tree and choose properties). This is not only cumbersome (imagine having to do this for 10 or 100 java files) but impractical too.

== ...and how things have evolved ==

The new functionality described in this article aims to remove the above problems and allow for more customization of the build system. So, what is different now?

<center>[[Image:AdvancedCompilerOptions.png|Advanced compiler options]]</center>

For starters, the command line macros are now paired with a list of source file extensions. So each command line macro (like the "Compile single file to object file") can now hold different macros ''depending on the source file extension''. This is the core of the new functionality: by adding a new command-extension pair, you effectively add support for these extension(s) to the build system!

Another thing that also got added was the ability to keep a list of files the custom command will generate (for each command-extension pair). These generated files are then automatically shown in the project tree, become part of the build process, etc. In other words, they are dynamically - and transparently - affecting the project. If you find this confusing, have a look at the provided example and things will clear up :).

== Let's see an example already ==

Here comes a real world example. I recently worked on a side project that required me to use [http://www.swig.org SWIG]. What the <tt>swig</tt> program does, in simple words, is take a special interface file (usually <tt>*.i</tt>) as input and, based on this input, it generates a C/C++ file to include in your project. This sounds like the perfect scenario to use as an example here :).

Here's what I did:

Command: '''Compile single file to object file'''
Extension: '''i'''
Macro: '''swig -c++ -lua $includes -o $file_basename.cpp $file'''
Generated files: '''$file_basename.cpp'''

What do the above mean?

For any file with extension '''i''', use the above macro to process (compile) it. Also lets Code::Blocks know that this macro will create a new file, named '''$file_basename.cpp'''. the file that is generating it.

With this info at hand, Code::Blocks will now do the following auto-magically when you add any *.i file to a project:

* Add the generated file(s) also to the project (even if they don't yet exist).
* Will display the file under the new "Auto-generated" tree folder (if files categorization is enabled).
* Will know how to process (compile) the *.i files.
* Will also schedule all the generated files for processing (compiling) ''after'' the *.i file is processed.
* Will still track dependencies so when the *.i file is changed, its generated files will be re-generated too.

== Notes ==

* All default commands are paired to no extension. These are used as fallback if a matching extension isn't defined.

== Known issues ==
* Currently, only the ''$file'' and ''$file_basename'' macros are supported in the generated files names.
* If you change any of the settings mentioned here in advanced compiler options, you '''must''' close and re-open your project so the changes will take effect. No message is displayed currently to note this.

[[User:Mandrav|Mandrav]] 11:55, 22 September 2007 (UTC)

File:AdvancedCompilerOptions.png

2007-09-22T11:45:13Z

Mandrav:

Adding support for non C/C++ files to the build system

2007-09-17T14:11:01Z

Mandrav: Mostly done

[[Category: User Documentation]]
This page is a work-in-progress and talks about a feature that is NOT yest available in Code::Blocks. This feature is nearing completion though so stay tuned :)

== Intro ==

As you may already know, Code::Blocks is designed mainly for C/C++ development. This means that when it "sees" C/C++ files in your project it knows how to compile and link them to generate the resulting binary output.
What about other types of files though? You may want to compile java or python files but, unfortunately, Code::Blocks knows nothing about them...

And there's this other case: in real world projects, it's not unusual for some of the files belonging to a project to be auto-generated. This is done through the use of another program/script that possibly takes an input file and generates one (or more) files based on that input. Code::Blocks, unfortunately, can't handle them either...

Or can it?

The answer is: ....... (drum-rolling) ........ (ta-da) ......... '''It sure can!'''.

Code::Blocks has been recently updated so it can be configured to recognize non C/C++ files and act accordingly on them during the build process. This article will describe those changes and provide a simple but real world example of usage.

== How things used to worked... ==

In case you never had a look in advanced compiler options, you can find them by clicking ''<tt>Settings->Compiler and debugger->Other settings->Advanced options</tt>''.
In that dialog you will find the command line macros used to build files. For example, each file belonging to the project, that had its compile flag on, would be compiled with the macro named "Compile single file to object file" (''<tt>"$compiler $options $includes -c $file -o $object"</tt>'', for the curious).

While this provide enough room for customizing the build system's configuration, it clearly didn't allow for some more generic customization.

If you wanted to include in your project and compile a java file, you would have to set a custom build command for that particular file, ''only'' for that file (right-click file in tree and choose properties). This is not only cumbersome (imagine having to do this for 10 or 100 java files) but impractical too.

== ...and how things have evolved ==

The new functionality described in this article aims to remove the above problems and allow for more customization of the build system. So, what is different now?

For starters, the command line macros are now paired with a list of source file extensions. So each command line macro (like the "Compile single file to object file") can now hold different macros ''depending on the source file extension''. This is the core of the new functionality: by adding a new command-extension pair, you effectively add support for these extension(s) to the build system!

Another thing that also got added was the ability to keep a list of files the custom command will generate (for each command-extension pair). These generated files are then automatically shown in the project tree, become part of the build process, etc. In other words, they are dynamically - and transparently - affecting the project. If you find this confusing, have a look at the provided example and things will clear up :).

== Let's see an example already ==

Here comes a real world example. I recently worked on a side project that required me to use [http://www.swig.org SWIG]. What the <tt>swig</tt> program does, in simple words, is take a special interface file (*.i) as input and, based on this input, it generates a C/C++ file to include in your project. This sounds like the perfect scenario to use as an example here :).

Here's what I did:

Command: '''Compile single file to object file'''
Extension: '''i'''
Macro: '''swig -c++ -lua $includes -o $file_basename.cpp $file'''
Generated files: '''$file_basename.cpp'''

What do the above mean?

For any file with extension '''i''', use the above macro to process (compile) it. Also lets Code::Blocks know that this macro will create a new file, named '''$file_basename.cpp'''.

With this info at hand, Code::Blocks will now do the following auto-magically when you add any *.i file to a project:

* Add the generated file(s) also to the project (even if they don't yet exist).
* Will know how to process (compile) the *.i files.
* Will also schedule all the generated files for processing (compiling) ''after'' the *.i file is processed.
* Will still track dependencies so when the *.i file is changed, its generated files will be re-generated too.

== Notes ==

* Currently, only the ''$file'' and ''$file_basename'' macros are supported in the generated files names.
* All default commands are paired to no extension. These are used as fallback if a matching extension isn't defined.

To Be Continued.

[[User:Mandrav|Mandrav]] 14:11, 17 September 2007 (UTC)

Adding support for non C/C++ files to the build system

2007-09-17T09:06:21Z

Mandrav: Intro

User documentation

2007-09-17T08:28:31Z

Mandrav: /* Application development */ Support for non C/C++ files

[[Category:Code::Blocks Documentation]]
[[Category:User Documentation]]
__TOC__
Articles for Code::Blocks users.

'''[[Installing Code::Blocks]]'''

:How to install Code::Blocks (from binary or source)

'''[[Keyboard Shortcuts]]'''

:List of keyboard shortcuts that can be used in Code::Blocks

'''[[Command line arguments]]'''

:List of command-line arguments that can be used with Code::Blocks.

'''[[Personalities]]'''

:Customize the Code::Blocks user interface for different workflows.

'''[[Code::Blocks Plugins]]'''

:List of plugins that come with Code::Blocks.

'''[[The build process of Code::Blocks]]'''

:Information about how Code::Blocks actually builds your source code.

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

'''[[wxSmith tutorials]]'''
:Information about how to use wxSmith RAD editor

'''[[Miscellaneous]]'''
:Miscellaneous things related to the user development experience. This is a catch all place.

== Application development ==

* [[Builtin variables]]
* [[Recommended global variables]]
* [[Code::Blocks variable types synthesis]]
* [[Debugging with Code::Blocks]]
* [[Adding support for non C/C++ files to the build system]]

== Compilers ==

* [[Global compiler variables]]
* [[Precompiled headers]]
* [[Installing a supported compiler]]
* [[Installing Cygwin Compiler]]
* [[Installing Fortran Compiler]]
* [[Installing Uniwin remote compiler]]
* [[Code::Blocks_and_Cross_Compilers|Using cross compilers]]
* [[Integrating Microsoft Visual Toolkit 2003 with Code::Blocks IDE]]
* [[Integrating Microsoft Visual C 6 with Code::Blocks IDE]]
* [[64Bit Windows|Setting up for 64-bit windows development with Mirosoft compilers]]

== Third-party libraries ==

* [[WxWindowsQuickRef|Using wxWidgets with Code::Blocks (Windows)]]
* [[Using SDL with Code::Blocks]]
* [[Using GLFW with Code::Blocks]]

== User interface development ==

* [[WxSmith Tutorial & Pointers|Creating a dialog for wxWidgets with wxSmith]]

64Bit Windows

2007-08-29T13:36:46Z

Mandrav: Categorized document

[[Category:User Documentation]]
== How-to compile amd64 code with Code::Blocks ==
(by Tjaalie)
 
''Requirements:'' 
- Code::Bocks (just get a nightly build) 
- Windows SDK ([http://www.microsoft.com/downloads/details.aspx?familyid=C2B1E300-F358-4523-B479-F53D234CDCCF&displaylang=en]) 
 
''Step1'') Make sure you have a nightly build because I don’t think that RC2 supports all the needed functionality to setup the compiler. 
 
''Step2'') Install the Windows SDK, you can deselect all the .net stuff because we won’t be needing it.
*tip If you deselect the documentation parts you reduce the download size to under 100mb.
 
''Step3'') Start Code::Blocks and go to ‘Settings->Compiler and Debugger settings’, then select ‘Microsoft Visual C++ 2005’ from the dropdown box and click the copy button. Now choose a name I used ‘Windows SDK x64’ but you can name it whatever you like. 
 
''Step4'') Now with ‘Windows SDK x64’ as the selected compiler go to the ‘Toolchain executables’ tab and '''EMPTY''' the directory text box. Then click the ‘Additional Paths’ tab inside the ‘Toolchain executables’ tab. Remove the directory that goes to your Visual C++ 2005 install dir '''NOT''' the debug one and add the following directory’s: 
- C:\Program Files\Microsoft SDKs\Windows\v6.0\Bin\x64 
- C:\Program Files\Microsoft SDKs\Windows\v6.0\VC\Bin\x64 
 
''Step5'') Now go to the ‘Search Directories’ tab and remove all items under the ‘Compiler’, ‘Linker’ and ‘Resource compiler’ tabs. And then add the following,
Compiler: 
- C:\Program Files\Microsoft SDKs\Windows\v6.0\VC\INCLUDE 
- C:\Program Files\Microsoft SDKs\Windows\v6.0\Include 
Linker: 
- C:\Program Files\Microsoft SDKs\Windows\v6.0\VC\LIB\x64 
- C:\Program Files\Microsoft SDKs\Windows\v6.0\Lib\x64 
Resource Compiler: 
- None 
 
''Step6'') Create a new project (console project) and select our new ‘Windows SDK x64’ compiler as the compiler to use. Now in the generated code add the following line: 
*cout << “sizeof(void*) = ” << sizeof(void*) << ";" << endl; 
Hit the compile button and off we go. When we execute the program it appears to have a 8byte long address (64 bits). 
 
''Remarks'') When you create a gui application Code::Blocks starts yelling at you about the PSDK, in fact the Windows SDK is the PSDK for Vista so you don’t need it, so you need to fill in a bogus path when creating the app (e.g. ‘c:\’) and then later remove the entries to the PSDK in ‘Build Options…->Search Directories’. A new template would be cool but that’s something for another time.

User documentation

2007-08-29T13:36:14Z

Mandrav: /* Compilers */ Link to 64bit windows setup

[[Category:Code::Blocks Documentation]]
[[Category:User Documentation]]
__TOC__
Articles for Code::Blocks users.

'''[[Installing Code::Blocks]]'''

:How to install Code::Blocks (from binary or source)

'''[[Keyboard Shortcuts]]'''

:List of keyboard shortcuts that can be used in Code::Blocks

'''[[Command line arguments]]'''

:List of command-line arguments that can be used with Code::Blocks.

'''[[Personalities]]'''

:Customize the Code::Blocks user interface for different workflows.

'''[[Code::Blocks Plugins]]'''

:List of plugins that come with Code::Blocks.

'''[[The build process of Code::Blocks]]'''

:Information about how Code::Blocks actually builds your source code.

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

'''[[wxSmith tutorials]]'''
:Information about how to use wxSmith RAD editor

'''[[Miscellaneous]]'''
:Miscellaneous things related to the user development experience. This is a catch all place.

== Application development ==

* [[Builtin variables]]
* [[Recommended global variables]]
* [[Code::Blocks variable types synthesis]]
* [[Debugging with Code::Blocks]]

== Compilers ==

* [[Global compiler variables]]
* [[Precompiled headers]]
* [[Installing a supported compiler]]
* [[Installing Cygwin Compiler]]
* [[Installing Fortran Compiler]]
* [[Installing Uniwin remote compiler]]
* [[Code::Blocks_and_Cross_Compilers|Using cross compilers]]
* [[Integrating Microsoft Visual Toolkit 2003 with Code::Blocks IDE]]
* [[Integrating Microsoft Visual C 6 with Code::Blocks IDE]]
* [[64Bit Windows|Setting up for 64-bit windows development with Mirosoft compilers]]

== Third-party libraries ==

* [[Using SDL with Code::Blocks]]
* [[Using GLFW with Code::Blocks]]

== User interface development ==

* [[WxSmith Tutorial & Pointers|Creating a dialog for wxWidgets with wxSmith]]

Code::Blocks SDK events

2007-07-06T13:20:34Z

Mandrav:

Developer documentation

2007-07-06T12:40:27Z

Mandrav: Added link to SDK events

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
Articles for Code::Blocks developers.

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

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

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

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

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

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

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

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

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

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

== Plug-In development ==

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

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

* [[wxSmith extensions]]

== Scripting ==

Using scripting to extend Code::Blocks' functionality

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

Managing Plug-in Resources

2007-07-05T13:18:51Z

Mandrav: /* What is XRC and why would I want to use it? */ Clarification about wxToolBarAddOn type

[[Category:Plugin development]]

==Prerequisites==

Please read the tutorial [[Creating a simple "Hello_World" plugin]] before starting this tutorial

This tutorial assumes you have a working version of Code::Blocks installed and some knowledge of how to deal with projects, in particular how to compile them. In order to use the Code::Blocks SDK you must also have a working version of wxWidgets installed. For more information see
[[Compiling wxWidgets 2.6.2 to develop Code::Blocks (MSW)|Compiling wxWidgets 2.6.2 to develop Code::Blocks]]

''' REVISE THIS...'''To develop Code::Blocks plugins you will also need a copy of the Code::Blocks SDK, which can be found on the Code::Blocks [https://www.codeblocks.org/downloads.shtml download page]. Install this to somewhere sensible that you will remember later on. Personally I keep the SDK in a folder called CodeBlocks\sdk (which contains the include/ and lib/ from in the zip). This means that the header files refered to in the tutorial would be found under ''Codeblocks\sdk\include'', so ''cbPlugin.h'' is ''Codeblocks\sdk\include\cbPlugin.h'' for example.

==Overview==

This tutorial will show you how to package and access Resources (toolbars, forms, dialogs and bitmaps) and other static data in your plug-in.

==Plugin File Structure==

Every plugin in its undeployed state is simply a nested file structure in compressed archive form (zip). The typical structure of a plugin (which we'll call "myplugin" in this tutorial) is as follows:

+myplugin.cbplugin
+myplugin.dll
+myplugin.png
+myplugin-off.png
+myplugin.zip
+manifest.xml
+XML Based Resources
+Extra Files

Most of this structure is created automatically when you build a plugin project created with the CB Plugin Wizard. What are these files?

* '''myplugin.cbplugin''': this is simply a zip archive containing all of the plugins files and resources. It is given a cbplugin extension to make it easy for the Code::Blocks plugin installer to recognize.
* '''myplugin.dll''' (or _libmy-plugin.so_ on linux): the compiled shared library containing you plugins executable content
* '''myplugin.png''': this is an 80x80 bitmap displayed by default in the image list in "Environment Settings" when the plugins configuration has the focus (for plugins that have a configuaration panel). ''This file is optional''
* '''myplugin-off.png''': this is an 80x80 bitmap displayed by default in the image list in "Environment Settings" when the plugins configuration does not have the focus(for plugins that have a configuaration panel). ''This file is optional''
* '''myplugin.zip''': a compressed archive file containing the file manifest.xml and resources
* '''manifest.xml''': a file containing information about the plugin. (see the [[Creating a simple "Hello_World" plugin]])
* '''XML Based Resources''': One or more wxWidgets XML based resource files (XRC files) such as toolbars, dialogs and forms. You can also place binary bitmap images in this archive if they are accompanied by and XRC descriptor file. ''XML Resources are option''
* '''Extra Files''': Place other static, non-XRC resources here. You should keep these files to a mimimum because they are copied to the shared space of the users Code::Blocks installation. ''These files are optional''

In this tutorial we will discuss the use of XML Based Resources and Extra Files

==Working with XML Based wxWidgets Resources==

===What is XRC and why would I want to use it?===

XRC is a standardized way of describing wxWidgets forms (including panels and dialogs), menus, toolbars and bitmap lists in a human readable XML format. A simple example is the XRC file for the compiler toolbar (found in the CB source at: <tt>src/plugins/compilergcc/resources/compiler_toolbar.xrc</tt>):

<?xml version="1.0" ?>
<resource>
<object class="wxToolBarAddOn" name="compiler_toolbar">
<object class="tool" name="idCompilerMenuCompile">
<tooltip>Build</tooltip>
<longhelp>Build the active project</longhelp>
<bitmap>images/compile.png</bitmap>
</object>
<object class="tool" name="idCompilerMenuRun">
<tooltip>Run</tooltip>
<longhelp>Run the active project</longhelp>
<bitmap>images/run.png</bitmap>
</object>
...
...
...
<object class="separator"/>
<object class="wxStaticText" name="idToolTargetLabel">
<label>Build target:</label>
</object>
<object class="wxChoice" name="idToolTarget">
<content/>
<size>160,-1</size>
</object>
</object>
</resource>

As you can see, this file specifies that it is an XML file in the first line, that it contains resources denoted by the <resource> and </resource> tags in the second and last lines respectively. Within the resource tags, the XRC file specifies a sequence of objects laid out in an hierarchical structure. Each object belongs to a class (specified with the attribute class, and corresponding to a wxWidgets form or control class) and has a unique identifier. In this file there is only one base level object, named "compiler_toolbar" derived from the Code::Blocks class "wxToolBarAddOn", a Code::Blocks extension of the wxWidgets type "wxToolbar". Note that base level objects are restricted to a handful of types, namely:

* Frames
* Dialogs
* Panels
* MenuBars
* Menus
* Toolbars
* Bitmaps
* Icons

In contrast, the objects owned by base level objects run the entire gamut of wxWidgets controls. In the case of the Compiler toolbar, it owns a sequence of standard bitmap toolbar buttons (idCompilerMenuCompile, idCompilerMenuRun etc), a static text control (idToolTargetLabel) and a choice box (idToolTarget). Panels and dialogs will also contain layout objects derived from classes such as <tt>wxSizer</tt>. In addition to the basic class and name attributes, base and lower level objects in an XRC file will specify additional detail about their structure, such as associated images, sizing and layout (basically giving you the same control over the intialization of an object as if you had executed its constructor in your c++ code).

While somewhat verbose, the XML-based XRC file is far more readable than the terse 50+ lines of equivalent C++ code required to create a toolbar, load its images and assign unique ids. XRC files can be loaded and displayed in a few lines of C++. You still retain the ability to access individual objects loaded from the XRC. We'll deal with these issues shortly.

In addition to its readability, XRC offers the advantage of separating form layout (contained in the XRC file) from form logic (coded into your plugin binary). XRC files are loaded each time you start your plugin, which allows you to make changes to the layout of a form without the need to recompile you plugin.

A definitive description of the XRC syntax is described in the wxWidgets wiki at http://www.wxwidgets.org/wiki/index.php/Using_XML_Resources_with_XRC

===Creating XRC files for use in your plugin===

CONTENT COMING SOON

===Working with XRC files in your plugin===

CONTENT COMING SOON...

==Working with Extra Files==

MORE CONTENT COMING SOON...

==Further Information==

It is essential to learn how wxWidgets works if you seriously plan on working on plugins, since most of Code::Blocks depends on it, and you will find it easier to add and manipulate components if you have a firm grasp of its principles. More information on this can be found in the wxWidgets [http://www.wxwidgets.org/docs.htm documentation]. Another good place to learn from is the source code from the existing Code::Blocks plugins, which can be downloaded along with the rest of the Code::Blocks source code from the [https://www.codeblocks.org/downloads.shtml download page].

Project file

2007-03-02T13:19:33Z

Mandrav:

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
'''NOTE: This page is not yet finished.'''

The project file is the most important file in Code::Blocks. It's what defines a project and rules how to build it.
So, without further ado, let's see how it is formatted. The following is a simple console project. Don't be overwhelmed by its size...
It just contains all possible elements for illustration purposes.
Normally, when a project is saved by Code::Blocks, it only contains the elements whose values are different than the default values.
The following XML text contains the default values for each element/attribute.

= Sample project file =

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<CodeBlocks_project_file>
<FileVersion major="1" minor="6" />
<Project>
<Option title="TestConsole" />
<Option platforms="All" />
<Option makefile="Makefile" />
<Option makefile_is_custom="0" />
<Option pch_mode="2" />
<Option default_target="" />
<Option compiler="gcc" />
<Option virtualFolders="" />
<Option extended_obj_names="0" />
<Option show_notes="0">
<notes>
<![CDATA[]]>
</notes>
</Option>
<MakeCommands>
<Build command="$make -f $makefile $target" />
<CompileFile command="$make -f $makefile $file" />
<Clean command="$make -f $makefile clean$target" />
<DistClean command="$make -f $makefile distclean$target" />
</MakeCommands>
<Build>
<Script file="" />
<Target title="default">
<Option platforms="All" />
<Option output="default" prefix_auto="1" extension_auto="1" />
<Option working_dir="." />
<Option object_output=".objs" />
<Option deps_output=".deps" />
<Option external_deps="" />
<Option additional_output="" />
<Option type="1" />
<Option compiler="gcc" />
<Option use_console_runner="1" />
<Option parameters="" />
<Option host_application="" />
<Option createDefFile="1" />
<Option createStaticLib="1" />
<Option projectCompilerOptionsRelation="3" />
<Option projectLinkerOptionsRelation="3" />
<Option projectIncludeDirsRelation="3" />
<Option projectResourceIncludeDirsRelation="3" />
<Option projectLibDirsRelation="3" />
<Script file="" />
<Compiler>
<Add option="" />
<Add directory="" />
</Compiler>
<ResourceCompiler>
<Add directory="" />
</ResourceCompiler>
<Linker>
<Add option="" />
<Add directory="" />
<Add library="" />
</Linker>
<ExtraCommands>
<Add before=""/>
<Add after=""/>
<Mode after="always" />
</ExtraCommands>
<MakeCommands>
<Build command="$make -f $makefile $target" />
<CompileFile command="$make -f $makefile $file" />
<Clean command="$make -f $makefile clean$target" />
<DistClean command="$make -f $makefile distclean$target" />
</MakeCommands>
</Target>
</Build>
<VirtualTargets>
<Add alias="" targets="" />
</VirtualTargets>
<Compiler>
<Add option="" />
<Add directory="" />
</Compiler>
<ResourceCompiler>
<Add directory="" />
</ResourceCompiler>
<Linker>
<Add option="" />
<Add directory="" />
<Add library="" />
</Linker>
<ExtraCommands>
<Add before=""/>
<Add after=""/>
<Mode after="always" />
</ExtraCommands>
<Unit filename="BuildScripts/config.script">
<Option compilerVar="CPP" />
<Option compile="0" />
<Option link="0" />
<Option weight="50" />
<Option virtualFolder="" />
<Option target="default" />
</Unit>
<Unit filename="main.cpp">
<Option compilerVar="CPP" />
<Option compile="1" />
<Option link="1" />
<Option weight="50" />
<Option virtualFolder="" />
<Option target="" />
</Unit>
</Project>
</CodeBlocks_project_file>

Let's see the XML elements one by one.

= Version =
<FileVersion major="1" minor="6" />
This defines the project file's version. Code::Blocks can open previous versions of project files but always saves in the latest version format.

= Project =

<Project>
Starts defining the project.

== Project options ==

=== Title ===
<Option title="TestConsole" />
Sets the project's title.

=== Platforms ===
<Option platforms="All" />
Defines which platforms this project is valid on. This setting can be redefined in target settings. But note that
this setting here must be a superset of any platform specification per-target. Meaning that if we define
here that the project is valid for Windows and Unix platforms only, we can't set the Mac platform in a target
because that platform is not marked as supported in the project level.
{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Value
!Platform
|-

|-
| Windows || Microsoft Windows (tm)
|-

|-
| Unix || Any Unix/Linux
|-

|-
| Mac || Any Mac platform
|-

|-
| All || Any platform
|-

|}
The value can either be "All" or a semi-colon separated list of the supported platforms' values in the table above

=== Makefile ===
<Option makefile="Makefile" />
Sets the makefile filename to use when building the project. This is only used when the project is set up to use
an external makefile to build (see next element). It is not used when building using Code::Blocks' build system.

<Option makefile_is_custom="0" />
If this option's value is set to "1", the internal build system is effectively disabled and an external makefile
is used to build the project.

=== PCH mode ===
<Option pch_mode="2" />
Sets the PCH (precompiled headers) mode. This can have one of the following values:
{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Value
!Description
|-

|-
| 0 || Generate PCH in a directory alongside original header.
|-

|-
| 1 || Generate PCH in the object output dir.
|-

|-
| 2 || Generate PCH alongside original header (default).
|-

|}

=== Default target ===
<Option default_target="" />
Sets the default target to "Run". When clicking on the "Build->Run" menu item, Code::Blocks "runs" the
default target of the project. This entry defines which is this target.

=== Compiler ===
<Option compiler="gcc" />
The compiler used to build this project (can be overridden by targets).
The internal compiler names used by Code::Blocks are the following:
{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Compiler
!Internal name
|-

|-
| GNU GCC || gcc
|-

|-
| Cygwin GCC || cygwin
|-

|-
| Borland C++ Compiler 5.5 || bcc
|-

|-
| Digital Mars Compiler || dmc
|-

|-
| Digital Mars D Compiler || dmd
|-

|-
| GDC D Compiler || gdc
|-

|-
| GNU ARM GCC Compiler || arm-elf-gcc
|-

|-
| Intel C/C++ Compiler || icc
|-

|-
| Microsoft Visual C++ Toolkit 2003 || msvctk
|-

|-
| Microsoft Visual C++ 2005 || msvc8
|-

|-
| OpenWatcom (W32) Compiler || ow
|-

|-
| SDCC Compiler || sdcc
|-

|-
| Tiny C Compiler || tcc
|-

|}
Note that not all of the above are present in all platforms.

=== Virtual folders ===
<Option virtualFolders="" />
Defines virtual folders for the project tree display. If present, it contains a semi-colon separated list of virtual
relative paths, e.g. "Sources/C++;Sources/Python". If virtual folders are used, each project file contains info on
what virtual folder it appears in.

=== Extended object names ===
<Option extended_obj_names="0" />
If this option's value equals to "1", then the generated object filenames contain the source file's extension too.
{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Source filename
!Object filename
(extended_obj_names="0")
!Object filename
(extended_obj_names="1")
|-

|-
| foo.cpp || foo.o || foo.cpp.o
|-

|}
This is especially useful in source trees where there are more than one files with the same basename (i.e. without extension) exist in the same directory.

=== Notes ===
<Option show_notes="0">
<notes>
<![CDATA[]]>
</notes>
</Option>
Project specific notes. If "show_notes" equals "1", then the notes contained in the "notes" element are automatically displayed
by Code::Blocks when it opens the project. If, on the other hand, "show_notes" equals "0", then the notes are not displayed automatically
by Code::Blocks but can be read by the user in the project properties dialog.

== "Make" commands ==
<MakeCommands>
<Build command="$make -f $makefile $target" />
<CompileFile command="$make -f $makefile $file" />
<Clean command="$make -f $makefile clean$target" />
<DistClean command="$make -f $makefile distclean$target" />
</MakeCommands>
Define how to invoke "make" when using an external makefile for the build.

== Build ==

<Build>
Starts defining the build properties.

=== Scripts ===
<Script file="" />
Adds a build script file in the project level (e.g. "BuildScripts/config.script").

=== Target ===

<Target title="default">
Starts defining a new target. It also sets the target's name.

==== Target options ====

===== Platforms =====
<Option platforms="All" />
Defines which platforms this target is valid on. This setting further refines the relevant project setting. But note that
this setting here must be a subset of any platform specification in the project level. Meaning that if we define
that the project is valid for Windows and Unix platforms only, we can't set the Mac platform here
because that platform is not marked as supported in the project level.
{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Value
!Platform
|-

|-
| Windows || Microsoft Windows (tm)
|-

|-
| Unix || Any Unix/Linux
|-

|-
| Mac || Any Mac platform
|-

|-
| All || Any platform
|-

|}
The value can either be "All" or a semi-colon separated list of the supported platforms' values in the table above

===== Output =====
<Option output="default" prefix_auto="1" extension_auto="1" />
Defines the output filename for this target. The attributes "prefix_auto" and "extension_auto" need only be present if there value equals "1".
They tell Code::Blocks that the filename should be automatically adjusted for the platform Code::Blocks is running on.
For example, if the target generates the static library "libfoo.a" for gcc, the "output" would be "Debug/foo". The "lib" prefix and ".a" extension
would automatically be added by Code::Blocks, if required by the current platform.

===== Working directory =====
<Option working_dir="." />
Defines the working directory when "running" this target.

===== Objects output =====
<Option object_output=".objs" />
Defines the directory where all the object files will be generated under, when building this target,

===== Dependencies output =====
<Option deps_output=".deps" />
Defines the directory where all the dependency files will be generated under, when building this target,
'''This setting is obsolete and not used anymore. It will be removed in a future version of the project file's format.'''

===== External dependencies =====
<Option external_deps="../TestLib/Debug/libTestLib.a;" />
Sets an external dependency that will force a re-link of the target's output file whenever that dependency changes.
For example, we could force a target to re-link if it uses a static library and that static library is updated: "../TestLib/Debug/libTestLib.a;".
The value entered here is a semi-colon separated list of external filenames whose modification time will be monitored by Code::Blocks'
build system.

===== Additional outputs =====
<Option additional_output="" />
This is a semi-colon separated list of filenames that their modification times are also checked against the target's output modification time.
If any of these is updated, the target's output is forced to re-link. Useful for generated files which Code::Blocks doesn't otherwise
know about.

===== Output type =====
<Option type="1" />
Defines what kind of output this target produces. Possible values are:
{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Value
!Kind of output
|-

|-
| 0 || GUI application (no console)
|-

|-
| 1 || Console application
|-

|-
| 2 || Static library
|-

|-
| 3 || Dynamic library (dll/so)
|-

|-
| 4 || Commands only (doesn't generate any output, just executes pre/post build steps)
|-

|-
| 5 || Native executable (valid only under windows where it produces a .sys file)
|-

|}

===== Compiler =====
<Option compiler="gcc" />
The compiler used to build this target (overrides the project-level compiler).
The internal compiler names used by Code::Blocks are the following:
{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Compiler
!Internal name
|-

|-
| GNU GCC || gcc
|-

|-
| Cygwin GCC || cygwin
|-

|-
| Borland C++ Compiler 5.5 || bcc
|-

|-
| Digital Mars Compiler || dmc
|-

|-
| Digital Mars D Compiler || dmd
|-

|-
| GDC D Compiler || gdc
|-

|-
| GNU ARM GCC Compiler || arm-elf-gcc
|-

|-
| Intel C/C++ Compiler || icc
|-

|-
| Microsoft Visual C++ Toolkit 2003 || msvctk
|-

|-
| Microsoft Visual C++ 2005 || msvc8
|-

|-
| OpenWatcom (W32) Compiler || ow
|-

|-
| SDCC Compiler || sdcc
|-

|-
| Tiny C Compiler || tcc
|-

|}
Note that not all of the above are present in all platforms.

===== Console runner =====
<Option use_console_runner="1" />
Valid for targets producing console applications. If value equals "1", the console executable runs through another Code::Blocks
utility program which, when the console executable ends, displays a "Press any key to continue" message.
This option is useful if the user wants the console to stay open so he/she can examine his/hers program's output.

===== Execution parameters =====
<Option parameters="" />
Any command-line parameters that should be passed to the executable when executing it from inside Code::Blocks.

===== Host application =====
<Option host_application="" />
If the target's output is not an executable, this element defines which executable to launch when "running" this target.
Useful for dynamic library targets (dll/so) where we can set the host application to launch.

===== Create DEF file =====
<Option createDefFile="1" />
If value equals "1", a DEF file will be generated. Valid only for Windows DLLs compiled with GCC (ignored in other configurations).

===== Create import library =====
<Option createStaticLib="1" />
If value equals "1", an import library will be generated. Valid only for Windows DLLs compiled with GCC (ignored in other configurations).

===== Compiler options relation =====
<Option projectCompilerOptionsRelation="3" />
Defines the relative order this target's compiler options are applied, regarding the project's compiler options.
Possible values are:
{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Value
!Relative order
|-

|-
| 0 || Ignore target's compiler options and only use project's compiler options
|-

|-
| 1 || Ignore project's compiler options and only use target's compiler options
|-

|-
| 2 || Apply target's compiler options '''before''' project's compiler options (project settings take precedence)
|-

|-
| 3 || Apply target's compiler options '''after''' project's compiler options (target settings take precedence)
|-

|}

===== Linker options relation =====
<Option projectLinkerOptionsRelation="3" />
Defines the relative order this target's linker options are applied, regarding the project's linker options.
Possible values are:
{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Value
!Relative order
|-

|-
| 0 || Ignore target's linker options and only use project's linker options
|-

|-
| 1 || Ignore project's linker options and only use target's linker options
|-

|-
| 2 || Apply target's linker options '''before''' project's linker options (project settings take precedence)
|-

|-
| 3 || Apply target's linker options '''after''' project's linker options (target settings take precedence)
|-

|}

===== Include directories relation =====
<Option projectIncludeDirsRelation="3" />
Defines the relative order this target's include dirs are searched, regarding the project's include dirs.
Possible values are:
{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Value
!Relative order
|-

|-
| 0 || Ignore target's include dirs and only use project's include dirs
|-

|-
| 1 || Ignore project's include dirs and only use target's include dirs
|-

|-
| 2 || Apply target's include dirs '''before''' project's include dirs (target settings take precedence)
|-

|-
| 3 || Apply target's include dirs '''after''' project's include dirs (project settings take precedence)
|-

|}

===== Resource include directories relation =====
<Option projectResourceIncludeDirsRelation="3" />
Defines the relative order this target's resource include dirs are applied, regarding the project's resource include dirs.
Possible values are:
{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Value
!Relative order
|-

|-
| 0 || Ignore target's resource include dirs and only use project's resource include dirs
|-

|-
| 1 || Ignore project's resource include dirs and only use target's resource include dirs
|-

|-
| 2 || Apply target's resource include dirs '''before''' project's resource include dirs (project settings take precedence)
|-

|-
| 3 || Apply target's resource include dirs '''after''' project's resource include dirs (target settings take precedence)
|-

|}

===== Library directories relation =====
<Option projectLibDirsRelation="3" />
Defines the relative order this target's library dirs are searched, regarding the project's library dirs.
Possible values are:
{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Value
!Relative order
|-

|-
| 0 || Ignore target's library dirs and only use project's library dirs
|-

|-
| 1 || Ignore project's library dirs and only use target's library dirs
|-

|-
| 2 || Apply target's library dirs '''before''' project's library dirs (target settings take precedence)
|-

|-
| 3 || Apply target's library dirs '''after''' project's library dirs (project settings take precedence)
|-

|}

===== Scripts =====
<Script file="" />
Adds a build script file at the target level (e.g. "BuildScripts/config.script").

===== Compiler settings =====
<Compiler>
Starts defining the compiler settings at target level.

<Add option="">
Adds a compiler option (e.g. "-g").

<Add directory="">
Adds a compiler search directory (includes).

===== Resource compiler settings =====
<ResourceCompiler>
Starts defining the resource compiler settings at target level.

<Add directory="">
Adds a resource compiler search directory (resource includes).

===== Linker settings =====
<Linker>
Starts defining the linker settings at target level.

<Add option="">
Adds a linker option (e.g. "-Wl,--export-all-symbols").

<Add directory="">
Adds a linker search directory.

<Add library="">
Adds a link library (e.g. "-ljpeg").

===== Pre/post build steps =====
<ExtraCommands>
Starts defining extra commands to run before/after compilation (aka pre/post build steps) at target level.

<Add before="" />
Adds a pre-build step.

<Add after="" />
Adds a post-build step.

<Mode after="always" />
Defines if the post-build steps for this target will run each time a build is made, regardless if the target is actually built
(or was already up-to-date and no build was needed for it).

===== "Make" commands =====
<MakeCommands>
<Build command="$make -f $makefile $target" />
<CompileFile command="$make -f $makefile $file" />
<Clean command="$make -f $makefile clean$target" />
<DistClean command="$make -f $makefile distclean$target" />
</MakeCommands>
Define how to invoke "make" when using an external makefile for the build. These settings override the relevant settings
at the project level.

== Virtual targets ==
<VirtualTargets>
Starts defining virtual targets. These are sets (or groups) of "real" targets.

<Add alias="" targets="" />
Adds a virtual target. The attribute "alias" defines the virtual target's name and the attribute "targets" is a semi-colon separated list of "real" target names.

== Compiler settings ==
<Compiler>
Starts defining the compiler settings at project level.

<Add option="">
Adds a compiler option (e.g. "-g").

<Add directory="">
Adds a compiler search directory (includes).

== Resource compiler settings ==
<ResourceCompiler>
Starts defining the resource compiler settings at project level.

<Add directory="">
Adds a resource compiler search directory (resource includes).

== Linker settings ==
<Linker>
Starts defining the linker settings at project level.

<Add option="">
Adds a linker option (e.g. "-Wl,--export-all-symbols").

<Add directory="">
Adds a linker search directory.

<Add library="">
Adds a link library (e.g. "-ljpeg").

== Pre/post build steps ==
<ExtraCommands>
Starts defining extra commands to run before/after compilation (aka pre/post build steps) at project level.

<Add before="" />
Adds a pre-build step.

<Add after="" />
Adds a post-build step.

<Mode after="always" />
Defines if the post-build steps for this project will run each time a build is made, regardless if the project is actually built
(or was already up-to-date and no build was needed for it).

== Project files ==
<Unit filename="">
Adds a single file (aka unit). The filename attribute contains the relative (to the project file) name of the file.

=== Options ===
<Option compilerVar="CPP" />
The tool to use to build this file. Code::Blocks automatically assigns the correct tool for each file based on its extension.
Valid tool names are "CPP", "C" and "WINDRES".

<Option compile="1" />
If the "compile" attribute equals "1" then this file is part of the compilation stage, else it's not.

<Option link="1" />
If the "link" attribute equals "1" then this file is part of the linking stage, else it's not.

<Option weight="50" />
By adjusting file weights we can change the order the files are compiled. Files with lower weight are compiled earlier (higher the priority).

<Option virtualFolder="" />
If this file should appear inside a virtual folder, this is where it is defined. The "virtualFolder" attribute must contain a relative "virtual" path, already present in the global virtual folders setting (described earlier).

<Option target="" />
The name of the target this file belongs in. The file can be part of more than one targets by using multiple such XML elements.
If the file belongs to all the targets in the project, this element is not needed.

'''To be continued...'''

[[User:Mandrav|Mandrav]] 13:19, 2 March 2007 (UTC)

Project file

2007-03-02T13:19:12Z

Mandrav: Mostly done

Project file

2007-03-01T14:06:18Z

Mandrav: Added TBC message

Project file

2007-03-01T13:53:11Z

Mandrav: Initial text

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
The project file is the most important file in Code::Blocks. It's what defines a project and rules how to build it.
So, without further ado, let's see how it is formatted. The following is a simple console project. Don't be overwhelmed by its size...
It just contains all possible elements for illustration purposes.
Normally, when a project is saved by Code::Blocks, it only contains the elements whose values are different than the default values.
The following XML text contains the default values for each element/attribute.

= Sample project file =

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<CodeBlocks_project_file>
<FileVersion major="1" minor="6" />
<Project>
<Option title="TestConsole" />
<Option platforms="All" />
<Option makefile="Makefile" />
<Option makefile_is_custom="0" />
<Option pch_mode="2" />
<Option default_target="" />
<Option compiler="gcc" />
<Option virtualFolders="" />
<Option extended_obj_names="0" />
<Option show_notes="0">
<notes>
<![CDATA[]]>
</notes>
</Option>
<MakeCommands>
<Build command="$make -f $makefile $target" />
<CompileFile command="$make -f $makefile $file" />
<Clean command="$make -f $makefile clean$target" />
<DistClean command="$make -f $makefile distclean$target" />
</MakeCommands>
<Build>
<Script file="" />
<Target title="Debug">
<Option platforms="All" />
<Option output="Debug/TestConsole" prefix_auto="1" extension_auto="1" />
<Option working_dir="." />
<Option object_output="Debug/obj/" />
<Option deps_output=".deps" />
<Option external_deps="../TestLib/Debug/libTestLib.a;" />
<Option additional_output="" />
<Option type="1" />
<Option compiler="gcc" />
<Option use_console_runner="0" />
<Option parameters="" />
<Option host_application="" />
<Option createDefFile="1" />
<Option createStaticLib="1" />
<Option projectCompilerOptionsRelation="3" />
<Option projectLinkerOptionsRelation="3" />
<Option projectIncludeDirsRelation="3" />
<Option projectResourceIncludeDirsRelation="3" />
<Option projectLibDirsRelation="3" />
<Script file="../BuildScripts/debug.script" />
<Script file="../BuildScripts/base.script" />
<Compiler>
<Add option="-g" />
</Compiler>
<ResourceCompiler />
<Linker />
<ExtraCommands>
<Mode after="always" />
</ExtraCommands>
<MakeCommands>
<Build command="$make -f $makefile $target" />
<CompileFile command="$make -f $makefile $file" />
<Clean command="$make -f $makefile clean$target" />
<DistClean command="$make -f $makefile distclean$target" />
</MakeCommands>
</Target>
</Build>
<VirtualTargets>
<Add alias="All" targets="Debug;" />
</VirtualTargets>
<Compiler>
<Add option="-Wall" />
<Add option="-fexceptions" />
</Compiler>
<ResourceCompiler />
<Linker />
<ExtraCommands>
<Mode after="always" />
</ExtraCommands>
<Unit filename="BuildScripts/config.script">
<Option compilerVar="CPP" />
<Option compile="0" />
<Option link="0" />
<Option weight="50" />
<Option virtualFolder="" />
<Option target="Debug" />
</Unit>
<Unit filename="main.cpp">
<Option compilerVar="CPP" />
<Option compile="1" />
<Option link="1" />
<Option weight="50" />
<Option virtualFolder="" />
<Option target="Debug" />
</Unit>
<Extensions>
<code_completion />
</Extensions>
</Project>
</CodeBlocks_project_file>

Let's see the XML elements one by one.

= Version =
<FileVersion major="1" minor="6" />
This defines the project file's version. Code::Blocks can open previous versions of project files but always saves in the latest version format.

= Project =

<Project>
Starts defining the project.

== Project options ==

=== Title ===
<Option title="TestConsole" />
Sets the project's title.

=== Platforms ===
<Option platforms="All" />
Defines which platforms this project is valid on. This setting can be redefined in target settings. But note that
this setting here must be a superset of any platform specification per-target. Meaning that if we define
here that the project is valid for Windows and Unix platforms only, we can't set the Mac platform in a target
because that platform is not marked as supported in the project level.
{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Value
!Platform
|-

|-
| Windows || Microsoft Windows (tm)
|-

|-
| Unix || Any Unix/Linux
|-

|-
| Mac || Any Mac platform
|-

|-
| All || Any platform
|-

|}
The value can either be "All" or a semi-colon separated list of the supported platforms' values in the table above

=== Makefile ===
<Option makefile="Makefile" />
Sets the makefile filename to use when building the project. This is only used when the project is set up to use
an external makefile to build (see next element). It is not used when building using Code::Blocks' build system.

<Option makefile_is_custom="0" />
If this option's value is set to "1", the internal build system is effectively disabled and an external makefile
is used to build the project.

=== PCH mode ===
<Option pch_mode="2" />
Sets the PCH (precompiled headers) mode. This can have one of the following values:
{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Value
!Description
|-

|-
| 0 || Generate PCH in a directory alongside original header.
|-

|-
| 1 || Generate PCH in the object output dir.
|-

|-
| 2 || Generate PCH alongside original header (default).
|-

|}

=== Default target ===
<Option default_target="" />
Sets the default target to "Run". When clicking on the "Build->Run" menu item, Code::Blocks "runs" the
default target of the project. This entry defines which is this target.

=== Compiler ===
<Option compiler="gcc" />
The compiler used to build this project (can be overridden by targets).
The internal compiler names used by Code::Blocks are the following:
{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Compiler
!Internal name
|-

|-
| GNU GCC || gcc
|-

|-
| Cygwin GCC || cygwin
|-

|-
| Borland C++ Compiler 5.5 || bcc
|-

|-
| Digital Mars Compiler || dmc
|-

|-
| Digital Mars D Compiler || dmd
|-

|-
| GDC D Compiler || gdc
|-

|-
| GNU ARM GCC Compiler || arm-elf-gcc
|-

|-
| Intel C/C++ Compiler || icc
|-

|-
| Microsoft Visual C++ Toolkit 2003 || msvctk
|-

|-
| Microsoft Visual C++ 2005 || msvc8
|-

|-
| OpenWatcom (W32) Compiler || ow
|-

|-
| SDCC Compiler || sdcc
|-

|-
| Tiny C Compiler || tcc
|-

|}
Note that not all of the above are present in all platforms.

=== Virtual folders ===
<Option virtualFolders="" />
Defines virtual folders for the project tree display. If present, it contains a semi-colon separated list of virtual
relative paths, e.g. "Sources/C++;Sources/Python". If virtual folders are used, each project file contains info on
what virtual folder it appears in.

=== Extended object names ===
<Option extended_obj_names="0" />
If this option's value equals to "1", then the generated object filenames contain the source file's extension too.
{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Source filename
!Object filename
(extended_obj_names="0")
!Object filename
(extended_obj_names="1")
|-

|-
| foo.cpp || foo.o || foo.cpp.o
|-

|}
This is especially useful in source trees where there are more than one files with the same basename (i.e. without extension) exist in the same directory.

=== Notes ===
<Option show_notes="0">
<notes>
<![CDATA[]]>
</notes>
</Option>
Project specific notes. If "show_notes" equals "1", then the notes contained in the "notes" element are automatically displayed
by Code::Blocks when it opens the project. If, on the other hand, "show_notes" equals "0", then the notes are not displayed automatically
by Code::Blocks but can be read by the user in the project properties dialog.

== "Make" commands ==
<MakeCommands>
<Build command="$make -f $makefile $target" />
<CompileFile command="$make -f $makefile $file" />
<Clean command="$make -f $makefile clean$target" />
<DistClean command="$make -f $makefile distclean$target" />
</MakeCommands>
Define how to invoke "make" when using an external makefile for the build.

== Build ==

<Build>
Starts defining the build properties.

=== Scripts ===
<Script file="" />
Adds a build script file in the project level (e.g. "BuildScripts/config.script").

=== Target ===

<Target title="Debug">
Starts defining a new target. It also sets the target's name.

==== Target options ====

===== Platforms =====
<Option platforms="All" />
Defines which platforms this target is valid on. This setting further refines the relevant project setting. But note that
this setting here must be a subset of any platform specification in the project level. Meaning that if we define
that the project is valid for Windows and Unix platforms only, we can't set the Mac platform here
because that platform is not marked as supported in the project level.
{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Value
!Platform
|-

|-
| Windows || Microsoft Windows (tm)
|-

|-
| Unix || Any Unix/Linux
|-

|-
| Mac || Any Mac platform
|-

|-
| All || Any platform
|-

|}
The value can either be "All" or a semi-colon separated list of the supported platforms' values in the table above

===== Output =====
<Option output="Debug/TestConsole" prefix_auto="1" extension_auto="1" />
Defines the output filename for this target. The attributes "prefix_auto" and "extension_auto" need only be present if there value equals "1".
They tell Code::Blocks that the filename should be automatically adjusted for the platform Code::Blocks is running on.
For example, if the target generates the static library "libfoo.a" for gcc, the "output" would be "Debug/foo". The "lib" prefix and ".a" extension
would automatically be added by Code::Blocks, if required by the current platform.

===== Working directory =====
<Option working_dir="." />
Defines the working directory when "running" this target.

===== Objects output =====
<Option object_output="Debug/obj/" />
Defines the directory where all the object files will be generated under, when building this target,

===== Dependencies output =====
<Option deps_output=".deps" />
Defines the directory where all the dependency files will be generated under, when building this target,
'''This setting is obsolete and not used anymore. It will be removed in a future version of the project file's format.'''

===== External dependencies =====
<Option external_deps="../TestLib/Debug/libTestLib.a;" />
Sets an external dependency that will force a re-link of the target's output file whenever that dependency changes.
For example, we could force a target to re-link if it uses a static library and that static library is updated: "../TestLib/Debug/libTestLib.a;".
The value entered here is a semi-colon separated list of external filenames whose modification time will be monitored by Code::Blocks'
build system.

===== Additional outputs =====
<Option additional_output="" />
This is a semi-colon separated list of filenames that their modification times are also checked against the target's output modification time.
If any of these is updated, the target's output is forced to re-link. Useful for generated files which Code::Blocks doesn't otherwise
know about.

===== Output type =====
<Option type="1" />
Defines what kind of output this target produces. Possible values are:
{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Value
!Kind of output
|-

|-
| 0 || GUI application (no console)
|-

|-
| 1 || Console application
|-

|-
| 2 || Static library
|-

|-
| 3 || Dynamic library (dll/so)
|-

|-
| 4 || Commands only (doesn't generate any output, just executes pre/post build steps)
|-

|-
| 5 || Native executable (valid only under windows where it produces a .sys file)
|-

|}

===== Compiler =====
<Option compiler="gcc" />
The compiler used to build this target (overrides the project-level compiler).
The internal compiler names used by Code::Blocks are the following:
{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Compiler
!Internal name
|-

|-
| GNU GCC || gcc
|-

|-
| Cygwin GCC || cygwin
|-

|-
| Borland C++ Compiler 5.5 || bcc
|-

|-
| Digital Mars Compiler || dmc
|-

|-
| Digital Mars D Compiler || dmd
|-

|-
| GDC D Compiler || gdc
|-

|-
| GNU ARM GCC Compiler || arm-elf-gcc
|-

|-
| Intel C/C++ Compiler || icc
|-

|-
| Microsoft Visual C++ Toolkit 2003 || msvctk
|-

|-
| Microsoft Visual C++ 2005 || msvc8
|-

|-
| OpenWatcom (W32) Compiler || ow
|-

|-
| SDCC Compiler || sdcc
|-

|-
| Tiny C Compiler || tcc
|-

|}
Note that not all of the above are present in all platforms.

===== Console runner =====
<Option use_console_runner="0" />
Valid for targets producing console applications. If value equals "1", the console executable runs through another Code::Blocks
utility program which, when the console executable ends, displays a "Press any key to continue" message.
This option is useful if the user wants the console to stay open so he/she can examine his/hers program's output.

===== Execution parameters =====
<Option parameters="" />
Any command-line parameters that should be passed to the executable when executing it from inside Code::Blocks.

===== Host application =====
<Option host_application="" />
If the target's output is not an executable, this element defines which executable to launch when "running" this target.
Useful for dynamic library targets (dll/so) where we can set the host application to launch.

===== Create DEF file =====
<Option createDefFile="1" />
If value equals "1", a DEF file will be generated. Valid only for Windows DLLs compiled with GCC (ignored in other configurations).

===== Create import library =====
<Option createStaticLib="1" />
If value equals "1", an import library will be generated. Valid only for Windows DLLs compiled with GCC (ignored in other configurations).

Workspace file

2007-03-01T11:59:28Z

Mandrav: Initial text

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
The workspace XML file is a very simple one.

A workspace is a collection of projects. Essentially the workspace file does exactly that: describes a collection of projects.
But let's see the contents of a sample workspace:

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<CodeBlocks_workspace_file>
<Workspace title="Test Workspace">
<Project filename="TestConsole/TestConsole.cbp" active="1">
<Depends filename="TestLib/TestLib.cbp" />
</Project>
<Project filename="TestLib/TestLib.cbp" />
</Workspace>
</CodeBlocks_workspace_file>

This XML text defines the workspace named "Test Workspace" containing two projects:

* TestConsole/TestConsole.cbp and
* TestLib/TestLib.cbp

Additionally, it defines a project dependency: the TestConsole project ''depends'' on the TestLib project. This instructs Code::Blocks to always make sure that the TestLib project is built ''before'' the TestConsole project.

'''NOTE:''' ''This is a build-order dependency that is being set. This will _not_ force a re-link of the TestConsole output (which is an executable) when the library generated by TestLib is updated. This behavior is influenced by another setting in the project file. See the [[Project file]] description for this.''

Well, I 'd love to add various comments in the XML itself, to describe each element, but as you see it's pretty simple and straightforward :). The only thing that requires perhaps some explanation is the "active" attribute seen in the "Project" element for the TestConsole project. That attribute appears only when its value equals to "1" and in only one "Project" element inside the workspace. All it does is define which of the workspace projects will be the active one by default, when opening the workspace in Code::Blocks.

That's all.

[[User:Mandrav|Mandrav]] 11:59, 1 March 2007 (UTC)

File formats description

2007-03-01T11:42:16Z

Mandrav: Initial text

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
Code::Blocks projects/workspaces are described in XML files. Here are contained links to documentation for each one of them.

This information is of interest to anyone wanting to write an importer/exporter/generator for other build systems/environments and therefore add support for Code::Blocks.

* '''[[Workspace file]]''' (*.workspace)
:Defines a Code::Blocks workspace (collection of projects).

* '''[[Project file]]''' (*.cbp)
:Defines a Code::Blocks project.

''Code::Blocks also produces a couple other files (*.layout and *.depend) but they only contain state information so they are not really useful to anyone else other than Code::Blocks itself.''

[[User:Mandrav|Mandrav]] 11:42, 1 March 2007 (UTC)

Developer documentation

2007-03-01T11:33:43Z

Mandrav: File formats entry

[[Category:Code::Blocks Documentation]]
[[Category:Developer Documentation]]
Articles for Code::Blocks developers.

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

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

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

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

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

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

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

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

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

== Plugin development ==

* [[Creating a simple "Hello World" plugin]]
* [[Creating a Plug-in which modifies CB's Menus]]
* [[Creating a plugin that actually does something]]

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

== Scripting ==

Using scripting to extend Code::Blocks' functionality

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

Scripting commands

2006-12-17T22:37:21Z

Mandrav: ProjectFile::file

[[Category:Scripting Code::Blocks]]
Scripting is no good if all you can do is use the scripting language's builtin 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.''

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}

== ScriptingManager ==

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

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

|}

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

== ConfigManager ==

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

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

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

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

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

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

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

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

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

|}

== ProjectManager ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}

== EditorManager ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}

== UserVariableManager ==

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

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

|}

== IO namespace ==

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

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

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

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

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

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

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

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

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

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

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

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

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

|}

'''Notes:'''
The functions in bold are going through the scripts security layer so there is no guarantee calling them will succeed. You should always examine the return value...
There exists one constant too, named ''allowInsecureScripts'', which allow you to test whether Code::Blocks was compiled with the functions going through the security layer.

== CompilerFactory ==

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

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

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

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

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

|}

== wxString ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|-
| wxString || BeforeLast || char ||
|-
|}

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

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

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

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

|}

== wxColour ==

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

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

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

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

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

|}

== ProjectFile ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}

== CompileOptionsBase ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}

== CompileTargetBase ==
Extends CompileOptionsBase.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}

== ProjectBuildTarget ==
Extends CompileTargetBase.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}

== cbProject ==
Extends CompileTargetBase.

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

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

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

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

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

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

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

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

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

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

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

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

|-
| bool || ShowOptions || ||
|-

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

|-
| int || GetFilesCount || ||
|-

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

|-
| ProjectFile* || GetFileByFilename || wxString,bool,bool ||
|-

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

|-
| ProjectFile* || AddFile || wxString|int,wxString,bool,bool,int ||
|-

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}

== EditorBase ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}

== cbEditor ==
Extends EditorBase.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}

== Constants ==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|-
| wxID_OK || int ||
|-

|-
| wxID_YES || int ||
|-

|-
| wxID_NO || int ||
|-

|-
| wxID_CANCEL || int ||
|-

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

|-
| ortCompilerOptions || enum ||
|-

|-
| ortLinkerOptions || enum ||
|-

|-
| ortIncludeDirs || enum ||
|-

|-
| ortLibDirs || enum ||
|-

|-
| ortResDirs || enum ||
|-

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

|-
| orUseParentOptionsOnly || enum ||
|-

|-
| orUseTargetOptionsOnly || enum ||
|-

|-
| orPrependToParentOptions || enum ||
|-

|-
| orAppendToParentOptions || enum ||
|-

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

|-
| ttExecutable || enum ||
|-

|-
| ttConsoleOnly || enum ||
|-

|-
| ttStaticLib || enum ||
|-

|-
| ttDynamicLib || enum ||
|-

|-
| ttCommandsOnly || enum ||
|-

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

|-
| mcClean || enum ||
|-

|-
| mcDistClean || enum ||
|-

|-
| mcBuild || enum ||
|-

|-
| mcCompileFile || enum ||
|-

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

|-
| pchSourceDir || enum ||
|-

|-
| pchObjectDir || enum ||
|-

|-
| pchSourceFile || enum ||
|-

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

|-
| psSelection || enum ||
|-

|-
| psActiveEditor || enum ||
|-

|-
| psAllOpenEditors || enum ||
|-

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

|-
| pcmBlackAndWhite || enum ||
|-

|-
| pcmColourOnWhite || enum ||
|-

|-
| pcmInvertColours || enum ||
|-

|-
| pcmAsIs || enum ||
|-

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

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

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

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

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

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

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

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

|-
| EXT_WORKSPACE || wxString ||
|-

|-
| EXT_CODEBLOCKS || wxString ||
|-

|-
| EXT_DEVCPP || wxString ||
|-

|-
| EXT_MSVC6 || wxString ||
|-

|-
| EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| EXT_MSVC7 || wxString ||
|-

|-
| EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| EXT_D || wxString ||
|-

|-
| EXT_F || wxString ||
|-

|-
| EXT_F77 || wxString ||
|-

|-
| EXT_F95 || wxString ||
|-

|-
| EXT_CPP || wxString ||
|-

|-
| EXT_C || wxString ||
|-

|-
| EXT_CC || wxString ||
|-

|-
| EXT_CXX || wxString ||
|-

|-
| EXT_HPP || wxString ||
|-

|-
| EXT_H || wxString ||
|-

|-
| EXT_HH || wxString ||
|-

|-
| EXT_HXX || wxString ||
|-

|-
| EXT_OBJECT || wxString ||
|-

|-
| EXT_XRCRESOURCE || wxString ||
|-

|-
| EXT_STATICLIB || wxString ||
|-

|-
| EXT_DYNAMICLIB || wxString ||
|-

|-
| EXT_EXECUTABLE || wxString ||
|-

|-
| EXT_RESOURCE || wxString ||
|-

|-
| EXT_RESOURCEBIN || wxString ||
|-

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

|-
| DOT_EXT_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_CODEBLOCKS || wxString ||
|-

|-
| DOT_EXT_DEVCPP || wxString ||
|-

|-
| DOT_EXT_MSVC6 || wxString ||
|-

|-
| DOT_EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_MSVC7 || wxString ||
|-

|-
| DOT_EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_D || wxString ||
|-

|-
| DOT_EXT_F || wxString ||
|-

|-
| DOT_EXT_F77 || wxString ||
|-

|-
| DOT_EXT_F95 || wxString ||
|-

|-
| DOT_EXT_CPP || wxString ||
|-

|-
| DOT_EXT_C || wxString ||
|-

|-
| DOT_EXT_CC || wxString ||
|-

|-
| DOT_EXT_CXX || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_H || wxString ||
|-

|-
| DOT_EXT_HH || wxString ||
|-

|-
| DOT_EXT_HXX || wxString ||
|-

|-
| DOT_EXT_OBJECT || wxString ||
|-

|-
| DOT_EXT_XRCRESOURCE || wxString ||
|-

|-
| DOT_EXT_STATICLIB || wxString ||
|-

|-
| DOT_EXT_DYNAMICLIB || wxString ||
|-

|-
| DOT_EXT_EXECUTABLE || wxString ||
|-

|-
| DOT_EXT_RESOURCE || wxString ||
|-

|-
| DOT_EXT_RESOURCEBIN || wxString ||
|-

|}

== See also ==

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

Scripting commands

2006-12-17T22:35:47Z

Mandrav: Added wxColour and some globals funcs

[[Category:Scripting Code::Blocks]]
Scripting is no good if all you can do is use the scripting language's builtin 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.''

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}

== ScriptingManager ==

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

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

|}

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

== ConfigManager ==

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

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

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

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

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

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

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

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

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

|}

== ProjectManager ==

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

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

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

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

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

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

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

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

|-
| bool || CloseWorkspace || ||
|-

|-
| cbProject* || IsOpen || wxString ||
|-

|-
| cbProject* || LoadProject || wxString,bool ||
|-

|-
| bool || SaveProject || cbProject* ||
|-

|-
| bool || SaveProjectAs || cbProject* ||
|-

|-
| bool || SaveActiveProject || ||
|-

|-
| bool || SaveActiveProjectAs || ||
|-

|-
| bool || SaveAllProjects || ||
|-

|-
| bool || CloseProject || cbProject*,bool,bool ||
|-

|-
| bool || CloseActiveProject || bool ||
|-

|-
| bool || CloseAllProjects || bool ||
|-

|-
| cbProject* || NewProject || wxString ||
|-

|-
| int || AddFileToProject || wxString,cbProject*,int ||
|-

|-
| int || AskForBuildTargetIndex || cbProject* ||
|-

|-
| void || RebuildTree || ||
|-

|}

== EditorManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || Configure || ||
|-

|-
| cbEditor* || New || wxString ||
|-

|-
| cbEditor* || Open || wxString ||
|-

|-
| cbEditor* || IsBuiltinOpen || wxString ||
|-

|-
| cbEditor* || GetBuiltinEditor || wxString|int ||
|-

|-
| cbEditor* || GetBuiltinActiveEditor || ||
|-

|-
| EditorBase* || GetActiveEditor || ||
|-

|-
| void || ActivateNext || ||
|-

|-
| void || ActivatePrevious || ||
|-

|-
| bool || SwapActiveHeaderSource || ||
|-

|-
| bool || CloseActive || bool ||
|-

|-
| bool || Close || wxString|int,bool ||
|-

|-
| bool || CloseAll || bool ||
|-

|-
| bool || Save || wxString|int ||
|-

|-
| bool || SaveActive || ||
|-

|-
| bool || SaveAs || int ||
|-

|-
| bool || SaveActiveAs || ||
|-

|-
| bool || SaveAll || ||
|-

|-
| int || ShowFindDialog || bool,bool ||
|-

|}

== UserVariableManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || Exists || wxString ||
|-

|}

== IO namespace ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || DirectoryExists || wxString ||
|-

|-
| wxString || SelectDirectory || wxString,wxString,bool ||
|-

|-
| bool || '''CreateDirectory''' || wxString,int || arg1=dir, arg2=permissions
|-

|-
| bool || '''RemoveDirectory''' || wxString ||
|-

|-
| bool || '''CopyFile''' || wxString,wxString,bool || src,dest,overwrite
|-

|-
| bool || '''RenameFile''' || wxString,wxString || old,new
|-

|-
| bool || '''RemoveFile''' || wxString ||
|-

|-
| bool || FileExists || wxString ||
|-

|-
| wxString || SelectFile || wxString,wxString,wxString ||
|-

|-
| bool || '''WriteFileContents''' || wxString,wxString || filename,contents
|-

|-
| int || '''Execute''' || wxString ||
|-

|-
| wxString || '''ExecuteAndGetOutput''' || wxString ||
|-

|}

'''Notes:'''
The functions in bold are going through the scripts security layer so there is no guarantee calling them will succeed. You should always examine the return value...
There exists one constant too, named ''allowInsecureScripts'', which allow you to test whether Code::Blocks was compiled with the functions going through the security layer.

== CompilerFactory ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || IsValidCompilerID || wxString ||
|-

|-
| int || GetCompilerIndex || wxString ||
|-

|-
| wxString || GetDefaultCompilerID || ||
|-

|-
| bool || CompilerInheritsFrom || ||
|-

|}

== wxString ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || operator+ || ||
|-

|-
| bool || operator< || ||
|-

|-
| bool || operator<= || ||
|-

|-
| bool || operator>= || ||
|-

|-
| bool || operator> || ||
|-

|-
| int || Find || wxString ||
|-

|-
| bool || Matches || wxString ||
|-

|-
| void || AddChar || char ||
|-

|-
| char || GetChar || int ||
|-

|-
| bool || IsEmpty || ||
|-

|-
| int || Length || ||
|-

|-
| int || length || || same as Length()
|-

|-
| int || len || || same as Length()
|-

|-
| int || size || || same as Length()
|-

|-
| wxString || Lower || ||
|-

|-
| wxString || LowerCase || || same as Lower()
|-

|-
| void || MakeLower || ||
|-

|-
| wxString || Upper || ||
|-

|-
| wxString || UpperCase || || same as Upper()
|-

|-
| void || MakeUpper || ||
|-

|-
| wxString || Mid || int,int ||
|-

|-
| void || Remove || int,int ||
|-

|-
| void || RemoveLast || ||
|-

|-
| int || Replace || wxString,wxString[,bool] ||
|-

|-
| wxString || Right || int ||
|-

|-
| wxString || AfterFirst || char ||
|-

|-
| wxString || AfterLast || char ||
|-

|-
| wxString || BeforeFirst || char ||
|-

|-
| wxString || BeforeLast || char ||
|-
|}

== 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 ||
|-

|-
| void || Clear || ||
|-

|-
| int || GetCount || ||
|-

|-
| wxString || Item || int ||
|-

|}

== wxColour ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| byte || Red || ||
|-

|-
| byte || Green || ||
|-

|-
| byte || Blue || ||
|-

|-
| void || Set || byte,byte,byte ||
|-

|}

== ProjectFile ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || AddBuildTarget || wxString ||
|-

|-
| void || RenameBuildTarget || wxString,wxString ||
|-

|-
| void || RemoveBuildTarget || wxString ||
|-

|-
| wxString || GetBaseName || ||
|-

|-
| wxString || GetObjName || ||
|-

|-
| void || SetObjName || wxString ||
|-

|-
| cbProject* || GetParentProject || ||
|-

|-
| wxString || relativeFilename || || (variable)
|-

|-
| wxString || relativeToCommonTopLevelPath || || (variable)
|-

|-
| bool || compile || || (variable)
|-

|-
| bool || link || || (variable)
|-

|-
| int || weight || || (variable)
|-

|-
| wxString || compilerVar || || (variable)
|-

|}

== CompileOptionsBase ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || SetLinkerOptions || wxArrayString ||
|-

|-
| void || SetLinkLibs || wxArrayString ||
|-

|-
| void || SetCompilerOptions || wxArrayString ||
|-

|-
| void || SetIncludeDirs || wxArrayString ||
|-

|-
| void || SetResourceIncludeDirs || wxArrayString ||
|-

|-
| void || SetLibDirs || wxArrayString ||
|-

|-
| void || SetCommandsBeforeBuild || wxArrayString ||
|-

|-
| void || SetCommandsAfterBuild || wxArrayString ||
|-

|-
| wxArrayString || GetLinkerOptions || ||
|-

|-
| wxArrayString || GetLinkLibs || ||
|-

|-
| wxArrayString || GetCompilerOptions || ||
|-

|-
| wxArrayString || GetIncludeDirs || ||
|-

|-
| wxArrayString || GetResourceIncludeDirs || ||
|-

|-
| wxArrayString || GetLibDirs || ||
|-

|-
| wxArrayString || GetCommandsBeforeBuild || ||
|-

|-
| wxArrayString || GetCommandsAfterBuild || ||
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| void || AddLinkerOption || wxString ||
|-

|-
| void || AddLinkLib || wxString ||
|-

|-
| void || AddCompilerOption || wxString ||
|-

|-
| void || AddIncludeDir || wxString ||
|-

|-
| void || AddResourceIncludeDir || wxString ||
|-

|-
| void || AddLibDir || wxString ||
|-

|-
| void || AddCommandsBeforeBuild || wxString ||
|-

|-
| void || AddCommandsAfterBuild || wxString ||
|-

|-
| void || RemoveLinkerOption || wxString ||
|-

|-
| void || RemoveLinkLib || wxString ||
|-

|-
| void || RemoveCompilerOption || wxString ||
|-

|-
| void || RemoveIncludeDir || wxString ||
|-

|-
| void || RemoveResourceIncludeDir || wxString ||
|-

|-
| void || RemoveLibDir || wxString ||
|-

|-
| void || RemoveCommandsBeforeBuild || wxString ||
|-

|-
| void || RemoveCommandsAfterBuild || wxString ||
|-

|-
| bool || GetAlwaysRunPostBuildSteps || ||
|-

|-
| void || SetAlwaysRunPostBuildSteps || bool ||
|-

|-
| bool || SetVar || wxString,wxString,bool ||
|-

|-
| wxString || GetVar || wxString ||
|-

|-
| bool || UnsetVar || wxString ||
|-

|-
| void || UnsetAllVars || ||
|-

|}

== CompileTargetBase ==
Extends CompileOptionsBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetFilename || ||
|-

|-
| wxString || GetTitle || ||
|-

|-
| void || SetTitle || wxString ||
|-

|-
| void || SetOutputFilename || wxString ||
|-

|-
| void || SetWorkingDir || wxString ||
|-

|-
| void || SetObjectOutput || wxString ||
|-

|-
| void || SetDepsOutput || wxString ||
|-

|-
| OptionsRelation || GetOptionRelation || OptionsRelationType ||
|-

|-
| void || SetOptionRelation || OptionsRelationType,OptionsRelation ||
|-

|-
| wxString || GetWorkingDir || ||
|-

|-
| wxString || GetObjectOutput || ||
|-

|-
| wxString || GetDepsOutput || ||
|-

|-
| wxString || GetOutputFilename || ||
|-

|-
| wxString || SuggestOutputFilename || ||
|-

|-
| wxString || GetExecutableFilename || ||
|-

|-
| wxString || GetDynamicLibFilename || ||
|-

|-
| wxString || GetDynamicLibDefFilename || ||
|-

|-
| wxString || GetStaticLibFilename || ||
|-

|-
| wxString || GetBasePath || ||
|-

|-
| void || SetTargetType || TargetType ||
|-

|-
| TargetType || GetTargetType || ||
|-

|-
| wxString || GetExecutionParameters || ||
|-

|-
| void || SetExecutionParameters || wxString ||
|-

|-
| wxString || GetHostApplication || ||
|-

|-
| void || SetHostApplication || wxString ||
|-

|-
| void || SetCompilerID || wxString ||
|-

|-
| wxString || GetCompilerID || ||
|-

|}

== ProjectBuildTarget ==
Extends CompileTargetBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| cbProject* || GetParentProject || ||
|-

|-
| wxString || GetFullTitle || ||
|-

|-
| wxString || GetExternalDeps || ||
|-

|-
| void || SetExternalDeps || wxString ||
|-

|-
| void || SetAdditionalOutputFiles || wxString ||
|-

|-
| wxString || GetAdditionalOutputFiles || ||
|-

|-
| bool || GetIncludeInTargetAll || ||
|-

|-
| void || SetIncludeInTargetAll || bool ||
|-

|-
| bool || GetCreateDefFile || ||
|-

|-
| void || SetCreateDefFile || bool ||
|-

|-
| bool || GetCreateStaticLib || ||
|-

|-
| void || SetCreateStaticLib || bool ||
|-

|-
| bool || GetUseConsoleRunner || ||
|-

|-
| void || SetUseConsoleRunner || bool ||
|-

|}

== cbProject ==
Extends CompileTargetBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| wxString || GetMakefile || ||
|-

|-
| void || SetMakefile || wxString ||
|-

|-
| bool || IsMakefileCustom || ||
|-

|-
| void || SetMakefileCustom || bool ||
|-

|-
| bool || CloseAllFiles || bool ||
|-

|-
| bool || SaveAllFiles || ||
|-

|-
| bool || Save || ||
|-

|-
| bool || SaveLayout || ||
|-

|-
| bool || LoadLayout || ||
|-

|-
| bool || ShowOptions || ||
|-

|-
| wxString || GetCommonTopLevelPath || ||
|-

|-
| int || GetFilesCount || ||
|-

|-
| ProjectFile* || GetFile || int ||
|-

|-
| ProjectFile* || GetFileByFilename || wxString,bool,bool ||
|-

|-
| bool || RemoveFile || int ||
|-

|-
| ProjectFile* || AddFile || wxString|int,wxString,bool,bool,int ||
|-

|-
| int || GetBuildTargetsCount || ||
|-

|-
| ProjectBuildTarget* || GetBuildTarget || wxString|int ||
|-

|-
| ProjectBuildTarget* || AddBuildTarget || wxString ||
|-

|-
| bool || RenameBuildTarget || wxString|int,wxString ||
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || wxString|int,wxString ||
|-

|-
| bool || RemoveBuildTarget || wxString|int ||
|-

|-
| bool || ExportTargetAsProject || wxString|int ||
|-

|-
| void || SetActiveBuildTarget || int ||
|-

|-
| int || GetActiveBuildTarget || ||
|-

|-
| int || SelectTarget || int,bool ||
|-

|-
| ProjectBuildTarget* || GetCurrentlyCompilingTarget || ||
|-

|-
| void || SetCurrentlyCompilingTarget || ProjectBuildTarget* ||
|-

|-
| PCHMode || GetModeForPCH || ||
|-

|-
| void || SetModeForPCH || PCHMode ||
|-

|}

== EditorBase ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetFilename || ||
|-

|-
| void || SetFilename || wxString ||
|-

|-
| wxString || GetShortName || ||
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| wxString || GetTitle || ||
|-

|-
| void || SetTitle || wxString ||
|-

|-
| void || Activate || ||
|-

|-
| bool || Close || ||
|-

|-
| bool || Save || ||
|-

|-
| bool || IsBuiltinEditor || ||
|-

|-
| bool || ThereAreOthers || ||
|-

|-
| void || GotoLine || int,bool ||
|-

|-
| void || ToggleBreakpoint || int,bool ||
|-

|-
| bool || HasBreakpoint || int ||
|-

|-
| void || GotoNextBreakpoint || ||
|-

|-
| void || GotoPreviousBreakpoint || ||
|-

|-
| void || ToggleBookmark || int,bool ||
|-

|-
| bool || HasBookmark || int ||
|-

|-
| void || GotoNextBookmark || ||
|-

|-
| void || GotoPreviousBookmark || ||
|-

|-
| void || Undo || ||
|-

|-
| void || Redo || ||
|-

|-
| void || Cut || ||
|-

|-
| void || Copy || ||
|-

|-
| void || Paste || ||
|-

|-
| bool || CanUndo || ||
|-

|-
| bool || CanRedo || ||
|-

|-
| bool || CanPaste || ||
|-

|-
| bool || HasSelection || ||
|-

|}

== cbEditor ==
Extends EditorBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || SetEditorTitle || wxString ||
|-

|-
| ProjectFile* || GetProjectFile || ||
|-

|-
| bool || SaveAs || ||
|-

|-
| void || FoldAll || ||
|-

|-
| void || UnfoldAll || ||
|-

|-
| void || ToggleAllFolds || ||
|-

|-
| void || FoldBlockFromLine || int ||
|-

|-
| void || UnfoldBlockFromLine || int ||
|-

|-
| void || ToggleFoldBlockFromLine || int ||
|-

|-
| int || GetLineIndentInSpaces || int ||
|-

|-
| wxString || GetLineIndentString || int ||
|-

|-
| void || Touch || ||
|-

|-
| bool || Reload || bool ||
|-

|-
| void || Print || bool,PrintColourMode,bool ||
|-

|-
| void || AutoComplete || ||
|-

|-
| bool || AddBreakpoint || int,bool ||
|-

|-
| bool || RemoveBreakpoint || int,bool ||
|-

|-
| void || SetText || wxString || this is not present in cbEditor; included to help scripts edit text
|-

|-
| wxString || GetText || || this is not present in cbEditor; included to help scripts edit text
|-

|}

== Constants ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"

|- style="background: #ececec; border: 0px solid gray"
!Constant
!Type
!Remarks
|-

|-
| PLATFORM || int || this defines the platform Code::Blocks is currently running on. It is equal to only one of the following PLATFORM_* constants
|-

|-
| PLATFORM_MSW || int || All Windows platforms
|-

|-
| PLATFORM_GTK || int || All GTK platforms (Linux, BSD, Solaris, Darwin, etc.)
|-

|-
| PLATFORM_MAC || int || All Mac platforms
|-

|-
| PLATFORM_OS2 || int || OS/2 platform
|-

|-
| PLATFORM_X11 || int || All X11 platforms
|-

|-
| PLATFORM_UNKNOWN || int || Unknown platform. Please inform us if PLATFORM == PLATFORM_UNKNOWN so we can make this platform known too ;)
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Message dialog flags'''
|-

|-
| wxOK || int || Flag for Message() 's third argument (flags).
|-

|-
| wxYES_NO || int || -"-
|-

|-
| wxCANCEL || int || -"-
|-

|-
| wxICON_QUESTION || int || -"-
|-

|-
| wxICON_INFORMATION || int || -"-
|-

|-
| wxICON_WARNING || int || -"-
|-

|-
| wxICON_ERROR || int || -"-
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Message dialog return values'''
|-

|-
| wxID_OK || int ||
|-

|-
| wxID_YES || int ||
|-

|-
| wxID_NO || int ||
|-

|-
| wxID_CANCEL || int ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum OptionsRelationType'''
|-

|-
| ortCompilerOptions || enum ||
|-

|-
| ortLinkerOptions || enum ||
|-

|-
| ortIncludeDirs || enum ||
|-

|-
| ortLibDirs || enum ||
|-

|-
| ortResDirs || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum OptionsRelation'''
|-

|-
| orUseParentOptionsOnly || enum ||
|-

|-
| orUseTargetOptionsOnly || enum ||
|-

|-
| orPrependToParentOptions || enum ||
|-

|-
| orAppendToParentOptions || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum TargetType'''
|-

|-
| ttExecutable || enum ||
|-

|-
| ttConsoleOnly || enum ||
|-

|-
| ttStaticLib || enum ||
|-

|-
| ttDynamicLib || enum ||
|-

|-
| ttCommandsOnly || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum MakeCommand'''
|-

|-
| mcClean || enum ||
|-

|-
| mcDistClean || enum ||
|-

|-
| mcBuild || enum ||
|-

|-
| mcCompileFile || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PCHMode'''
|-

|-
| pchSourceDir || enum ||
|-

|-
| pchObjectDir || enum ||
|-

|-
| pchSourceFile || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PrintScope'''
|-

|-
| psSelection || enum ||
|-

|-
| psActiveEditor || enum ||
|-

|-
| psAllOpenEditors || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PrintColourMode'''
|-

|-
| pcmBlackAndWhite || enum ||
|-

|-
| pcmColourOnWhite || enum ||
|-

|-
| pcmInvertColours || enum ||
|-

|-
| pcmAsIs || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum TemplateOutputType'''
|-

|-
| wizProject || enum || TemplateOutputType::totProject
|-

|-
| wizTarget || enum || TemplateOutputType::totTarget
|-

|-
| wizFiles || enum || TemplateOutputType::totFiles
|-

|-
| wizCustom || enum || TemplateOutputType::totCustom
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Other constants'''
|-

|-
| wxFILE_SEP_PATH || wxString || Path separator. "\" for windows, "/" for all other platforms
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''File extensions (e.g. "cbp")'''
|-

|-
| EXT_WORKSPACE || wxString ||
|-

|-
| EXT_CODEBLOCKS || wxString ||
|-

|-
| EXT_DEVCPP || wxString ||
|-

|-
| EXT_MSVC6 || wxString ||
|-

|-
| EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| EXT_MSVC7 || wxString ||
|-

|-
| EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| EXT_D || wxString ||
|-

|-
| EXT_F || wxString ||
|-

|-
| EXT_F77 || wxString ||
|-

|-
| EXT_F95 || wxString ||
|-

|-
| EXT_CPP || wxString ||
|-

|-
| EXT_C || wxString ||
|-

|-
| EXT_CC || wxString ||
|-

|-
| EXT_CXX || wxString ||
|-

|-
| EXT_HPP || wxString ||
|-

|-
| EXT_H || wxString ||
|-

|-
| EXT_HH || wxString ||
|-

|-
| EXT_HXX || wxString ||
|-

|-
| EXT_OBJECT || wxString ||
|-

|-
| EXT_XRCRESOURCE || wxString ||
|-

|-
| EXT_STATICLIB || wxString ||
|-

|-
| EXT_DYNAMICLIB || wxString ||
|-

|-
| EXT_EXECUTABLE || wxString ||
|-

|-
| EXT_RESOURCE || wxString ||
|-

|-
| EXT_RESOURCEBIN || wxString ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''File extensions with leading dot (e.g. ".cbp")'''
|-

|-
| DOT_EXT_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_CODEBLOCKS || wxString ||
|-

|-
| DOT_EXT_DEVCPP || wxString ||
|-

|-
| DOT_EXT_MSVC6 || wxString ||
|-

|-
| DOT_EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_MSVC7 || wxString ||
|-

|-
| DOT_EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_D || wxString ||
|-

|-
| DOT_EXT_F || wxString ||
|-

|-
| DOT_EXT_F77 || wxString ||
|-

|-
| DOT_EXT_F95 || wxString ||
|-

|-
| DOT_EXT_CPP || wxString ||
|-

|-
| DOT_EXT_C || wxString ||
|-

|-
| DOT_EXT_CC || wxString ||
|-

|-
| DOT_EXT_CXX || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_H || wxString ||
|-

|-
| DOT_EXT_HH || wxString ||
|-

|-
| DOT_EXT_HXX || wxString ||
|-

|-
| DOT_EXT_OBJECT || wxString ||
|-

|-
| DOT_EXT_XRCRESOURCE || wxString ||
|-

|-
| DOT_EXT_STATICLIB || wxString ||
|-

|-
| DOT_EXT_DYNAMICLIB || wxString ||
|-

|-
| DOT_EXT_EXECUTABLE || wxString ||
|-

|-
| DOT_EXT_RESOURCE || wxString ||
|-

|-
| DOT_EXT_RESOURCEBIN || wxString ||
|-

|}

== See also ==

* [[Scripting Code::Blocks|Scripting index]]

Scripting commands

2006-12-15T13:53:12Z

Mandrav: IO notes about the security layer

[[Category:Scripting Code::Blocks]]
Scripting is no good if all you can do is use the scripting language's builtin 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.''

== 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 ||
|-

|-
| void || ShowMessage || wxString ||
|-

|-
| void || ShowWarning || wxString ||
|-

|-
| void || ShowError || wxString ||
|-

|-
| void || ShowInfo || wxString ||
|-

|-
| wxString || ReplaceMacros || wxString,bool ||
|-

|-
| ScriptingManager* || GetScriptingManager || ||
|-

|-
| ProjectManager* || GetProjectManager || ||
|-

|-
| EditorManager* || GetEditorManager || ||
|-

|-
| ConfigManager* || GetConfigManager || ||
|-

|-
| UserVariableManager* || GetUserVariableManager || ||
|-

|-
| CompilerFactory* || GetCompilerFactory || ||
|-

|-
| wxString || GetFolder || int || see API docs for ConfigManager::GetFolder()
|-

|-
| wxString || LocateDataFile|| wxString, int || see API docs for ConfigManager::LocateDataFile()
|-

|-
| bool || InstallPlugin || wxString,bool, bool || Install a binary plugin
|-

|-
| void || Include || wxString || similar to C/C++ ''<tt>#include "name"</tt>''
|-

|-
| bool || IsNull || void* ||
|-

|-
| wxString || _T || const char* || basically this is the wxString constructor
|-

|}

== ScriptingManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || RegisterScriptMenu || wxString, wxString || registers the script file (arg1) under a menu item (arg2).
e.g. <tt>GetScriptingManager().RegisterScriptMenu(_T("sample.script"), _T("Scripts/Sample script"))</tt>;
|-

|}

Notes about the <tt>RegisterScriptMenu</tt> function: 
* The second argument (menu item) is a string containing the full menu path to create the menu item. The path separator is a slash (/). For example, the string "Settings/Sample menu/Sample item" would create the menu path "Settings->Sample menu->Sample item".
* When each part of the path is evaluated, it is checked whether it starts with a number followed by a colon (:). If so then this is considered to be a menu index in the parent menu and the menu is inserted at that index instead of being appended to the menu. The number and colon are removed from the string.
* If the menu item starts with a dash (-), then a separator line is prepended in the menu before the menu item (e.g. "Scripts/'''-'''Sample script").
* For your convenience, all menu items created using this function have one extra functionality: if you keep the SHIFT key pressed while clicking on any of these "script menu items", instead of running the attached script, Code::Blocks will open it in the editor for you to view/edit :).
* Have a look at the [[Startup script#Example|startup script example]].

== ConfigManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| int || Read || int,int ||
|-

|-
| bool || Read || bool,bool ||
|-

|-
| float || Read || float,float ||
|-

|-
| wxString || Read || wxString,wxString ||
|-

|-
| void || Write || int,int ||
|-

|-
| void || Write || bool,bool ||
|-

|-
| void || Write || float,float ||
|-

|-
| void || Write || wxString,wxString[,bool] ||
|-

|}

== ProjectManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetDefaultPath || ||
|-

|-
| void || SetDefaultPath || wxString ||
|-

|-
| cbProject* || GetActiveProject || ||
|-

|-
| void || SetProject || cbProject* ||
|-

|-
| bool || LoadWorkspace || wxString ||
|-

|-
| bool || SaveWorkspace || ||
|-

|-
| bool || SaveWorkspaceAs || wxString ||
|-

|-
| bool || CloseWorkspace || ||
|-

|-
| cbProject* || IsOpen || wxString ||
|-

|-
| cbProject* || LoadProject || wxString,bool ||
|-

|-
| bool || SaveProject || cbProject* ||
|-

|-
| bool || SaveProjectAs || cbProject* ||
|-

|-
| bool || SaveActiveProject || ||
|-

|-
| bool || SaveActiveProjectAs || ||
|-

|-
| bool || SaveAllProjects || ||
|-

|-
| bool || CloseProject || cbProject*,bool,bool ||
|-

|-
| bool || CloseActiveProject || bool ||
|-

|-
| bool || CloseAllProjects || bool ||
|-

|-
| cbProject* || NewProject || wxString ||
|-

|-
| int || AddFileToProject || wxString,cbProject*,int ||
|-

|-
| int || AskForBuildTargetIndex || cbProject* ||
|-

|-
| void || RebuildTree || ||
|-

|}

== EditorManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || Configure || ||
|-

|-
| cbEditor* || New || wxString ||
|-

|-
| cbEditor* || Open || wxString ||
|-

|-
| cbEditor* || IsBuiltinOpen || wxString ||
|-

|-
| cbEditor* || GetBuiltinEditor || wxString|int ||
|-

|-
| cbEditor* || GetBuiltinActiveEditor || ||
|-

|-
| EditorBase* || GetActiveEditor || ||
|-

|-
| void || ActivateNext || ||
|-

|-
| void || ActivatePrevious || ||
|-

|-
| bool || SwapActiveHeaderSource || ||
|-

|-
| bool || CloseActive || bool ||
|-

|-
| bool || Close || wxString|int,bool ||
|-

|-
| bool || CloseAll || bool ||
|-

|-
| bool || Save || wxString|int ||
|-

|-
| bool || SaveActive || ||
|-

|-
| bool || SaveAs || int ||
|-

|-
| bool || SaveActiveAs || ||
|-

|-
| bool || SaveAll || ||
|-

|-
| int || ShowFindDialog || bool,bool ||
|-

|}

== UserVariableManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || Exists || wxString ||
|-

|}

== IO namespace ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || DirectoryExists || wxString ||
|-

|-
| wxString || SelectDirectory || wxString,wxString,bool ||
|-

|-
| bool || '''CreateDirectory''' || wxString,int || arg1=dir, arg2=permissions
|-

|-
| bool || '''RemoveDirectory''' || wxString ||
|-

|-
| bool || '''CopyFile''' || wxString,wxString,bool || src,dest,overwrite
|-

|-
| bool || '''RenameFile''' || wxString,wxString || old,new
|-

|-
| bool || '''RemoveFile''' || wxString ||
|-

|-
| bool || FileExists || wxString ||
|-

|-
| wxString || SelectFile || wxString,wxString,wxString ||
|-

|-
| bool || '''WriteFileContents''' || wxString,wxString || filename,contents
|-

|-
| int || '''Execute''' || wxString ||
|-

|-
| wxString || '''ExecuteAndGetOutput''' || wxString ||
|-

|}

'''Notes:'''
The functions in bold are going through the scripts security layer so there is no guarantee calling them will succeed. You should always examine the return value...
There exists one constant too, named ''allowInsecureScripts'', which allow you to test whether Code::Blocks was compiled with the functions going through the security layer.

== CompilerFactory ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || IsValidCompilerID || wxString ||
|-

|-
| int || GetCompilerIndex || wxString ||
|-

|-
| wxString || GetDefaultCompilerID || ||
|-

|-
| bool || CompilerInheritsFrom || ||
|-

|}

== wxString ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || operator+ || ||
|-

|-
| bool || operator< || ||
|-

|-
| bool || operator<= || ||
|-

|-
| bool || operator>= || ||
|-

|-
| bool || operator> || ||
|-

|-
| int || Find || wxString ||
|-

|-
| bool || Matches || wxString ||
|-

|-
| void || AddChar || char ||
|-

|-
| char || GetChar || int ||
|-

|-
| bool || IsEmpty || ||
|-

|-
| int || Length || ||
|-

|-
| int || length || || same as Length()
|-

|-
| int || len || || same as Length()
|-

|-
| int || size || || same as Length()
|-

|-
| wxString || Lower || ||
|-

|-
| wxString || LowerCase || || same as Lower()
|-

|-
| void || MakeLower || ||
|-

|-
| wxString || Upper || ||
|-

|-
| wxString || UpperCase || || same as Upper()
|-

|-
| void || MakeUpper || ||
|-

|-
| wxString || Mid || int,int ||
|-

|-
| void || Remove || int,int ||
|-

|-
| void || RemoveLast || ||
|-

|-
| int || Replace || wxString,wxString[,bool] ||
|-

|-
| wxString || Right || int ||
|-

|-
| wxString || AfterFirst || char ||
|-

|-
| wxString || AfterLast || char ||
|-

|-
| wxString || BeforeFirst || char ||
|-

|-
| wxString || BeforeLast || char ||
|-
|}

== 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 ||
|-

|-
| void || Clear || ||
|-

|-
| int || GetCount || ||
|-

|-
| wxString || Item || int ||
|-

|}

== ProjectFile ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || AddBuildTarget || wxString ||
|-

|-
| void || RenameBuildTarget || wxString,wxString ||
|-

|-
| void || RemoveBuildTarget || wxString ||
|-

|-
| wxString || GetBaseName || ||
|-

|-
| wxString || GetObjName || ||
|-

|-
| void || SetObjName || wxString ||
|-

|-
| cbProject* || GetParentProject || ||
|-

|-
| wxString || relativeFilename || || (variable)
|-

|-
| wxString || relativeToCommonTopLevelPath || || (variable)
|-

|-
| bool || compile || || (variable)
|-

|-
| bool || link || || (variable)
|-

|-
| int || weight || || (variable)
|-

|-
| wxString || compilerVar || || (variable)
|-

|}

== CompileOptionsBase ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || SetLinkerOptions || wxArrayString ||
|-

|-
| void || SetLinkLibs || wxArrayString ||
|-

|-
| void || SetCompilerOptions || wxArrayString ||
|-

|-
| void || SetIncludeDirs || wxArrayString ||
|-

|-
| void || SetResourceIncludeDirs || wxArrayString ||
|-

|-
| void || SetLibDirs || wxArrayString ||
|-

|-
| void || SetCommandsBeforeBuild || wxArrayString ||
|-

|-
| void || SetCommandsAfterBuild || wxArrayString ||
|-

|-
| wxArrayString || GetLinkerOptions || ||
|-

|-
| wxArrayString || GetLinkLibs || ||
|-

|-
| wxArrayString || GetCompilerOptions || ||
|-

|-
| wxArrayString || GetIncludeDirs || ||
|-

|-
| wxArrayString || GetResourceIncludeDirs || ||
|-

|-
| wxArrayString || GetLibDirs || ||
|-

|-
| wxArrayString || GetCommandsBeforeBuild || ||
|-

|-
| wxArrayString || GetCommandsAfterBuild || ||
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| void || AddLinkerOption || wxString ||
|-

|-
| void || AddLinkLib || wxString ||
|-

|-
| void || AddCompilerOption || wxString ||
|-

|-
| void || AddIncludeDir || wxString ||
|-

|-
| void || AddResourceIncludeDir || wxString ||
|-

|-
| void || AddLibDir || wxString ||
|-

|-
| void || AddCommandsBeforeBuild || wxString ||
|-

|-
| void || AddCommandsAfterBuild || wxString ||
|-

|-
| void || RemoveLinkerOption || wxString ||
|-

|-
| void || RemoveLinkLib || wxString ||
|-

|-
| void || RemoveCompilerOption || wxString ||
|-

|-
| void || RemoveIncludeDir || wxString ||
|-

|-
| void || RemoveResourceIncludeDir || wxString ||
|-

|-
| void || RemoveLibDir || wxString ||
|-

|-
| void || RemoveCommandsBeforeBuild || wxString ||
|-

|-
| void || RemoveCommandsAfterBuild || wxString ||
|-

|-
| bool || GetAlwaysRunPostBuildSteps || ||
|-

|-
| void || SetAlwaysRunPostBuildSteps || bool ||
|-

|-
| bool || SetVar || wxString,wxString,bool ||
|-

|-
| wxString || GetVar || wxString ||
|-

|-
| bool || UnsetVar || wxString ||
|-

|-
| void || UnsetAllVars || ||
|-

|}

== CompileTargetBase ==
Extends CompileOptionsBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetFilename || ||
|-

|-
| wxString || GetTitle || ||
|-

|-
| void || SetTitle || wxString ||
|-

|-
| void || SetOutputFilename || wxString ||
|-

|-
| void || SetWorkingDir || wxString ||
|-

|-
| void || SetObjectOutput || wxString ||
|-

|-
| void || SetDepsOutput || wxString ||
|-

|-
| OptionsRelation || GetOptionRelation || OptionsRelationType ||
|-

|-
| void || SetOptionRelation || OptionsRelationType,OptionsRelation ||
|-

|-
| wxString || GetWorkingDir || ||
|-

|-
| wxString || GetObjectOutput || ||
|-

|-
| wxString || GetDepsOutput || ||
|-

|-
| wxString || GetOutputFilename || ||
|-

|-
| wxString || SuggestOutputFilename || ||
|-

|-
| wxString || GetExecutableFilename || ||
|-

|-
| wxString || GetDynamicLibFilename || ||
|-

|-
| wxString || GetDynamicLibDefFilename || ||
|-

|-
| wxString || GetStaticLibFilename || ||
|-

|-
| wxString || GetBasePath || ||
|-

|-
| void || SetTargetType || TargetType ||
|-

|-
| TargetType || GetTargetType || ||
|-

|-
| wxString || GetExecutionParameters || ||
|-

|-
| void || SetExecutionParameters || wxString ||
|-

|-
| wxString || GetHostApplication || ||
|-

|-
| void || SetHostApplication || wxString ||
|-

|-
| void || SetCompilerID || wxString ||
|-

|-
| wxString || GetCompilerID || ||
|-

|}

== ProjectBuildTarget ==
Extends CompileTargetBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| cbProject* || GetParentProject || ||
|-

|-
| wxString || GetFullTitle || ||
|-

|-
| wxString || GetExternalDeps || ||
|-

|-
| void || SetExternalDeps || wxString ||
|-

|-
| void || SetAdditionalOutputFiles || wxString ||
|-

|-
| wxString || GetAdditionalOutputFiles || ||
|-

|-
| bool || GetIncludeInTargetAll || ||
|-

|-
| void || SetIncludeInTargetAll || bool ||
|-

|-
| bool || GetCreateDefFile || ||
|-

|-
| void || SetCreateDefFile || bool ||
|-

|-
| bool || GetCreateStaticLib || ||
|-

|-
| void || SetCreateStaticLib || bool ||
|-

|-
| bool || GetUseConsoleRunner || ||
|-

|-
| void || SetUseConsoleRunner || bool ||
|-

|}

== cbProject ==
Extends CompileTargetBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| wxString || GetMakefile || ||
|-

|-
| void || SetMakefile || wxString ||
|-

|-
| bool || IsMakefileCustom || ||
|-

|-
| void || SetMakefileCustom || bool ||
|-

|-
| bool || CloseAllFiles || bool ||
|-

|-
| bool || SaveAllFiles || ||
|-

|-
| bool || Save || ||
|-

|-
| bool || SaveLayout || ||
|-

|-
| bool || LoadLayout || ||
|-

|-
| bool || ShowOptions || ||
|-

|-
| wxString || GetCommonTopLevelPath || ||
|-

|-
| int || GetFilesCount || ||
|-

|-
| ProjectFile* || GetFile || int ||
|-

|-
| ProjectFile* || GetFileByFilename || wxString,bool,bool ||
|-

|-
| bool || RemoveFile || int ||
|-

|-
| ProjectFile* || AddFile || wxString|int,wxString,bool,bool,int ||
|-

|-
| int || GetBuildTargetsCount || ||
|-

|-
| ProjectBuildTarget* || GetBuildTarget || wxString|int ||
|-

|-
| ProjectBuildTarget* || AddBuildTarget || wxString ||
|-

|-
| bool || RenameBuildTarget || wxString|int,wxString ||
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || wxString|int,wxString ||
|-

|-
| bool || RemoveBuildTarget || wxString|int ||
|-

|-
| bool || ExportTargetAsProject || wxString|int ||
|-

|-
| void || SetActiveBuildTarget || int ||
|-

|-
| int || GetActiveBuildTarget || ||
|-

|-
| int || SelectTarget || int,bool ||
|-

|-
| ProjectBuildTarget* || GetCurrentlyCompilingTarget || ||
|-

|-
| void || SetCurrentlyCompilingTarget || ProjectBuildTarget* ||
|-

|-
| PCHMode || GetModeForPCH || ||
|-

|-
| void || SetModeForPCH || PCHMode ||
|-

|}

== EditorBase ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetFilename || ||
|-

|-
| void || SetFilename || wxString ||
|-

|-
| wxString || GetShortName || ||
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| wxString || GetTitle || ||
|-

|-
| void || SetTitle || wxString ||
|-

|-
| void || Activate || ||
|-

|-
| bool || Close || ||
|-

|-
| bool || Save || ||
|-

|-
| bool || IsBuiltinEditor || ||
|-

|-
| bool || ThereAreOthers || ||
|-

|-
| void || GotoLine || int,bool ||
|-

|-
| void || ToggleBreakpoint || int,bool ||
|-

|-
| bool || HasBreakpoint || int ||
|-

|-
| void || GotoNextBreakpoint || ||
|-

|-
| void || GotoPreviousBreakpoint || ||
|-

|-
| void || ToggleBookmark || int,bool ||
|-

|-
| bool || HasBookmark || int ||
|-

|-
| void || GotoNextBookmark || ||
|-

|-
| void || GotoPreviousBookmark || ||
|-

|-
| void || Undo || ||
|-

|-
| void || Redo || ||
|-

|-
| void || Cut || ||
|-

|-
| void || Copy || ||
|-

|-
| void || Paste || ||
|-

|-
| bool || CanUndo || ||
|-

|-
| bool || CanRedo || ||
|-

|-
| bool || CanPaste || ||
|-

|-
| bool || HasSelection || ||
|-

|}

== cbEditor ==
Extends EditorBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || SetEditorTitle || wxString ||
|-

|-
| ProjectFile* || GetProjectFile || ||
|-

|-
| bool || SaveAs || ||
|-

|-
| void || FoldAll || ||
|-

|-
| void || UnfoldAll || ||
|-

|-
| void || ToggleAllFolds || ||
|-

|-
| void || FoldBlockFromLine || int ||
|-

|-
| void || UnfoldBlockFromLine || int ||
|-

|-
| void || ToggleFoldBlockFromLine || int ||
|-

|-
| int || GetLineIndentInSpaces || int ||
|-

|-
| wxString || GetLineIndentString || int ||
|-

|-
| void || Touch || ||
|-

|-
| bool || Reload || bool ||
|-

|-
| void || Print || bool,PrintColourMode,bool ||
|-

|-
| void || AutoComplete || ||
|-

|-
| bool || AddBreakpoint || int,bool ||
|-

|-
| bool || RemoveBreakpoint || int,bool ||
|-

|-
| void || SetText || wxString || this is not present in cbEditor; included to help scripts edit text
|-

|-
| wxString || GetText || || this is not present in cbEditor; included to help scripts edit text
|-

|}

== Constants ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"

|- style="background: #ececec; border: 0px solid gray"
!Constant
!Type
!Remarks
|-

|-
| PLATFORM || int || this defines the platform Code::Blocks is currently running on. It is equal to only one of the following PLATFORM_* constants
|-

|-
| PLATFORM_MSW || int || All Windows platforms
|-

|-
| PLATFORM_GTK || int || All GTK platforms (Linux, BSD, Solaris, Darwin, etc.)
|-

|-
| PLATFORM_MAC || int || All Mac platforms
|-

|-
| PLATFORM_OS2 || int || OS/2 platform
|-

|-
| PLATFORM_X11 || int || All X11 platforms
|-

|-
| PLATFORM_UNKNOWN || int || Unknown platform. Please inform us if PLATFORM == PLATFORM_UNKNOWN so we can make this platform known too ;)
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Message dialog flags'''
|-

|-
| wxOK || int || Flag for Message() 's third argument (flags).
|-

|-
| wxYES_NO || int || -"-
|-

|-
| wxCANCEL || int || -"-
|-

|-
| wxICON_QUESTION || int || -"-
|-

|-
| wxICON_INFORMATION || int || -"-
|-

|-
| wxICON_WARNING || int || -"-
|-

|-
| wxICON_ERROR || int || -"-
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Message dialog return values'''
|-

|-
| wxID_OK || int ||
|-

|-
| wxID_YES || int ||
|-

|-
| wxID_NO || int ||
|-

|-
| wxID_CANCEL || int ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum OptionsRelationType'''
|-

|-
| ortCompilerOptions || enum ||
|-

|-
| ortLinkerOptions || enum ||
|-

|-
| ortIncludeDirs || enum ||
|-

|-
| ortLibDirs || enum ||
|-

|-
| ortResDirs || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum OptionsRelation'''
|-

|-
| orUseParentOptionsOnly || enum ||
|-

|-
| orUseTargetOptionsOnly || enum ||
|-

|-
| orPrependToParentOptions || enum ||
|-

|-
| orAppendToParentOptions || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum TargetType'''
|-

|-
| ttExecutable || enum ||
|-

|-
| ttConsoleOnly || enum ||
|-

|-
| ttStaticLib || enum ||
|-

|-
| ttDynamicLib || enum ||
|-

|-
| ttCommandsOnly || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum MakeCommand'''
|-

|-
| mcClean || enum ||
|-

|-
| mcDistClean || enum ||
|-

|-
| mcBuild || enum ||
|-

|-
| mcCompileFile || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PCHMode'''
|-

|-
| pchSourceDir || enum ||
|-

|-
| pchObjectDir || enum ||
|-

|-
| pchSourceFile || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PrintScope'''
|-

|-
| psSelection || enum ||
|-

|-
| psActiveEditor || enum ||
|-

|-
| psAllOpenEditors || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PrintColourMode'''
|-

|-
| pcmBlackAndWhite || enum ||
|-

|-
| pcmColourOnWhite || enum ||
|-

|-
| pcmInvertColours || enum ||
|-

|-
| pcmAsIs || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum TemplateOutputType'''
|-

|-
| wizProject || enum || TemplateOutputType::totProject
|-

|-
| wizTarget || enum || TemplateOutputType::totTarget
|-

|-
| wizFiles || enum || TemplateOutputType::totFiles
|-

|-
| wizCustom || enum || TemplateOutputType::totCustom
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Other constants'''
|-

|-
| wxFILE_SEP_PATH || wxString || Path separator. "\" for windows, "/" for all other platforms
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''File extensions (e.g. "cbp")'''
|-

|-
| EXT_WORKSPACE || wxString ||
|-

|-
| EXT_CODEBLOCKS || wxString ||
|-

|-
| EXT_DEVCPP || wxString ||
|-

|-
| EXT_MSVC6 || wxString ||
|-

|-
| EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| EXT_MSVC7 || wxString ||
|-

|-
| EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| EXT_D || wxString ||
|-

|-
| EXT_F || wxString ||
|-

|-
| EXT_F77 || wxString ||
|-

|-
| EXT_F95 || wxString ||
|-

|-
| EXT_CPP || wxString ||
|-

|-
| EXT_C || wxString ||
|-

|-
| EXT_CC || wxString ||
|-

|-
| EXT_CXX || wxString ||
|-

|-
| EXT_HPP || wxString ||
|-

|-
| EXT_H || wxString ||
|-

|-
| EXT_HH || wxString ||
|-

|-
| EXT_HXX || wxString ||
|-

|-
| EXT_OBJECT || wxString ||
|-

|-
| EXT_XRCRESOURCE || wxString ||
|-

|-
| EXT_STATICLIB || wxString ||
|-

|-
| EXT_DYNAMICLIB || wxString ||
|-

|-
| EXT_EXECUTABLE || wxString ||
|-

|-
| EXT_RESOURCE || wxString ||
|-

|-
| EXT_RESOURCEBIN || wxString ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''File extensions with leading dot (e.g. ".cbp")'''
|-

|-
| DOT_EXT_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_CODEBLOCKS || wxString ||
|-

|-
| DOT_EXT_DEVCPP || wxString ||
|-

|-
| DOT_EXT_MSVC6 || wxString ||
|-

|-
| DOT_EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_MSVC7 || wxString ||
|-

|-
| DOT_EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_D || wxString ||
|-

|-
| DOT_EXT_F || wxString ||
|-

|-
| DOT_EXT_F77 || wxString ||
|-

|-
| DOT_EXT_F95 || wxString ||
|-

|-
| DOT_EXT_CPP || wxString ||
|-

|-
| DOT_EXT_C || wxString ||
|-

|-
| DOT_EXT_CC || wxString ||
|-

|-
| DOT_EXT_CXX || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_H || wxString ||
|-

|-
| DOT_EXT_HH || wxString ||
|-

|-
| DOT_EXT_HXX || wxString ||
|-

|-
| DOT_EXT_OBJECT || wxString ||
|-

|-
| DOT_EXT_XRCRESOURCE || wxString ||
|-

|-
| DOT_EXT_STATICLIB || wxString ||
|-

|-
| DOT_EXT_DYNAMICLIB || wxString ||
|-

|-
| DOT_EXT_EXECUTABLE || wxString ||
|-

|-
| DOT_EXT_RESOURCE || wxString ||
|-

|-
| DOT_EXT_RESOURCEBIN || wxString ||
|-

|}

== See also ==

* [[Scripting Code::Blocks|Scripting index]]

Scripting commands

2006-12-15T13:46:00Z

Mandrav: Update IO functions

[[Category:Scripting Code::Blocks]]
Scripting is no good if all you can do is use the scripting language's builtin 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.''

== 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 ||
|-

|-
| void || ShowMessage || wxString ||
|-

|-
| void || ShowWarning || wxString ||
|-

|-
| void || ShowError || wxString ||
|-

|-
| void || ShowInfo || wxString ||
|-

|-
| wxString || ReplaceMacros || wxString,bool ||
|-

|-
| ScriptingManager* || GetScriptingManager || ||
|-

|-
| ProjectManager* || GetProjectManager || ||
|-

|-
| EditorManager* || GetEditorManager || ||
|-

|-
| ConfigManager* || GetConfigManager || ||
|-

|-
| UserVariableManager* || GetUserVariableManager || ||
|-

|-
| CompilerFactory* || GetCompilerFactory || ||
|-

|-
| wxString || GetFolder || int || see API docs for ConfigManager::GetFolder()
|-

|-
| wxString || LocateDataFile|| wxString, int || see API docs for ConfigManager::LocateDataFile()
|-

|-
| bool || InstallPlugin || wxString,bool, bool || Install a binary plugin
|-

|-
| void || Include || wxString || similar to C/C++ ''<tt>#include "name"</tt>''
|-

|-
| bool || IsNull || void* ||
|-

|-
| wxString || _T || const char* || basically this is the wxString constructor
|-

|}

== ScriptingManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || RegisterScriptMenu || wxString, wxString || registers the script file (arg1) under a menu item (arg2).
e.g. <tt>GetScriptingManager().RegisterScriptMenu(_T("sample.script"), _T("Scripts/Sample script"))</tt>;
|-

|}

Notes about the <tt>RegisterScriptMenu</tt> function: 
* The second argument (menu item) is a string containing the full menu path to create the menu item. The path separator is a slash (/). For example, the string "Settings/Sample menu/Sample item" would create the menu path "Settings->Sample menu->Sample item".
* When each part of the path is evaluated, it is checked whether it starts with a number followed by a colon (:). If so then this is considered to be a menu index in the parent menu and the menu is inserted at that index instead of being appended to the menu. The number and colon are removed from the string.
* If the menu item starts with a dash (-), then a separator line is prepended in the menu before the menu item (e.g. "Scripts/'''-'''Sample script").
* For your convenience, all menu items created using this function have one extra functionality: if you keep the SHIFT key pressed while clicking on any of these "script menu items", instead of running the attached script, Code::Blocks will open it in the editor for you to view/edit :).
* Have a look at the [[Startup script#Example|startup script example]].

== ConfigManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| int || Read || int,int ||
|-

|-
| bool || Read || bool,bool ||
|-

|-
| float || Read || float,float ||
|-

|-
| wxString || Read || wxString,wxString ||
|-

|-
| void || Write || int,int ||
|-

|-
| void || Write || bool,bool ||
|-

|-
| void || Write || float,float ||
|-

|-
| void || Write || wxString,wxString[,bool] ||
|-

|}

== ProjectManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetDefaultPath || ||
|-

|-
| void || SetDefaultPath || wxString ||
|-

|-
| cbProject* || GetActiveProject || ||
|-

|-
| void || SetProject || cbProject* ||
|-

|-
| bool || LoadWorkspace || wxString ||
|-

|-
| bool || SaveWorkspace || ||
|-

|-
| bool || SaveWorkspaceAs || wxString ||
|-

|-
| bool || CloseWorkspace || ||
|-

|-
| cbProject* || IsOpen || wxString ||
|-

|-
| cbProject* || LoadProject || wxString,bool ||
|-

|-
| bool || SaveProject || cbProject* ||
|-

|-
| bool || SaveProjectAs || cbProject* ||
|-

|-
| bool || SaveActiveProject || ||
|-

|-
| bool || SaveActiveProjectAs || ||
|-

|-
| bool || SaveAllProjects || ||
|-

|-
| bool || CloseProject || cbProject*,bool,bool ||
|-

|-
| bool || CloseActiveProject || bool ||
|-

|-
| bool || CloseAllProjects || bool ||
|-

|-
| cbProject* || NewProject || wxString ||
|-

|-
| int || AddFileToProject || wxString,cbProject*,int ||
|-

|-
| int || AskForBuildTargetIndex || cbProject* ||
|-

|-
| void || RebuildTree || ||
|-

|}

== EditorManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || Configure || ||
|-

|-
| cbEditor* || New || wxString ||
|-

|-
| cbEditor* || Open || wxString ||
|-

|-
| cbEditor* || IsBuiltinOpen || wxString ||
|-

|-
| cbEditor* || GetBuiltinEditor || wxString|int ||
|-

|-
| cbEditor* || GetBuiltinActiveEditor || ||
|-

|-
| EditorBase* || GetActiveEditor || ||
|-

|-
| void || ActivateNext || ||
|-

|-
| void || ActivatePrevious || ||
|-

|-
| bool || SwapActiveHeaderSource || ||
|-

|-
| bool || CloseActive || bool ||
|-

|-
| bool || Close || wxString|int,bool ||
|-

|-
| bool || CloseAll || bool ||
|-

|-
| bool || Save || wxString|int ||
|-

|-
| bool || SaveActive || ||
|-

|-
| bool || SaveAs || int ||
|-

|-
| bool || SaveActiveAs || ||
|-

|-
| bool || SaveAll || ||
|-

|-
| int || ShowFindDialog || bool,bool ||
|-

|}

== UserVariableManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || Exists || wxString ||
|-

|}

== IO namespace ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || DirectoryExists || wxString ||
|-

|-
| wxString || SelectDirectory || wxString,wxString,bool ||
|-

|-
| bool || CreateDirectory || wxString,int || arg1=dir, arg2=permissions
|-

|-
| bool || RemoveDirectory || wxString ||
|-

|-
| bool || CopyFile || wxString,wxString,bool || src,dest,overwrite
|-

|-
| bool || RenameFile || wxString,wxString || old,new
|-

|-
| bool || RemoveFile || wxString ||
|-

|-
| bool || FileExists || wxString ||
|-

|-
| wxString || SelectFile || wxString,wxString,wxString ||
|-

|-
| bool || WriteFileContents || wxString,wxString || filename,contents
|-

|-
| int || Execute || wxString ||
|-

|-
| wxString || ExecuteAndGetOutput || wxString ||
|-

|}

== CompilerFactory ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || IsValidCompilerID || wxString ||
|-

|-
| int || GetCompilerIndex || wxString ||
|-

|-
| wxString || GetDefaultCompilerID || ||
|-

|-
| bool || CompilerInheritsFrom || ||
|-

|}

== wxString ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || operator+ || ||
|-

|-
| bool || operator< || ||
|-

|-
| bool || operator<= || ||
|-

|-
| bool || operator>= || ||
|-

|-
| bool || operator> || ||
|-

|-
| int || Find || wxString ||
|-

|-
| bool || Matches || wxString ||
|-

|-
| void || AddChar || char ||
|-

|-
| char || GetChar || int ||
|-

|-
| bool || IsEmpty || ||
|-

|-
| int || Length || ||
|-

|-
| int || length || || same as Length()
|-

|-
| int || len || || same as Length()
|-

|-
| int || size || || same as Length()
|-

|-
| wxString || Lower || ||
|-

|-
| wxString || LowerCase || || same as Lower()
|-

|-
| void || MakeLower || ||
|-

|-
| wxString || Upper || ||
|-

|-
| wxString || UpperCase || || same as Upper()
|-

|-
| void || MakeUpper || ||
|-

|-
| wxString || Mid || int,int ||
|-

|-
| void || Remove || int,int ||
|-

|-
| void || RemoveLast || ||
|-

|-
| int || Replace || wxString,wxString[,bool] ||
|-

|-
| wxString || Right || int ||
|-

|-
| wxString || AfterFirst || char ||
|-

|-
| wxString || AfterLast || char ||
|-

|-
| wxString || BeforeFirst || char ||
|-

|-
| wxString || BeforeLast || char ||
|-
|}

== 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 ||
|-

|-
| void || Clear || ||
|-

|-
| int || GetCount || ||
|-

|-
| wxString || Item || int ||
|-

|}

== ProjectFile ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || AddBuildTarget || wxString ||
|-

|-
| void || RenameBuildTarget || wxString,wxString ||
|-

|-
| void || RemoveBuildTarget || wxString ||
|-

|-
| wxString || GetBaseName || ||
|-

|-
| wxString || GetObjName || ||
|-

|-
| void || SetObjName || wxString ||
|-

|-
| cbProject* || GetParentProject || ||
|-

|-
| wxString || relativeFilename || || (variable)
|-

|-
| wxString || relativeToCommonTopLevelPath || || (variable)
|-

|-
| bool || compile || || (variable)
|-

|-
| bool || link || || (variable)
|-

|-
| int || weight || || (variable)
|-

|-
| wxString || compilerVar || || (variable)
|-

|}

== CompileOptionsBase ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || SetLinkerOptions || wxArrayString ||
|-

|-
| void || SetLinkLibs || wxArrayString ||
|-

|-
| void || SetCompilerOptions || wxArrayString ||
|-

|-
| void || SetIncludeDirs || wxArrayString ||
|-

|-
| void || SetResourceIncludeDirs || wxArrayString ||
|-

|-
| void || SetLibDirs || wxArrayString ||
|-

|-
| void || SetCommandsBeforeBuild || wxArrayString ||
|-

|-
| void || SetCommandsAfterBuild || wxArrayString ||
|-

|-
| wxArrayString || GetLinkerOptions || ||
|-

|-
| wxArrayString || GetLinkLibs || ||
|-

|-
| wxArrayString || GetCompilerOptions || ||
|-

|-
| wxArrayString || GetIncludeDirs || ||
|-

|-
| wxArrayString || GetResourceIncludeDirs || ||
|-

|-
| wxArrayString || GetLibDirs || ||
|-

|-
| wxArrayString || GetCommandsBeforeBuild || ||
|-

|-
| wxArrayString || GetCommandsAfterBuild || ||
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| void || AddLinkerOption || wxString ||
|-

|-
| void || AddLinkLib || wxString ||
|-

|-
| void || AddCompilerOption || wxString ||
|-

|-
| void || AddIncludeDir || wxString ||
|-

|-
| void || AddResourceIncludeDir || wxString ||
|-

|-
| void || AddLibDir || wxString ||
|-

|-
| void || AddCommandsBeforeBuild || wxString ||
|-

|-
| void || AddCommandsAfterBuild || wxString ||
|-

|-
| void || RemoveLinkerOption || wxString ||
|-

|-
| void || RemoveLinkLib || wxString ||
|-

|-
| void || RemoveCompilerOption || wxString ||
|-

|-
| void || RemoveIncludeDir || wxString ||
|-

|-
| void || RemoveResourceIncludeDir || wxString ||
|-

|-
| void || RemoveLibDir || wxString ||
|-

|-
| void || RemoveCommandsBeforeBuild || wxString ||
|-

|-
| void || RemoveCommandsAfterBuild || wxString ||
|-

|-
| bool || GetAlwaysRunPostBuildSteps || ||
|-

|-
| void || SetAlwaysRunPostBuildSteps || bool ||
|-

|-
| bool || SetVar || wxString,wxString,bool ||
|-

|-
| wxString || GetVar || wxString ||
|-

|-
| bool || UnsetVar || wxString ||
|-

|-
| void || UnsetAllVars || ||
|-

|}

== CompileTargetBase ==
Extends CompileOptionsBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetFilename || ||
|-

|-
| wxString || GetTitle || ||
|-

|-
| void || SetTitle || wxString ||
|-

|-
| void || SetOutputFilename || wxString ||
|-

|-
| void || SetWorkingDir || wxString ||
|-

|-
| void || SetObjectOutput || wxString ||
|-

|-
| void || SetDepsOutput || wxString ||
|-

|-
| OptionsRelation || GetOptionRelation || OptionsRelationType ||
|-

|-
| void || SetOptionRelation || OptionsRelationType,OptionsRelation ||
|-

|-
| wxString || GetWorkingDir || ||
|-

|-
| wxString || GetObjectOutput || ||
|-

|-
| wxString || GetDepsOutput || ||
|-

|-
| wxString || GetOutputFilename || ||
|-

|-
| wxString || SuggestOutputFilename || ||
|-

|-
| wxString || GetExecutableFilename || ||
|-

|-
| wxString || GetDynamicLibFilename || ||
|-

|-
| wxString || GetDynamicLibDefFilename || ||
|-

|-
| wxString || GetStaticLibFilename || ||
|-

|-
| wxString || GetBasePath || ||
|-

|-
| void || SetTargetType || TargetType ||
|-

|-
| TargetType || GetTargetType || ||
|-

|-
| wxString || GetExecutionParameters || ||
|-

|-
| void || SetExecutionParameters || wxString ||
|-

|-
| wxString || GetHostApplication || ||
|-

|-
| void || SetHostApplication || wxString ||
|-

|-
| void || SetCompilerID || wxString ||
|-

|-
| wxString || GetCompilerID || ||
|-

|}

== ProjectBuildTarget ==
Extends CompileTargetBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| cbProject* || GetParentProject || ||
|-

|-
| wxString || GetFullTitle || ||
|-

|-
| wxString || GetExternalDeps || ||
|-

|-
| void || SetExternalDeps || wxString ||
|-

|-
| void || SetAdditionalOutputFiles || wxString ||
|-

|-
| wxString || GetAdditionalOutputFiles || ||
|-

|-
| bool || GetIncludeInTargetAll || ||
|-

|-
| void || SetIncludeInTargetAll || bool ||
|-

|-
| bool || GetCreateDefFile || ||
|-

|-
| void || SetCreateDefFile || bool ||
|-

|-
| bool || GetCreateStaticLib || ||
|-

|-
| void || SetCreateStaticLib || bool ||
|-

|-
| bool || GetUseConsoleRunner || ||
|-

|-
| void || SetUseConsoleRunner || bool ||
|-

|}

== cbProject ==
Extends CompileTargetBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| wxString || GetMakefile || ||
|-

|-
| void || SetMakefile || wxString ||
|-

|-
| bool || IsMakefileCustom || ||
|-

|-
| void || SetMakefileCustom || bool ||
|-

|-
| bool || CloseAllFiles || bool ||
|-

|-
| bool || SaveAllFiles || ||
|-

|-
| bool || Save || ||
|-

|-
| bool || SaveLayout || ||
|-

|-
| bool || LoadLayout || ||
|-

|-
| bool || ShowOptions || ||
|-

|-
| wxString || GetCommonTopLevelPath || ||
|-

|-
| int || GetFilesCount || ||
|-

|-
| ProjectFile* || GetFile || int ||
|-

|-
| ProjectFile* || GetFileByFilename || wxString,bool,bool ||
|-

|-
| bool || RemoveFile || int ||
|-

|-
| ProjectFile* || AddFile || wxString|int,wxString,bool,bool,int ||
|-

|-
| int || GetBuildTargetsCount || ||
|-

|-
| ProjectBuildTarget* || GetBuildTarget || wxString|int ||
|-

|-
| ProjectBuildTarget* || AddBuildTarget || wxString ||
|-

|-
| bool || RenameBuildTarget || wxString|int,wxString ||
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || wxString|int,wxString ||
|-

|-
| bool || RemoveBuildTarget || wxString|int ||
|-

|-
| bool || ExportTargetAsProject || wxString|int ||
|-

|-
| void || SetActiveBuildTarget || int ||
|-

|-
| int || GetActiveBuildTarget || ||
|-

|-
| int || SelectTarget || int,bool ||
|-

|-
| ProjectBuildTarget* || GetCurrentlyCompilingTarget || ||
|-

|-
| void || SetCurrentlyCompilingTarget || ProjectBuildTarget* ||
|-

|-
| PCHMode || GetModeForPCH || ||
|-

|-
| void || SetModeForPCH || PCHMode ||
|-

|}

== EditorBase ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetFilename || ||
|-

|-
| void || SetFilename || wxString ||
|-

|-
| wxString || GetShortName || ||
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| wxString || GetTitle || ||
|-

|-
| void || SetTitle || wxString ||
|-

|-
| void || Activate || ||
|-

|-
| bool || Close || ||
|-

|-
| bool || Save || ||
|-

|-
| bool || IsBuiltinEditor || ||
|-

|-
| bool || ThereAreOthers || ||
|-

|-
| void || GotoLine || int,bool ||
|-

|-
| void || ToggleBreakpoint || int,bool ||
|-

|-
| bool || HasBreakpoint || int ||
|-

|-
| void || GotoNextBreakpoint || ||
|-

|-
| void || GotoPreviousBreakpoint || ||
|-

|-
| void || ToggleBookmark || int,bool ||
|-

|-
| bool || HasBookmark || int ||
|-

|-
| void || GotoNextBookmark || ||
|-

|-
| void || GotoPreviousBookmark || ||
|-

|-
| void || Undo || ||
|-

|-
| void || Redo || ||
|-

|-
| void || Cut || ||
|-

|-
| void || Copy || ||
|-

|-
| void || Paste || ||
|-

|-
| bool || CanUndo || ||
|-

|-
| bool || CanRedo || ||
|-

|-
| bool || CanPaste || ||
|-

|-
| bool || HasSelection || ||
|-

|}

== cbEditor ==
Extends EditorBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || SetEditorTitle || wxString ||
|-

|-
| ProjectFile* || GetProjectFile || ||
|-

|-
| bool || SaveAs || ||
|-

|-
| void || FoldAll || ||
|-

|-
| void || UnfoldAll || ||
|-

|-
| void || ToggleAllFolds || ||
|-

|-
| void || FoldBlockFromLine || int ||
|-

|-
| void || UnfoldBlockFromLine || int ||
|-

|-
| void || ToggleFoldBlockFromLine || int ||
|-

|-
| int || GetLineIndentInSpaces || int ||
|-

|-
| wxString || GetLineIndentString || int ||
|-

|-
| void || Touch || ||
|-

|-
| bool || Reload || bool ||
|-

|-
| void || Print || bool,PrintColourMode,bool ||
|-

|-
| void || AutoComplete || ||
|-

|-
| bool || AddBreakpoint || int,bool ||
|-

|-
| bool || RemoveBreakpoint || int,bool ||
|-

|-
| void || SetText || wxString || this is not present in cbEditor; included to help scripts edit text
|-

|-
| wxString || GetText || || this is not present in cbEditor; included to help scripts edit text
|-

|}

== Constants ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"

|- style="background: #ececec; border: 0px solid gray"
!Constant
!Type
!Remarks
|-

|-
| PLATFORM || int || this defines the platform Code::Blocks is currently running on. It is equal to only one of the following PLATFORM_* constants
|-

|-
| PLATFORM_MSW || int || All Windows platforms
|-

|-
| PLATFORM_GTK || int || All GTK platforms (Linux, BSD, Solaris, Darwin, etc.)
|-

|-
| PLATFORM_MAC || int || All Mac platforms
|-

|-
| PLATFORM_OS2 || int || OS/2 platform
|-

|-
| PLATFORM_X11 || int || All X11 platforms
|-

|-
| PLATFORM_UNKNOWN || int || Unknown platform. Please inform us if PLATFORM == PLATFORM_UNKNOWN so we can make this platform known too ;)
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Message dialog flags'''
|-

|-
| wxOK || int || Flag for Message() 's third argument (flags).
|-

|-
| wxYES_NO || int || -"-
|-

|-
| wxCANCEL || int || -"-
|-

|-
| wxICON_QUESTION || int || -"-
|-

|-
| wxICON_INFORMATION || int || -"-
|-

|-
| wxICON_WARNING || int || -"-
|-

|-
| wxICON_ERROR || int || -"-
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Message dialog return values'''
|-

|-
| wxID_OK || int ||
|-

|-
| wxID_YES || int ||
|-

|-
| wxID_NO || int ||
|-

|-
| wxID_CANCEL || int ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum OptionsRelationType'''
|-

|-
| ortCompilerOptions || enum ||
|-

|-
| ortLinkerOptions || enum ||
|-

|-
| ortIncludeDirs || enum ||
|-

|-
| ortLibDirs || enum ||
|-

|-
| ortResDirs || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum OptionsRelation'''
|-

|-
| orUseParentOptionsOnly || enum ||
|-

|-
| orUseTargetOptionsOnly || enum ||
|-

|-
| orPrependToParentOptions || enum ||
|-

|-
| orAppendToParentOptions || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum TargetType'''
|-

|-
| ttExecutable || enum ||
|-

|-
| ttConsoleOnly || enum ||
|-

|-
| ttStaticLib || enum ||
|-

|-
| ttDynamicLib || enum ||
|-

|-
| ttCommandsOnly || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum MakeCommand'''
|-

|-
| mcClean || enum ||
|-

|-
| mcDistClean || enum ||
|-

|-
| mcBuild || enum ||
|-

|-
| mcCompileFile || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PCHMode'''
|-

|-
| pchSourceDir || enum ||
|-

|-
| pchObjectDir || enum ||
|-

|-
| pchSourceFile || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PrintScope'''
|-

|-
| psSelection || enum ||
|-

|-
| psActiveEditor || enum ||
|-

|-
| psAllOpenEditors || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PrintColourMode'''
|-

|-
| pcmBlackAndWhite || enum ||
|-

|-
| pcmColourOnWhite || enum ||
|-

|-
| pcmInvertColours || enum ||
|-

|-
| pcmAsIs || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum TemplateOutputType'''
|-

|-
| wizProject || enum || TemplateOutputType::totProject
|-

|-
| wizTarget || enum || TemplateOutputType::totTarget
|-

|-
| wizFiles || enum || TemplateOutputType::totFiles
|-

|-
| wizCustom || enum || TemplateOutputType::totCustom
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Other constants'''
|-

|-
| wxFILE_SEP_PATH || wxString || Path separator. "\" for windows, "/" for all other platforms
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''File extensions (e.g. "cbp")'''
|-

|-
| EXT_WORKSPACE || wxString ||
|-

|-
| EXT_CODEBLOCKS || wxString ||
|-

|-
| EXT_DEVCPP || wxString ||
|-

|-
| EXT_MSVC6 || wxString ||
|-

|-
| EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| EXT_MSVC7 || wxString ||
|-

|-
| EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| EXT_D || wxString ||
|-

|-
| EXT_F || wxString ||
|-

|-
| EXT_F77 || wxString ||
|-

|-
| EXT_F95 || wxString ||
|-

|-
| EXT_CPP || wxString ||
|-

|-
| EXT_C || wxString ||
|-

|-
| EXT_CC || wxString ||
|-

|-
| EXT_CXX || wxString ||
|-

|-
| EXT_HPP || wxString ||
|-

|-
| EXT_H || wxString ||
|-

|-
| EXT_HH || wxString ||
|-

|-
| EXT_HXX || wxString ||
|-

|-
| EXT_OBJECT || wxString ||
|-

|-
| EXT_XRCRESOURCE || wxString ||
|-

|-
| EXT_STATICLIB || wxString ||
|-

|-
| EXT_DYNAMICLIB || wxString ||
|-

|-
| EXT_EXECUTABLE || wxString ||
|-

|-
| EXT_RESOURCE || wxString ||
|-

|-
| EXT_RESOURCEBIN || wxString ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''File extensions with leading dot (e.g. ".cbp")'''
|-

|-
| DOT_EXT_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_CODEBLOCKS || wxString ||
|-

|-
| DOT_EXT_DEVCPP || wxString ||
|-

|-
| DOT_EXT_MSVC6 || wxString ||
|-

|-
| DOT_EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_MSVC7 || wxString ||
|-

|-
| DOT_EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_D || wxString ||
|-

|-
| DOT_EXT_F || wxString ||
|-

|-
| DOT_EXT_F77 || wxString ||
|-

|-
| DOT_EXT_F95 || wxString ||
|-

|-
| DOT_EXT_CPP || wxString ||
|-

|-
| DOT_EXT_C || wxString ||
|-

|-
| DOT_EXT_CC || wxString ||
|-

|-
| DOT_EXT_CXX || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_H || wxString ||
|-

|-
| DOT_EXT_HH || wxString ||
|-

|-
| DOT_EXT_HXX || wxString ||
|-

|-
| DOT_EXT_OBJECT || wxString ||
|-

|-
| DOT_EXT_XRCRESOURCE || wxString ||
|-

|-
| DOT_EXT_STATICLIB || wxString ||
|-

|-
| DOT_EXT_DYNAMICLIB || wxString ||
|-

|-
| DOT_EXT_EXECUTABLE || wxString ||
|-

|-
| DOT_EXT_RESOURCE || wxString ||
|-

|-
| DOT_EXT_RESOURCEBIN || wxString ||
|-

|}

== See also ==

* [[Scripting Code::Blocks|Scripting index]]

Script plugins

2006-12-15T12:57:13Z

Mandrav:

Script plugins are plugins that are written entirely in script. They are great for smaller-scale plugins or for quick prototyping. Their main practical difference compared to simple scripts is that a script plugin ''can add entries in context menus''.

Let's look at a sample plugin (by coincidence, this is shipped with Code::Blocks):

// Script plugins must extend cbScriptPlugin

class TestPlugin extends cbScriptPlugin
{
// mandatory to setup the plugin's info
constructor()
{
info.name = _T("TestPlugin");
info.title = _T("Test script");
info.version = _T("0.1a");
info.license = _T("GPL");
}

// optional to create menubar items
function GetMenu()
{
local entries = ::wxArrayString();
entries.Add(_T("Project/7:-Export Makefile"), 1);
return entries;
}

// optional to create context menu entries
function GetModuleMenu(who, data)
{
local entries = ::wxArrayString();

if (who == ::mtEditorManager)
{
local f = wxFileName();
f.Assign(data.GetFolder(), ::wxPATH_NATIVE);
entries.Add(_T("Work with ") + f.GetFullName(), 1);

entries.Add(_T("Sample entry"), 1);
}

return entries;
}

// optional to support ExecutePlugin(pluginNameString)
function Execute()
{
::ShowMessage(_T("Ho-ho was here ;)"));
return 0;
}

// optional calback for menubar items clicking
function OnMenuClicked(index)
{
if (index == 0)
::ShowMessage(_T("Exporting Makefile..."));
}

// optional calback for context menu items clicking
function OnModuleMenuClicked(index)
{
if (index == 0)
::ShowMessage(_T("Working with file"));
else if (index == 1)
::ShowMessage(_T("Sample entry not working yet"));
else
::ShowMessage(_T("?!? Functionality not implemented yet"));
}
}

// this call actually registers the script plugin with Code::Blocks
RegisterPlugin(TestPlugin());

// if you want to call this plugin's Execute() function, use this in a script:
// ExecutePlugin(_T("TestPlugin"));

As you can see it is well documented so it should be easy to grasp. The one thing that might strike you odd is the following line in <tt>GetMenu()</tt>:

entries.Add(_T("Project/7:-Export Makefile"), 1);

What "7:-Export Makefile" does is explained in [[Scripting commands#ScriptingManager|ScriptingManager's notes]]. In simple words it means "''insert'' <tt>'Export Makefile'</tt> menu item at position ''7'' of the <tt>'Project'</tt> menu, prepending a separator line before the menu item".

Scripting commands

2006-12-15T12:45:15Z

Mandrav:

[[Category:Scripting Code::Blocks]]
Scripting is no good if all you can do is use the scripting language's builtin 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.''

== 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 ||
|-

|-
| void || ShowMessage || wxString ||
|-

|-
| void || ShowWarning || wxString ||
|-

|-
| void || ShowError || wxString ||
|-

|-
| void || ShowInfo || wxString ||
|-

|-
| wxString || ReplaceMacros || wxString,bool ||
|-

|-
| ScriptingManager* || GetScriptingManager || ||
|-

|-
| ProjectManager* || GetProjectManager || ||
|-

|-
| EditorManager* || GetEditorManager || ||
|-

|-
| ConfigManager* || GetConfigManager || ||
|-

|-
| UserVariableManager* || GetUserVariableManager || ||
|-

|-
| CompilerFactory* || GetCompilerFactory || ||
|-

|-
| wxString || GetFolder || int || see API docs for ConfigManager::GetFolder()
|-

|-
| wxString || LocateDataFile|| wxString, int || see API docs for ConfigManager::LocateDataFile()
|-

|-
| bool || InstallPlugin || wxString,bool, bool || Install a binary plugin
|-

|-
| void || Include || wxString || similar to C/C++ ''<tt>#include "name"</tt>''
|-

|-
| bool || IsNull || void* ||
|-

|-
| wxString || _T || const char* || basically this is the wxString constructor
|-

|}

== ScriptingManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || RegisterScriptMenu || wxString, wxString || registers the script file (arg1) under a menu item (arg2).
e.g. <tt>GetScriptingManager().RegisterScriptMenu(_T("sample.script"), _T("Scripts/Sample script"))</tt>;
|-

|}

Notes about the <tt>RegisterScriptMenu</tt> function: 
* The second argument (menu item) is a string containing the full menu path to create the menu item. The path separator is a slash (/). For example, the string "Settings/Sample menu/Sample item" would create the menu path "Settings->Sample menu->Sample item".
* When each part of the path is evaluated, it is checked whether it starts with a number followed by a colon (:). If so then this is considered to be a menu index in the parent menu and the menu is inserted at that index instead of being appended to the menu. The number and colon are removed from the string.
* If the menu item starts with a dash (-), then a separator line is prepended in the menu before the menu item (e.g. "Scripts/'''-'''Sample script").
* For your convenience, all menu items created using this function have one extra functionality: if you keep the SHIFT key pressed while clicking on any of these "script menu items", instead of running the attached script, Code::Blocks will open it in the editor for you to view/edit :).
* Have a look at the [[Startup script#Example|startup script example]].

== ConfigManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| int || Read || int,int ||
|-

|-
| bool || Read || bool,bool ||
|-

|-
| float || Read || float,float ||
|-

|-
| wxString || Read || wxString,wxString ||
|-

|-
| void || Write || int,int ||
|-

|-
| void || Write || bool,bool ||
|-

|-
| void || Write || float,float ||
|-

|-
| void || Write || wxString,wxString[,bool] ||
|-

|}

== ProjectManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetDefaultPath || ||
|-

|-
| void || SetDefaultPath || wxString ||
|-

|-
| cbProject* || GetActiveProject || ||
|-

|-
| void || SetProject || cbProject* ||
|-

|-
| bool || LoadWorkspace || wxString ||
|-

|-
| bool || SaveWorkspace || ||
|-

|-
| bool || SaveWorkspaceAs || wxString ||
|-

|-
| bool || CloseWorkspace || ||
|-

|-
| cbProject* || IsOpen || wxString ||
|-

|-
| cbProject* || LoadProject || wxString,bool ||
|-

|-
| bool || SaveProject || cbProject* ||
|-

|-
| bool || SaveProjectAs || cbProject* ||
|-

|-
| bool || SaveActiveProject || ||
|-

|-
| bool || SaveActiveProjectAs || ||
|-

|-
| bool || SaveAllProjects || ||
|-

|-
| bool || CloseProject || cbProject*,bool,bool ||
|-

|-
| bool || CloseActiveProject || bool ||
|-

|-
| bool || CloseAllProjects || bool ||
|-

|-
| cbProject* || NewProject || wxString ||
|-

|-
| int || AddFileToProject || wxString,cbProject*,int ||
|-

|-
| int || AskForBuildTargetIndex || cbProject* ||
|-

|-
| void || RebuildTree || ||
|-

|}

== EditorManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || Configure || ||
|-

|-
| cbEditor* || New || wxString ||
|-

|-
| cbEditor* || Open || wxString ||
|-

|-
| cbEditor* || IsBuiltinOpen || wxString ||
|-

|-
| cbEditor* || GetBuiltinEditor || wxString|int ||
|-

|-
| cbEditor* || GetBuiltinActiveEditor || ||
|-

|-
| EditorBase* || GetActiveEditor || ||
|-

|-
| void || ActivateNext || ||
|-

|-
| void || ActivatePrevious || ||
|-

|-
| bool || SwapActiveHeaderSource || ||
|-

|-
| bool || CloseActive || bool ||
|-

|-
| bool || Close || wxString|int,bool ||
|-

|-
| bool || CloseAll || bool ||
|-

|-
| bool || Save || wxString|int ||
|-

|-
| bool || SaveActive || ||
|-

|-
| bool || SaveAs || int ||
|-

|-
| bool || SaveActiveAs || ||
|-

|-
| bool || SaveAll || ||
|-

|-
| int || ShowFindDialog || bool,bool ||
|-

|}

== UserVariableManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || Exists || wxString ||
|-

|}

== IO namespace ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || DirectoryExists || wxString ||
|-

|-
| wxString || SelectDirectory || wxString,wxString,bool ||
|-

|-
| bool || FileExists || wxString ||
|-

|-
| wxString || SelectFile || wxString,wxString,wxString ||
|-

|}

== CompilerFactory ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || IsValidCompilerID || wxString ||
|-

|-
| int || GetCompilerIndex || wxString ||
|-

|-
| wxString || GetDefaultCompilerID || ||
|-

|-
| bool || CompilerInheritsFrom || ||
|-

|}

== wxString ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || operator+ || ||
|-

|-
| bool || operator< || ||
|-

|-
| bool || operator<= || ||
|-

|-
| bool || operator>= || ||
|-

|-
| bool || operator> || ||
|-

|-
| int || Find || wxString ||
|-

|-
| bool || Matches || wxString ||
|-

|-
| void || AddChar || char ||
|-

|-
| char || GetChar || int ||
|-

|-
| bool || IsEmpty || ||
|-

|-
| int || Length || ||
|-

|-
| int || length || || same as Length()
|-

|-
| int || len || || same as Length()
|-

|-
| int || size || || same as Length()
|-

|-
| wxString || Lower || ||
|-

|-
| wxString || LowerCase || || same as Lower()
|-

|-
| void || MakeLower || ||
|-

|-
| wxString || Upper || ||
|-

|-
| wxString || UpperCase || || same as Upper()
|-

|-
| void || MakeUpper || ||
|-

|-
| wxString || Mid || int,int ||
|-

|-
| void || Remove || int,int ||
|-

|-
| void || RemoveLast || ||
|-

|-
| int || Replace || wxString,wxString[,bool] ||
|-

|-
| wxString || Right || int ||
|-

|-
| wxString || AfterFirst || char ||
|-

|-
| wxString || AfterLast || char ||
|-

|-
| wxString || BeforeFirst || char ||
|-

|-
| wxString || BeforeLast || char ||
|-
|}

== 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 ||
|-

|-
| void || Clear || ||
|-

|-
| int || GetCount || ||
|-

|-
| wxString || Item || int ||
|-

|}

== ProjectFile ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || AddBuildTarget || wxString ||
|-

|-
| void || RenameBuildTarget || wxString,wxString ||
|-

|-
| void || RemoveBuildTarget || wxString ||
|-

|-
| wxString || GetBaseName || ||
|-

|-
| wxString || GetObjName || ||
|-

|-
| void || SetObjName || wxString ||
|-

|-
| cbProject* || GetParentProject || ||
|-

|-
| wxString || relativeFilename || || (variable)
|-

|-
| wxString || relativeToCommonTopLevelPath || || (variable)
|-

|-
| bool || compile || || (variable)
|-

|-
| bool || link || || (variable)
|-

|-
| int || weight || || (variable)
|-

|-
| wxString || compilerVar || || (variable)
|-

|}

== CompileOptionsBase ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || SetLinkerOptions || wxArrayString ||
|-

|-
| void || SetLinkLibs || wxArrayString ||
|-

|-
| void || SetCompilerOptions || wxArrayString ||
|-

|-
| void || SetIncludeDirs || wxArrayString ||
|-

|-
| void || SetResourceIncludeDirs || wxArrayString ||
|-

|-
| void || SetLibDirs || wxArrayString ||
|-

|-
| void || SetCommandsBeforeBuild || wxArrayString ||
|-

|-
| void || SetCommandsAfterBuild || wxArrayString ||
|-

|-
| wxArrayString || GetLinkerOptions || ||
|-

|-
| wxArrayString || GetLinkLibs || ||
|-

|-
| wxArrayString || GetCompilerOptions || ||
|-

|-
| wxArrayString || GetIncludeDirs || ||
|-

|-
| wxArrayString || GetResourceIncludeDirs || ||
|-

|-
| wxArrayString || GetLibDirs || ||
|-

|-
| wxArrayString || GetCommandsBeforeBuild || ||
|-

|-
| wxArrayString || GetCommandsAfterBuild || ||
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| void || AddLinkerOption || wxString ||
|-

|-
| void || AddLinkLib || wxString ||
|-

|-
| void || AddCompilerOption || wxString ||
|-

|-
| void || AddIncludeDir || wxString ||
|-

|-
| void || AddResourceIncludeDir || wxString ||
|-

|-
| void || AddLibDir || wxString ||
|-

|-
| void || AddCommandsBeforeBuild || wxString ||
|-

|-
| void || AddCommandsAfterBuild || wxString ||
|-

|-
| void || RemoveLinkerOption || wxString ||
|-

|-
| void || RemoveLinkLib || wxString ||
|-

|-
| void || RemoveCompilerOption || wxString ||
|-

|-
| void || RemoveIncludeDir || wxString ||
|-

|-
| void || RemoveResourceIncludeDir || wxString ||
|-

|-
| void || RemoveLibDir || wxString ||
|-

|-
| void || RemoveCommandsBeforeBuild || wxString ||
|-

|-
| void || RemoveCommandsAfterBuild || wxString ||
|-

|-
| bool || GetAlwaysRunPostBuildSteps || ||
|-

|-
| void || SetAlwaysRunPostBuildSteps || bool ||
|-

|-
| bool || SetVar || wxString,wxString,bool ||
|-

|-
| wxString || GetVar || wxString ||
|-

|-
| bool || UnsetVar || wxString ||
|-

|-
| void || UnsetAllVars || ||
|-

|}

== CompileTargetBase ==
Extends CompileOptionsBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetFilename || ||
|-

|-
| wxString || GetTitle || ||
|-

|-
| void || SetTitle || wxString ||
|-

|-
| void || SetOutputFilename || wxString ||
|-

|-
| void || SetWorkingDir || wxString ||
|-

|-
| void || SetObjectOutput || wxString ||
|-

|-
| void || SetDepsOutput || wxString ||
|-

|-
| OptionsRelation || GetOptionRelation || OptionsRelationType ||
|-

|-
| void || SetOptionRelation || OptionsRelationType,OptionsRelation ||
|-

|-
| wxString || GetWorkingDir || ||
|-

|-
| wxString || GetObjectOutput || ||
|-

|-
| wxString || GetDepsOutput || ||
|-

|-
| wxString || GetOutputFilename || ||
|-

|-
| wxString || SuggestOutputFilename || ||
|-

|-
| wxString || GetExecutableFilename || ||
|-

|-
| wxString || GetDynamicLibFilename || ||
|-

|-
| wxString || GetDynamicLibDefFilename || ||
|-

|-
| wxString || GetStaticLibFilename || ||
|-

|-
| wxString || GetBasePath || ||
|-

|-
| void || SetTargetType || TargetType ||
|-

|-
| TargetType || GetTargetType || ||
|-

|-
| wxString || GetExecutionParameters || ||
|-

|-
| void || SetExecutionParameters || wxString ||
|-

|-
| wxString || GetHostApplication || ||
|-

|-
| void || SetHostApplication || wxString ||
|-

|-
| void || SetCompilerID || wxString ||
|-

|-
| wxString || GetCompilerID || ||
|-

|}

== ProjectBuildTarget ==
Extends CompileTargetBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| cbProject* || GetParentProject || ||
|-

|-
| wxString || GetFullTitle || ||
|-

|-
| wxString || GetExternalDeps || ||
|-

|-
| void || SetExternalDeps || wxString ||
|-

|-
| void || SetAdditionalOutputFiles || wxString ||
|-

|-
| wxString || GetAdditionalOutputFiles || ||
|-

|-
| bool || GetIncludeInTargetAll || ||
|-

|-
| void || SetIncludeInTargetAll || bool ||
|-

|-
| bool || GetCreateDefFile || ||
|-

|-
| void || SetCreateDefFile || bool ||
|-

|-
| bool || GetCreateStaticLib || ||
|-

|-
| void || SetCreateStaticLib || bool ||
|-

|-
| bool || GetUseConsoleRunner || ||
|-

|-
| void || SetUseConsoleRunner || bool ||
|-

|}

== cbProject ==
Extends CompileTargetBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| wxString || GetMakefile || ||
|-

|-
| void || SetMakefile || wxString ||
|-

|-
| bool || IsMakefileCustom || ||
|-

|-
| void || SetMakefileCustom || bool ||
|-

|-
| bool || CloseAllFiles || bool ||
|-

|-
| bool || SaveAllFiles || ||
|-

|-
| bool || Save || ||
|-

|-
| bool || SaveLayout || ||
|-

|-
| bool || LoadLayout || ||
|-

|-
| bool || ShowOptions || ||
|-

|-
| wxString || GetCommonTopLevelPath || ||
|-

|-
| int || GetFilesCount || ||
|-

|-
| ProjectFile* || GetFile || int ||
|-

|-
| ProjectFile* || GetFileByFilename || wxString,bool,bool ||
|-

|-
| bool || RemoveFile || int ||
|-

|-
| ProjectFile* || AddFile || wxString|int,wxString,bool,bool,int ||
|-

|-
| int || GetBuildTargetsCount || ||
|-

|-
| ProjectBuildTarget* || GetBuildTarget || wxString|int ||
|-

|-
| ProjectBuildTarget* || AddBuildTarget || wxString ||
|-

|-
| bool || RenameBuildTarget || wxString|int,wxString ||
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || wxString|int,wxString ||
|-

|-
| bool || RemoveBuildTarget || wxString|int ||
|-

|-
| bool || ExportTargetAsProject || wxString|int ||
|-

|-
| void || SetActiveBuildTarget || int ||
|-

|-
| int || GetActiveBuildTarget || ||
|-

|-
| int || SelectTarget || int,bool ||
|-

|-
| ProjectBuildTarget* || GetCurrentlyCompilingTarget || ||
|-

|-
| void || SetCurrentlyCompilingTarget || ProjectBuildTarget* ||
|-

|-
| PCHMode || GetModeForPCH || ||
|-

|-
| void || SetModeForPCH || PCHMode ||
|-

|}

== EditorBase ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetFilename || ||
|-

|-
| void || SetFilename || wxString ||
|-

|-
| wxString || GetShortName || ||
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| wxString || GetTitle || ||
|-

|-
| void || SetTitle || wxString ||
|-

|-
| void || Activate || ||
|-

|-
| bool || Close || ||
|-

|-
| bool || Save || ||
|-

|-
| bool || IsBuiltinEditor || ||
|-

|-
| bool || ThereAreOthers || ||
|-

|-
| void || GotoLine || int,bool ||
|-

|-
| void || ToggleBreakpoint || int,bool ||
|-

|-
| bool || HasBreakpoint || int ||
|-

|-
| void || GotoNextBreakpoint || ||
|-

|-
| void || GotoPreviousBreakpoint || ||
|-

|-
| void || ToggleBookmark || int,bool ||
|-

|-
| bool || HasBookmark || int ||
|-

|-
| void || GotoNextBookmark || ||
|-

|-
| void || GotoPreviousBookmark || ||
|-

|-
| void || Undo || ||
|-

|-
| void || Redo || ||
|-

|-
| void || Cut || ||
|-

|-
| void || Copy || ||
|-

|-
| void || Paste || ||
|-

|-
| bool || CanUndo || ||
|-

|-
| bool || CanRedo || ||
|-

|-
| bool || CanPaste || ||
|-

|-
| bool || HasSelection || ||
|-

|}

== cbEditor ==
Extends EditorBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || SetEditorTitle || wxString ||
|-

|-
| ProjectFile* || GetProjectFile || ||
|-

|-
| bool || SaveAs || ||
|-

|-
| void || FoldAll || ||
|-

|-
| void || UnfoldAll || ||
|-

|-
| void || ToggleAllFolds || ||
|-

|-
| void || FoldBlockFromLine || int ||
|-

|-
| void || UnfoldBlockFromLine || int ||
|-

|-
| void || ToggleFoldBlockFromLine || int ||
|-

|-
| int || GetLineIndentInSpaces || int ||
|-

|-
| wxString || GetLineIndentString || int ||
|-

|-
| void || Touch || ||
|-

|-
| bool || Reload || bool ||
|-

|-
| void || Print || bool,PrintColourMode,bool ||
|-

|-
| void || AutoComplete || ||
|-

|-
| bool || AddBreakpoint || int,bool ||
|-

|-
| bool || RemoveBreakpoint || int,bool ||
|-

|-
| void || SetText || wxString || this is not present in cbEditor; included to help scripts edit text
|-

|-
| wxString || GetText || || this is not present in cbEditor; included to help scripts edit text
|-

|}

== Constants ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"

|- style="background: #ececec; border: 0px solid gray"
!Constant
!Type
!Remarks
|-

|-
| PLATFORM || int || this defines the platform Code::Blocks is currently running on. It is equal to only one of the following PLATFORM_* constants
|-

|-
| PLATFORM_MSW || int || All Windows platforms
|-

|-
| PLATFORM_GTK || int || All GTK platforms (Linux, BSD, Solaris, Darwin, etc.)
|-

|-
| PLATFORM_MAC || int || All Mac platforms
|-

|-
| PLATFORM_OS2 || int || OS/2 platform
|-

|-
| PLATFORM_X11 || int || All X11 platforms
|-

|-
| PLATFORM_UNKNOWN || int || Unknown platform. Please inform us if PLATFORM == PLATFORM_UNKNOWN so we can make this platform known too ;)
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Message dialog flags'''
|-

|-
| wxOK || int || Flag for Message() 's third argument (flags).
|-

|-
| wxYES_NO || int || -"-
|-

|-
| wxCANCEL || int || -"-
|-

|-
| wxICON_QUESTION || int || -"-
|-

|-
| wxICON_INFORMATION || int || -"-
|-

|-
| wxICON_WARNING || int || -"-
|-

|-
| wxICON_ERROR || int || -"-
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Message dialog return values'''
|-

|-
| wxID_OK || int ||
|-

|-
| wxID_YES || int ||
|-

|-
| wxID_NO || int ||
|-

|-
| wxID_CANCEL || int ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum OptionsRelationType'''
|-

|-
| ortCompilerOptions || enum ||
|-

|-
| ortLinkerOptions || enum ||
|-

|-
| ortIncludeDirs || enum ||
|-

|-
| ortLibDirs || enum ||
|-

|-
| ortResDirs || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum OptionsRelation'''
|-

|-
| orUseParentOptionsOnly || enum ||
|-

|-
| orUseTargetOptionsOnly || enum ||
|-

|-
| orPrependToParentOptions || enum ||
|-

|-
| orAppendToParentOptions || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum TargetType'''
|-

|-
| ttExecutable || enum ||
|-

|-
| ttConsoleOnly || enum ||
|-

|-
| ttStaticLib || enum ||
|-

|-
| ttDynamicLib || enum ||
|-

|-
| ttCommandsOnly || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum MakeCommand'''
|-

|-
| mcClean || enum ||
|-

|-
| mcDistClean || enum ||
|-

|-
| mcBuild || enum ||
|-

|-
| mcCompileFile || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PCHMode'''
|-

|-
| pchSourceDir || enum ||
|-

|-
| pchObjectDir || enum ||
|-

|-
| pchSourceFile || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PrintScope'''
|-

|-
| psSelection || enum ||
|-

|-
| psActiveEditor || enum ||
|-

|-
| psAllOpenEditors || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PrintColourMode'''
|-

|-
| pcmBlackAndWhite || enum ||
|-

|-
| pcmColourOnWhite || enum ||
|-

|-
| pcmInvertColours || enum ||
|-

|-
| pcmAsIs || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum TemplateOutputType'''
|-

|-
| wizProject || enum || TemplateOutputType::totProject
|-

|-
| wizTarget || enum || TemplateOutputType::totTarget
|-

|-
| wizFiles || enum || TemplateOutputType::totFiles
|-

|-
| wizCustom || enum || TemplateOutputType::totCustom
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Other constants'''
|-

|-
| wxFILE_SEP_PATH || wxString || Path separator. "\" for windows, "/" for all other platforms
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''File extensions (e.g. "cbp")'''
|-

|-
| EXT_WORKSPACE || wxString ||
|-

|-
| EXT_CODEBLOCKS || wxString ||
|-

|-
| EXT_DEVCPP || wxString ||
|-

|-
| EXT_MSVC6 || wxString ||
|-

|-
| EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| EXT_MSVC7 || wxString ||
|-

|-
| EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| EXT_D || wxString ||
|-

|-
| EXT_F || wxString ||
|-

|-
| EXT_F77 || wxString ||
|-

|-
| EXT_F95 || wxString ||
|-

|-
| EXT_CPP || wxString ||
|-

|-
| EXT_C || wxString ||
|-

|-
| EXT_CC || wxString ||
|-

|-
| EXT_CXX || wxString ||
|-

|-
| EXT_HPP || wxString ||
|-

|-
| EXT_H || wxString ||
|-

|-
| EXT_HH || wxString ||
|-

|-
| EXT_HXX || wxString ||
|-

|-
| EXT_OBJECT || wxString ||
|-

|-
| EXT_XRCRESOURCE || wxString ||
|-

|-
| EXT_STATICLIB || wxString ||
|-

|-
| EXT_DYNAMICLIB || wxString ||
|-

|-
| EXT_EXECUTABLE || wxString ||
|-

|-
| EXT_RESOURCE || wxString ||
|-

|-
| EXT_RESOURCEBIN || wxString ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''File extensions with leading dot (e.g. ".cbp")'''
|-

|-
| DOT_EXT_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_CODEBLOCKS || wxString ||
|-

|-
| DOT_EXT_DEVCPP || wxString ||
|-

|-
| DOT_EXT_MSVC6 || wxString ||
|-

|-
| DOT_EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_MSVC7 || wxString ||
|-

|-
| DOT_EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_D || wxString ||
|-

|-
| DOT_EXT_F || wxString ||
|-

|-
| DOT_EXT_F77 || wxString ||
|-

|-
| DOT_EXT_F95 || wxString ||
|-

|-
| DOT_EXT_CPP || wxString ||
|-

|-
| DOT_EXT_C || wxString ||
|-

|-
| DOT_EXT_CC || wxString ||
|-

|-
| DOT_EXT_CXX || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_H || wxString ||
|-

|-
| DOT_EXT_HH || wxString ||
|-

|-
| DOT_EXT_HXX || wxString ||
|-

|-
| DOT_EXT_OBJECT || wxString ||
|-

|-
| DOT_EXT_XRCRESOURCE || wxString ||
|-

|-
| DOT_EXT_STATICLIB || wxString ||
|-

|-
| DOT_EXT_DYNAMICLIB || wxString ||
|-

|-
| DOT_EXT_EXECUTABLE || wxString ||
|-

|-
| DOT_EXT_RESOURCE || wxString ||
|-

|-
| DOT_EXT_RESOURCEBIN || wxString ||
|-

|}

== See also ==

* [[Scripting Code::Blocks|Scripting index]]

Scripting commands

2006-12-15T12:44:21Z

Mandrav: Updated info for latest changes

[[Category:Scripting Code::Blocks]]
Scripting is no good if all you can do is use the scripting language's builtin 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.''

== 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 ||
|-

|-
| void || ShowMessage || wxString ||
|-

|-
| void || ShowWarning || wxString ||
|-

|-
| void || ShowError || wxString ||
|-

|-
| void || ShowInfo || wxString ||
|-

|-
| wxString || ReplaceMacros || wxString,bool ||
|-

|-
| ScriptingManager* || GetScriptingManager || ||
|-

|-
| ProjectManager* || GetProjectManager || ||
|-

|-
| EditorManager* || GetEditorManager || ||
|-

|-
| ConfigManager* || GetConfigManager || ||
|-

|-
| UserVariableManager* || GetUserVariableManager || ||
|-

|-
| CompilerFactory* || GetCompilerFactory || ||
|-

|-
| wxString || GetFolder || int || see API docs for ConfigManager::GetFolder()
|-

|-
| wxString || LocateDataFile|| wxString, int || see API docs for ConfigManager::LocateDataFile()
|-

|-
| bool || InstallPlugin || wxString,bool, bool || Install a binary plugin
|-

|-
| void || Include || wxString || similar to C/C++ #include "name"
|-

|-
| bool || IsNull || void* ||
|-

|-
| wxString || _T || const char* || basically this is the wxString constructor
|-

|}

== ScriptingManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || RegisterScriptMenu || wxString, wxString || registers the script file (arg1) under a menu item (arg2).
e.g. <tt>GetScriptingManager().RegisterScriptMenu(_T("sample.script"), _T("Scripts/Sample script"))</tt>;
|-

|}

Notes about the <tt>RegisterScriptMenu</tt> function: 
* The second argument (menu item) is a string containing the full menu path to create the menu item. The path separator is a slash (/). For example, the string "Settings/Sample menu/Sample item" would create the menu path "Settings->Sample menu->Sample item".
* When each part of the path is evaluated, it is checked whether it starts with a number followed by a colon (:). If so then this is considered to be a menu index in the parent menu and the menu is inserted at that index instead of being appended to the menu. The number and colon are removed from the string.
* If the menu item starts with a dash (-), then a separator line is prepended in the menu before the menu item (e.g. "Scripts/'''-'''Sample script").
* For your convenience, all menu items created using this function have one extra functionality: if you keep the SHIFT key pressed while clicking on any of these "script menu items", instead of running the attached script, Code::Blocks will open it in the editor for you to view/edit :).
* Have a look at the [[Startup script#Example|startup script example]].

== ConfigManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| int || Read || int,int ||
|-

|-
| bool || Read || bool,bool ||
|-

|-
| float || Read || float,float ||
|-

|-
| wxString || Read || wxString,wxString ||
|-

|-
| void || Write || int,int ||
|-

|-
| void || Write || bool,bool ||
|-

|-
| void || Write || float,float ||
|-

|-
| void || Write || wxString,wxString[,bool] ||
|-

|}

== ProjectManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetDefaultPath || ||
|-

|-
| void || SetDefaultPath || wxString ||
|-

|-
| cbProject* || GetActiveProject || ||
|-

|-
| void || SetProject || cbProject* ||
|-

|-
| bool || LoadWorkspace || wxString ||
|-

|-
| bool || SaveWorkspace || ||
|-

|-
| bool || SaveWorkspaceAs || wxString ||
|-

|-
| bool || CloseWorkspace || ||
|-

|-
| cbProject* || IsOpen || wxString ||
|-

|-
| cbProject* || LoadProject || wxString,bool ||
|-

|-
| bool || SaveProject || cbProject* ||
|-

|-
| bool || SaveProjectAs || cbProject* ||
|-

|-
| bool || SaveActiveProject || ||
|-

|-
| bool || SaveActiveProjectAs || ||
|-

|-
| bool || SaveAllProjects || ||
|-

|-
| bool || CloseProject || cbProject*,bool,bool ||
|-

|-
| bool || CloseActiveProject || bool ||
|-

|-
| bool || CloseAllProjects || bool ||
|-

|-
| cbProject* || NewProject || wxString ||
|-

|-
| int || AddFileToProject || wxString,cbProject*,int ||
|-

|-
| int || AskForBuildTargetIndex || cbProject* ||
|-

|-
| void || RebuildTree || ||
|-

|}

== EditorManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || Configure || ||
|-

|-
| cbEditor* || New || wxString ||
|-

|-
| cbEditor* || Open || wxString ||
|-

|-
| cbEditor* || IsBuiltinOpen || wxString ||
|-

|-
| cbEditor* || GetBuiltinEditor || wxString|int ||
|-

|-
| cbEditor* || GetBuiltinActiveEditor || ||
|-

|-
| EditorBase* || GetActiveEditor || ||
|-

|-
| void || ActivateNext || ||
|-

|-
| void || ActivatePrevious || ||
|-

|-
| bool || SwapActiveHeaderSource || ||
|-

|-
| bool || CloseActive || bool ||
|-

|-
| bool || Close || wxString|int,bool ||
|-

|-
| bool || CloseAll || bool ||
|-

|-
| bool || Save || wxString|int ||
|-

|-
| bool || SaveActive || ||
|-

|-
| bool || SaveAs || int ||
|-

|-
| bool || SaveActiveAs || ||
|-

|-
| bool || SaveAll || ||
|-

|-
| int || ShowFindDialog || bool,bool ||
|-

|}

== UserVariableManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || Exists || wxString ||
|-

|}

== IO namespace ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || DirectoryExists || wxString ||
|-

|-
| wxString || SelectDirectory || wxString,wxString,bool ||
|-

|-
| bool || FileExists || wxString ||
|-

|-
| wxString || SelectFile || wxString,wxString,wxString ||
|-

|}

== CompilerFactory ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || IsValidCompilerID || wxString ||
|-

|-
| int || GetCompilerIndex || wxString ||
|-

|-
| wxString || GetDefaultCompilerID || ||
|-

|-
| bool || CompilerInheritsFrom || ||
|-

|}

== wxString ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || operator+ || ||
|-

|-
| bool || operator< || ||
|-

|-
| bool || operator<= || ||
|-

|-
| bool || operator>= || ||
|-

|-
| bool || operator> || ||
|-

|-
| int || Find || wxString ||
|-

|-
| bool || Matches || wxString ||
|-

|-
| void || AddChar || char ||
|-

|-
| char || GetChar || int ||
|-

|-
| bool || IsEmpty || ||
|-

|-
| int || Length || ||
|-

|-
| int || length || || same as Length()
|-

|-
| int || len || || same as Length()
|-

|-
| int || size || || same as Length()
|-

|-
| wxString || Lower || ||
|-

|-
| wxString || LowerCase || || same as Lower()
|-

|-
| void || MakeLower || ||
|-

|-
| wxString || Upper || ||
|-

|-
| wxString || UpperCase || || same as Upper()
|-

|-
| void || MakeUpper || ||
|-

|-
| wxString || Mid || int,int ||
|-

|-
| void || Remove || int,int ||
|-

|-
| void || RemoveLast || ||
|-

|-
| int || Replace || wxString,wxString[,bool] ||
|-

|-
| wxString || Right || int ||
|-

|-
| wxString || AfterFirst || char ||
|-

|-
| wxString || AfterLast || char ||
|-

|-
| wxString || BeforeFirst || char ||
|-

|-
| wxString || BeforeLast || char ||
|-
|}

== 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 ||
|-

|-
| void || Clear || ||
|-

|-
| int || GetCount || ||
|-

|-
| wxString || Item || int ||
|-

|}

== ProjectFile ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || AddBuildTarget || wxString ||
|-

|-
| void || RenameBuildTarget || wxString,wxString ||
|-

|-
| void || RemoveBuildTarget || wxString ||
|-

|-
| wxString || GetBaseName || ||
|-

|-
| wxString || GetObjName || ||
|-

|-
| void || SetObjName || wxString ||
|-

|-
| cbProject* || GetParentProject || ||
|-

|-
| wxString || relativeFilename || || (variable)
|-

|-
| wxString || relativeToCommonTopLevelPath || || (variable)
|-

|-
| bool || compile || || (variable)
|-

|-
| bool || link || || (variable)
|-

|-
| int || weight || || (variable)
|-

|-
| wxString || compilerVar || || (variable)
|-

|}

== CompileOptionsBase ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || SetLinkerOptions || wxArrayString ||
|-

|-
| void || SetLinkLibs || wxArrayString ||
|-

|-
| void || SetCompilerOptions || wxArrayString ||
|-

|-
| void || SetIncludeDirs || wxArrayString ||
|-

|-
| void || SetResourceIncludeDirs || wxArrayString ||
|-

|-
| void || SetLibDirs || wxArrayString ||
|-

|-
| void || SetCommandsBeforeBuild || wxArrayString ||
|-

|-
| void || SetCommandsAfterBuild || wxArrayString ||
|-

|-
| wxArrayString || GetLinkerOptions || ||
|-

|-
| wxArrayString || GetLinkLibs || ||
|-

|-
| wxArrayString || GetCompilerOptions || ||
|-

|-
| wxArrayString || GetIncludeDirs || ||
|-

|-
| wxArrayString || GetResourceIncludeDirs || ||
|-

|-
| wxArrayString || GetLibDirs || ||
|-

|-
| wxArrayString || GetCommandsBeforeBuild || ||
|-

|-
| wxArrayString || GetCommandsAfterBuild || ||
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| void || AddLinkerOption || wxString ||
|-

|-
| void || AddLinkLib || wxString ||
|-

|-
| void || AddCompilerOption || wxString ||
|-

|-
| void || AddIncludeDir || wxString ||
|-

|-
| void || AddResourceIncludeDir || wxString ||
|-

|-
| void || AddLibDir || wxString ||
|-

|-
| void || AddCommandsBeforeBuild || wxString ||
|-

|-
| void || AddCommandsAfterBuild || wxString ||
|-

|-
| void || RemoveLinkerOption || wxString ||
|-

|-
| void || RemoveLinkLib || wxString ||
|-

|-
| void || RemoveCompilerOption || wxString ||
|-

|-
| void || RemoveIncludeDir || wxString ||
|-

|-
| void || RemoveResourceIncludeDir || wxString ||
|-

|-
| void || RemoveLibDir || wxString ||
|-

|-
| void || RemoveCommandsBeforeBuild || wxString ||
|-

|-
| void || RemoveCommandsAfterBuild || wxString ||
|-

|-
| bool || GetAlwaysRunPostBuildSteps || ||
|-

|-
| void || SetAlwaysRunPostBuildSteps || bool ||
|-

|-
| bool || SetVar || wxString,wxString,bool ||
|-

|-
| wxString || GetVar || wxString ||
|-

|-
| bool || UnsetVar || wxString ||
|-

|-
| void || UnsetAllVars || ||
|-

|}

== CompileTargetBase ==
Extends CompileOptionsBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetFilename || ||
|-

|-
| wxString || GetTitle || ||
|-

|-
| void || SetTitle || wxString ||
|-

|-
| void || SetOutputFilename || wxString ||
|-

|-
| void || SetWorkingDir || wxString ||
|-

|-
| void || SetObjectOutput || wxString ||
|-

|-
| void || SetDepsOutput || wxString ||
|-

|-
| OptionsRelation || GetOptionRelation || OptionsRelationType ||
|-

|-
| void || SetOptionRelation || OptionsRelationType,OptionsRelation ||
|-

|-
| wxString || GetWorkingDir || ||
|-

|-
| wxString || GetObjectOutput || ||
|-

|-
| wxString || GetDepsOutput || ||
|-

|-
| wxString || GetOutputFilename || ||
|-

|-
| wxString || SuggestOutputFilename || ||
|-

|-
| wxString || GetExecutableFilename || ||
|-

|-
| wxString || GetDynamicLibFilename || ||
|-

|-
| wxString || GetDynamicLibDefFilename || ||
|-

|-
| wxString || GetStaticLibFilename || ||
|-

|-
| wxString || GetBasePath || ||
|-

|-
| void || SetTargetType || TargetType ||
|-

|-
| TargetType || GetTargetType || ||
|-

|-
| wxString || GetExecutionParameters || ||
|-

|-
| void || SetExecutionParameters || wxString ||
|-

|-
| wxString || GetHostApplication || ||
|-

|-
| void || SetHostApplication || wxString ||
|-

|-
| void || SetCompilerID || wxString ||
|-

|-
| wxString || GetCompilerID || ||
|-

|}

== ProjectBuildTarget ==
Extends CompileTargetBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| cbProject* || GetParentProject || ||
|-

|-
| wxString || GetFullTitle || ||
|-

|-
| wxString || GetExternalDeps || ||
|-

|-
| void || SetExternalDeps || wxString ||
|-

|-
| void || SetAdditionalOutputFiles || wxString ||
|-

|-
| wxString || GetAdditionalOutputFiles || ||
|-

|-
| bool || GetIncludeInTargetAll || ||
|-

|-
| void || SetIncludeInTargetAll || bool ||
|-

|-
| bool || GetCreateDefFile || ||
|-

|-
| void || SetCreateDefFile || bool ||
|-

|-
| bool || GetCreateStaticLib || ||
|-

|-
| void || SetCreateStaticLib || bool ||
|-

|-
| bool || GetUseConsoleRunner || ||
|-

|-
| void || SetUseConsoleRunner || bool ||
|-

|}

== cbProject ==
Extends CompileTargetBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| wxString || GetMakefile || ||
|-

|-
| void || SetMakefile || wxString ||
|-

|-
| bool || IsMakefileCustom || ||
|-

|-
| void || SetMakefileCustom || bool ||
|-

|-
| bool || CloseAllFiles || bool ||
|-

|-
| bool || SaveAllFiles || ||
|-

|-
| bool || Save || ||
|-

|-
| bool || SaveLayout || ||
|-

|-
| bool || LoadLayout || ||
|-

|-
| bool || ShowOptions || ||
|-

|-
| wxString || GetCommonTopLevelPath || ||
|-

|-
| int || GetFilesCount || ||
|-

|-
| ProjectFile* || GetFile || int ||
|-

|-
| ProjectFile* || GetFileByFilename || wxString,bool,bool ||
|-

|-
| bool || RemoveFile || int ||
|-

|-
| ProjectFile* || AddFile || wxString|int,wxString,bool,bool,int ||
|-

|-
| int || GetBuildTargetsCount || ||
|-

|-
| ProjectBuildTarget* || GetBuildTarget || wxString|int ||
|-

|-
| ProjectBuildTarget* || AddBuildTarget || wxString ||
|-

|-
| bool || RenameBuildTarget || wxString|int,wxString ||
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || wxString|int,wxString ||
|-

|-
| bool || RemoveBuildTarget || wxString|int ||
|-

|-
| bool || ExportTargetAsProject || wxString|int ||
|-

|-
| void || SetActiveBuildTarget || int ||
|-

|-
| int || GetActiveBuildTarget || ||
|-

|-
| int || SelectTarget || int,bool ||
|-

|-
| ProjectBuildTarget* || GetCurrentlyCompilingTarget || ||
|-

|-
| void || SetCurrentlyCompilingTarget || ProjectBuildTarget* ||
|-

|-
| PCHMode || GetModeForPCH || ||
|-

|-
| void || SetModeForPCH || PCHMode ||
|-

|}

== EditorBase ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetFilename || ||
|-

|-
| void || SetFilename || wxString ||
|-

|-
| wxString || GetShortName || ||
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| wxString || GetTitle || ||
|-

|-
| void || SetTitle || wxString ||
|-

|-
| void || Activate || ||
|-

|-
| bool || Close || ||
|-

|-
| bool || Save || ||
|-

|-
| bool || IsBuiltinEditor || ||
|-

|-
| bool || ThereAreOthers || ||
|-

|-
| void || GotoLine || int,bool ||
|-

|-
| void || ToggleBreakpoint || int,bool ||
|-

|-
| bool || HasBreakpoint || int ||
|-

|-
| void || GotoNextBreakpoint || ||
|-

|-
| void || GotoPreviousBreakpoint || ||
|-

|-
| void || ToggleBookmark || int,bool ||
|-

|-
| bool || HasBookmark || int ||
|-

|-
| void || GotoNextBookmark || ||
|-

|-
| void || GotoPreviousBookmark || ||
|-

|-
| void || Undo || ||
|-

|-
| void || Redo || ||
|-

|-
| void || Cut || ||
|-

|-
| void || Copy || ||
|-

|-
| void || Paste || ||
|-

|-
| bool || CanUndo || ||
|-

|-
| bool || CanRedo || ||
|-

|-
| bool || CanPaste || ||
|-

|-
| bool || HasSelection || ||
|-

|}

== cbEditor ==
Extends EditorBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || SetEditorTitle || wxString ||
|-

|-
| ProjectFile* || GetProjectFile || ||
|-

|-
| bool || SaveAs || ||
|-

|-
| void || FoldAll || ||
|-

|-
| void || UnfoldAll || ||
|-

|-
| void || ToggleAllFolds || ||
|-

|-
| void || FoldBlockFromLine || int ||
|-

|-
| void || UnfoldBlockFromLine || int ||
|-

|-
| void || ToggleFoldBlockFromLine || int ||
|-

|-
| int || GetLineIndentInSpaces || int ||
|-

|-
| wxString || GetLineIndentString || int ||
|-

|-
| void || Touch || ||
|-

|-
| bool || Reload || bool ||
|-

|-
| void || Print || bool,PrintColourMode,bool ||
|-

|-
| void || AutoComplete || ||
|-

|-
| bool || AddBreakpoint || int,bool ||
|-

|-
| bool || RemoveBreakpoint || int,bool ||
|-

|-
| void || SetText || wxString || this is not present in cbEditor; included to help scripts edit text
|-

|-
| wxString || GetText || || this is not present in cbEditor; included to help scripts edit text
|-

|}

== Constants ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"

|- style="background: #ececec; border: 0px solid gray"
!Constant
!Type
!Remarks
|-

|-
| PLATFORM || int || this defines the platform Code::Blocks is currently running on. It is equal to only one of the following PLATFORM_* constants
|-

|-
| PLATFORM_MSW || int || All Windows platforms
|-

|-
| PLATFORM_GTK || int || All GTK platforms (Linux, BSD, Solaris, Darwin, etc.)
|-

|-
| PLATFORM_MAC || int || All Mac platforms
|-

|-
| PLATFORM_OS2 || int || OS/2 platform
|-

|-
| PLATFORM_X11 || int || All X11 platforms
|-

|-
| PLATFORM_UNKNOWN || int || Unknown platform. Please inform us if PLATFORM == PLATFORM_UNKNOWN so we can make this platform known too ;)
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Message dialog flags'''
|-

|-
| wxOK || int || Flag for Message() 's third argument (flags).
|-

|-
| wxYES_NO || int || -"-
|-

|-
| wxCANCEL || int || -"-
|-

|-
| wxICON_QUESTION || int || -"-
|-

|-
| wxICON_INFORMATION || int || -"-
|-

|-
| wxICON_WARNING || int || -"-
|-

|-
| wxICON_ERROR || int || -"-
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Message dialog return values'''
|-

|-
| wxID_OK || int ||
|-

|-
| wxID_YES || int ||
|-

|-
| wxID_NO || int ||
|-

|-
| wxID_CANCEL || int ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum OptionsRelationType'''
|-

|-
| ortCompilerOptions || enum ||
|-

|-
| ortLinkerOptions || enum ||
|-

|-
| ortIncludeDirs || enum ||
|-

|-
| ortLibDirs || enum ||
|-

|-
| ortResDirs || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum OptionsRelation'''
|-

|-
| orUseParentOptionsOnly || enum ||
|-

|-
| orUseTargetOptionsOnly || enum ||
|-

|-
| orPrependToParentOptions || enum ||
|-

|-
| orAppendToParentOptions || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum TargetType'''
|-

|-
| ttExecutable || enum ||
|-

|-
| ttConsoleOnly || enum ||
|-

|-
| ttStaticLib || enum ||
|-

|-
| ttDynamicLib || enum ||
|-

|-
| ttCommandsOnly || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum MakeCommand'''
|-

|-
| mcClean || enum ||
|-

|-
| mcDistClean || enum ||
|-

|-
| mcBuild || enum ||
|-

|-
| mcCompileFile || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PCHMode'''
|-

|-
| pchSourceDir || enum ||
|-

|-
| pchObjectDir || enum ||
|-

|-
| pchSourceFile || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PrintScope'''
|-

|-
| psSelection || enum ||
|-

|-
| psActiveEditor || enum ||
|-

|-
| psAllOpenEditors || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PrintColourMode'''
|-

|-
| pcmBlackAndWhite || enum ||
|-

|-
| pcmColourOnWhite || enum ||
|-

|-
| pcmInvertColours || enum ||
|-

|-
| pcmAsIs || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum TemplateOutputType'''
|-

|-
| wizProject || enum || TemplateOutputType::totProject
|-

|-
| wizTarget || enum || TemplateOutputType::totTarget
|-

|-
| wizFiles || enum || TemplateOutputType::totFiles
|-

|-
| wizCustom || enum || TemplateOutputType::totCustom
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Other constants'''
|-

|-
| wxFILE_SEP_PATH || wxString || Path separator. "\" for windows, "/" for all other platforms
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''File extensions (e.g. "cbp")'''
|-

|-
| EXT_WORKSPACE || wxString ||
|-

|-
| EXT_CODEBLOCKS || wxString ||
|-

|-
| EXT_DEVCPP || wxString ||
|-

|-
| EXT_MSVC6 || wxString ||
|-

|-
| EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| EXT_MSVC7 || wxString ||
|-

|-
| EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| EXT_D || wxString ||
|-

|-
| EXT_F || wxString ||
|-

|-
| EXT_F77 || wxString ||
|-

|-
| EXT_F95 || wxString ||
|-

|-
| EXT_CPP || wxString ||
|-

|-
| EXT_C || wxString ||
|-

|-
| EXT_CC || wxString ||
|-

|-
| EXT_CXX || wxString ||
|-

|-
| EXT_HPP || wxString ||
|-

|-
| EXT_H || wxString ||
|-

|-
| EXT_HH || wxString ||
|-

|-
| EXT_HXX || wxString ||
|-

|-
| EXT_OBJECT || wxString ||
|-

|-
| EXT_XRCRESOURCE || wxString ||
|-

|-
| EXT_STATICLIB || wxString ||
|-

|-
| EXT_DYNAMICLIB || wxString ||
|-

|-
| EXT_EXECUTABLE || wxString ||
|-

|-
| EXT_RESOURCE || wxString ||
|-

|-
| EXT_RESOURCEBIN || wxString ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''File extensions with leading dot (e.g. ".cbp")'''
|-

|-
| DOT_EXT_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_CODEBLOCKS || wxString ||
|-

|-
| DOT_EXT_DEVCPP || wxString ||
|-

|-
| DOT_EXT_MSVC6 || wxString ||
|-

|-
| DOT_EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_MSVC7 || wxString ||
|-

|-
| DOT_EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_D || wxString ||
|-

|-
| DOT_EXT_F || wxString ||
|-

|-
| DOT_EXT_F77 || wxString ||
|-

|-
| DOT_EXT_F95 || wxString ||
|-

|-
| DOT_EXT_CPP || wxString ||
|-

|-
| DOT_EXT_C || wxString ||
|-

|-
| DOT_EXT_CC || wxString ||
|-

|-
| DOT_EXT_CXX || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_H || wxString ||
|-

|-
| DOT_EXT_HH || wxString ||
|-

|-
| DOT_EXT_HXX || wxString ||
|-

|-
| DOT_EXT_OBJECT || wxString ||
|-

|-
| DOT_EXT_XRCRESOURCE || wxString ||
|-

|-
| DOT_EXT_STATICLIB || wxString ||
|-

|-
| DOT_EXT_DYNAMICLIB || wxString ||
|-

|-
| DOT_EXT_EXECUTABLE || wxString ||
|-

|-
| DOT_EXT_RESOURCE || wxString ||
|-

|-
| DOT_EXT_RESOURCEBIN || wxString ||
|-

|}

== See also ==

* [[Scripting Code::Blocks|Scripting index]]

Startup script

2006-12-15T12:29:54Z

Mandrav: Updated info for latest changes

[[Category:Scripting Code::Blocks]]

When Code::Blocks finishes loading, it tries to load a script named ''startup.script''. If it is found it then executes it (no need for ''"function main()"'' inside it anymore). The user can edit this script to run arbitrary customization commands on application startup.
The shipped ''startup.script'' demonstrates a couple of the newest scripting features.

Log(_T("Running startup script"));

// #include any script plugins; this will register them too
// un-comment the line below to register a pointless sample plugin
// Include(_T("sample_plugin.script"));

// add a menu entry to edit this script
GetScriptingManager().RegisterScriptMenu(_T("edit_startup_script.script"), _T("Settings/-Edit startup script"));

== Example ==
An example script is now shipping with Code::Blocks. Please read the last line of the startup.script above:

// add a menu entry to edit this script
GetScriptingManager().RegisterScriptMenu(_T("edit_startup_script.script"), _T("Settings/-Edit startup script"));

This actually binds the script named <tt>edit_startup_script.script</tt> to the menu entry <tt>"Settings/-Edit startup script"</tt>.

And don't forget that Code::Blocks conveniently allows you to edit the <tt>edit_startup_script.script</tt> at any time. All you have to do is keep SHIFT pressed while clicking on the <tt>"Edit startup script"</tt> menu item ;).

== See also ==

* [[Scripting commands]]

Scripting Code::Blocks

2006-12-15T12:22:01Z

Mandrav: Added link to script plugins

[[Category:Developer Documentation]]
[[Category:Scripting Code::Blocks]]
Code::Blocks supports '''scripting''' to extend various parts of its functionality during runtime. The scripting language used is [http://www.squirrel-lang.org Squirrel].

Currently, Code::Blocks uses scripts for:

'''[[Startup script|Startup]]'''
: Run arbitrary commands on application startup.

'''[[Wizard scripts|Wizards]]'''
: Register new wizards for generating projects, build targets, files or anything else. All wizards shipped with Code::Blocks are scripted.

'''[[Script plugins]]
: Create and register new plugins written entirely in [http://www.squirrel-lang.org Squirrel].

'''[[Debugger scripts|Debugger]]'''
: Extend the GNU Debugger (and others) to support arbitrary data types. Code::Blocks ships with scripts that add wxString, std::string and std::vector "knowledge" to the GNU Debugger.

'''[[Build scripts|Build]]'''
: Extend the build system. Scripts can be attached to projects and/or build targets and are executed before and/or after each of these is built. 

'''[[Variable expansion]]'''
:As a special case of [[variable expansion]], scripts can be run in place of a variable, expanding to the output generated by the script.

More Code::Blocks parts may be exposed to scripting in the future.

== See also ==
* [[Scripting commands]]

== External links ==
* [http://www.squirrel-lang.org/#doc Squirrel documentation]

User documentation

2006-12-15T12:19:01Z

Mandrav: Added link to scripting docs

[[Category:Code::Blocks Documentation]]
[[Category:User Documentation]]
__TOC__
Articles for Code::Blocks users.

'''[[Installing Code::Blocks]]'''

:How to install Code::Blocks (from binary or source)

'''[[Keyboard Shortcuts]]'''

:List of keyboard shortcuts that can be used in Code::Blocks

'''[[Command line arguments]]'''

:List of command-line arguments that can be used with Code::Blocks.

'''[[Personalities]]'''

:Customize the Code::Blocks user interface for different workflows.

'''[[Code::Blocks Plugins]]'''

:List of plugins that come with Code::Blocks.

'''[[The build process of Code::Blocks]]'''

:Information about how Code::Blocks actually builds your source code.

'''[[Scripting Code::Blocks]]'''
:Information about scripting Code::Blocks with [http://www.squirrel-lang.org/ Squirrel].

== Application development ==

* [[Builtin variables]]
* [[Recommended global variables]]
* [[Debugging with Code::Blocks]]

== Compilers ==

* [[Global compiler variables]]
* [[Precompiled headers]]
* [[Installing a supported compiler]]
* [[Installing Cygwin Compiler]]
* [[Installing Fortran Compiler]]
* [[Installing Uniwin remote compiler]]
* [[Code::Blocks_and_Cross_Compilers|Using cross compilers]]
* [[Integrating Microsoft Visual Toolkit 2003 with Code::Blocks IDE]]
* [[Integrating Microsoft Visual C 6 with Code::Blocks IDE]]

== Third-party libraries ==

* [[Using SDL with Code::Blocks]]
* [[Using GLFW with Code::Blocks]]

== User interface development ==

* [[WxSmith Tutorial & Pointers|Creating a dialog for wxWidgets with wxSmith]]

Scripting commands

2006-12-10T20:18:54Z

Mandrav:

[[Category:Scripting Code::Blocks]]
Scripting is no good if all you can do is use the scripting language's builtin 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.''

== Application object ==
The application object is accessed through the variable named '''<tt>App</tt>'''. Currently bound functions are:

{| 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 || RegisterScript || (char*,char*) or (wxString,wxString) || registers the script file (arg1) under a menu item (arg2).
e.g. <tt>App.RegisterScript("sample.script", "Scripts/Sample script")</tt>;
|-

|}

Notes about the <tt>RegisterScript</tt> function: 
* The second argument (menu item) is a string containing two values separated by a slash (/). The first value (part before the slash) is the '''menu''' under which to add the '''menu item''' (which is the part after the slash).
* 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]].

== 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 debug log
|-

|-
| int || Message || wxString,wxString,int ||
|-

|-
| void || ShowMessage || wxString ||
|-

|-
| void || ShowWarning || wxString ||
|-

|-
| void || ShowError || wxString ||
|-

|-
| void || ShowInfo || wxString ||
|-

|-
| wxString || ReplaceMacros || wxString,bool ||
|-

|-
| ProjectManager* || GetProjectManager || ||
|-

|-
| EditorManager* || GetEditorManager || ||
|-

|-
| ConfigManager* || GetConfigManager || ||
|-

|-
| UserVariableManager* || GetUserVariableManager || ||
|-

|-
| CompilerFactory* || GetCompilerFactory || ||
|-

|-
| bool || IsNull || void* ||
|-

|-
| wxString || _T || const char* || basically this is the wxString constructor
|-

|}

== ConfigManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| int || Read || int,int ||
|-

|-
| bool || Read || bool,bool ||
|-

|-
| float || Read || float,float ||
|-

|-
| wxString || Read || wxString,wxString ||
|-

|-
| void || Write || int,int ||
|-

|-
| void || Write || bool,bool ||
|-

|-
| void || Write || float,float ||
|-

|-
| void || Write || wxString,wxString[,bool] ||
|-

|}

== ProjectManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetDefaultPath || ||
|-

|-
| void || SetDefaultPath || wxString ||
|-

|-
| cbProject* || GetActiveProject || ||
|-

|-
| void || SetProject || cbProject* ||
|-

|-
| bool || LoadWorkspace || wxString ||
|-

|-
| bool || SaveWorkspace || ||
|-

|-
| bool || SaveWorkspaceAs || wxString ||
|-

|-
| bool || CloseWorkspace || ||
|-

|-
| cbProject* || IsOpen || wxString ||
|-

|-
| cbProject* || LoadProject || wxString,bool ||
|-

|-
| bool || SaveProject || cbProject* ||
|-

|-
| bool || SaveProjectAs || cbProject* ||
|-

|-
| bool || SaveActiveProject || ||
|-

|-
| bool || SaveActiveProjectAs || ||
|-

|-
| bool || SaveAllProjects || ||
|-

|-
| bool || CloseProject || cbProject*,bool,bool ||
|-

|-
| bool || CloseActiveProject || bool ||
|-

|-
| bool || CloseAllProjects || bool ||
|-

|-
| cbProject* || NewProject || wxString ||
|-

|-
| int || AddFileToProject || wxString,cbProject*,int ||
|-

|-
| int || AskForBuildTargetIndex || cbProject* ||
|-

|-
| void || RebuildTree || ||
|-

|}

== EditorManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || Configure || ||
|-

|-
| cbEditor* || New || wxString ||
|-

|-
| cbEditor* || Open || wxString ||
|-

|-
| cbEditor* || IsBuiltinOpen || wxString ||
|-

|-
| cbEditor* || GetBuiltinEditor || wxString|int ||
|-

|-
| cbEditor* || GetBuiltinActiveEditor || ||
|-

|-
| EditorBase* || GetActiveEditor || ||
|-

|-
| void || ActivateNext || ||
|-

|-
| void || ActivatePrevious || ||
|-

|-
| bool || SwapActiveHeaderSource || ||
|-

|-
| bool || CloseActive || bool ||
|-

|-
| bool || Close || wxString|int,bool ||
|-

|-
| bool || CloseAll || bool ||
|-

|-
| bool || Save || wxString|int ||
|-

|-
| bool || SaveActive || ||
|-

|-
| bool || SaveAs || int ||
|-

|-
| bool || SaveActiveAs || ||
|-

|-
| bool || SaveAll || ||
|-

|-
| int || ShowFindDialog || bool,bool ||
|-

|}

== UserVariableManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || Exists || wxString ||
|-

|}

== IO namespace ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || DirectoryExists || wxString ||
|-

|-
| wxString || SelectDirectory || wxString,wxString,bool ||
|-

|-
| bool || FileExists || wxString ||
|-

|-
| wxString || SelectFile || wxString,wxString,wxString ||
|-

|}

== CompilerFactory ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || IsValidCompilerID || wxString ||
|-

|-
| int || GetCompilerIndex || wxString ||
|-

|-
| wxString || GetDefaultCompilerID || ||
|-

|-
| bool || CompilerInheritsFrom || ||
|-

|}

== wxString ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || operator+ || ||
|-

|-
| bool || operator< || ||
|-

|-
| bool || operator<= || ||
|-

|-
| bool || operator>= || ||
|-

|-
| bool || operator> || ||
|-

|-
| int || Find || wxString ||
|-

|-
| bool || Matches || wxString ||
|-

|-
| void || AddChar || char ||
|-

|-
| char || GetChar || int ||
|-

|-
| bool || IsEmpty || ||
|-

|-
| int || Length || ||
|-

|-
| int || length || || same as Length()
|-

|-
| int || len || || same as Length()
|-

|-
| int || size || || same as Length()
|-

|-
| wxString || Lower || ||
|-

|-
| wxString || LowerCase || || same as Lower()
|-

|-
| void || MakeLower || ||
|-

|-
| wxString || Upper || ||
|-

|-
| wxString || UpperCase || || same as Upper()
|-

|-
| void || MakeUpper || ||
|-

|-
| wxString || Mid || int,int ||
|-

|-
| void || Remove || int,int ||
|-

|-
| void || RemoveLast || ||
|-

|-
| int || Replace || wxString,wxString[,bool] ||
|-

|-
| wxString || Right || int ||
|-

|-
| wxString || AfterFirst || char ||
|-

|-
| wxString || AfterLast || char ||
|-

|-
| wxString || BeforeFirst || char ||
|-

|-
| wxString || BeforeLast || char ||
|-
|}

== 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 ||
|-

|-
| void || Clear || ||
|-

|-
| int || GetCount || ||
|-

|-
| wxString || Item || int ||
|-

|}

== ProjectFile ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || AddBuildTarget || wxString ||
|-

|-
| void || RenameBuildTarget || wxString,wxString ||
|-

|-
| void || RemoveBuildTarget || wxString ||
|-

|-
| wxString || GetBaseName || ||
|-

|-
| wxString || GetObjName || ||
|-

|-
| void || SetObjName || wxString ||
|-

|-
| cbProject* || GetParentProject || ||
|-

|-
| wxString || relativeFilename || || (variable)
|-

|-
| wxString || relativeToCommonTopLevelPath || || (variable)
|-

|-
| bool || compile || || (variable)
|-

|-
| bool || link || || (variable)
|-

|-
| int || weight || || (variable)
|-

|-
| wxString || compilerVar || || (variable)
|-

|}

== CompileOptionsBase ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || SetLinkerOptions || wxArrayString ||
|-

|-
| void || SetLinkLibs || wxArrayString ||
|-

|-
| void || SetCompilerOptions || wxArrayString ||
|-

|-
| void || SetIncludeDirs || wxArrayString ||
|-

|-
| void || SetResourceIncludeDirs || wxArrayString ||
|-

|-
| void || SetLibDirs || wxArrayString ||
|-

|-
| void || SetCommandsBeforeBuild || wxArrayString ||
|-

|-
| void || SetCommandsAfterBuild || wxArrayString ||
|-

|-
| wxArrayString || GetLinkerOptions || ||
|-

|-
| wxArrayString || GetLinkLibs || ||
|-

|-
| wxArrayString || GetCompilerOptions || ||
|-

|-
| wxArrayString || GetIncludeDirs || ||
|-

|-
| wxArrayString || GetResourceIncludeDirs || ||
|-

|-
| wxArrayString || GetLibDirs || ||
|-

|-
| wxArrayString || GetCommandsBeforeBuild || ||
|-

|-
| wxArrayString || GetCommandsAfterBuild || ||
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| void || AddLinkerOption || wxString ||
|-

|-
| void || AddLinkLib || wxString ||
|-

|-
| void || AddCompilerOption || wxString ||
|-

|-
| void || AddIncludeDir || wxString ||
|-

|-
| void || AddResourceIncludeDir || wxString ||
|-

|-
| void || AddLibDir || wxString ||
|-

|-
| void || AddCommandsBeforeBuild || wxString ||
|-

|-
| void || AddCommandsAfterBuild || wxString ||
|-

|-
| void || RemoveLinkerOption || wxString ||
|-

|-
| void || RemoveLinkLib || wxString ||
|-

|-
| void || RemoveCompilerOption || wxString ||
|-

|-
| void || RemoveIncludeDir || wxString ||
|-

|-
| void || RemoveResourceIncludeDir || wxString ||
|-

|-
| void || RemoveLibDir || wxString ||
|-

|-
| void || RemoveCommandsBeforeBuild || wxString ||
|-

|-
| void || RemoveCommandsAfterBuild || wxString ||
|-

|-
| bool || GetAlwaysRunPostBuildSteps || ||
|-

|-
| void || SetAlwaysRunPostBuildSteps || bool ||
|-

|-
| bool || SetVar || wxString,wxString,bool ||
|-

|-
| wxString || GetVar || wxString ||
|-

|-
| bool || UnsetVar || wxString ||
|-

|-
| void || UnsetAllVars || ||
|-

|}

== CompileTargetBase ==
Extends CompileOptionsBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetFilename || ||
|-

|-
| wxString || GetTitle || ||
|-

|-
| void || SetTitle || wxString ||
|-

|-
| void || SetOutputFilename || wxString ||
|-

|-
| void || SetWorkingDir || wxString ||
|-

|-
| void || SetObjectOutput || wxString ||
|-

|-
| void || SetDepsOutput || wxString ||
|-

|-
| OptionsRelation || GetOptionRelation || OptionsRelationType ||
|-

|-
| void || SetOptionRelation || OptionsRelationType,OptionsRelation ||
|-

|-
| wxString || GetWorkingDir || ||
|-

|-
| wxString || GetObjectOutput || ||
|-

|-
| wxString || GetDepsOutput || ||
|-

|-
| wxString || GetOutputFilename || ||
|-

|-
| wxString || SuggestOutputFilename || ||
|-

|-
| wxString || GetExecutableFilename || ||
|-

|-
| wxString || GetDynamicLibFilename || ||
|-

|-
| wxString || GetDynamicLibDefFilename || ||
|-

|-
| wxString || GetStaticLibFilename || ||
|-

|-
| wxString || GetBasePath || ||
|-

|-
| void || SetTargetType || TargetType ||
|-

|-
| TargetType || GetTargetType || ||
|-

|-
| wxString || GetExecutionParameters || ||
|-

|-
| void || SetExecutionParameters || wxString ||
|-

|-
| wxString || GetHostApplication || ||
|-

|-
| void || SetHostApplication || wxString ||
|-

|-
| void || SetCompilerID || wxString ||
|-

|-
| wxString || GetCompilerID || ||
|-

|}

== ProjectBuildTarget ==
Extends CompileTargetBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| cbProject* || GetParentProject || ||
|-

|-
| wxString || GetFullTitle || ||
|-

|-
| wxString || GetExternalDeps || ||
|-

|-
| void || SetExternalDeps || wxString ||
|-

|-
| void || SetAdditionalOutputFiles || wxString ||
|-

|-
| wxString || GetAdditionalOutputFiles || ||
|-

|-
| bool || GetIncludeInTargetAll || ||
|-

|-
| void || SetIncludeInTargetAll || bool ||
|-

|-
| bool || GetCreateDefFile || ||
|-

|-
| void || SetCreateDefFile || bool ||
|-

|-
| bool || GetCreateStaticLib || ||
|-

|-
| void || SetCreateStaticLib || bool ||
|-

|-
| bool || GetUseConsoleRunner || ||
|-

|-
| void || SetUseConsoleRunner || bool ||
|-

|}

== cbProject ==
Extends CompileTargetBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| wxString || GetMakefile || ||
|-

|-
| void || SetMakefile || wxString ||
|-

|-
| bool || IsMakefileCustom || ||
|-

|-
| void || SetMakefileCustom || bool ||
|-

|-
| bool || CloseAllFiles || bool ||
|-

|-
| bool || SaveAllFiles || ||
|-

|-
| bool || Save || ||
|-

|-
| bool || SaveLayout || ||
|-

|-
| bool || LoadLayout || ||
|-

|-
| bool || ShowOptions || ||
|-

|-
| wxString || GetCommonTopLevelPath || ||
|-

|-
| int || GetFilesCount || ||
|-

|-
| ProjectFile* || GetFile || int ||
|-

|-
| ProjectFile* || GetFileByFilename || wxString,bool,bool ||
|-

|-
| bool || RemoveFile || int ||
|-

|-
| ProjectFile* || AddFile || wxString|int,wxString,bool,bool,int ||
|-

|-
| int || GetBuildTargetsCount || ||
|-

|-
| ProjectBuildTarget* || GetBuildTarget || wxString|int ||
|-

|-
| ProjectBuildTarget* || AddBuildTarget || wxString ||
|-

|-
| bool || RenameBuildTarget || wxString|int,wxString ||
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || wxString|int,wxString ||
|-

|-
| bool || RemoveBuildTarget || wxString|int ||
|-

|-
| bool || ExportTargetAsProject || wxString|int ||
|-

|-
| void || SetActiveBuildTarget || int ||
|-

|-
| int || GetActiveBuildTarget || ||
|-

|-
| int || SelectTarget || int,bool ||
|-

|-
| ProjectBuildTarget* || GetCurrentlyCompilingTarget || ||
|-

|-
| void || SetCurrentlyCompilingTarget || ProjectBuildTarget* ||
|-

|-
| PCHMode || GetModeForPCH || ||
|-

|-
| void || SetModeForPCH || PCHMode ||
|-

|}

== EditorBase ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetFilename || ||
|-

|-
| void || SetFilename || wxString ||
|-

|-
| wxString || GetShortName || ||
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| wxString || GetTitle || ||
|-

|-
| void || SetTitle || wxString ||
|-

|-
| void || Activate || ||
|-

|-
| bool || Close || ||
|-

|-
| bool || Save || ||
|-

|-
| bool || IsBuiltinEditor || ||
|-

|-
| bool || ThereAreOthers || ||
|-

|-
| void || GotoLine || int,bool ||
|-

|-
| void || ToggleBreakpoint || int,bool ||
|-

|-
| bool || HasBreakpoint || int ||
|-

|-
| void || GotoNextBreakpoint || ||
|-

|-
| void || GotoPreviousBreakpoint || ||
|-

|-
| void || ToggleBookmark || int,bool ||
|-

|-
| bool || HasBookmark || int ||
|-

|-
| void || GotoNextBookmark || ||
|-

|-
| void || GotoPreviousBookmark || ||
|-

|-
| void || Undo || ||
|-

|-
| void || Redo || ||
|-

|-
| void || Cut || ||
|-

|-
| void || Copy || ||
|-

|-
| void || Paste || ||
|-

|-
| bool || CanUndo || ||
|-

|-
| bool || CanRedo || ||
|-

|-
| bool || CanPaste || ||
|-

|-
| bool || HasSelection || ||
|-

|}

== cbEditor ==
Extends EditorBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || SetEditorTitle || wxString ||
|-

|-
| ProjectFile* || GetProjectFile || ||
|-

|-
| bool || SaveAs || ||
|-

|-
| void || FoldAll || ||
|-

|-
| void || UnfoldAll || ||
|-

|-
| void || ToggleAllFolds || ||
|-

|-
| void || FoldBlockFromLine || int ||
|-

|-
| void || UnfoldBlockFromLine || int ||
|-

|-
| void || ToggleFoldBlockFromLine || int ||
|-

|-
| int || GetLineIndentInSpaces || int ||
|-

|-
| wxString || GetLineIndentString || int ||
|-

|-
| void || Touch || ||
|-

|-
| bool || Reload || bool ||
|-

|-
| void || Print || bool,PrintColourMode,bool ||
|-

|-
| void || AutoComplete || ||
|-

|-
| bool || AddBreakpoint || int,bool ||
|-

|-
| bool || RemoveBreakpoint || int,bool ||
|-

|-
| void || SetText || wxString || this is not present in cbEditor; included to help scripts edit text
|-

|-
| wxString || GetText || || this is not present in cbEditor; included to help scripts edit text
|-

|}

== Constants ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"

|- style="background: #ececec; border: 0px solid gray"
!Constant
!Type
!Remarks
|-

|-
| PLATFORM || int || this defines the platform Code::Blocks is currently running on. It is equal to only one of the following PLATFORM_* constants
|-

|-
| PLATFORM_MSW || int || All Windows platforms
|-

|-
| PLATFORM_GTK || int || All GTK platforms (Linux, BSD, Solaris, Darwin, etc.)
|-

|-
| PLATFORM_MAC || int || All Mac platforms
|-

|-
| PLATFORM_OS2 || int || OS/2 platform
|-

|-
| PLATFORM_X11 || int || All X11 platforms
|-

|-
| PLATFORM_UNKNOWN || int || Unknown platform. Please inform us if PLATFORM == PLATFORM_UNKNOWN so we can make this platform known too ;)
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Message dialog flags'''
|-

|-
| wxOK || int || Flag for Message() 's third argument (flags).
|-

|-
| wxYES_NO || int || -"-
|-

|-
| wxCANCEL || int || -"-
|-

|-
| wxICON_QUESTION || int || -"-
|-

|-
| wxICON_INFORMATION || int || -"-
|-

|-
| wxICON_WARNING || int || -"-
|-

|-
| wxICON_ERROR || int || -"-
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Message dialog return values'''
|-

|-
| wxID_OK || int ||
|-

|-
| wxID_YES || int ||
|-

|-
| wxID_NO || int ||
|-

|-
| wxID_CANCEL || int ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum OptionsRelationType'''
|-

|-
| ortCompilerOptions || enum ||
|-

|-
| ortLinkerOptions || enum ||
|-

|-
| ortIncludeDirs || enum ||
|-

|-
| ortLibDirs || enum ||
|-

|-
| ortResDirs || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum OptionsRelation'''
|-

|-
| orUseParentOptionsOnly || enum ||
|-

|-
| orUseTargetOptionsOnly || enum ||
|-

|-
| orPrependToParentOptions || enum ||
|-

|-
| orAppendToParentOptions || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum TargetType'''
|-

|-
| ttExecutable || enum ||
|-

|-
| ttConsoleOnly || enum ||
|-

|-
| ttStaticLib || enum ||
|-

|-
| ttDynamicLib || enum ||
|-

|-
| ttCommandsOnly || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum MakeCommand'''
|-

|-
| mcClean || enum ||
|-

|-
| mcDistClean || enum ||
|-

|-
| mcBuild || enum ||
|-

|-
| mcCompileFile || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PCHMode'''
|-

|-
| pchSourceDir || enum ||
|-

|-
| pchObjectDir || enum ||
|-

|-
| pchSourceFile || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PrintScope'''
|-

|-
| psSelection || enum ||
|-

|-
| psActiveEditor || enum ||
|-

|-
| psAllOpenEditors || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PrintColourMode'''
|-

|-
| pcmBlackAndWhite || enum ||
|-

|-
| pcmColourOnWhite || enum ||
|-

|-
| pcmInvertColours || enum ||
|-

|-
| pcmAsIs || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum TemplateOutputType'''
|-

|-
| wizProject || enum || TemplateOutputType::totProject
|-

|-
| wizTarget || enum || TemplateOutputType::totTarget
|-

|-
| wizFiles || enum || TemplateOutputType::totFiles
|-

|-
| wizCustom || enum || TemplateOutputType::totCustom
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Other constants'''
|-

|-
| wxFILE_SEP_PATH || wxString || Path separator. "\" for windows, "/" for all other platforms
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''File extensions (e.g. "cbp")'''
|-

|-
| EXT_WORKSPACE || wxString ||
|-

|-
| EXT_CODEBLOCKS || wxString ||
|-

|-
| EXT_DEVCPP || wxString ||
|-

|-
| EXT_MSVC6 || wxString ||
|-

|-
| EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| EXT_MSVC7 || wxString ||
|-

|-
| EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| EXT_D || wxString ||
|-

|-
| EXT_F || wxString ||
|-

|-
| EXT_F77 || wxString ||
|-

|-
| EXT_F95 || wxString ||
|-

|-
| EXT_CPP || wxString ||
|-

|-
| EXT_C || wxString ||
|-

|-
| EXT_CC || wxString ||
|-

|-
| EXT_CXX || wxString ||
|-

|-
| EXT_HPP || wxString ||
|-

|-
| EXT_H || wxString ||
|-

|-
| EXT_HH || wxString ||
|-

|-
| EXT_HXX || wxString ||
|-

|-
| EXT_OBJECT || wxString ||
|-

|-
| EXT_XRCRESOURCE || wxString ||
|-

|-
| EXT_STATICLIB || wxString ||
|-

|-
| EXT_DYNAMICLIB || wxString ||
|-

|-
| EXT_EXECUTABLE || wxString ||
|-

|-
| EXT_RESOURCE || wxString ||
|-

|-
| EXT_RESOURCEBIN || wxString ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''File extensions with leading dot (e.g. ".cbp")'''
|-

|-
| DOT_EXT_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_CODEBLOCKS || wxString ||
|-

|-
| DOT_EXT_DEVCPP || wxString ||
|-

|-
| DOT_EXT_MSVC6 || wxString ||
|-

|-
| DOT_EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_MSVC7 || wxString ||
|-

|-
| DOT_EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_D || wxString ||
|-

|-
| DOT_EXT_F || wxString ||
|-

|-
| DOT_EXT_F77 || wxString ||
|-

|-
| DOT_EXT_F95 || wxString ||
|-

|-
| DOT_EXT_CPP || wxString ||
|-

|-
| DOT_EXT_C || wxString ||
|-

|-
| DOT_EXT_CC || wxString ||
|-

|-
| DOT_EXT_CXX || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_H || wxString ||
|-

|-
| DOT_EXT_HH || wxString ||
|-

|-
| DOT_EXT_HXX || wxString ||
|-

|-
| DOT_EXT_OBJECT || wxString ||
|-

|-
| DOT_EXT_XRCRESOURCE || wxString ||
|-

|-
| DOT_EXT_STATICLIB || wxString ||
|-

|-
| DOT_EXT_DYNAMICLIB || wxString ||
|-

|-
| DOT_EXT_EXECUTABLE || wxString ||
|-

|-
| DOT_EXT_RESOURCE || wxString ||
|-

|-
| DOT_EXT_RESOURCEBIN || wxString ||
|-

|}

== See also ==

* [[Scripting Code::Blocks|Scripting index]]

Scripting commands

2006-12-10T20:18:15Z

Mandrav: /* Application object */ link to startup script example and hint for SHIFT

[[Category:Scripting Code::Blocks]]
Scripting is no good if all you can do is use the scripting language's builtin 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.''

== Application object ==
The application object is accessed through the variable named '''<tt>App</tt>'''. Currently bound functions are:

{| 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 || RegisterScript || (char*,char*) or (wxString,wxString) || registers the script file (arg1) under a menu item (arg2).
e.g. <tt>App.RegisterScript("sample.script", "Scripts/Sample script")</tt>;
|-

|}

Notes about the <tt>RegisterScript</tt> function: 
* The second argument (menu item) is a string containing two values separated by a slash (/). The first value (part before the slash) is the '''menu''' under which to add the '''menu item''' (which is the part after the slash).
* 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]].

== 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 debug log
|-

|-
| int || Message || wxString,wxString,int ||
|-

|-
| void || ShowMessage || wxString ||
|-

|-
| void || ShowWarning || wxString ||
|-

|-
| void || ShowError || wxString ||
|-

|-
| void || ShowInfo || wxString ||
|-

|-
| wxString || ReplaceMacros || wxString,bool ||
|-

|-
| ProjectManager* || GetProjectManager || ||
|-

|-
| EditorManager* || GetEditorManager || ||
|-

|-
| ConfigManager* || GetConfigManager || ||
|-

|-
| UserVariableManager* || GetUserVariableManager || ||
|-

|-
| CompilerFactory* || GetCompilerFactory || ||
|-

|-
| bool || IsNull || void* ||
|-

|-
| wxString || _T || const char* || basically this is the wxString constructor
|-

|}

== ConfigManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| int || Read || int,int ||
|-

|-
| bool || Read || bool,bool ||
|-

|-
| float || Read || float,float ||
|-

|-
| wxString || Read || wxString,wxString ||
|-

|-
| void || Write || int,int ||
|-

|-
| void || Write || bool,bool ||
|-

|-
| void || Write || float,float ||
|-

|-
| void || Write || wxString,wxString[,bool] ||
|-

|}

== ProjectManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetDefaultPath || ||
|-

|-
| void || SetDefaultPath || wxString ||
|-

|-
| cbProject* || GetActiveProject || ||
|-

|-
| void || SetProject || cbProject* ||
|-

|-
| bool || LoadWorkspace || wxString ||
|-

|-
| bool || SaveWorkspace || ||
|-

|-
| bool || SaveWorkspaceAs || wxString ||
|-

|-
| bool || CloseWorkspace || ||
|-

|-
| cbProject* || IsOpen || wxString ||
|-

|-
| cbProject* || LoadProject || wxString,bool ||
|-

|-
| bool || SaveProject || cbProject* ||
|-

|-
| bool || SaveProjectAs || cbProject* ||
|-

|-
| bool || SaveActiveProject || ||
|-

|-
| bool || SaveActiveProjectAs || ||
|-

|-
| bool || SaveAllProjects || ||
|-

|-
| bool || CloseProject || cbProject*,bool,bool ||
|-

|-
| bool || CloseActiveProject || bool ||
|-

|-
| bool || CloseAllProjects || bool ||
|-

|-
| cbProject* || NewProject || wxString ||
|-

|-
| int || AddFileToProject || wxString,cbProject*,int ||
|-

|-
| int || AskForBuildTargetIndex || cbProject* ||
|-

|-
| void || RebuildTree || ||
|-

|}

== EditorManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || Configure || ||
|-

|-
| cbEditor* || New || wxString ||
|-

|-
| cbEditor* || Open || wxString ||
|-

|-
| cbEditor* || IsBuiltinOpen || wxString ||
|-

|-
| cbEditor* || GetBuiltinEditor || wxString|int ||
|-

|-
| cbEditor* || GetBuiltinActiveEditor || ||
|-

|-
| EditorBase* || GetActiveEditor || ||
|-

|-
| void || ActivateNext || ||
|-

|-
| void || ActivatePrevious || ||
|-

|-
| bool || SwapActiveHeaderSource || ||
|-

|-
| bool || CloseActive || bool ||
|-

|-
| bool || Close || wxString|int,bool ||
|-

|-
| bool || CloseAll || bool ||
|-

|-
| bool || Save || wxString|int ||
|-

|-
| bool || SaveActive || ||
|-

|-
| bool || SaveAs || int ||
|-

|-
| bool || SaveActiveAs || ||
|-

|-
| bool || SaveAll || ||
|-

|-
| int || ShowFindDialog || bool,bool ||
|-

|}

== UserVariableManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || Exists || wxString ||
|-

|}

== IO namespace ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || DirectoryExists || wxString ||
|-

|-
| wxString || SelectDirectory || wxString,wxString,bool ||
|-

|-
| bool || FileExists || wxString ||
|-

|-
| wxString || SelectFile || wxString,wxString,wxString ||
|-

|}

== CompilerFactory ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || IsValidCompilerID || wxString ||
|-

|-
| int || GetCompilerIndex || wxString ||
|-

|-
| wxString || GetDefaultCompilerID || ||
|-

|-
| bool || CompilerInheritsFrom || ||
|-

|}

== wxString ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || operator+ || ||
|-

|-
| bool || operator< || ||
|-

|-
| bool || operator<= || ||
|-

|-
| bool || operator>= || ||
|-

|-
| bool || operator> || ||
|-

|-
| int || Find || wxString ||
|-

|-
| bool || Matches || wxString ||
|-

|-
| void || AddChar || char ||
|-

|-
| char || GetChar || int ||
|-

|-
| bool || IsEmpty || ||
|-

|-
| int || Length || ||
|-

|-
| int || length || || same as Length()
|-

|-
| int || len || || same as Length()
|-

|-
| int || size || || same as Length()
|-

|-
| wxString || Lower || ||
|-

|-
| wxString || LowerCase || || same as Lower()
|-

|-
| void || MakeLower || ||
|-

|-
| wxString || Upper || ||
|-

|-
| wxString || UpperCase || || same as Upper()
|-

|-
| void || MakeUpper || ||
|-

|-
| wxString || Mid || int,int ||
|-

|-
| void || Remove || int,int ||
|-

|-
| void || RemoveLast || ||
|-

|-
| int || Replace || wxString,wxString[,bool] ||
|-

|-
| wxString || Right || int ||
|-

|-
| wxString || AfterFirst || char ||
|-

|-
| wxString || AfterLast || char ||
|-

|-
| wxString || BeforeFirst || char ||
|-

|-
| wxString || BeforeLast || char ||
|-
|}

== 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 ||
|-

|-
| void || Clear || ||
|-

|-
| int || GetCount || ||
|-

|-
| wxString || Item || int ||
|-

|}

== ProjectFile ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || AddBuildTarget || wxString ||
|-

|-
| void || RenameBuildTarget || wxString,wxString ||
|-

|-
| void || RemoveBuildTarget || wxString ||
|-

|-
| wxString || GetBaseName || ||
|-

|-
| wxString || GetObjName || ||
|-

|-
| void || SetObjName || wxString ||
|-

|-
| cbProject* || GetParentProject || ||
|-

|-
| wxString || relativeFilename || || (variable)
|-

|-
| wxString || relativeToCommonTopLevelPath || || (variable)
|-

|-
| bool || compile || || (variable)
|-

|-
| bool || link || || (variable)
|-

|-
| int || weight || || (variable)
|-

|-
| wxString || compilerVar || || (variable)
|-

|}

== CompileOptionsBase ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || SetLinkerOptions || wxArrayString ||
|-

|-
| void || SetLinkLibs || wxArrayString ||
|-

|-
| void || SetCompilerOptions || wxArrayString ||
|-

|-
| void || SetIncludeDirs || wxArrayString ||
|-

|-
| void || SetResourceIncludeDirs || wxArrayString ||
|-

|-
| void || SetLibDirs || wxArrayString ||
|-

|-
| void || SetCommandsBeforeBuild || wxArrayString ||
|-

|-
| void || SetCommandsAfterBuild || wxArrayString ||
|-

|-
| wxArrayString || GetLinkerOptions || ||
|-

|-
| wxArrayString || GetLinkLibs || ||
|-

|-
| wxArrayString || GetCompilerOptions || ||
|-

|-
| wxArrayString || GetIncludeDirs || ||
|-

|-
| wxArrayString || GetResourceIncludeDirs || ||
|-

|-
| wxArrayString || GetLibDirs || ||
|-

|-
| wxArrayString || GetCommandsBeforeBuild || ||
|-

|-
| wxArrayString || GetCommandsAfterBuild || ||
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| void || AddLinkerOption || wxString ||
|-

|-
| void || AddLinkLib || wxString ||
|-

|-
| void || AddCompilerOption || wxString ||
|-

|-
| void || AddIncludeDir || wxString ||
|-

|-
| void || AddResourceIncludeDir || wxString ||
|-

|-
| void || AddLibDir || wxString ||
|-

|-
| void || AddCommandsBeforeBuild || wxString ||
|-

|-
| void || AddCommandsAfterBuild || wxString ||
|-

|-
| void || RemoveLinkerOption || wxString ||
|-

|-
| void || RemoveLinkLib || wxString ||
|-

|-
| void || RemoveCompilerOption || wxString ||
|-

|-
| void || RemoveIncludeDir || wxString ||
|-

|-
| void || RemoveResourceIncludeDir || wxString ||
|-

|-
| void || RemoveLibDir || wxString ||
|-

|-
| void || RemoveCommandsBeforeBuild || wxString ||
|-

|-
| void || RemoveCommandsAfterBuild || wxString ||
|-

|-
| bool || GetAlwaysRunPostBuildSteps || ||
|-

|-
| void || SetAlwaysRunPostBuildSteps || bool ||
|-

|-
| bool || SetVar || wxString,wxString,bool ||
|-

|-
| wxString || GetVar || wxString ||
|-

|-
| bool || UnsetVar || wxString ||
|-

|-
| void || UnsetAllVars || ||
|-

|}

== CompileTargetBase ==
Extends CompileOptionsBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetFilename || ||
|-

|-
| wxString || GetTitle || ||
|-

|-
| void || SetTitle || wxString ||
|-

|-
| void || SetOutputFilename || wxString ||
|-

|-
| void || SetWorkingDir || wxString ||
|-

|-
| void || SetObjectOutput || wxString ||
|-

|-
| void || SetDepsOutput || wxString ||
|-

|-
| OptionsRelation || GetOptionRelation || OptionsRelationType ||
|-

|-
| void || SetOptionRelation || OptionsRelationType,OptionsRelation ||
|-

|-
| wxString || GetWorkingDir || ||
|-

|-
| wxString || GetObjectOutput || ||
|-

|-
| wxString || GetDepsOutput || ||
|-

|-
| wxString || GetOutputFilename || ||
|-

|-
| wxString || SuggestOutputFilename || ||
|-

|-
| wxString || GetExecutableFilename || ||
|-

|-
| wxString || GetDynamicLibFilename || ||
|-

|-
| wxString || GetDynamicLibDefFilename || ||
|-

|-
| wxString || GetStaticLibFilename || ||
|-

|-
| wxString || GetBasePath || ||
|-

|-
| void || SetTargetType || TargetType ||
|-

|-
| TargetType || GetTargetType || ||
|-

|-
| wxString || GetExecutionParameters || ||
|-

|-
| void || SetExecutionParameters || wxString ||
|-

|-
| wxString || GetHostApplication || ||
|-

|-
| void || SetHostApplication || wxString ||
|-

|-
| void || SetCompilerID || wxString ||
|-

|-
| wxString || GetCompilerID || ||
|-

|}

== ProjectBuildTarget ==
Extends CompileTargetBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| cbProject* || GetParentProject || ||
|-

|-
| wxString || GetFullTitle || ||
|-

|-
| wxString || GetExternalDeps || ||
|-

|-
| void || SetExternalDeps || wxString ||
|-

|-
| void || SetAdditionalOutputFiles || wxString ||
|-

|-
| wxString || GetAdditionalOutputFiles || ||
|-

|-
| bool || GetIncludeInTargetAll || ||
|-

|-
| void || SetIncludeInTargetAll || bool ||
|-

|-
| bool || GetCreateDefFile || ||
|-

|-
| void || SetCreateDefFile || bool ||
|-

|-
| bool || GetCreateStaticLib || ||
|-

|-
| void || SetCreateStaticLib || bool ||
|-

|-
| bool || GetUseConsoleRunner || ||
|-

|-
| void || SetUseConsoleRunner || bool ||
|-

|}

== cbProject ==
Extends CompileTargetBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| wxString || GetMakefile || ||
|-

|-
| void || SetMakefile || wxString ||
|-

|-
| bool || IsMakefileCustom || ||
|-

|-
| void || SetMakefileCustom || bool ||
|-

|-
| bool || CloseAllFiles || bool ||
|-

|-
| bool || SaveAllFiles || ||
|-

|-
| bool || Save || ||
|-

|-
| bool || SaveLayout || ||
|-

|-
| bool || LoadLayout || ||
|-

|-
| bool || ShowOptions || ||
|-

|-
| wxString || GetCommonTopLevelPath || ||
|-

|-
| int || GetFilesCount || ||
|-

|-
| ProjectFile* || GetFile || int ||
|-

|-
| ProjectFile* || GetFileByFilename || wxString,bool,bool ||
|-

|-
| bool || RemoveFile || int ||
|-

|-
| ProjectFile* || AddFile || wxString|int,wxString,bool,bool,int ||
|-

|-
| int || GetBuildTargetsCount || ||
|-

|-
| ProjectBuildTarget* || GetBuildTarget || wxString|int ||
|-

|-
| ProjectBuildTarget* || AddBuildTarget || wxString ||
|-

|-
| bool || RenameBuildTarget || wxString|int,wxString ||
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || wxString|int,wxString ||
|-

|-
| bool || RemoveBuildTarget || wxString|int ||
|-

|-
| bool || ExportTargetAsProject || wxString|int ||
|-

|-
| void || SetActiveBuildTarget || int ||
|-

|-
| int || GetActiveBuildTarget || ||
|-

|-
| int || SelectTarget || int,bool ||
|-

|-
| ProjectBuildTarget* || GetCurrentlyCompilingTarget || ||
|-

|-
| void || SetCurrentlyCompilingTarget || ProjectBuildTarget* ||
|-

|-
| PCHMode || GetModeForPCH || ||
|-

|-
| void || SetModeForPCH || PCHMode ||
|-

|}

== EditorBase ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetFilename || ||
|-

|-
| void || SetFilename || wxString ||
|-

|-
| wxString || GetShortName || ||
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| wxString || GetTitle || ||
|-

|-
| void || SetTitle || wxString ||
|-

|-
| void || Activate || ||
|-

|-
| bool || Close || ||
|-

|-
| bool || Save || ||
|-

|-
| bool || IsBuiltinEditor || ||
|-

|-
| bool || ThereAreOthers || ||
|-

|-
| void || GotoLine || int,bool ||
|-

|-
| void || ToggleBreakpoint || int,bool ||
|-

|-
| bool || HasBreakpoint || int ||
|-

|-
| void || GotoNextBreakpoint || ||
|-

|-
| void || GotoPreviousBreakpoint || ||
|-

|-
| void || ToggleBookmark || int,bool ||
|-

|-
| bool || HasBookmark || int ||
|-

|-
| void || GotoNextBookmark || ||
|-

|-
| void || GotoPreviousBookmark || ||
|-

|-
| void || Undo || ||
|-

|-
| void || Redo || ||
|-

|-
| void || Cut || ||
|-

|-
| void || Copy || ||
|-

|-
| void || Paste || ||
|-

|-
| bool || CanUndo || ||
|-

|-
| bool || CanRedo || ||
|-

|-
| bool || CanPaste || ||
|-

|-
| bool || HasSelection || ||
|-

|}

== cbEditor ==
Extends EditorBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || SetEditorTitle || wxString ||
|-

|-
| ProjectFile* || GetProjectFile || ||
|-

|-
| bool || SaveAs || ||
|-

|-
| void || FoldAll || ||
|-

|-
| void || UnfoldAll || ||
|-

|-
| void || ToggleAllFolds || ||
|-

|-
| void || FoldBlockFromLine || int ||
|-

|-
| void || UnfoldBlockFromLine || int ||
|-

|-
| void || ToggleFoldBlockFromLine || int ||
|-

|-
| int || GetLineIndentInSpaces || int ||
|-

|-
| wxString || GetLineIndentString || int ||
|-

|-
| void || Touch || ||
|-

|-
| bool || Reload || bool ||
|-

|-
| void || Print || bool,PrintColourMode,bool ||
|-

|-
| void || AutoComplete || ||
|-

|-
| bool || AddBreakpoint || int,bool ||
|-

|-
| bool || RemoveBreakpoint || int,bool ||
|-

|-
| void || SetText || wxString || this is not present in cbEditor; included to help scripts edit text
|-

|-
| wxString || GetText || || this is not present in cbEditor; included to help scripts edit text
|-

|}

== Constants ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"

|- style="background: #ececec; border: 0px solid gray"
!Constant
!Type
!Remarks
|-

|-
| PLATFORM || int || this defines the platform Code::Blocks is currently running on. It is equal to only one of the following PLATFORM_* constants
|-

|-
| PLATFORM_MSW || int || All Windows platforms
|-

|-
| PLATFORM_GTK || int || All GTK platforms (Linux, BSD, Solaris, Darwin, etc.)
|-

|-
| PLATFORM_MAC || int || All Mac platforms
|-

|-
| PLATFORM_OS2 || int || OS/2 platform
|-

|-
| PLATFORM_X11 || int || All X11 platforms
|-

|-
| PLATFORM_UNKNOWN || int || Unknown platform. Please inform us if PLATFORM == PLATFORM_UNKNOWN so we can make this platform known too ;)
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Message dialog flags'''
|-

|-
| wxOK || int || Flag for Message() 's third argument (flags).
|-

|-
| wxYES_NO || int || -"-
|-

|-
| wxCANCEL || int || -"-
|-

|-
| wxICON_QUESTION || int || -"-
|-

|-
| wxICON_INFORMATION || int || -"-
|-

|-
| wxICON_WARNING || int || -"-
|-

|-
| wxICON_ERROR || int || -"-
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Message dialog return values'''
|-

|-
| wxID_OK || int ||
|-

|-
| wxID_YES || int ||
|-

|-
| wxID_NO || int ||
|-

|-
| wxID_CANCEL || int ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum OptionsRelationType'''
|-

|-
| ortCompilerOptions || enum ||
|-

|-
| ortLinkerOptions || enum ||
|-

|-
| ortIncludeDirs || enum ||
|-

|-
| ortLibDirs || enum ||
|-

|-
| ortResDirs || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum OptionsRelation'''
|-

|-
| orUseParentOptionsOnly || enum ||
|-

|-
| orUseTargetOptionsOnly || enum ||
|-

|-
| orPrependToParentOptions || enum ||
|-

|-
| orAppendToParentOptions || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum TargetType'''
|-

|-
| ttExecutable || enum ||
|-

|-
| ttConsoleOnly || enum ||
|-

|-
| ttStaticLib || enum ||
|-

|-
| ttDynamicLib || enum ||
|-

|-
| ttCommandsOnly || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum MakeCommand'''
|-

|-
| mcClean || enum ||
|-

|-
| mcDistClean || enum ||
|-

|-
| mcBuild || enum ||
|-

|-
| mcCompileFile || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PCHMode'''
|-

|-
| pchSourceDir || enum ||
|-

|-
| pchObjectDir || enum ||
|-

|-
| pchSourceFile || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PrintScope'''
|-

|-
| psSelection || enum ||
|-

|-
| psActiveEditor || enum ||
|-

|-
| psAllOpenEditors || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PrintColourMode'''
|-

|-
| pcmBlackAndWhite || enum ||
|-

|-
| pcmColourOnWhite || enum ||
|-

|-
| pcmInvertColours || enum ||
|-

|-
| pcmAsIs || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum TemplateOutputType'''
|-

|-
| wizProject || enum || TemplateOutputType::totProject
|-

|-
| wizTarget || enum || TemplateOutputType::totTarget
|-

|-
| wizFiles || enum || TemplateOutputType::totFiles
|-

|-
| wizCustom || enum || TemplateOutputType::totCustom
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Other constants'''
|-

|-
| wxFILE_SEP_PATH || wxString || Path separator. "\" for windows, "/" for all other platforms
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''File extensions (e.g. "cbp")'''
|-

|-
| EXT_WORKSPACE || wxString ||
|-

|-
| EXT_CODEBLOCKS || wxString ||
|-

|-
| EXT_DEVCPP || wxString ||
|-

|-
| EXT_MSVC6 || wxString ||
|-

|-
| EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| EXT_MSVC7 || wxString ||
|-

|-
| EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| EXT_D || wxString ||
|-

|-
| EXT_F || wxString ||
|-

|-
| EXT_F77 || wxString ||
|-

|-
| EXT_F95 || wxString ||
|-

|-
| EXT_CPP || wxString ||
|-

|-
| EXT_C || wxString ||
|-

|-
| EXT_CC || wxString ||
|-

|-
| EXT_CXX || wxString ||
|-

|-
| EXT_HPP || wxString ||
|-

|-
| EXT_H || wxString ||
|-

|-
| EXT_HH || wxString ||
|-

|-
| EXT_HXX || wxString ||
|-

|-
| EXT_OBJECT || wxString ||
|-

|-
| EXT_XRCRESOURCE || wxString ||
|-

|-
| EXT_STATICLIB || wxString ||
|-

|-
| EXT_DYNAMICLIB || wxString ||
|-

|-
| EXT_EXECUTABLE || wxString ||
|-

|-
| EXT_RESOURCE || wxString ||
|-

|-
| EXT_RESOURCEBIN || wxString ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''File extensions with leading dot (e.g. ".cbp")'''
|-

|-
| DOT_EXT_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_CODEBLOCKS || wxString ||
|-

|-
| DOT_EXT_DEVCPP || wxString ||
|-

|-
| DOT_EXT_MSVC6 || wxString ||
|-

|-
| DOT_EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_MSVC7 || wxString ||
|-

|-
| DOT_EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_D || wxString ||
|-

|-
| DOT_EXT_F || wxString ||
|-

|-
| DOT_EXT_F77 || wxString ||
|-

|-
| DOT_EXT_F95 || wxString ||
|-

|-
| DOT_EXT_CPP || wxString ||
|-

|-
| DOT_EXT_C || wxString ||
|-

|-
| DOT_EXT_CC || wxString ||
|-

|-
| DOT_EXT_CXX || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_H || wxString ||
|-

|-
| DOT_EXT_HH || wxString ||
|-

|-
| DOT_EXT_HXX || wxString ||
|-

|-
| DOT_EXT_OBJECT || wxString ||
|-

|-
| DOT_EXT_XRCRESOURCE || wxString ||
|-

|-
| DOT_EXT_STATICLIB || wxString ||
|-

|-
| DOT_EXT_DYNAMICLIB || wxString ||
|-

|-
| DOT_EXT_EXECUTABLE || wxString ||
|-

|-
| DOT_EXT_RESOURCE || wxString ||
|-

|-
| DOT_EXT_RESOURCEBIN || wxString ||
|-

|}

== See also ==

* [[Scripting Code::Blocks|Scripting index]]

Startup script

2006-12-10T20:17:55Z

Mandrav: Added example

[[Category:Scripting Code::Blocks]]

When Code::Blocks finishes loading, it tries to load a script named ''startup.script''. If it is found it then tries to execute the ''"function main()"'' inside it (if there). The user can edit this script to run arbitrary customization commands on application startup.
The shipped ''startup.script'' just logs its presence in the application's debug log.

function main()
{
Log(_T("Running startup script"));
}

== Example ==
As an example, you could register some scripts you have written and bind them to Code::Blocks' menus.

To do this, you will need to access the ''[[Scripting commands#Application object|application object]]''. It provides the '''<tt>RegisterScript</tt>''' function which comes handy for our little example :).

First thing you need to do is either:
* edit the global startup script (which can be found in the <tt>share/codeblocks/scripts</tt> subfolder of the folder you installed Code::Blocks, or
* create you own startup.script in your home folder (if Code::Blocks "sees" the script in your home folder, it will always favor it over the globally installed one). For unix systems this folder would be "<tt>~/.codeblocks/share/codeblocks/scripts</tt>" while for windows XP "<tt>C:\Documents and Settings\''username''\Application Data\codeblocks\Share\codeblocks\scripts</tt>".

Now, let's edit our startup script:

function main()
{
Log(_T("Running startup script"));

// register a script with Code::Blocks' menus
App.RegisterScript("sample.script", "Scripts/Sample script");
}

That wasn't hard, was it? We added a single line which will add a menu "Scripts" in the menu bar. Inside this "Scripts" menu it will add a "Sample script" item. When you click on this item, the script "sample.script" will be executed. Simple :).

All you have to do now, is create the "sample.script" file in the same folder. Here's an example:

// A sample script
ShowMessage(_T("Hello from inside the sample script!"));

And don't forget that Code::Blocks conveniently allows you to edit the "sample.script" at any time. All you have to do is keep SHIFT pressed while clicking on the "Sample script" menu item ;).

== See also ==

* [[Scripting commands]]

Scripting commands

2006-12-10T19:47:40Z

Mandrav: Added App object

[[Category:Scripting Code::Blocks]]
Scripting is no good if all you can do is use the scripting language's builtin 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.''

== Application object ==
The application object is accessed through the variable named '''<tt>App</tt>'''. Currently bound functions are:

{| 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 || RegisterScript || (char*,char*) or (wxString,wxString) || registers the script file (arg1) under a menu item (arg2).
e.g. <tt>App.RegisterScript("sample.script", "Scripts/Sample script")</tt>;
|-

|}

Notes about the <tt>RegisterScript</tt> function: 
The second argument (menu item) is a string containing two values separated by a slash (/). The first value (part before the slash) is the '''menu''' under which to add the '''menu item''' (which is the part after the slash). 
If menu item starts with a dash (-), then a separator line is prepended in the menu before the menu item.

== 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 debug log
|-

|-
| int || Message || wxString,wxString,int ||
|-

|-
| void || ShowMessage || wxString ||
|-

|-
| void || ShowWarning || wxString ||
|-

|-
| void || ShowError || wxString ||
|-

|-
| void || ShowInfo || wxString ||
|-

|-
| wxString || ReplaceMacros || wxString,bool ||
|-

|-
| ProjectManager* || GetProjectManager || ||
|-

|-
| EditorManager* || GetEditorManager || ||
|-

|-
| ConfigManager* || GetConfigManager || ||
|-

|-
| UserVariableManager* || GetUserVariableManager || ||
|-

|-
| CompilerFactory* || GetCompilerFactory || ||
|-

|-
| bool || IsNull || void* ||
|-

|-
| wxString || _T || const char* || basically this is the wxString constructor
|-

|}

== ConfigManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| int || Read || int,int ||
|-

|-
| bool || Read || bool,bool ||
|-

|-
| float || Read || float,float ||
|-

|-
| wxString || Read || wxString,wxString ||
|-

|-
| void || Write || int,int ||
|-

|-
| void || Write || bool,bool ||
|-

|-
| void || Write || float,float ||
|-

|-
| void || Write || wxString,wxString[,bool] ||
|-

|}

== ProjectManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetDefaultPath || ||
|-

|-
| void || SetDefaultPath || wxString ||
|-

|-
| cbProject* || GetActiveProject || ||
|-

|-
| void || SetProject || cbProject* ||
|-

|-
| bool || LoadWorkspace || wxString ||
|-

|-
| bool || SaveWorkspace || ||
|-

|-
| bool || SaveWorkspaceAs || wxString ||
|-

|-
| bool || CloseWorkspace || ||
|-

|-
| cbProject* || IsOpen || wxString ||
|-

|-
| cbProject* || LoadProject || wxString,bool ||
|-

|-
| bool || SaveProject || cbProject* ||
|-

|-
| bool || SaveProjectAs || cbProject* ||
|-

|-
| bool || SaveActiveProject || ||
|-

|-
| bool || SaveActiveProjectAs || ||
|-

|-
| bool || SaveAllProjects || ||
|-

|-
| bool || CloseProject || cbProject*,bool,bool ||
|-

|-
| bool || CloseActiveProject || bool ||
|-

|-
| bool || CloseAllProjects || bool ||
|-

|-
| cbProject* || NewProject || wxString ||
|-

|-
| int || AddFileToProject || wxString,cbProject*,int ||
|-

|-
| int || AskForBuildTargetIndex || cbProject* ||
|-

|-
| void || RebuildTree || ||
|-

|}

== EditorManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || Configure || ||
|-

|-
| cbEditor* || New || wxString ||
|-

|-
| cbEditor* || Open || wxString ||
|-

|-
| cbEditor* || IsBuiltinOpen || wxString ||
|-

|-
| cbEditor* || GetBuiltinEditor || wxString|int ||
|-

|-
| cbEditor* || GetBuiltinActiveEditor || ||
|-

|-
| EditorBase* || GetActiveEditor || ||
|-

|-
| void || ActivateNext || ||
|-

|-
| void || ActivatePrevious || ||
|-

|-
| bool || SwapActiveHeaderSource || ||
|-

|-
| bool || CloseActive || bool ||
|-

|-
| bool || Close || wxString|int,bool ||
|-

|-
| bool || CloseAll || bool ||
|-

|-
| bool || Save || wxString|int ||
|-

|-
| bool || SaveActive || ||
|-

|-
| bool || SaveAs || int ||
|-

|-
| bool || SaveActiveAs || ||
|-

|-
| bool || SaveAll || ||
|-

|-
| int || ShowFindDialog || bool,bool ||
|-

|}

== UserVariableManager ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || Exists || wxString ||
|-

|}

== IO namespace ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || DirectoryExists || wxString ||
|-

|-
| wxString || SelectDirectory || wxString,wxString,bool ||
|-

|-
| bool || FileExists || wxString ||
|-

|-
| wxString || SelectFile || wxString,wxString,wxString ||
|-

|}

== CompilerFactory ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || IsValidCompilerID || wxString ||
|-

|-
| int || GetCompilerIndex || wxString ||
|-

|-
| wxString || GetDefaultCompilerID || ||
|-

|-
| bool || CompilerInheritsFrom || ||
|-

|}

== wxString ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || operator+ || ||
|-

|-
| bool || operator< || ||
|-

|-
| bool || operator<= || ||
|-

|-
| bool || operator>= || ||
|-

|-
| bool || operator> || ||
|-

|-
| int || Find || wxString ||
|-

|-
| bool || Matches || wxString ||
|-

|-
| void || AddChar || char ||
|-

|-
| char || GetChar || int ||
|-

|-
| bool || IsEmpty || ||
|-

|-
| int || Length || ||
|-

|-
| int || length || || same as Length()
|-

|-
| int || len || || same as Length()
|-

|-
| int || size || || same as Length()
|-

|-
| wxString || Lower || ||
|-

|-
| wxString || LowerCase || || same as Lower()
|-

|-
| void || MakeLower || ||
|-

|-
| wxString || Upper || ||
|-

|-
| wxString || UpperCase || || same as Upper()
|-

|-
| void || MakeUpper || ||
|-

|-
| wxString || Mid || int,int ||
|-

|-
| void || Remove || int,int ||
|-

|-
| void || RemoveLast || ||
|-

|-
| int || Replace || wxString,wxString[,bool] ||
|-

|-
| wxString || Right || int ||
|-

|-
| wxString || AfterFirst || char ||
|-

|-
| wxString || AfterLast || char ||
|-

|-
| wxString || BeforeFirst || char ||
|-

|-
| wxString || BeforeLast || char ||
|-
|}

== 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 ||
|-

|-
| void || Clear || ||
|-

|-
| int || GetCount || ||
|-

|-
| wxString || Item || int ||
|-

|}

== ProjectFile ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || AddBuildTarget || wxString ||
|-

|-
| void || RenameBuildTarget || wxString,wxString ||
|-

|-
| void || RemoveBuildTarget || wxString ||
|-

|-
| wxString || GetBaseName || ||
|-

|-
| wxString || GetObjName || ||
|-

|-
| void || SetObjName || wxString ||
|-

|-
| cbProject* || GetParentProject || ||
|-

|-
| wxString || relativeFilename || || (variable)
|-

|-
| wxString || relativeToCommonTopLevelPath || || (variable)
|-

|-
| bool || compile || || (variable)
|-

|-
| bool || link || || (variable)
|-

|-
| int || weight || || (variable)
|-

|-
| wxString || compilerVar || || (variable)
|-

|}

== CompileOptionsBase ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || SetLinkerOptions || wxArrayString ||
|-

|-
| void || SetLinkLibs || wxArrayString ||
|-

|-
| void || SetCompilerOptions || wxArrayString ||
|-

|-
| void || SetIncludeDirs || wxArrayString ||
|-

|-
| void || SetResourceIncludeDirs || wxArrayString ||
|-

|-
| void || SetLibDirs || wxArrayString ||
|-

|-
| void || SetCommandsBeforeBuild || wxArrayString ||
|-

|-
| void || SetCommandsAfterBuild || wxArrayString ||
|-

|-
| wxArrayString || GetLinkerOptions || ||
|-

|-
| wxArrayString || GetLinkLibs || ||
|-

|-
| wxArrayString || GetCompilerOptions || ||
|-

|-
| wxArrayString || GetIncludeDirs || ||
|-

|-
| wxArrayString || GetResourceIncludeDirs || ||
|-

|-
| wxArrayString || GetLibDirs || ||
|-

|-
| wxArrayString || GetCommandsBeforeBuild || ||
|-

|-
| wxArrayString || GetCommandsAfterBuild || ||
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| void || AddLinkerOption || wxString ||
|-

|-
| void || AddLinkLib || wxString ||
|-

|-
| void || AddCompilerOption || wxString ||
|-

|-
| void || AddIncludeDir || wxString ||
|-

|-
| void || AddResourceIncludeDir || wxString ||
|-

|-
| void || AddLibDir || wxString ||
|-

|-
| void || AddCommandsBeforeBuild || wxString ||
|-

|-
| void || AddCommandsAfterBuild || wxString ||
|-

|-
| void || RemoveLinkerOption || wxString ||
|-

|-
| void || RemoveLinkLib || wxString ||
|-

|-
| void || RemoveCompilerOption || wxString ||
|-

|-
| void || RemoveIncludeDir || wxString ||
|-

|-
| void || RemoveResourceIncludeDir || wxString ||
|-

|-
| void || RemoveLibDir || wxString ||
|-

|-
| void || RemoveCommandsBeforeBuild || wxString ||
|-

|-
| void || RemoveCommandsAfterBuild || wxString ||
|-

|-
| bool || GetAlwaysRunPostBuildSteps || ||
|-

|-
| void || SetAlwaysRunPostBuildSteps || bool ||
|-

|-
| bool || SetVar || wxString,wxString,bool ||
|-

|-
| wxString || GetVar || wxString ||
|-

|-
| bool || UnsetVar || wxString ||
|-

|-
| void || UnsetAllVars || ||
|-

|}

== CompileTargetBase ==
Extends CompileOptionsBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetFilename || ||
|-

|-
| wxString || GetTitle || ||
|-

|-
| void || SetTitle || wxString ||
|-

|-
| void || SetOutputFilename || wxString ||
|-

|-
| void || SetWorkingDir || wxString ||
|-

|-
| void || SetObjectOutput || wxString ||
|-

|-
| void || SetDepsOutput || wxString ||
|-

|-
| OptionsRelation || GetOptionRelation || OptionsRelationType ||
|-

|-
| void || SetOptionRelation || OptionsRelationType,OptionsRelation ||
|-

|-
| wxString || GetWorkingDir || ||
|-

|-
| wxString || GetObjectOutput || ||
|-

|-
| wxString || GetDepsOutput || ||
|-

|-
| wxString || GetOutputFilename || ||
|-

|-
| wxString || SuggestOutputFilename || ||
|-

|-
| wxString || GetExecutableFilename || ||
|-

|-
| wxString || GetDynamicLibFilename || ||
|-

|-
| wxString || GetDynamicLibDefFilename || ||
|-

|-
| wxString || GetStaticLibFilename || ||
|-

|-
| wxString || GetBasePath || ||
|-

|-
| void || SetTargetType || TargetType ||
|-

|-
| TargetType || GetTargetType || ||
|-

|-
| wxString || GetExecutionParameters || ||
|-

|-
| void || SetExecutionParameters || wxString ||
|-

|-
| wxString || GetHostApplication || ||
|-

|-
| void || SetHostApplication || wxString ||
|-

|-
| void || SetCompilerID || wxString ||
|-

|-
| wxString || GetCompilerID || ||
|-

|}

== ProjectBuildTarget ==
Extends CompileTargetBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| cbProject* || GetParentProject || ||
|-

|-
| wxString || GetFullTitle || ||
|-

|-
| wxString || GetExternalDeps || ||
|-

|-
| void || SetExternalDeps || wxString ||
|-

|-
| void || SetAdditionalOutputFiles || wxString ||
|-

|-
| wxString || GetAdditionalOutputFiles || ||
|-

|-
| bool || GetIncludeInTargetAll || ||
|-

|-
| void || SetIncludeInTargetAll || bool ||
|-

|-
| bool || GetCreateDefFile || ||
|-

|-
| void || SetCreateDefFile || bool ||
|-

|-
| bool || GetCreateStaticLib || ||
|-

|-
| void || SetCreateStaticLib || bool ||
|-

|-
| bool || GetUseConsoleRunner || ||
|-

|-
| void || SetUseConsoleRunner || bool ||
|-

|}

== cbProject ==
Extends CompileTargetBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| wxString || GetMakefile || ||
|-

|-
| void || SetMakefile || wxString ||
|-

|-
| bool || IsMakefileCustom || ||
|-

|-
| void || SetMakefileCustom || bool ||
|-

|-
| bool || CloseAllFiles || bool ||
|-

|-
| bool || SaveAllFiles || ||
|-

|-
| bool || Save || ||
|-

|-
| bool || SaveLayout || ||
|-

|-
| bool || LoadLayout || ||
|-

|-
| bool || ShowOptions || ||
|-

|-
| wxString || GetCommonTopLevelPath || ||
|-

|-
| int || GetFilesCount || ||
|-

|-
| ProjectFile* || GetFile || int ||
|-

|-
| ProjectFile* || GetFileByFilename || wxString,bool,bool ||
|-

|-
| bool || RemoveFile || int ||
|-

|-
| ProjectFile* || AddFile || wxString|int,wxString,bool,bool,int ||
|-

|-
| int || GetBuildTargetsCount || ||
|-

|-
| ProjectBuildTarget* || GetBuildTarget || wxString|int ||
|-

|-
| ProjectBuildTarget* || AddBuildTarget || wxString ||
|-

|-
| bool || RenameBuildTarget || wxString|int,wxString ||
|-

|-
| ProjectBuildTarget* || DuplicateBuildTarget || wxString|int,wxString ||
|-

|-
| bool || RemoveBuildTarget || wxString|int ||
|-

|-
| bool || ExportTargetAsProject || wxString|int ||
|-

|-
| void || SetActiveBuildTarget || int ||
|-

|-
| int || GetActiveBuildTarget || ||
|-

|-
| int || SelectTarget || int,bool ||
|-

|-
| ProjectBuildTarget* || GetCurrentlyCompilingTarget || ||
|-

|-
| void || SetCurrentlyCompilingTarget || ProjectBuildTarget* ||
|-

|-
| PCHMode || GetModeForPCH || ||
|-

|-
| void || SetModeForPCH || PCHMode ||
|-

|}

== EditorBase ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| wxString || GetFilename || ||
|-

|-
| void || SetFilename || wxString ||
|-

|-
| wxString || GetShortName || ||
|-

|-
| bool || GetModified || ||
|-

|-
| void || SetModified || bool ||
|-

|-
| wxString || GetTitle || ||
|-

|-
| void || SetTitle || wxString ||
|-

|-
| void || Activate || ||
|-

|-
| bool || Close || ||
|-

|-
| bool || Save || ||
|-

|-
| bool || IsBuiltinEditor || ||
|-

|-
| bool || ThereAreOthers || ||
|-

|-
| void || GotoLine || int,bool ||
|-

|-
| void || ToggleBreakpoint || int,bool ||
|-

|-
| bool || HasBreakpoint || int ||
|-

|-
| void || GotoNextBreakpoint || ||
|-

|-
| void || GotoPreviousBreakpoint || ||
|-

|-
| void || ToggleBookmark || int,bool ||
|-

|-
| bool || HasBookmark || int ||
|-

|-
| void || GotoNextBookmark || ||
|-

|-
| void || GotoPreviousBookmark || ||
|-

|-
| void || Undo || ||
|-

|-
| void || Redo || ||
|-

|-
| void || Cut || ||
|-

|-
| void || Copy || ||
|-

|-
| void || Paste || ||
|-

|-
| bool || CanUndo || ||
|-

|-
| bool || CanRedo || ||
|-

|-
| bool || CanPaste || ||
|-

|-
| bool || HasSelection || ||
|-

|}

== cbEditor ==
Extends EditorBase.

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"
|- style="background: #ececec; border: 0px solid gray"
!Return value
!Name
!Arguments
!Remarks
|-

|-
| void || SetEditorTitle || wxString ||
|-

|-
| ProjectFile* || GetProjectFile || ||
|-

|-
| bool || SaveAs || ||
|-

|-
| void || FoldAll || ||
|-

|-
| void || UnfoldAll || ||
|-

|-
| void || ToggleAllFolds || ||
|-

|-
| void || FoldBlockFromLine || int ||
|-

|-
| void || UnfoldBlockFromLine || int ||
|-

|-
| void || ToggleFoldBlockFromLine || int ||
|-

|-
| int || GetLineIndentInSpaces || int ||
|-

|-
| wxString || GetLineIndentString || int ||
|-

|-
| void || Touch || ||
|-

|-
| bool || Reload || bool ||
|-

|-
| void || Print || bool,PrintColourMode,bool ||
|-

|-
| void || AutoComplete || ||
|-

|-
| bool || AddBreakpoint || int,bool ||
|-

|-
| bool || RemoveBreakpoint || int,bool ||
|-

|-
| void || SetText || wxString || this is not present in cbEditor; included to help scripts edit text
|-

|-
| wxString || GetText || || this is not present in cbEditor; included to help scripts edit text
|-

|}

== Constants ==

{| border="1" cellpadding="3" cellspacing="0" style="border: 1px solid gray; border-collapse: collapse;"

|- style="background: #ececec; border: 0px solid gray"
!Constant
!Type
!Remarks
|-

|-
| PLATFORM || int || this defines the platform Code::Blocks is currently running on. It is equal to only one of the following PLATFORM_* constants
|-

|-
| PLATFORM_MSW || int || All Windows platforms
|-

|-
| PLATFORM_GTK || int || All GTK platforms (Linux, BSD, Solaris, Darwin, etc.)
|-

|-
| PLATFORM_MAC || int || All Mac platforms
|-

|-
| PLATFORM_OS2 || int || OS/2 platform
|-

|-
| PLATFORM_X11 || int || All X11 platforms
|-

|-
| PLATFORM_UNKNOWN || int || Unknown platform. Please inform us if PLATFORM == PLATFORM_UNKNOWN so we can make this platform known too ;)
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Message dialog flags'''
|-

|-
| wxOK || int || Flag for Message() 's third argument (flags).
|-

|-
| wxYES_NO || int || -"-
|-

|-
| wxCANCEL || int || -"-
|-

|-
| wxICON_QUESTION || int || -"-
|-

|-
| wxICON_INFORMATION || int || -"-
|-

|-
| wxICON_WARNING || int || -"-
|-

|-
| wxICON_ERROR || int || -"-
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Message dialog return values'''
|-

|-
| wxID_OK || int ||
|-

|-
| wxID_YES || int ||
|-

|-
| wxID_NO || int ||
|-

|-
| wxID_CANCEL || int ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum OptionsRelationType'''
|-

|-
| ortCompilerOptions || enum ||
|-

|-
| ortLinkerOptions || enum ||
|-

|-
| ortIncludeDirs || enum ||
|-

|-
| ortLibDirs || enum ||
|-

|-
| ortResDirs || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum OptionsRelation'''
|-

|-
| orUseParentOptionsOnly || enum ||
|-

|-
| orUseTargetOptionsOnly || enum ||
|-

|-
| orPrependToParentOptions || enum ||
|-

|-
| orAppendToParentOptions || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum TargetType'''
|-

|-
| ttExecutable || enum ||
|-

|-
| ttConsoleOnly || enum ||
|-

|-
| ttStaticLib || enum ||
|-

|-
| ttDynamicLib || enum ||
|-

|-
| ttCommandsOnly || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum MakeCommand'''
|-

|-
| mcClean || enum ||
|-

|-
| mcDistClean || enum ||
|-

|-
| mcBuild || enum ||
|-

|-
| mcCompileFile || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PCHMode'''
|-

|-
| pchSourceDir || enum ||
|-

|-
| pchObjectDir || enum ||
|-

|-
| pchSourceFile || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PrintScope'''
|-

|-
| psSelection || enum ||
|-

|-
| psActiveEditor || enum ||
|-

|-
| psAllOpenEditors || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum PrintColourMode'''
|-

|-
| pcmBlackAndWhite || enum ||
|-

|-
| pcmColourOnWhite || enum ||
|-

|-
| pcmInvertColours || enum ||
|-

|-
| pcmAsIs || enum ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''enum TemplateOutputType'''
|-

|-
| wizProject || enum || TemplateOutputType::totProject
|-

|-
| wizTarget || enum || TemplateOutputType::totTarget
|-

|-
| wizFiles || enum || TemplateOutputType::totFiles
|-

|-
| wizCustom || enum || TemplateOutputType::totCustom
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''Other constants'''
|-

|-
| wxFILE_SEP_PATH || wxString || Path separator. "\" for windows, "/" for all other platforms
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''File extensions (e.g. "cbp")'''
|-

|-
| EXT_WORKSPACE || wxString ||
|-

|-
| EXT_CODEBLOCKS || wxString ||
|-

|-
| EXT_DEVCPP || wxString ||
|-

|-
| EXT_MSVC6 || wxString ||
|-

|-
| EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| EXT_MSVC7 || wxString ||
|-

|-
| EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| EXT_D || wxString ||
|-

|-
| EXT_F || wxString ||
|-

|-
| EXT_F77 || wxString ||
|-

|-
| EXT_F95 || wxString ||
|-

|-
| EXT_CPP || wxString ||
|-

|-
| EXT_C || wxString ||
|-

|-
| EXT_CC || wxString ||
|-

|-
| EXT_CXX || wxString ||
|-

|-
| EXT_HPP || wxString ||
|-

|-
| EXT_H || wxString ||
|-

|-
| EXT_HH || wxString ||
|-

|-
| EXT_HXX || wxString ||
|-

|-
| EXT_OBJECT || wxString ||
|-

|-
| EXT_XRCRESOURCE || wxString ||
|-

|-
| EXT_STATICLIB || wxString ||
|-

|-
| EXT_DYNAMICLIB || wxString ||
|-

|-
| EXT_EXECUTABLE || wxString ||
|-

|-
| EXT_RESOURCE || wxString ||
|-

|-
| EXT_RESOURCEBIN || wxString ||
|-

|-
| colspan="3" align="center" style="background: #f8f8f8;" | '''File extensions with leading dot (e.g. ".cbp")'''
|-

|-
| DOT_EXT_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_CODEBLOCKS || wxString ||
|-

|-
| DOT_EXT_DEVCPP || wxString ||
|-

|-
| DOT_EXT_MSVC6 || wxString ||
|-

|-
| DOT_EXT_MSVC6_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_MSVC7 || wxString ||
|-

|-
| DOT_EXT_MSVC7_WORKSPACE || wxString ||
|-

|-
| DOT_EXT_D || wxString ||
|-

|-
| DOT_EXT_F || wxString ||
|-

|-
| DOT_EXT_F77 || wxString ||
|-

|-
| DOT_EXT_F95 || wxString ||
|-

|-
| DOT_EXT_CPP || wxString ||
|-

|-
| DOT_EXT_C || wxString ||
|-

|-
| DOT_EXT_CC || wxString ||
|-

|-
| DOT_EXT_CXX || wxString ||
|-

|-
| DOT_EXT_HPP || wxString ||
|-

|-
| DOT_EXT_H || wxString ||
|-

|-
| DOT_EXT_HH || wxString ||
|-

|-
| DOT_EXT_HXX || wxString ||
|-

|-
| DOT_EXT_OBJECT || wxString ||
|-

|-
| DOT_EXT_XRCRESOURCE || wxString ||
|-

|-
| DOT_EXT_STATICLIB || wxString ||
|-

|-
| DOT_EXT_DYNAMICLIB || wxString ||
|-

|-
| DOT_EXT_EXECUTABLE || wxString ||
|-

|-
| DOT_EXT_RESOURCE || wxString ||
|-

|-
| DOT_EXT_RESOURCEBIN || wxString ||
|-

|}

== See also ==

* [[Scripting Code::Blocks|Scripting index]]

Installing Uniwin remote compiler

2006-12-07T10:42:09Z

Mandrav: Added troubleshooting section

[[Category:User Documentation]]
== What is Uniwin ==
If you already know what Uniwin is and what it does, please skip to the next section.

This is from Uniwin's readme file:

<tt>
Uniwin is a ssh/sftp based toolset to develop C/C++ systems on remote Unix servers (including all Unix systems supporting ssh and sftp) based on Windows clients. By automatically synchronizing the source files on the client with the server and replacing GNU toolsets with some small stubs for them, Uniwin presents a seamless interface for remote development. Nothing needs to be changed to your favorite development environment just like you are developing on a local system. With a simple configuration procedure, all operations such as editing, compiling, and debugging will be exactly same as developing a local program.

Uniwin also can be used as an automatical SFTP file synchronizing system between local Windows client and remote server. Another usage of Uniwin may be treating it as a FTP to SFTP Bridge. In fact, a fully functioned, multi-threaded FTP to SFTP Bridge is incorporated into the package to support the team synchronizing tools provided by eclipse.

The advantage of Uniwin is it brings no change to you but providing a remote development environment in the backend.
</tt>

The rest of this document will describe everything needed to setup a valid Code::Blocks/Uniwin combination.

== Installing Uniwin ==
The first step is to download Uniwin. You can get it now by clicking [http://sourceforge.net/projects/uniwin here].
Once the file is downloaded you may extract it in any location you like. For the rest of this document I will assume you installed it on the root of the C: drive (e.g. C:\Uniwin).

The next step is to configure it. To do this now, launch C:\Uniwin\Uniwin.exe.

[[Image:Uniwin1.png]]

The "ssh" page defines the SSH connection settings for the build commands.
You need to adjust the fields for your setup:

* Remote host: The name or IP address of the unix host you will build your software on.
* Username: Your username on the remote unix host.
* Password: Your password.
* Leave the rest as they are. They 're sensible defaults.

Now switch to the "sftp" page. SFTP is used to synchronize the local directory with the remote one and vice-versa.

[[Image:Uniwin2.png]]

Edit the top three fields and use the same values as those you used in the "ssh" page.

Next, switch to the "Dir mapping" page. In this page you "map" local directories to remote ones.

[[Image:Uniwin3.png]]

In the picture above you can see that I have defined one directory mapping:
C:\Devel\NetTest --> /home/op/NetTest
What this does is keep those two directories (local and remote) synchronized when any file/folder is changed.

You can add as many directory mappings as you like. Usually one is enough though (the base directory of your workspace/project).

That was all the configuration that was needed. Pretty easy, huh? :).
Now click the OK button. This will close the Uniwin configuration dialog.

'''Very important note:'''

''Uniwin must be running while you work on a project that uses it. This means that you should launch the Uniwin configuration before building a project with Uniwin and let it run while you work on that project. To hide Uniwin out of sight, hit the Close button on the top-right of the window (do '''not''' click OK or Cancel). This will shove it to systray and let it run there.''

== Configuring Code::Blocks for Uniwin ==
The "hard part" is over now. You can return to the comfortable Code::Blocks environment (pun intended) to configure it to use Uniwin ;).

What you need to do is add a new compiler. To do this, click on the menu "Settings->Compiler and debugger".
The dialog that comes up will read "Global compiler settings", which is exactly what we want.

Now, make sure you have the "GNU GCC Compiler" selected in the "Selected compiler" section:

[[Image:Uniwin4.png]]

Click the "Copy" button. Code::Blocks will ask you to enter a name for the new compiler. Use "GCC (Uniwin)" as the name. An informational message will appear. Click OK to close it and switch to the "Programs" page.

Change the installation directory and programs like shown below:

[[Image:Uniwin5.png]]

Once done, switch to the "Other" page and click the button labeled "Advanced options...". In the new dialog that opens, switch to the "Others" page:

[[Image:Uniwin6.png]]

Check the box labeled "Force forward slash as path separator".

That's it! This wasn't so hard, was it?

== Configuring a project for Uniwin ==
This is the easiest part of all :).
Just select the newly added compiler for each project you want to build using Uniwin.

''Don't forget to run Uniwin.exe before trying to build a project using this compiler.''

== Troubleshooting ==
With the current Uniwin versions, you can't actually debug remote projects from inside Code::Blocks. I have patched Uniwin's proxy gdb.exe to allow for this. You can get the patched file from [/index.php?topic=4516.msg36708#msg36708 this forum message]. Just decompress it in Uniwin's folder, replacing the old gdb.exe.

Installing Uniwin remote compiler

2006-12-06T12:58:31Z

Mandrav: /* Configuring Code::Blocks for Uniwin */

[[Category:User Documentation]]
== What is Uniwin ==
If you already know what Uniwin is and what it does, please skip to the next section.

This is from Uniwin's readme file:

<tt>
Uniwin is a ssh/sftp based toolset to develop C/C++ systems on remote Unix servers (including all Unix systems supporting ssh and sftp) based on Windows clients. By automatically synchronizing the source files on the client with the server and replacing GNU toolsets with some small stubs for them, Uniwin presents a seamless interface for remote development. Nothing needs to be changed to your favorite development environment just like you are developing on a local system. With a simple configuration procedure, all operations such as editing, compiling, and debugging will be exactly same as developing a local program.

Uniwin also can be used as an automatical SFTP file synchronizing system between local Windows client and remote server. Another usage of Uniwin may be treating it as a FTP to SFTP Bridge. In fact, a fully functioned, multi-threaded FTP to SFTP Bridge is incorporated into the package to support the team synchronizing tools provided by eclipse.

The advantage of Uniwin is it brings no change to you but providing a remote development environment in the backend.
</tt>

The rest of this document will describe everything needed to setup a valid Code::Blocks/Uniwin combination.

== Installing Uniwin ==
The first step is to download Uniwin. You can get it now by clicking [http://downloads.sourceforge.net/uniwin/uniwin.0.5b.binary.02_26_2006.zip?use_mirror=puzzle here].
Once the file is downloaded you may extract it in any location you like. For the rest of this document I will assume you installed it on the root of the C: drive (e.g. C:\Uniwin).

The next step is to configure it. To do this now, launch C:\Uniwin\Uniwin.exe.

[[Image:Uniwin1.png]]

The "ssh" page defines the SSH connection settings for the build commands.
You need to adjust the fields for your setup:

* Remote host: The name or IP address of the unix host you will build your software on.
* Username: Your username on the remote unix host.
* Password: Your password.
* Leave the rest as they are. They 're sensible defaults.

Now switch to the "sftp" page. SFTP is used to synchronize the local directory with the remote one and vice-versa.

[[Image:Uniwin2.png]]

Edit the top three fields and use the same values as those you used in the "ssh" page.

Next, switch to the "Dir mapping" page. In this page you "map" local directories to remote ones.

[[Image:Uniwin3.png]]

In the picture above you can see that I have defined one directory mapping:
C:\Devel\NetTest --> /home/op/NetTest
What this does is keep those two directories (local and remote) synchronized when any file/folder is changed.

You can add as many directory mappings as you like. Usually one is enough though (the base directory of your workspace/project).

That was all the configuration that was needed. Pretty easy, huh? :).
Now click the OK button. This will close the Uniwin configuration dialog.

'''Very important note:'''

''Uniwin must be running while you work on a project that uses it. This means that you should launch the Uniwin configuration before building a project with Uniwin and let it run while you work on that project. To hide Uniwin out of sight, hit the Close button on the top-right of the window (do '''not''' click OK or Cancel). This will shove it to systray and let it run there.''

== Configuring Code::Blocks for Uniwin ==
The "hard part" is over now. You can return to the comfortable Code::Blocks environment (pun intended) to configure it to use Uniwin ;).

What you need to do is add a new compiler. To do this, click on the menu "Settings->Compiler and debugger".
The dialog that comes up will read "Global compiler settings", which is exactly what we want.

Now, make sure you have the "GNU GCC Compiler" selected in the "Selected compiler" section:

[[Image:Uniwin4.png]]

Click the "Copy" button. Code::Blocks will ask you to enter a name for the new compiler. Use "GCC (Uniwin)" as the name. An informational message will appear. Click OK to close it and switch to the "Programs" page.

Change the installation directory and programs like shown below:

[[Image:Uniwin5.png]]

Once done, switch to the "Other" page and click the button labeled "Advanced options...". In the new dialog that opens, switch to the "Others" page:

[[Image:Uniwin6.png]]

Check the box labeled "Force forward slash as path separator".

That's it! This wasn't so hard, was it?

== Configuring a project for Uniwin ==
This is the easiest part of all :).
Just select the newly added compiler for each project you want to build using Uniwin.

''Don't forget to run Uniwin.exe before trying to build a project using this compiler.''