Classes
class	DocumentArray

Functions
Module Methods
Methods that can be called on the module.
String	MakeValidObjectName (String inputStr)

int	Choice (String button0, String button1, String button2, String text)

int	ChoiceWithDefault (String button0, String button1, String button2, int defaultChoice, String text)

bool	Question (String s)

bool	QuestionDefault (String s, bool defaultAnswer)

void	Error (String s)

void	MsgBox (String s)

String	SaveDialog (String caption, String directory, String filters, String defaultSuffix=String())

String	OpenDialog (String caption, String directory, String filters, bool isCreateFileAllowed=false)

String	OpenDirectoryDialog (String caption, String directory)

std::vector< String >	OpenMultiselectDialog (String caption, String directory, String filters)

String	GetApplicationLanguage ()

void	RegisterAlternateClassPathChooser (PyObject *pyfunc)

void	UnregisterAlternateClassPathChooser ()

void	RegisterCatalyzerScriptChooser (PyObject *pyfunc)

void	UnregisterCatalyzerScriptChooser ()

Detailed Description

The Editor Python Script Engine global features.

Copyright: Copyright Information

Function Documentation

int Choice	(	String	button0,
		String	button1,
		String	button2,
		String	text
	)

Creates and shows a pop-up dialog box and displays a text string and up to (3) buttons labeled according to the first three input parameters.

To hide any of the buttons, pass an empty string to the corresponding param. A question icon is displayed. This is equivalent to the fltk "fl_choice" message type.

Parameters

button0	The label for button 0 (ESC is shortcut for this Right button)
button1	The label for button 1 (RET is shortcut for this Center button)
button2	The label for button 2 (left-most button)
text	The text string to display

Returns: Equals 0 if button0 pressed, 1 if button1 pressed, 2 if button2 pressed

Since: GL Studio 6.0.1

int ChoiceWithDefault	(	String	button0,
		String	button1,
		String	button2,
		int	defaultChoice,
		String	text
	)

Creates and shows a pop-up dialog box and displays a text string and up to (3) buttons labeled according to the first three input parameters.

To hide any of the buttons, pass an empty string to the corresponding param. A question icon is displayed. This is equivalent to the fltk "fl_choice" message type.

Parameters

button0	The label for button 0 (ESC is shortcut for this Right button)
button1	The label for button 1 (RET is shortcut for this Center button)
button2	The label for button 2 (left-most button)
defaultChoice	The value returned when in command-line mode
text	The text string to display

Returns: Equals 0 if b0 pressed, 1 if b1 pressed, 2 if b2 pressed

Since: GL Studio 6.0.1

void Error ( String s )

Creates and shows a pop-up dialog box and displays a text string and (1) button labeled 'OK'.

An exclamation icon is displayed. This is equivalent to the fltk "fl_alert" message type.

Parameters

s	The text string to display

Since: GL Studio 6.0.1

String GetApplicationLanguage ( )

Returns the language code that is currently in use.

Returns: the 2-letter language code

Since: GL Studio 6.0.1

String MakeValidObjectName ( String inputStr )

Make a string a valid C++ identifier.

Parameters

inputStr a string that will be converted to a valid C++ identifier

Returns: valid C++ identifier

Exceptions

if	the inputStr could not be made into a valid C++ identifier.

Since: GL Studio 6.0.1

void MsgBox ( String s )

Creates and shows a pop-up dialog box and displays a text string and (1) button labeled 'OK'.

An 'i' (information) icon is displayed. This is equivalent to the fltk "fl_message" message type.

Parameters

s	The text string to display

Since: GL Studio 6.0.1

String OpenDialog	(	String	caption,
		String	directory,
		String	filters,
		bool	isCreateFileAllowed = `false`
	)

Displays an open dialog.

Parameters

	caption	The dialog box title
[in,out]	directory	As input, the starting directory; as output, the returning the chosen directory.
	filters	The filters of the form "Images (.png .xpm .jpg);;Text files (.txt);;XML files (*.xml)"
	isCreateFileAllowed	If enabled, allows the file dialog to create new files

Returns: The chosen filename to open (or empty if canceled)

Since: GL Studio 6.0.1

String OpenDirectoryDialog	(	String	caption,
		String	directory
	)

Displays an open directory dialog.

Parameters

	caption	The dialog box title
[in,out]	directory	As input, the starting directory; as output, the returning the chosen directory.

Returns: The chosen filename to open (or empty if canceled)

Since: GL Studio 6.0.1

std::vector<String > OpenMultiselectDialog	(	String	caption,
		String	directory,
		String	filters
	)

Displays an open dialog.

Parameters

	caption	The dialog box title.
[in,out]	directory	As input, the starting directory; as output, the returning the chosen directory.
	filters	The filters of the form "Images (.png .xpm .jpg);;Text files (.txt);;XML files (*.xml)"

Returns: The chosen filenames to open (or empty if canceled).

Since: GL Studio 6.0.1

bool Question ( String s )

Creates and shows a pop-up dialog box and displays a text string and (2) buttons labeled 'Yes' and 'No'.

A question mark icon is displayed. This is equivalent to the fltk "fl_choice" message type.

Parameters

s	The text string to display

Returns: Equals true if user pressed 'Yes', otherwise false

Since: GL Studio 6.0.1

bool QuestionDefault	(	String	s,
		bool	defaultAnswer
	)

Creates and shows a pop-up dialog box and displays a text string and (2) buttons labeled 'Yes' and 'No'.

A question mark icon is displayed. This is equivalent to the fltk "fl_choice" message type. This calls ChoiceWithDefault with buttons for "Yes" and "No.

Parameters

s	The text string to display
defaultAnswer	The value returned when in command-line mode

Returns: Equals true if user pressed 'Yes', otherwise false

Since: GL Studio 6.0.1

void RegisterAlternateClassPathChooser ( PyObject * pyfunc )

Register a function that can provide a path to an alternate class header file.

Overwrites any previously registered alternate class path chooser

Parameters

pyfunc the python function to call. Should take no parameters and return a string which is a path to the alternate class header (either an absolute file path or a path relative to the gls file)

void RegisterCatalyzerScriptChooser ( PyObject * pyfunc )

Register a function that can provide a path to an Catalyzer Script.

Overwrites any previously registered catalyzer script chooser

Parameters

pyfunc the python function to call. Should take no parameters and return a string which is a path to catalyzer script (either an absolute file path or a path relative to the gls file)

String SaveDialog	(	String	caption,
		String	directory,
		String	filters,
		String	defaultSuffix = `String ()`
	)

Displays a save dialog.

Parameters

	caption	The dialog box title
[in,out]	directory	As input, the starting directory; as output, the returning the chosen directory.
	filters	The filters of the form "Images (.png .xpm .jpg);;Text files (.txt);;XML files (*.xml)"
	defaultSuffix	the default extension to add if the user does not provide one. Can be NULL.

Returns: The chosen filename for saving to (or empty if canceled)

Since: GL Studio 6.0.1

void UnregisterAlternateClassPathChooser ( )

Clears out any registered alternate clas path chooser so that the default alternate class path chooser is used.

void UnregisterCatalyzerScriptChooser ( )

Clears out any registered catalyzer script chooser so that the default catlyzer script chooser is used.

Classes

Functions

Detailed Description

Function Documentation