Inheritance diagram for CEGUI::System:
Public Member Functions | |
System (Renderer *renderer, const utf8 *logFile=(const utf8 *)"CEGUI.log") | |
Constructs a System object. | |
System (Renderer *renderer, ResourceProvider *resourceProvider, const utf8 *logFile=(const utf8 *)"CEGUI.log") | |
Construct a new System object. | |
System (Renderer *renderer, ScriptModule *scriptModule, const utf8 *configFile=(const utf8 *)"cegui.config") | |
Construct a new System object. | |
System (Renderer *renderer, ScriptModule *scriptModule, ResourceProvider *resourceProvider, const utf8 *configFile=(const utf8 *)"cegui.config") | |
Construct a new System object. | |
System (Renderer *renderer, XMLParser *xmlParser, const utf8 *logFile=(const utf8 *)"CEGUI.log") | |
Constructs a System object. | |
System (Renderer *renderer, ResourceProvider *resourceProvider, XMLParser *xmlParser, const utf8 *logFile=(const utf8 *)"CEGUI.log") | |
Constructs a System object. | |
System (Renderer *renderer, XMLParser *xmlParser, ScriptModule *scriptModule, const utf8 *configFile=(const utf8 *)"cegui.config") | |
Construct a new System object. | |
System (Renderer *renderer, ResourceProvider *resourceProvider, XMLParser *xmlParser, ScriptModule *scriptModule, const utf8 *configFile=(const utf8 *)"cegui.config") | |
Construct a new System object. | |
~System (void) | |
Destructor for System objects. | |
Renderer * | getRenderer (void) const |
Return a pointer to the Renderer object being used by the system. | |
void | setDefaultFont (const String &name) |
Set the default font to be used by the system. | |
void | setDefaultFont (Font *font) |
Set the default font to be used by the system. | |
Font * | getDefaultFont (void) const |
Return a pointer to the default Font for the GUI system. | |
void | signalRedraw () |
Causes a full re-draw next time renderGUI() is called. | |
bool | isRedrawRequested () const |
Return a boolean value to indicate whether a full re-draw is requested next time renderGUI() is called. | |
void | renderGUI (void) |
Render the GUI. | |
Window * | setGUISheet (Window *sheet) |
Set the active GUI sheet (root) window. | |
Window * | getGUISheet (void) const |
Return a pointer to the active GUI sheet (root) window. | |
double | getSingleClickTimeout (void) const |
Return the current timeout for generation of single-click events. | |
double | getMultiClickTimeout (void) const |
Return the current timeout for generation of multi-click events. | |
const Size & | getMultiClickToleranceAreaSize (void) const |
Return the size of the allowable mouse movement tolerance used when generating multi-click events. | |
void | setSingleClickTimeout (double timeout) |
Set the timeout used for generation of single-click events. | |
void | setMultiClickTimeout (double timeout) |
Set the timeout to be used for the generation of multi-click events. | |
void | setMultiClickToleranceAreaSize (const Size &sz) |
Set the size of the allowable mouse movement tolerance used when generating multi-click events. | |
const Image * | getDefaultMouseCursor (void) const |
Return the currently set default mouse cursor image. | |
void | setDefaultMouseCursor (const Image *image) |
Set the image to be used as the default mouse cursor. | |
void | setDefaultMouseCursor (MouseCursorImage image) |
Set the image to be used as the default mouse cursor. | |
void | setDefaultMouseCursor (const String &imageset, const String &image_name) |
Set the image to be used as the default mouse cursor. | |
Window * | getWindowContainingMouse (void) const |
Return the Window object that the mouse is presently within. | |
ScriptModule * | getScriptingModule (void) const |
Return a pointer to the ScriptModule being used for scripting within the GUI system. | |
ResourceProvider * | getResourceProvider (void) const |
Return a pointer to the ResourceProvider being used within the GUI system. | |
void | executeScriptFile (const String &filename, const String &resourceGroup="") const |
Execute a script file if possible. | |
int | executeScriptGlobal (const String &function_name) const |
Execute a scripted global function if possible. The function should not take any parameters and should return an integer. | |
void | executeScriptString (const String &str) const |
If possible, execute script code contained in the given CEGUI::String object. | |
float | getMouseMoveScaling (void) const |
return the current mouse movement scaling factor. | |
void | setMouseMoveScaling (float scaling) |
Set the current mouse movement scaling factor. | |
void | notifyWindowDestroyed (const Window *window) |
Internal method used to inform the System object whenever a window is destroyed, so that System can perform any required housekeeping. | |
uint | getSystemKeys (void) const |
Return the current system keys value. | |
XMLParser * | getXMLParser (void) const |
Return the XMLParser object. | |
void | setTooltip (Tooltip *tooltip) |
Set the system default Tooltip object. This value may be NULL to indicate that no default Tooltip will be available. | |
void | setTooltip (const String &tooltipType) |
Set the system default Tooltip to be used by specifying a Window type. | |
Tooltip * | getDefaultTooltip (void) const |
return a poiter to the system default tooltip. May return 0. | |
void | setModalTarget (Window *target) |
Internal method to directly set the current modal target. | |
Window * | getModalTarget (void) const |
Return a pointer to the Window that is currently the modal target. | |
bool | injectMouseMove (float delta_x, float delta_y) |
Method that injects a mouse movement event into the system. | |
bool | injectMouseLeaves (void) |
Method that injects that the mouse has left the application window. | |
bool | injectMouseButtonDown (MouseButton button) |
Method that injects a mouse button down event into the system. | |
bool | injectMouseButtonUp (MouseButton button) |
Method that injects a mouse button up event into the system. | |
bool | injectKeyDown (uint key_code) |
Method that injects a key down event into the system. | |
bool | injectKeyUp (uint key_code) |
Method that injects a key up event into the system. | |
bool | injectChar (utf32 code_point) |
Method that injects a typed character event into the system. | |
bool | injectMouseWheelChange (float delta) |
Method that injects a mouse-wheel / scroll-wheel event into the system. | |
bool | injectMousePosition (float x_pos, float y_pos) |
Method that injects a new position for the mouse cursor. | |
bool | injectTimePulse (float timeElapsed) |
Method to inject time pulses into the system. | |
Static Public Member Functions | |
static System & | getSingleton (void) |
Return singleton System object. | |
static System * | getSingletonPtr (void) |
Return pointer to singleton System object. | |
Static Public Attributes | |
static const String | EventNamespace |
Namespace for global events. | |
static const double | DefaultSingleClickTimeout = 0.2 |
Default timeout for generation of single click events. | |
static const double | DefaultMultiClickTimeout = 0.33 |
Default timeout for generation of multi-click events. | |
static const Size | DefaultMultiClickAreaSize |
Default allowable mouse movement for multi-click event generation. | |
static const String | EventGUISheetChanged |
Name of event fired whenever the GUI sheet is changed. | |
static const String | EventSingleClickTimeoutChanged |
Name of event fired when the single-click timeout is changed. | |
static const String | EventMultiClickTimeoutChanged |
Name of event fired when the multi-click timeout is changed. | |
static const String | EventMultiClickAreaSizeChanged |
Name of event fired when the size of the multi-click tolerance area is changed. | |
static const String | EventDefaultFontChanged |
Name of event fired when the default font changes. | |
static const String | EventDefaultMouseCursorChanged |
Name of event fired when the default mouse cursor changes. | |
static const String | EventMouseMoveScalingChanged |
Name of event fired when the mouse move scaling factor changes. |
This object must be created by the client application. The System object requires that you pass it an initialised Renderer object which it can use to interface to whatever rendering system will be used to display the GUI imagery.
|
Constructs a System object.
|
|
Construct a new System object.
|
|
Construct a new System object.
|
|
Construct a new System object.
|
|
Constructs a System object.
|
|
Constructs a System object.
|
|
Construct a new System object.
|
|
Construct a new System object.
|
|
Execute a script file if possible.
|
|
Execute a scripted global function if possible. The function should not take any parameters and should return an integer.
|
|
If possible, execute script code contained in the given CEGUI::String object.
|
|
Return a pointer to the default Font for the GUI system.
|
|
Return the currently set default mouse cursor image.
|
|
return a poiter to the system default tooltip. May return 0.
|
|
Return a pointer to the active GUI sheet (root) window.
|
|
Return a pointer to the Window that is currently the modal target.
|
|
return the current mouse movement scaling factor.
|
|
Return the current timeout for generation of multi-click events. 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 size of the allowable mouse movement tolerance used when generating multi-click events. This size defines an area with the mouse at the centre. The mouse must stay within the tolerance defined for a multi-click (double click, or triple click) event to be generated.
|
|
Return a pointer to the Renderer object being used by the system.
|
|
Return a pointer to the ResourceProvider being used within the GUI system.
|
|
Return a pointer to the ScriptModule being used for scripting within the GUI system.
|
|
Return the current timeout for generation of single-click events. A single-click is defined here as a button being pressed and then released.
|
|
Return singleton System object.
|
|
Return pointer to singleton System object.
|
|
Return the current system keys value.
|
|
Return the Window object that the mouse is presently within.
|
|
Method that injects a typed character event into the system.
|
|
Method that injects a key down event into the system.
|
|
Method that injects a key up event into the system.
|
|
Method that injects a mouse button down event into the system.
|
|
Method that injects a mouse button up event into the system.
|
|
Method that injects that the mouse has left the application window.
|
|
Method that injects a mouse movement event into the system.
|
|
Method that injects a new position for the mouse cursor.
|
|
Method that injects a mouse-wheel / scroll-wheel event into the system.
|
|
Method to inject time pulses into the system.
|
|
Return a boolean value to indicate whether a full re-draw is requested next time renderGUI() is called.
|
|
Internal method used to inform the System object whenever a window is destroyed, so that System can perform any required housekeeping.
|
|
Render the GUI. Depending upon the internal state, this may either re-use rendering from last time, or trigger a full re-draw from all elements.
|
|
Set the default font to be used by the system.
|
|
Set the default font to be used by the system.
|
|
Set the image to be used as the default mouse cursor.
|
|
Set the image to be used as the default mouse cursor.
|
|
Set the image to be used as the default mouse cursor.
|
|
Set the active GUI sheet (root) window.
|
|
Internal method to directly set the current modal target.
|
|
Set the current mouse movement scaling factor.
|
|
Set the timeout to be used for the generation of multi-click events. 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.
|
|
Set the size of the allowable mouse movement tolerance used when generating multi-click events. This size defines an area with the mouse at the centre. The mouse must stay within the tolerance defined for a multi-click (double click, or triple click) event to be generated.
|
|
Set the timeout used for generation of single-click events. A single-click is defined here as a button being pressed and then released.
|
|
Set the system default Tooltip to be used by specifying a Window type. 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 Tooltip object. This value may be NULL to indicate that no default Tooltip will be available.
|
|
Causes a full re-draw next time renderGUI() is called.
|