Safe Haskell	None

HGamer3D.Bindings.CEGUI.ClassSystem

Synopsis

Documentation

create Source

Arguments

:: HG3DClass	renderer - Reference to a valid Renderer object that will be used to render GUI imagery.
-> HG3DClass	resourceProvider - Pointer to a ResourceProvider object, or NULL to use whichever default the Renderer provides.
-> HG3DClass	xmlParser - Pointer to a valid XMLParser object to be used when parsing XML files, or NULL to use a default parser.
-> HG3DClass	imageCodec - Pointer to a valid ImageCodec object to be used when loading image files, or NULL to use a default image codec.
-> HG3DClass	scriptModule - Pointer to a ScriptModule object. may be NULL for none.
-> String	configFile - String object containing the name of a configuration file to use.
-> String	logFile - String object containing the name to use for the log file.
-> IO HG3DClass

Create the System

destroy Source

Arguments

:: IO ()

Destroy the System

getSingleton Source

Arguments

:: IO HG3DClass

return value - Singleton

Return singleton System

getSingletonPtr Source

Arguments

:: IO HG3DClass

return value - Pointer to singleton

Return pointer to singleton System

getDefaultXMLParserName Source

Arguments

:: IO String

return value - String holding the currently set default xml parser name. Note that if this name has been changed after instantiating the system, the name returned may not actually correspond to the module in use.

setDefaultImageCodecName Source

Arguments

:: String	codecName
-> IO ()

Get the name of the default image codec.

Set the name of the default image codec to be used.

getDefaultImageCodecName Source

Arguments

:: IO String

getRenderer Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO HG3DClass	return value - Pointer to the

Return a pointer to the Renderer

setDefaultFont Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> String	name - String object containing the name of the font to be used as the system default.
-> IO ()	return value - Nothing.

Set the default font to be used by the system.

setDefaultFont2 Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> HG3DClass	font - Pointer to the font to be used as the system default.
-> IO ()	return value - Nothing.

Return a pointer to the default Font

setDefaultXMLParserName Source

Arguments

:: String	parserName
-> IO ()

Static member to set the name of the default XML parser module that should be used. - Details: If you want to modify the default parser from the one compiled in, you need to call this static member prior to instantiating the main CEGUI::System object.

Note that calling this member to change the name of the default module after CEGUI::System, and therefore the default xml parser, has been created will have no real effect - the default parser name will be updated, though no actual changes to the xml parser module will occur.

The built-in options for this are: - XercesParser - ExpatParser - LibxmlParser - TinyXMLParser

Whether these are actually available, depends upon how you built the system. If you have some custom parser, you can provide the name of that here to have it used as the default, though note that the final filename of the parser module should be of the form:

prefix: CEGUI[parserName][suffix]

where:

Return the name of the currently set default xml parser module.

getDefaultFont Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO HG3DClass	return value - Pointer to a

signalRedraw Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO ()	return value - Nothing

Return a boolean value to indicate whether a full re-draw is requested next time renderGUI()

Causes a full re-draw next time renderGUI()

isRedrawRequested Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Bool	return value - true if a re-draw has been requested

renderGUI Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO ()

Set the active GUI sheet (root) window.

Render the GUI. - Details: Depending upon the internal state, this may either re-use rendering from last time, or trigger a full re-draw from all elements.

setGUISheet Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> HG3DClass	sheet - Pointer to a Window object that will become the new GUI `root`
-> IO HG3DClass	return value - Pointer to the window that was previously set as the GUI root.

getGUISheet Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO HG3DClass	return value - Pointer to the window object that has been set as the GUI root element.

Return a pointer to the active GUI sheet (root) window.

getSingleClickTimeout Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Double

Return the current timeout for generation of multi-click events. - Details: A multi-click event is a double-click, or a triple-click. The value returned here is the maximum allowable time between mouse button down events for which a multi-click event will be generated.

Return the current timeout for generation of single-click events. - Details: A single-click is defined here as a button being pressed and then released.

getMultiClickTimeout Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Double

Set the timeout used for generation of single-click events. - Details: A single-click is defined here as a button being pressed and then released.

setSingleClickTimeout Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Double	timeout
-> IO ()

Set the timeout to be used for the generation of multi-click events. - Details: A multi-click event is a double-click, or a triple-click. The value returned here is the maximum allowable time between mouse button down events for which a multi-click event will be generated.

setMultiClickTimeout Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Double	timeout
-> IO ()

Return whether automatic mouse button click and multi-click (i.e. double-click and treble-click) event generation is enabled.

isMouseClickEventGenerationEnabled Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Bool

setMouseClickEventGenerationEnabled Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Bool	enable -
-> IO ()

Set the image to be used as the default mouse cursor.

Set whether automatic mouse button click and multi-click (i.e. double-click and treble-click) event generation will occur.

setDefaultMouseCursor3 Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> String	imageset - String object that contains the name of the Imageset that contains the image to be used.
-> String	image_name - String object that contains the name of the Image on imageset that is to be used.
-> IO ()	return value - Nothing.

Return the Window

getWindowContainingMouse Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO HG3DClass	return value - Pointer to the

getScriptingModule Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO HG3DClass	return value - Pointer to a

Return a pointer to the ScriptModule

setScriptingModule Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> HG3DClass	scriptModule - Pointer to a ScriptModule based object, or 0 for none (be careful!)
-> IO ()	return value - Nothing

Return a pointer to the ResourceProvider

Set the ScriptModule

getResourceProvider Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO HG3DClass	return value - Pointer to a

executeScriptFile Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> String	filename - String object holding the filename of the script file that is to be executed
-> String	resourceGroup - Resource group identifier to be passed to the ResourceProvider when loading the script file.
-> IO ()

Execute a scripted global function if possible. The function should not take any parameters and should return an integer.

Execute a script file if possible.

executeScriptGlobal Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> String	function_name - String object holding the name of the function, in the global script environment, that is to be executed.
-> IO Int	return value - The integer value returned from the script function.

executeScriptString Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> String	str - String object holding the valid script code that should be executed.
-> IO ()	return value - Nothing.

return the current mouse movement scaling factor.

If possible, execute script code contained in the given CEGUI::String object.

getMouseMoveScaling Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Float	return value - float value that is equal to the currently set mouse movement scaling factor. Defaults to 1.0f.

setMouseMoveScaling Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Float	scaling - float value specifying the scaling to be applied to mouse movement inputs.
-> IO ()	return value - nothing.

Internal method used to inform the SystemSystem - Details: This method is not intended for client code usage. If you use this method anything can, and probably will, go wrong!

Set the current mouse movement scaling factor.

notifyWindowDestroyed Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> HG3DClass	window
-> IO ()

Return the current system keys value.

getSystemKeys Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Int	return value - uint value representing a combination of the SystemKey bits.

setXMLParser Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> String	parserName
-> IO ()

Sets the XMLParser - Details: The current XMLParser will be cleaned up and, if owned by the system, also deleted, as will any dynamically loaded module associated with the XMLParser object.

If the argument passed in the a parser parameter is 0, the system will cleanup any existing parser as described above, and revert to using the parser provided by the default module (see getDefaultXMLParserName and setDefaultXMLParserName).

Set a new XML parser module to be used. - Details: The current XMLParser will be cleaned up and, if owned by the system, also deleted, as will any dynamically loaded module associated with the XMLParser object. The newly created XMLParser object, and the associated module will be owned by the system.

getXMLParser Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO HG3DClass

setXMLParser2 Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> HG3DClass	parser
-> IO ()

Return the XMLParser

setDefaultTooltip Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> HG3DClass	tooltip - Pointer to a valid Tooltip based object which should be used as the default tooltip for the system, or NULL to indicate that no system default tooltip is required. Note that when passing a pointer to a Tooltip object, ownership of the Tooltip does not pass to System.
-> IO ()	return value - Nothing.

Set the system default TooltipWindow - Details: System will internally attempt to create an instance of the specified window type (which must be derived from the base Tooltip class). If the Tooltip creation fails, the error is logged and no system default Tooltip will be available.

Set the system default TooltipTooltip

setDefaultTooltip2 Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> String	tooltipType
-> IO ()

return a poiter to the system default tooltip. May return 0.

getDefaultTooltip Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO HG3DClass	return value - Pointer to the current system default tooltip. May return 0 if no system default tooltip is available.

setModalTarget Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> HG3DClass	target
-> IO ()

Return a pointer to the Window

Internal method to directly set the current modal target. - Details: This method is called internally by Window

getModalTarget Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO HG3DClass	return value - Pointer to the current modal target. NULL if there is no modal target.

updateWindowContainingMouse Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Bool

Perform updates with regards to the window that contains the mouse cursor, firing any required MouseEnters / MouseLeaves events. - Details: The CEGUI

getImageCodec Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO HG3DClass

Retrieve the image codec to be used by the system.

setImageCodec Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> String	codecName
-> IO ()

Set the image codec to use from an existing image codec. - Details: In this case the renderer does not take the ownership of the image codec object.

Set the image codec to be used by the system.

setImageCodec2 Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> HG3DClass	codec
-> IO ()

Invalidate all imagery and geometry caches for CEGUI - Details: This function will invalidate the caches used for both imagery and geometry for all content that is managed by the core CEGUIWindow

invalidateAllCachedRendering Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO ()

Method that injects a mouse movement event into the system.

injectMouseMove Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Float	delta_x - amount the mouse moved on the x axis.
-> Float	delta_y - amount the mouse moved on the y axis.
-> IO Bool

injectMouseLeaves Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Bool

Method that injects that the mouse has left the application window.

injectMouseButtonDown Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> EnumMouseButton	button - One of the MouseButton values indicating which button was pressed.
-> IO Bool

Method that injects a mouse button down event into the system.

injectMouseButtonUp Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> EnumMouseButton	button - One of the MouseButton values indicating which button was released.
-> IO Bool

Method that injects a mouse button up event into the system.

injectKeyDown Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Int	key_code - uint value indicating which key was pressed.
-> IO Bool

Method that injects a key down event into the system.

injectKeyUp Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Int	key_code - uint value indicating which key was released.
-> IO Bool

Method that injects a key up event into the system.

injectChar Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Int	code_point - Unicode code point of the character that was typed.
-> IO Bool

Method that injects a typed character event into the system.

injectMouseWheelChange Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Float	delta - float value representing the amount the wheel moved.
-> IO Bool

Method that injects a mouse-wheel / scroll-wheel event into the system.

injectMousePosition Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Float	x_pos - New absolute pixel position of the mouse cursor on the x axis.
-> Float	y_pos - New absolute pixel position of the mouse cursoe in the y axis.
-> IO Bool

Method that injects a new position for the mouse cursor.

injectTimePulse Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Float	timeElapsed - float value indicating the amount of time passed, in seconds, since the last time this method was called.
-> IO Bool	return value - Currently, this method always returns true.

Method to inject time pulses into the system.

injectMouseButtonClick Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> EnumMouseButton	button
-> IO Bool

Function to directly inject a mouse button double-click event. - Details: Here 'double-click' means a single mouse button had the sequence down, up, down within a predefined period of time.

Function to directly inject a mouse button click event. - Details: Here click means a mouse button down event followed by a mouse button up event.

injectMouseButtonDoubleClick Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> EnumMouseButton	button
-> IO Bool

Function to directly inject a mouse button triple-click event. - Details: Here 'triple-click' means a single mouse button had the sequence down, up, down, up, down within a predefined period of time.

injectMouseButtonTripleClick Source

Arguments