#include <OpenGUI_Window.h>
Inheritance diagram for OpenGUI::Window:
Windows are ContainerControls that provide some basic built in window-like functionality, such as resizing and moving based on cursor input. It is up to the inheriting class to initiate and end these behaviors via the eventMove_Begin(), eventMove_End(), eventResize_Begin(), eventResize_End() functions. You will also need to ensure that m_Moveable and m_Resizable have the proper values, as they provide an overall lock mechanism for the built in functions.
Public Member Functions | |
| Window () | |
| public constructor | |
| virtual | ~Window () |
| public destructor | |
| virtual ObjectAccessorList * | getAccessors () |
| returns this object's ObjectAccessorList head | |
| virtual unsigned int | getObjectType () const |
| Returns an integer identifying the type of object. | |
Event Injectors | |
| void | eventMove_Begin () |
| Called to trigger beginning of a click & drag move sequence. | |
| void | eventMove_End () |
| Called to trigger end of a click & drag move sequence. | |
| void | eventResize_Begin (bool sizeHeight=true, bool sizeWidth=true, bool revWidth=false, bool revHeight=false) |
| Called to trigger beginning of a click & drag resize sequence. | |
| void | eventResize_End () |
| Called to trigger end of a click & drag resize sequence. | |
Protected Member Functions | |
Event Handlers | |
| virtual void | onMove_Begin (Object *sender, EventArgs &evtArgs) |
| "Move_Begin" event | |
| virtual void | onMove_End (Object *sender, EventArgs &evtArgs) |
| "Move_End" event | |
| virtual void | onResize_Begin (Object *sender, WindowResizeBeginEventArgs &evtArgs) |
| "Resize_Begin" event | |
| virtual void | onResize_End (Object *sender, EventArgs &evtArgs) |
| "Resize_End" event | |
| virtual void | onCursorMove (Object *sender, Cursor_EventArgs &evtArgs) |
"CursorMove" event, only allows Control to consume if ConsumeInput is true | |
| virtual void | onCursorFocused (Object *sender, Focus_EventArgs &evtArgs) |
| "CursorFocused" event | |
| virtual void | onCursorFocusLost (Object *sender, Focus_EventArgs &evtArgs) |
| "CursorFocusLost" event | |
| OpenGUI::Window::Window | ( | ) |
public constructor
| OpenGUI::Window::~Window | ( | ) | [virtual] |
public destructor
| void OpenGUI::Window::eventMove_Begin | ( | ) |
Called to trigger beginning of a click & drag move sequence.
| void OpenGUI::Window::eventMove_End | ( | ) |
Called to trigger end of a click & drag move sequence.
| void OpenGUI::Window::eventResize_Begin | ( | bool | sizeHeight = true, |
|
| bool | sizeWidth = true, |
|||
| bool | revWidth = false, |
|||
| bool | revHeight = false | |||
| ) |
Called to trigger beginning of a click & drag resize sequence.
The reversal arguments allow you to control how the cursor affects the window resizing. By reversing an axis, the window sizing effect will be reversed along that axis, and the window will be moved as necessary to keep the opposite side to remain stationary.
| void OpenGUI::Window::eventResize_End | ( | ) |
Called to trigger end of a click & drag resize sequence.
| ObjectAccessorList * OpenGUI::Window::getAccessors | ( | ) | [virtual] |
| unsigned int OpenGUI::Window::getObjectType | ( | ) | const [virtual] |
Returns an integer identifying the type of object.
Reimplemented from OpenGUI::ContainerControl.
| void OpenGUI::Window::onCursorFocused | ( | Object * | sender, | |
| Focus_EventArgs & | evtArgs | |||
| ) | [protected, virtual] |
| void OpenGUI::Window::onCursorFocusLost | ( | Object * | sender, | |
| Focus_EventArgs & | evtArgs | |||
| ) | [protected, virtual] |
| void OpenGUI::Window::onCursorMove | ( | Object * | sender, | |
| Cursor_EventArgs & | evtArgs | |||
| ) | [protected, virtual] |
"CursorMove" event, only allows Control to consume if ConsumeInput is true
Reimplemented from OpenGUI::ContainerControl.
"Move_Begin" event
"Move_End" event
| void OpenGUI::Window::onResize_Begin | ( | Object * | sender, | |
| WindowResizeBeginEventArgs & | evtArgs | |||
| ) | [protected, virtual] |
"Resize_Begin" event
"Resize_End" event