Crazy Eddie's GUI System  ${CEGUI_VERSION}
GUIContext_wrapper Struct Reference
+ Inheritance diagram for GUIContext_wrapper:
+ Collaboration diagram for GUIContext_wrapper:

Public Member Functions

 GUIContext_wrapper (::CEGUI::RenderTarget &target)
 
bool areaChangedHandler (::CEGUI::EventArgs const &args)
 
void createDefaultTooltipWindowInstance () const
 
void destroyDefaultTooltipWindowInstance ()
 
virtual void draw ()
 Draw the GeometryBuffers for all rendering queues to the RenderTarget that this RenderingSurface is targetting. More...
 
void default_draw ()
 
virtual void drawContent ()
 
virtual void default_drawContent ()
 
void drawWindowContentToTarget ()
 
::CEGUI::WindowgetCommonAncestor (::CEGUI::Window *w1,::CEGUI::Window *w2) const
 
::CEGUI::WindowgetKeyboardTargetWindow () const
 
::CEGUI::WindowgetTargetWindow (::CEGUI::Vector2f const &pt, bool const allow_disabled) const
 
virtual bool injectChar (::CEGUI::utf32 code_point)
 
bool default_injectChar (::CEGUI::utf32 code_point)
 
virtual bool injectCopyRequest ()
 Tells the receiver to perform a clipboard copy operation. More...
 
bool default_injectCopyRequest ()
 
virtual bool injectCutRequest ()
 Tells the system to perform a clipboard cut operation. More...
 
bool default_injectCutRequest ()
 
virtual bool injectKeyDown (::CEGUI::Key::Scan scan_code)
 
bool default_injectKeyDown (::CEGUI::Key::Scan scan_code)
 
virtual bool injectKeyUp (::CEGUI::Key::Scan scan_code)
 
bool default_injectKeyUp (::CEGUI::Key::Scan scan_code)
 
virtual bool injectMouseButtonClick (::CEGUI::MouseButton const button)
 
bool default_injectMouseButtonClick (::CEGUI::MouseButton const button)
 
virtual bool injectMouseButtonDoubleClick (::CEGUI::MouseButton const button)
 
bool default_injectMouseButtonDoubleClick (::CEGUI::MouseButton const button)
 
virtual bool injectMouseButtonDown (::CEGUI::MouseButton button)
 
bool default_injectMouseButtonDown (::CEGUI::MouseButton button)
 
virtual bool injectMouseButtonTripleClick (::CEGUI::MouseButton const button)
 
bool default_injectMouseButtonTripleClick (::CEGUI::MouseButton const button)
 
virtual bool injectMouseButtonUp (::CEGUI::MouseButton button)
 
bool default_injectMouseButtonUp (::CEGUI::MouseButton button)
 
virtual bool injectMouseLeaves ()
 Function that notifies that the mouse has left the host area that the receiver receives input for. More...
 
bool default_injectMouseLeaves ()
 
virtual bool injectMouseMove (float delta_x, float delta_y)
 Function that injects a mouse movement event into the receiver. More...
 
bool default_injectMouseMove (float delta_x, float delta_y)
 
virtual bool injectMousePosition (float x_pos, float y_pos)
 Function that injects a new position for the mouse cursor. More...
 
bool default_injectMousePosition (float x_pos, float y_pos)
 
virtual bool injectMouseWheelChange (float delta)
 Function that injects a mouse-wheel / scroll-wheel event into the receiver. More...
 
bool default_injectMouseWheelChange (float delta)
 
virtual bool injectPasteRequest ()
 Tells the system to perform a clipboard paste operation. More...
 
bool default_injectPasteRequest ()
 
virtual bool injectTimePulse (float timeElapsed)
 Function to inject time pulses into the receiver. More...
 
bool default_injectTimePulse (float timeElapsed)
 
bool mouseMoveInjection_impl (::CEGUI::MouseEventArgs &ma)
 
void notifyDefaultFontChanged (::CEGUI::Window *hierarchy_root) const
 
virtual void onDefaultFontChanged (::CEGUI::EventArgs &args)
 
virtual void default_onDefaultFontChanged (::CEGUI::EventArgs &args)
 
virtual void onMouseButtonClickTimeoutChanged (::CEGUI::GUIContextEventArgs &args)
 
virtual void default_onMouseButtonClickTimeoutChanged (::CEGUI::GUIContextEventArgs &args)
 
virtual void onMouseButtonMultiClickTimeoutChanged (::CEGUI::GUIContextEventArgs &args)
 
virtual void default_onMouseButtonMultiClickTimeoutChanged (::CEGUI::GUIContextEventArgs &args)
 
virtual void onMouseButtonMultiClickToleranceChanged (::CEGUI::GUIContextEventArgs &args)
 
virtual void default_onMouseButtonMultiClickToleranceChanged (::CEGUI::GUIContextEventArgs &args)
 
virtual void onMouseMoveScalingFactorChanged (::CEGUI::GUIContextEventArgs &args)
 
virtual void default_onMouseMoveScalingFactorChanged (::CEGUI::GUIContextEventArgs &args)
 
virtual void onRenderTargetChanged (::CEGUI::GUIContextRenderTargetEventArgs &args)
 
virtual void default_onRenderTargetChanged (::CEGUI::GUIContextRenderTargetEventArgs &args)
 
virtual void onRootWindowChanged (::CEGUI::WindowEventArgs &args)
 
virtual void default_onRootWindowChanged (::CEGUI::WindowEventArgs &args)
 
void renderWindowHierarchyToSurfaces ()
 
void resetWindowContainingMouse ()
 
void updateRootWindowAreaRects () const
 
bool updateWindowContainingMouse_impl () const
 
bool windowDestroyedHandler (::CEGUI::EventArgs const &args)
 
void attachWindow (::CEGUI::RenderingWindow &w)
 
virtual void destroyRenderingWindow (::CEGUI::RenderingWindow &window)
 
void default_destroyRenderingWindow (::CEGUI::RenderingWindow &window)
 
void detatchWindow (::CEGUI::RenderingWindow &w)
 
void draw (::CEGUI::RenderQueue const &queue,::CEGUI::RenderQueueEventArgs &args)
 
virtual void fireEvent (::CEGUI::String const &name,::CEGUI::EventArgs &args,::CEGUI::String const &eventNamespace="")
 
void default_fireEvent (::CEGUI::String const &name,::CEGUI::EventArgs &args,::CEGUI::String const &eventNamespace="")
 
void fireEvent_impl (::CEGUI::String const &name,::CEGUI::EventArgs &args)
 
::CEGUI::ScriptModulegetScriptModule () const
 
virtual void invalidate ()
 Marks the RenderingSurface as invalid, causing the geometry to be rerendered to the RenderTarget next time draw is called. More...
 
void default_invalidate ()
 
virtual bool isRenderingWindow () const
 Return whether this RenderingSurface is actually an instance of the RenderingWindow subclass. More...
 
bool default_isRenderingWindow () const
 
virtual ::CEGUI::RefCounted< CEGUI::BoundSlotsubscribeScriptedEvent (::CEGUI::String const &name,::CEGUI::String const &subscriber_name)
 
::CEGUI::RefCounted< CEGUI::BoundSlotdefault_subscribeScriptedEvent (::CEGUI::String const &name,::CEGUI::String const &subscriber_name)
 
virtual ::CEGUI::RefCounted< CEGUI::BoundSlotsubscribeScriptedEvent (::CEGUI::String const &name, unsigned int group,::CEGUI::String const &subscriber_name)
 
::CEGUI::RefCounted< CEGUI::BoundSlotdefault_subscribeScriptedEvent (::CEGUI::String const &name, unsigned int group,::CEGUI::String const &subscriber_name)
 
virtual void transferRenderingWindow (::CEGUI::RenderingWindow &window)
 
void default_transferRenderingWindow (::CEGUI::RenderingWindow &window)
 
- Public Member Functions inherited from CEGUI::GUIContext
 GUIContext (RenderTarget &target)
 
WindowgetRootWindow () const
 
void setRootWindow (Window *new_root)
 
void setModalWindow (Window *window)
 Internal function to directly set the current modal window. More...
 
WindowgetModalWindow () const
 Return a pointer to the Window that is currently set as modal.
 
WindowgetWindowContainingMouse () const
 
const SizefgetSurfaceSize () const
 
const SystemKeysgetSystemKeys () const
 
void markAsDirty ()
 call to indicate that some redrawing is required.
 
bool isDirty () const
 
MouseCursorgetMouseCursor ()
 Retrieves MouseCursor used in this GUIContext. More...
 
const MouseCursorgetMouseCursor () const
 
void setMouseMoveScalingFactor (float factor)
 
float getMouseMoveScalingFactor () const
 
void setMouseButtonClickTimeout (float seconds)
 
float getMouseButtonClickTimeout () const
 
void setMouseButtonMultiClickTimeout (float seconds)
 
float getMouseButtonMultiClickTimeout () const
 
void setMouseButtonMultiClickTolerance (const Sizef &sz)
 
const SizefgetMouseButtonMultiClickTolerance () const
 
void setMouseClickEventGenerationEnabled (const bool enable)
 Set whether automatic mouse button click and multi-click (i.e. double-click and treble-click) event generation will occur. More...
 
bool isMouseClickEventGenerationEnabled () const
 Return whether automatic mouse button click and multi-click (i.e. double-click and treble-click) event generation is enabled. More...
 
void updateWindowContainingMouse ()
 Tell the context to reconsider which window it thinks the mouse is in.
 
WindowgetInputCaptureWindow () const
 
void setInputCaptureWindow (Window *window)
 
void setDefaultTooltipObject (Tooltip *tooltip)
 Set the default Tooltip object for this GUIContext. This value may be 0 to indicate that no default Tooltip object will be available. More...
 
void setDefaultTooltipType (const String &tooltip_type)
 Set the default Tooltip to be used by specifying a Window type. More...
 
TooltipgetDefaultTooltipObject () const
 Returns a pointer to the context's default tooltip object. May return 0.
 
void setRenderTarget (RenderTarget &target)
 
void setDefaultFont (const String &name)
 Set the default font to be used by the GUIContext. More...
 
void setDefaultFont (Font *font)
 Set the default font to be used by the GUIContext. More...
 
FontgetDefaultFont () const
 Return a pointer to the default Font for the GUIContext. More...
 
bool injectMouseButtonDown (MouseButton button)
 Function that injects a mouse button down event into the receiver. More...
 
bool injectMouseButtonUp (MouseButton button)
 Function that injects a mouse button up event into the receiver. More...
 
bool injectKeyDown (Key::Scan scan_code)
 Function that injects a key down event into the receiver. More...
 
bool injectKeyUp (Key::Scan scan_code)
 Function that injects a key up event into the receiver. More...
 
bool injectChar (String::value_type code_point)
 Function that injects a typed character event into the receiver. More...
 
bool injectMouseButtonClick (const MouseButton button)
 Function to directly inject a mouse button click event. More...
 
bool injectMouseButtonDoubleClick (const MouseButton button)
 Function to directly inject a mouse button double-click event. More...
 
bool injectMouseButtonTripleClick (const MouseButton button)
 Function to directly inject a mouse button triple-click event. More...
 
 GUIContext (RenderTarget &target)
 
WindowgetRootWindow () const
 
void setRootWindow (Window *new_root)
 
void setModalWindow (Window *window)
 Internal function to directly set the current modal window. More...
 
WindowgetModalWindow () const
 Return a pointer to the Window that is currently set as modal.
 
WindowgetWindowContainingMouse () const
 
const SizefgetSurfaceSize () const
 
const SystemKeysgetSystemKeys () const
 
void markAsDirty ()
 call to indicate that some redrawing is required.
 
bool isDirty () const
 
MouseCursorgetMouseCursor ()
 Retrieves MouseCursor used in this GUIContext. More...
 
const MouseCursorgetMouseCursor () const
 
void setMouseMoveScalingFactor (float factor)
 
float getMouseMoveScalingFactor () const
 
void setMouseButtonClickTimeout (float seconds)
 
float getMouseButtonClickTimeout () const
 
void setMouseButtonMultiClickTimeout (float seconds)
 
float getMouseButtonMultiClickTimeout () const
 
void setMouseButtonMultiClickTolerance (const Sizef &sz)
 
const SizefgetMouseButtonMultiClickTolerance () const
 
void setMouseClickEventGenerationEnabled (const bool enable)
 Set whether automatic mouse button click and multi-click (i.e. double-click and treble-click) event generation will occur. More...
 
bool isMouseClickEventGenerationEnabled () const
 Return whether automatic mouse button click and multi-click (i.e. double-click and treble-click) event generation is enabled. More...
 
void updateWindowContainingMouse ()
 Tell the context to reconsider which window it thinks the mouse is in.
 
WindowgetInputCaptureWindow () const
 
void setInputCaptureWindow (Window *window)
 
void setDefaultTooltipObject (Tooltip *tooltip)
 Set the default Tooltip object for this GUIContext. This value may be 0 to indicate that no default Tooltip object will be available. More...
 
void setDefaultTooltipType (const String &tooltip_type)
 Set the default Tooltip to be used by specifying a Window type. More...
 
TooltipgetDefaultTooltipObject () const
 Returns a pointer to the context's default tooltip object. May return 0.
 
void setRenderTarget (RenderTarget &target)
 
void setDefaultFont (const String &name)
 Set the default font to be used by the GUIContext. More...
 
void setDefaultFont (Font *font)
 Set the default font to be used by the GUIContext. More...
 
FontgetDefaultFont () const
 Return a pointer to the default Font for the GUIContext. More...
 
bool injectMouseMove (float delta_x, float delta_y)
 Function that injects a mouse movement event into the receiver. More...
 
bool injectMouseLeaves (void)
 Function that notifies that the mouse has left the host area that the receiver receives input for. More...
 
bool injectMouseButtonDown (MouseButton button)
 Function that injects a mouse button down event into the receiver. More...
 
bool injectMouseButtonUp (MouseButton button)
 Function that injects a mouse button up event into the receiver. More...
 
bool injectKeyDown (Key::Scan scan_code)
 Function that injects a key down event into the receiver. More...
 
bool injectKeyUp (Key::Scan scan_code)
 Function that injects a key up event into the receiver. More...
 
bool injectChar (String::value_type code_point)
 Function that injects a typed character event into the receiver. More...
 
bool injectMouseWheelChange (float delta)
 Function that injects a mouse-wheel / scroll-wheel event into the receiver. More...
 
bool injectMousePosition (float x_pos, float y_pos)
 Function that injects a new position for the mouse cursor. More...
 
bool injectTimePulse (float timeElapsed)
 Function to inject time pulses into the receiver. More...
 
bool injectMouseButtonClick (const MouseButton button)
 Function to directly inject a mouse button click event. More...
 
bool injectMouseButtonDoubleClick (const MouseButton button)
 Function to directly inject a mouse button double-click event. More...
 
bool injectMouseButtonTripleClick (const MouseButton button)
 Function to directly inject a mouse button triple-click event. More...
 
bool injectCopyRequest ()
 Tells the receiver to perform a clipboard copy operation. More...
 
bool injectCutRequest ()
 Tells the system to perform a clipboard cut operation. More...
 
bool injectPasteRequest ()
 Tells the system to perform a clipboard paste operation. More...
 
void draw ()
 Draw the GeometryBuffers for all rendering queues to the RenderTarget that this RenderingSurface is targetting. More...
 
- Public Member Functions inherited from CEGUI::RenderingSurface
 RenderingSurface (RenderTarget &target)
 Constructor for RenderingSurface objects. More...
 
virtual ~RenderingSurface ()
 Destructor for RenderingSurface objects.
 
void addGeometryBuffer (const RenderQueueID queue, const GeometryBuffer &buffer)
 Add the specified GeometryBuffer to the specified queue for rendering when the RenderingSurface is drawn. More...
 
void removeGeometryBuffer (const RenderQueueID queue, const GeometryBuffer &buffer)
 Remove the specified GeometryBuffer from the specified queue. More...
 
void clearGeometry (const RenderQueueID queue)
 Clears all GeometryBuffers from the specified rendering queue. More...
 
void clearGeometry ()
 Clears all GeometryBuffers from all rendering queues. More...
 
bool isInvalidated () const
 Return whether this RenderingSurface is invalidated. More...
 
virtual RenderingWindowcreateRenderingWindow (TextureTarget &target)
 Create and return a reference to a child RenderingWindow object that will render back onto this RenderingSurface when it's draw member function is called. More...
 
virtual void destroyRenderingWindow (RenderingWindow &window)
 Destroy a RenderingWindow we own. If we are not the present owner of the given RenderingWindow, nothing happens. More...
 
virtual void transferRenderingWindow (RenderingWindow &window)
 transfer ownership of the RenderingWindow to this RenderingSurface. More...
 
const RenderTargetgetRenderTarget () const
 Return the RenderTarget object that this RenderingSurface is drawing to. More...
 
RenderTargetgetRenderTarget ()
 
 RenderingSurface (RenderTarget &target)
 Constructor for RenderingSurface objects. More...
 
virtual ~RenderingSurface ()
 Destructor for RenderingSurface objects.
 
void addGeometryBuffer (const RenderQueueID queue, const GeometryBuffer &buffer)
 Add the specified GeometryBuffer to the specified queue for rendering when the RenderingSurface is drawn. More...
 
void removeGeometryBuffer (const RenderQueueID queue, const GeometryBuffer &buffer)
 Remove the specified GeometryBuffer from the specified queue. More...
 
void clearGeometry (const RenderQueueID queue)
 Clears all GeometryBuffers from the specified rendering queue. More...
 
void clearGeometry ()
 Clears all GeometryBuffers from all rendering queues. More...
 
bool isInvalidated () const
 Return whether this RenderingSurface is invalidated. More...
 
virtual RenderingWindowcreateRenderingWindow (TextureTarget &target)
 Create and return a reference to a child RenderingWindow object that will render back onto this RenderingSurface when it's draw member function is called. More...
 
virtual void destroyRenderingWindow (RenderingWindow &window)
 Destroy a RenderingWindow we own. If we are not the present owner of the given RenderingWindow, nothing happens. More...
 
virtual void transferRenderingWindow (RenderingWindow &window)
 transfer ownership of the RenderingWindow to this RenderingSurface. More...
 
const RenderTargetgetRenderTarget () const
 Return the RenderTarget object that this RenderingSurface is drawing to. More...
 
RenderTargetgetRenderTarget ()
 
- Public Member Functions inherited from CEGUI::EventSet
 EventSet ()
 Constructor for EventSet objects.
 
virtual ~EventSet (void)
 Destructor for EventSet objects.
 
void addEvent (const String &name)
 Creates a new Event object with the given name and adds it to the EventSet. More...
 
void addEvent (Event &event)
 Adds the given Event object to the EventSet. Ownership of the object passes to EventSet and it will be deleted when it is removed from the EventSet - whether explicitly via removeEvent or when the EventSet is destroyed. More...
 
void removeEvent (const String &name)
 Removes the Event with the given name. All connections to the event are disconnected, and the underlying Event object is destroyed. More...
 
void removeEvent (Event &event)
 Removes the given event from the EventSet. All connections to the event are disconnected, and the event object is destroyed. More...
 
void removeAllEvents (void)
 Remove all Event objects from the EventSet. Add connections will be disconnected, and all Event objects destroyed.
 
bool isEventPresent (const String &name)
 Checks to see if an Event with the given name is present in this EventSet. More...
 
virtual Event::Connection subscribeEvent (const String &name, Event::Subscriber subscriber)
 Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
 
virtual Event::Connection subscribeEvent (const String &name, Event::Group group, Event::Subscriber subscriber)
 Subscribes a handler to the specified group of the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
 
template<typename Arg1 , typename Arg2 >
Event::Connection subscribeEvent (const String &name, Arg1 arg1, Arg2 arg2)
 Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
 
template<typename Arg1 , typename Arg2 >
Event::Connection subscribeEvent (const String &name, Event::Group group, Arg1 arg1, Arg2 arg2)
 Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
 
virtual Event::Connection subscribeScriptedEvent (const String &name, const String &subscriber_name)
 Subscribes the named Event to a scripted funtion. More...
 
virtual Event::Connection subscribeScriptedEvent (const String &name, Event::Group group, const String &subscriber_name)
 Subscribes the specified group of the named Event to a scripted funtion. More...
 
virtual void fireEvent (const String &name, EventArgs &args, const String &eventNamespace="")
 Fires the named event passing the given EventArgs object. More...
 
bool isMuted (void) const
 Return whether the EventSet is muted or not. More...
 
void setMutedState (bool setting)
 Set the mute state for this EventSet. More...
 
EventgetEventObject (const String &name, bool autoAdd=false)
 Return a pointer to the Event object with the given name, optionally adding such an Event object to the EventSet if it does not already exist. More...
 
EventIterator getEventIterator (void) const
 Return a EventSet::EventIterator object to iterate over the events currently added to the EventSet.
 
 EventSet ()
 Constructor for EventSet objects.
 
virtual ~EventSet (void)
 Destructor for EventSet objects.
 
void addEvent (const String &name)
 Creates a new Event object with the given name and adds it to the EventSet. More...
 
void addEvent (Event &event)
 Adds the given Event object to the EventSet. Ownership of the object passes to EventSet and it will be deleted when it is removed from the EventSet - whether explicitly via removeEvent or when the EventSet is destroyed. More...
 
void removeEvent (const String &name)
 Removes the Event with the given name. All connections to the event are disconnected, and the underlying Event object is destroyed. More...
 
void removeEvent (Event &event)
 Removes the given event from the EventSet. All connections to the event are disconnected, and the event object is destroyed. More...
 
void removeAllEvents (void)
 Remove all Event objects from the EventSet. Add connections will be disconnected, and all Event objects destroyed.
 
bool isEventPresent (const String &name)
 Checks to see if an Event with the given name is present in this EventSet. More...
 
virtual Event::Connection subscribeEvent (const String &name, Event::Subscriber subscriber)
 Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
 
virtual Event::Connection subscribeEvent (const String &name, Event::Group group, Event::Subscriber subscriber)
 Subscribes a handler to the specified group of the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
 
template<typename Arg1 , typename Arg2 >
Event::Connection subscribeEvent (const String &name, Arg1 arg1, Arg2 arg2)
 Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
 
template<typename Arg1 , typename Arg2 >
Event::Connection subscribeEvent (const String &name, Event::Group group, Arg1 arg1, Arg2 arg2)
 Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
 
virtual Event::Connection subscribeScriptedEvent (const String &name, const String &subscriber_name)
 Subscribes the named Event to a scripted funtion. More...
 
virtual Event::Connection subscribeScriptedEvent (const String &name, Event::Group group, const String &subscriber_name)
 Subscribes the specified group of the named Event to a scripted funtion. More...
 
virtual void fireEvent (const String &name, EventArgs &args, const String &eventNamespace="")
 Fires the named event passing the given EventArgs object. More...
 
bool isMuted (void) const
 Return whether the EventSet is muted or not. More...
 
void setMutedState (bool setting)
 Set the mute state for this EventSet. More...
 
EventgetEventObject (const String &name, bool autoAdd=false)
 Return a pointer to the Event object with the given name, optionally adding such an Event object to the EventSet if it does not already exist. More...
 
EventIterator getEventIterator (void) const
 Return a EventSet::EventIterator object to iterate over the events currently added to the EventSet.
 

Additional Inherited Members

- Public Types inherited from CEGUI::EventSet
typedef ConstMapIterator< EventMap > EventIterator
 
typedef ConstMapIterator< EventMap > EventIterator
 
- Static Public Attributes inherited from CEGUI::GUIContext
static const float DefaultMouseButtonClickTimeout = 0.0f
 
static const float DefaultMouseButtonMultiClickTimeout = 0.3333f
 
static const Sizef DefaultMouseButtonMultiClickTolerance
 
static const String EventRootWindowChanged
 
static const String EventMouseMoveScalingFactorChanged
 
static const String EventMouseButtonClickTimeoutChanged
 
static const String EventMouseButtonMultiClickTimeoutChanged
 
static const String EventMouseButtonMultiClickToleranceChanged
 
static const String EventRenderTargetChanged
 
static const String EventDefaultFontChanged
 
- Static Public Attributes inherited from CEGUI::RenderingSurface
static const String EventNamespace
 Namespace for global events from RenderingSurface objects.
 
static const String EventRenderQueueStarted
 
static const String EventRenderQueueEnded
 
- Protected Types inherited from CEGUI::RenderingSurface
typedef std::map< RenderQueueID, RenderQueueRenderQueueList
 collection type for the queues
 
typedef std::vector< RenderingWindow *CEGUI_VECTOR_ALLOC(RenderingWindow *)> RenderingWindowList
 collection type for created RenderingWindow objects
 
typedef std::map< RenderQueueID, RenderQueueRenderQueueList
 collection type for the queues
 
typedef std::vector< RenderingWindow *CEGUI_VECTOR_ALLOC(RenderingWindow *)> RenderingWindowList
 collection type for created RenderingWindow objects
 
- Protected Types inherited from CEGUI::EventSet
typedef std::map< String, Event *, StringFastLessCompare CEGUI_MAP_ALLOC(String, Event *)> EventMap
 
typedef std::map< String, Event *, StringFastLessCompare CEGUI_MAP_ALLOC(String, Event *)> EventMap
 
- Protected Member Functions inherited from CEGUI::GUIContext
void updateRootWindowAreaRects () const
 
void drawWindowContentToTarget ()
 
void renderWindowHierarchyToSurfaces ()
 
void createDefaultTooltipWindowInstance () const
 
void destroyDefaultTooltipWindowInstance ()
 
void notifyDefaultFontChanged (Window *hierarchy_root) const
 notify windows in a hierarchy using default font, when font changes.
 
bool mouseMoveInjection_impl (MouseEventArgs &ma)
 
WindowgetTargetWindow (const Vector2f &pt, const bool allow_disabled) const
 
WindowgetKeyboardTargetWindow () const
 
WindowgetCommonAncestor (Window *w1, Window *w2) const
 
void notifyMouseTransition (Window *top, Window *bottom, void(Window::*func)(MouseEventArgs &), MouseEventArgs &args) const
 call some function for a chain of windows: (top, bottom]
 
bool areaChangedHandler (const EventArgs &args)
 
bool windowDestroyedHandler (const EventArgs &args)
 
bool updateWindowContainingMouse_impl () const
 returns whether the window containing the mouse had changed.
 
void resetWindowContainingMouse ()
 
virtual void onRootWindowChanged (WindowEventArgs &args)
 
virtual void onMouseMoveScalingFactorChanged (GUIContextEventArgs &args)
 
virtual void onMouseButtonClickTimeoutChanged (GUIContextEventArgs &args)
 
virtual void onMouseButtonMultiClickTimeoutChanged (GUIContextEventArgs &args)
 
virtual void onMouseButtonMultiClickToleranceChanged (GUIContextEventArgs &args)
 
virtual void onRenderTargetChanged (GUIContextRenderTargetEventArgs &args)
 
virtual void onDefaultFontChanged (EventArgs &args)
 
void updateRootWindowAreaRects () const
 
void drawWindowContentToTarget ()
 
void renderWindowHierarchyToSurfaces ()
 
void createDefaultTooltipWindowInstance () const
 
void destroyDefaultTooltipWindowInstance ()
 
void notifyDefaultFontChanged (Window *hierarchy_root) const
 notify windows in a hierarchy using default font, when font changes.
 
bool mouseMoveInjection_impl (MouseEventArgs &ma)
 
WindowgetTargetWindow (const Vector2f &pt, const bool allow_disabled) const
 
WindowgetKeyboardTargetWindow () const
 
WindowgetCommonAncestor (Window *w1, Window *w2) const
 
void notifyMouseTransition (Window *top, Window *bottom, void(Window::*func)(MouseEventArgs &), MouseEventArgs &args) const
 call some function for a chain of windows: (top, bottom]
 
bool areaChangedHandler (const EventArgs &args)
 
bool windowDestroyedHandler (const EventArgs &args)
 
bool updateWindowContainingMouse_impl () const
 returns whether the window containing the mouse had changed.
 
void resetWindowContainingMouse ()
 
virtual void onRootWindowChanged (WindowEventArgs &args)
 
virtual void onMouseMoveScalingFactorChanged (GUIContextEventArgs &args)
 
virtual void onMouseButtonClickTimeoutChanged (GUIContextEventArgs &args)
 
virtual void onMouseButtonMultiClickTimeoutChanged (GUIContextEventArgs &args)
 
virtual void onMouseButtonMultiClickToleranceChanged (GUIContextEventArgs &args)
 
virtual void onRenderTargetChanged (GUIContextRenderTargetEventArgs &args)
 
virtual void onDefaultFontChanged (EventArgs &args)
 
void drawContent ()
 
- Protected Member Functions inherited from CEGUI::RenderingSurface
void draw (const RenderQueue &queue, RenderQueueEventArgs &args)
 draw a rendering queue, firing events before and after.
 
void detatchWindow (RenderingWindow &w)
 detatch ReneringWindow from this RenderingSurface
 
void attachWindow (RenderingWindow &w)
 attach ReneringWindow from this RenderingSurface
 
void draw (const RenderQueue &queue, RenderQueueEventArgs &args)
 draw a rendering queue, firing events before and after.
 
void detatchWindow (RenderingWindow &w)
 detatch ReneringWindow from this RenderingSurface
 
void attachWindow (RenderingWindow &w)
 attach ReneringWindow from this RenderingSurface
 
- Protected Member Functions inherited from CEGUI::EventSet
void fireEvent_impl (const String &name, EventArgs &args)
 Implementation event firing member.
 
ScriptModulegetScriptModule () const
 Helper to return the script module pointer or throw.
 
 EventSet (EventSet &)
 
EventSetoperator= (EventSet &)
 
void fireEvent_impl (const String &name, EventArgs &args)
 Implementation event firing member.
 
ScriptModulegetScriptModule () const
 Helper to return the script module pointer or throw.
 
 EventSet (EventSet &)
 
EventSetoperator= (EventSet &)
 
- Protected Attributes inherited from CEGUI::GUIContext
Windowd_rootWindow
 
bool d_isDirty
 
MouseCursor d_mouseCursor
 
float d_mouseMovementScalingFactor
 Scaling factor applied to injected mouse move deltas.
 
bool d_generateMouseClickEvents
 should mouse click/multi-click events be automatically generated.
 
float d_mouseButtonClickTimeout
 Timeout used to when detecting a single-click.
 
float d_mouseButtonMultiClickTimeout
 Timeout used when detecting multi-click events.
 
Sizef d_mouseButtonMultiClickTolerance
 Movement tolerance used when detecting multi-click events.
 
Tooltipd_defaultTooltipObject
 
bool d_weCreatedTooltipObject
 
String d_defaultTooltipType
 
Fontd_defaultFont
 
Sizef d_surfaceSize
 a cache of the target surface size, allows returning by ref.
 
Windowd_windowContainingMouse
 
bool d_windowContainingMouseIsUpToDate
 
Windowd_modalWindow
 
Windowd_captureWindow
 
SystemKeys d_systemKeys
 
MouseClickTrackerd_mouseClickTrackers
 
Event::ScopedConnection d_areaChangedEventConnection
 
Event::ScopedConnection d_windowDestroyedEventConnection
 
- Protected Attributes inherited from CEGUI::RenderingSurface
RenderQueueList d_queues
 the collection of RenderQueue objects.
 
RenderingWindowList d_windows
 collection of RenderingWindow object we own
 
RenderTargetd_target
 RenderTarget that this surface actually draws to.
 
bool d_invalidated
 holds invalidated state of target (as far as we are concerned)
 
- Protected Attributes inherited from CEGUI::EventSet
EventMap d_events
 
bool d_muted
 true if events for this EventSet have been muted.
 

Member Function Documentation

virtual void GUIContext_wrapper::draw ( void  )
inlinevirtual

Draw the GeometryBuffers for all rendering queues to the RenderTarget that this RenderingSurface is targetting.

The GeometryBuffers remain in the rendering queues after the draw operation is complete. This allows the next draw operation to occur without needing to requeue all the GeometryBuffers (if for instance the sequence of buffers to be drawn remains unchanged).

Reimplemented from CEGUI::GUIContext.

References CEGUI::GUIContext::draw().

Referenced by injectTimePulse(), and isRenderingWindow().

virtual void GUIContext_wrapper::drawContent ( )
inlinevirtual

draw the surface content. Default impl draws the render queues. NB: Called between RenderTarget activate and deactivate calls.

Reimplemented from CEGUI::GUIContext.

References CEGUI::GUIContext::drawContent(), and CEGUI::GUIContext::injectChar().

virtual bool GUIContext_wrapper::injectCopyRequest ( )
inlinevirtual

Tells the receiver to perform a clipboard copy operation.

Returns
  • true if the copy was successful
  • false if the copy was denied

Reimplemented from CEGUI::GUIContext.

References CEGUI::GUIContext::injectCopyRequest().

virtual bool GUIContext_wrapper::injectCutRequest ( )
inlinevirtual
virtual bool GUIContext_wrapper::injectMouseLeaves ( )
inlinevirtual

Function that notifies that the mouse has left the host area that the receiver receives input for.

Returns
  • true if the event was handled.
  • false if the event was not handled.

Reimplemented from CEGUI::GUIContext.

References CEGUI::GUIContext::injectMouseLeaves().

virtual bool GUIContext_wrapper::injectMouseMove ( float  delta_x,
float  delta_y 
)
inlinevirtual

Function that injects a mouse movement event into the receiver.

Parameters
delta_xamount the mouse moved on the x axis.
delta_yamount the mouse moved on the y axis.
Returns
  • true if the input was processed by the input receiver.
  • false if the input was not processed by the input receiver.

Reimplemented from CEGUI::GUIContext.

References CEGUI::GUIContext::injectMouseMove().

virtual bool GUIContext_wrapper::injectMousePosition ( float  x_pos,
float  y_pos 
)
inlinevirtual

Function that injects a new position for the mouse cursor.

Parameters
x_posNew absolute pixel position of the mouse cursor on the x axis.
y_posNew absolute pixel position of the mouse cursoe in the y axis.
Returns
  • true if the generated mouse move event was handled.
  • false if the generated mouse move event was not handled.

Reimplemented from CEGUI::GUIContext.

References CEGUI::GUIContext::injectMousePosition().

virtual bool GUIContext_wrapper::injectMouseWheelChange ( float  delta)
inlinevirtual

Function that injects a mouse-wheel / scroll-wheel event into the receiver.

Parameters
deltafloat value representing the amount the wheel moved.
Returns
  • true if the input was processed by the receiver.
  • false if the input was not processed by the receiver.

Reimplemented from CEGUI::GUIContext.

References CEGUI::GUIContext::injectMouseWheelChange().

virtual bool GUIContext_wrapper::injectPasteRequest ( )
inlinevirtual

Tells the system to perform a clipboard paste operation.

Returns
  • true if the paste was successful
  • false if the paste was denied

Reimplemented from CEGUI::GUIContext.

References CEGUI::GUIContext::injectPasteRequest().

virtual bool GUIContext_wrapper::injectTimePulse ( float  timeElapsed)
inlinevirtual

Function to inject time pulses into the receiver.

Parameters
timeElapsedfloat value indicating the amount of time passed, in seconds, since the last time this method was called.
Returns
Currently, this method always returns true.

Reimplemented from CEGUI::GUIContext.

References CEGUI::RenderingSurface::attachWindow(), CEGUI::RenderingSurface::destroyRenderingWindow(), CEGUI::RenderingSurface::detatchWindow(), draw(), CEGUI::RenderingSurface::draw(), CEGUI::EventSet::fireEvent(), CEGUI::EventSet::fireEvent_impl(), CEGUI::EventSet::getScriptModule(), CEGUI::GUIContext::injectTimePulse(), CEGUI::GUIContext::notifyDefaultFontChanged(), and CEGUI::GUIContext::updateWindowContainingMouse_impl().

virtual void GUIContext_wrapper::invalidate ( void  )
inlinevirtual

Marks the RenderingSurface as invalid, causing the geometry to be rerendered to the RenderTarget next time draw is called.

Note that some surface types can never be in a 'valid' state and so rerendering occurs whenever draw is called. This function mainly exists as a means to hint to other surface types - those that physically cache the rendered output - that geometry content has changed and the cached imagery should be cleared and redrawn.

Reimplemented from CEGUI::RenderingSurface.

References CEGUI::RenderingSurface::invalidate().

virtual bool GUIContext_wrapper::isRenderingWindow ( ) const
inlinevirtual

Return whether this RenderingSurface is actually an instance of the RenderingWindow subclass.

Returns
  • true to indicate the RenderingSurface is a RenderingWindow instance.
  • false to indicate the RenderingSurface is not a RenderingWindow.

Reimplemented from CEGUI::RenderingSurface.

References CEGUI::RenderingSurface::createRenderingWindow(), CEGUI::RenderingSurface::destroyRenderingWindow(), draw(), CEGUI::GUIContext::draw(), CEGUI::GUIContext::EventDefaultFontChanged, CEGUI::GUIContext::EventMouseButtonClickTimeoutChanged, CEGUI::GUIContext::EventMouseButtonMultiClickTimeoutChanged, CEGUI::GUIContext::EventMouseButtonMultiClickToleranceChanged, CEGUI::GUIContext::EventMouseMoveScalingFactorChanged, CEGUI::GUIContext::EventRenderTargetChanged, CEGUI::GUIContext::EventRootWindowChanged, CEGUI::EventSet::fireEvent(), CEGUI::GUIContext::getDefaultFont(), CEGUI::GUIContext::getDefaultTooltipObject(), CEGUI::GUIContext::getModalWindow(), CEGUI::GUIContext::getMouseCursor(), CEGUI::GUIContext::injectChar(), CEGUI::GUIContext::injectCopyRequest(), CEGUI::GUIContext::injectCutRequest(), CEGUI::GUIContext::injectKeyDown(), CEGUI::GUIContext::injectKeyUp(), CEGUI::GUIContext::injectMouseButtonClick(), CEGUI::GUIContext::injectMouseButtonDoubleClick(), CEGUI::GUIContext::injectMouseButtonDown(), CEGUI::GUIContext::injectMouseButtonTripleClick(), CEGUI::GUIContext::injectMouseButtonUp(), CEGUI::GUIContext::injectMouseLeaves(), CEGUI::GUIContext::injectMouseMove(), CEGUI::GUIContext::injectMousePosition(), CEGUI::GUIContext::injectMouseWheelChange(), CEGUI::GUIContext::injectPasteRequest(), CEGUI::GUIContext::injectTimePulse(), CEGUI::RenderingSurface::invalidate(), CEGUI::GUIContext::isMouseClickEventGenerationEnabled(), CEGUI::RenderingSurface::isRenderingWindow(), CEGUI::GUIContext::markAsDirty(), CEGUI::GUIContext::setDefaultFont(), CEGUI::GUIContext::setDefaultTooltipObject(), CEGUI::GUIContext::setDefaultTooltipType(), CEGUI::GUIContext::setModalWindow(), CEGUI::GUIContext::setMouseClickEventGenerationEnabled(), CEGUI::EventSet::subscribeScriptedEvent(), CEGUI::RenderingSurface::transferRenderingWindow(), and CEGUI::GUIContext::updateWindowContainingMouse().