Code::Blocks - User contributions [en]

Wizard Scripting Commands

2006-12-20T02:46:50Z

Nfz:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[[Image:Project_path_panel.png]]
}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Adds a custom page from XRC resource.

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

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

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

== Text controls (wxTextCtrl) ==

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

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

== Checkbox controls (wxCheckBox) ==

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

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

== Combobox controls (wxComboBox) ==

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

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

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

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

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

== Radiobox controls (wxRadioBox) ==

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

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

== Listbox controls (wxListBox) ==

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

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

== All controls (common functions) ==

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

(to be continued)

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

Wizard scripts

2006-12-20T02:42:25Z

Nfz: /* What files do I need to create a valid wizard? */

[[Category:Scripting Code::Blocks]]
When you click "File->New", you 're presented with wizards to create various new things. These are:

* New project
* New build target inside the active project
* New file(s)
* New anything (custom)
* User template

[[Image:New_wiz.png|"New..." dialog]]

All the above functionality (except user templates) is provided by wizard scripts. In this section, I 'm gonna try to explain everything about wizard scripts.

Before starting out creating your own wizard scripts or editing existing ones, these are "must read":

* [[Wizard Scripting Commands]]
* [[Wizard Page Events]]

== Where are they located? ==
Wizard scripts are located under the Code::Blocks' data folder.
The base wizards folder is <tt>[Code::Blocks install dir]/share/codeblocks/templates/wizards</tt>.

Scripts are arranged in subfolders (one for each wizard) inside the above folder.
To make this clear, the structure of this folder is displayed below with the "console" wizard expanded to see all its files:

Base folder
console
c
main.c
cpp
main.cpp
logo.png
wizard.png
wizard.script
wizard.xrc
fltk
...
...
empty
...
...
common_functions.script
config.script

== What files do I need to create a valid wizard? ==
There are three files that are absolutely needed for your wizard to be registered correctly:
* '''logo.png''' - The wizard's icon. This will be displayed in the "New..." dialog.
* '''wizard.png''' - The wizard's bitmap. This bitmap is displayed on the left side in the wizard dialog.
* '''wizard.script''' - The wizard's script. You didn't think you could have a scripted wizard without a script, did you? ;)
* '''wizard.xrc''' - The wizard's custom pages. This file is optional but if you are using custom pages then all the panels as XRC resources must be placed in wizard.xrc.

== How do I edit an existing wizard? ==
That's easy: edit its script :). This can be done easily from within Code::Blocks. Just right-click on the wizard's icon in the "New..." dialog. The same context menu contains an option to edit the global configuration script (''config.script'').

[[Image:Edit_wiz_script.png|Wizard scripts context menu]]

Note that no restart is needed if you edit a script. Just save it and launch the wizard again :).

Code::Blocks needs to be restarted only when editing the global configuration script. An informational message is displayed in this case so you don't wonder why your changes are not taking any effect ;).

== How do I create a new wizard? ==
First thing you should do is read about [[Wizard Scripting Commands]] and use it as a reference on what commands are accepted and what their syntax is.

== How do I register my new wizard? ==
Wizard scripts are registered with Code::Blocks by adding a registration line in the global wizards configuration script (config.script).

Let's look at the registration of an existing wizard:

// config.script
function RegisterWizards()
{

RegisterWizard(wizProject, _T("empty"), _T("Empty project"), _T("Console"));

// more wizards following
...
...
}

The arguments to the RegisterWizard() function are as follows:

# The type of output for this wizard. Can be one of the following, self-explaining types:
#* wizProject
#* wizTarget
#* wizFiles
#* wizCustom
# The subfolder where this wizard's files are located
# The wizard's title, as will appear in the "New..." dialog
# The wizard's category. Free-form text. If your wizard fits one of the existing categories, please use it.

After you add the new wizard in ''config.script'', you must restart Code::Blocks to re-initialize all the registered wizards.

[[User:Mandrav|Mandrav]] 07:51, 9 July 2006 (EDT)

Wizard scripts

2006-12-20T02:41:10Z

Nfz: /* Where are they located? */

[[Category:Scripting Code::Blocks]]
When you click "File->New", you 're presented with wizards to create various new things. These are:

* New project
* New build target inside the active project
* New file(s)
* New anything (custom)
* User template

[[Image:New_wiz.png|"New..." dialog]]

All the above functionality (except user templates) is provided by wizard scripts. In this section, I 'm gonna try to explain everything about wizard scripts.

Before starting out creating your own wizard scripts or editing existing ones, these are "must read":

* [[Wizard Scripting Commands]]
* [[Wizard Page Events]]

== Where are they located? ==
Wizard scripts are located under the Code::Blocks' data folder.
The base wizards folder is <tt>[Code::Blocks install dir]/share/codeblocks/templates/wizards</tt>.

Scripts are arranged in subfolders (one for each wizard) inside the above folder.
To make this clear, the structure of this folder is displayed below with the "console" wizard expanded to see all its files:

Base folder
console
c
main.c
cpp
main.cpp
logo.png
wizard.png
wizard.script
wizard.xrc
fltk
...
...
empty
...
...
common_functions.script
config.script

== What files do I need to create a valid wizard? ==
There are three files that are absolutely needed for your wizard to be registered correctly:
* '''logo.png''' - The wizard's icon. This will be displayed in the "New..." dialog.
* '''wizard.png''' - The wizard's bitmap. This bitmap is displayed on the left side in the wizard dialog.
* '''wizard.script''' - The wizard's script. You didn't think you could have a scripted wizard without a script, did you? ;)
* '''wizard.xrc''' - The wizard's custom pages. This file is optional but if you are using custom pages then all the panels must be placed in wizard.xrc.

== How do I edit an existing wizard? ==
That's easy: edit its script :). This can be done easily from within Code::Blocks. Just right-click on the wizard's icon in the "New..." dialog. The same context menu contains an option to edit the global configuration script (''config.script'').

[[Image:Edit_wiz_script.png|Wizard scripts context menu]]

Note that no restart is needed if you edit a script. Just save it and launch the wizard again :).

Code::Blocks needs to be restarted only when editing the global configuration script. An informational message is displayed in this case so you don't wonder why your changes are not taking any effect ;).

== How do I create a new wizard? ==
First thing you should do is read about [[Wizard Scripting Commands]] and use it as a reference on what commands are accepted and what their syntax is.

== How do I register my new wizard? ==
Wizard scripts are registered with Code::Blocks by adding a registration line in the global wizards configuration script (config.script).

Let's look at the registration of an existing wizard:

// config.script
function RegisterWizards()
{

RegisterWizard(wizProject, _T("empty"), _T("Empty project"), _T("Console"));

// more wizards following
...
...
}

The arguments to the RegisterWizard() function are as follows:

# The type of output for this wizard. Can be one of the following, self-explaining types:
#* wizProject
#* wizTarget
#* wizFiles
#* wizCustom
# The subfolder where this wizard's files are located
# The wizard's title, as will appear in the "New..." dialog
# The wizard's category. Free-form text. If your wizard fits one of the existing categories, please use it.

After you add the new wizard in ''config.script'', you must restart Code::Blocks to re-initialize all the registered wizards.

[[User:Mandrav|Mandrav]] 07:51, 9 July 2006 (EDT)

Wizard scripts

2006-12-20T02:40:27Z

Nfz: /* What files do I need to create a valid wizard? */

[[Category:Scripting Code::Blocks]]
When you click "File->New", you 're presented with wizards to create various new things. These are:

* New project
* New build target inside the active project
* New file(s)
* New anything (custom)
* User template

[[Image:New_wiz.png|"New..." dialog]]

All the above functionality (except user templates) is provided by wizard scripts. In this section, I 'm gonna try to explain everything about wizard scripts.

Before starting out creating your own wizard scripts or editing existing ones, these are "must read":

* [[Wizard Scripting Commands]]
* [[Wizard Page Events]]

== Where are they located? ==
Wizard scripts are located under the Code::Blocks' data folder.
The base wizards folder is <tt>[Code::Blocks install dir]/share/codeblocks/templates/wizards</tt>.

Scripts are arranged in subfolders (one for each wizard) inside the above folder.
To make this clear, the structure of this folder is displayed below with the "console" wizard expanded to see all its files:

Base folder
console
c
main.c
cpp
main.cpp
logo.png
wizard.png
wizard.script
fltk
...
...
empty
...
...
common_functions.script
config.script

== What files do I need to create a valid wizard? ==
There are three files that are absolutely needed for your wizard to be registered correctly:
* '''logo.png''' - The wizard's icon. This will be displayed in the "New..." dialog.
* '''wizard.png''' - The wizard's bitmap. This bitmap is displayed on the left side in the wizard dialog.
* '''wizard.script''' - The wizard's script. You didn't think you could have a scripted wizard without a script, did you? ;)
* '''wizard.xrc''' - The wizard's custom pages. This file is optional but if you are using custom pages then all the panels must be placed in wizard.xrc.

== How do I edit an existing wizard? ==
That's easy: edit its script :). This can be done easily from within Code::Blocks. Just right-click on the wizard's icon in the "New..." dialog. The same context menu contains an option to edit the global configuration script (''config.script'').

[[Image:Edit_wiz_script.png|Wizard scripts context menu]]

Note that no restart is needed if you edit a script. Just save it and launch the wizard again :).

Code::Blocks needs to be restarted only when editing the global configuration script. An informational message is displayed in this case so you don't wonder why your changes are not taking any effect ;).

== How do I create a new wizard? ==
First thing you should do is read about [[Wizard Scripting Commands]] and use it as a reference on what commands are accepted and what their syntax is.

== How do I register my new wizard? ==
Wizard scripts are registered with Code::Blocks by adding a registration line in the global wizards configuration script (config.script).

Let's look at the registration of an existing wizard:

// config.script
function RegisterWizards()
{

RegisterWizard(wizProject, _T("empty"), _T("Empty project"), _T("Console"));

// more wizards following
...
...
}

The arguments to the RegisterWizard() function are as follows:

# The type of output for this wizard. Can be one of the following, self-explaining types:
#* wizProject
#* wizTarget
#* wizFiles
#* wizCustom
# The subfolder where this wizard's files are located
# The wizard's title, as will appear in the "New..." dialog
# The wizard's category. Free-form text. If your wizard fits one of the existing categories, please use it.

After you add the new wizard in ''config.script'', you must restart Code::Blocks to re-initialize all the registered wizards.

[[User:Mandrav|Mandrav]] 07:51, 9 July 2006 (EDT)