Inheritance diagram for CEGUI::FrameWindow:
Public Types | |
enum | SizingLocation { SizingNone, SizingTopLeft, SizingTopRight, SizingBottomLeft, SizingBottomRight, SizingTop, SizingLeft, SizingBottom, SizingRight } |
Enumeration that defines the set of possible locations for the mouse on a frame windows sizing border. More... | |
Public Member Functions | |
virtual void | initialise (void) |
Initialises the Window based object ready for use. | |
bool | isSizingEnabled (void) const |
Return whether this window is sizable. Note that this requires that the window have an enabled frame and that sizing itself is enabled. | |
bool | isFrameEnabled (void) const |
Return whether the frame for this window is enabled. | |
bool | isTitleBarEnabled (void) const |
Return whether the title bar for this window is enabled. | |
bool | isCloseButtonEnabled (void) const |
Return whether this close button for this window is enabled. | |
bool | isRollupEnabled (void) const |
Return whether roll up (a.k.a shading) is enabled for this window. | |
bool | isRolledup (void) const |
Return whether the window is currently rolled up (a.k.a shaded). | |
float | getSizingBorderThickness (void) const |
Return the thickness of the sizing border. | |
void | setSizingEnabled (bool setting) |
Enables or disables sizing for this window. | |
void | setFrameEnabled (bool setting) |
Enables or disables the frame for this window. | |
void | setTitleBarEnabled (bool setting) |
Enables or disables the title bar for the frame window. | |
void | setCloseButtonEnabled (bool setting) |
Enables or disables the close button for the frame window. | |
void | setRollupEnabled (bool setting) |
Enables or disables roll-up (shading) for this window. | |
void | toggleRollup (void) |
Toggles the state of the window between rolled-up (shaded) and normal sizes. This requires roll-up to be enabled. | |
void | setSizingBorderThickness (float pixels) |
Set the size of the sizing border for this window. | |
void | setTitlebarFont (const String &name) |
Set the font to use for the title bar text. | |
void | setTitlebarFont (Font *font) |
Set the font to use for the title bar text. | |
void | offsetPixelPosition (const Vector2 &offset) |
Move the window by the pixel offsets specified in offset. | |
bool | isDragMovingEnabled (void) const |
Return whether this FrameWindow can be moved by dragging the title bar. | |
void | setDragMovingEnabled (bool setting) |
Set whether this FrameWindow can be moved by dragging the title bar. | |
const Font * | getTitlebarFont (void) const |
Return the font being used for the title bar text. | |
colour | getCaptionColour (void) const |
Return the current colour used for rendering the caption text. | |
void | setCaptionColour (colour col) |
Sets the colour to be used for rendering the caption text. | |
const Image * | getNSSizingCursorImage () const |
Return a pointer to the currently set Image to be used for the north-south sizing mouse cursor. | |
const Image * | getEWSizingCursorImage () const |
Return a pointer to the currently set Image to be used for the east-west sizing mouse cursor. | |
const Image * | getNWSESizingCursorImage () const |
Return a pointer to the currently set Image to be used for the northwest-southeast sizing mouse cursor. | |
const Image * | getNESWSizingCursorImage () const |
Return a pointer to the currently set Image to be used for the northeast-southwest sizing mouse cursor. | |
void | setNSSizingCursorImage (const Image *image) |
Set the Image to be used for the north-south sizing mouse cursor. | |
void | setEWSizingCursorImage (const Image *image) |
Set the Image to be used for the east-west sizing mouse cursor. | |
void | setNWSESizingCursorImage (const Image *image) |
Set the Image to be used for the northwest-southeast sizing mouse cursor. | |
void | setNESWSizingCursorImage (const Image *image) |
Set the Image to be used for the northeast-southwest sizing mouse cursor. | |
void | setNSSizingCursorImage (const String &imageset, const String &image) |
Set the image to be used for the north-south sizing mouse cursor. | |
void | setEWSizingCursorImage (const String &imageset, const String &image) |
Set the image to be used for the east-west sizing mouse cursor. | |
void | setNWSESizingCursorImage (const String &imageset, const String &image) |
Set the image to be used for the northwest-southeast sizing mouse cursor. | |
void | setNESWSizingCursorImage (const String &imageset, const String &image) |
Set the image to be used for the northeast-southwest sizing mouse cursor. | |
bool | isHit (const Point &position) const |
check if the given position would hit this window. | |
FrameWindow (const String &name, const String &type) | |
Constructor for FrameWindow objects. | |
virtual | ~FrameWindow (void) |
Destructor for FramwWindow objects. | |
Static Public Attributes | |
static const String | EventNamespace |
Namespace for global events. | |
static const String | EventRollupToggled |
Fired when the rollup (shade) state of the window changes. | |
static const String | EventCloseClicked |
Fired when the close button for the window is clicked. | |
static const float | DefaultSizingBorderSize = 8.0f |
Default size for the sizing border (in pixels). | |
Protected Member Functions | |
virtual Titlebar * | createTitlebar (const String &name) const =0 |
Create a control based upon the Titlebar base class to be used as the title bar for this window. | |
virtual PushButton * | createCloseButton (const String &name) const =0 |
Create a control based upon the PushButton base class, to be used at the close button for the window. | |
void | moveLeftEdge (float delta) |
move the window's left edge by 'delta'. The rest of the window does not move, thus this changes the size of the Window. | |
void | moveRightEdge (float delta) |
move the window's right edge by 'delta'. The rest of the window does not move, thus this changes the size of the Window. | |
void | moveTopEdge (float delta) |
move the window's top edge by 'delta'. The rest of the window does not move, thus this changes the size of the Window. | |
void | moveBottomEdge (float delta) |
move the window's bottom edge by 'delta'. The rest of the window does not move, thus this changes the size of the Window. | |
SizingLocation | getSizingBorderAtPoint (const Point &pt) const |
check local pixel co-ordinate point 'pt' and return one of the SizingLocation enumerated values depending where the point falls on the sizing border. | |
bool | isLeftSizingLocation (SizingLocation loc) const |
return true if given SizingLocation is on left edge. | |
bool | isRightSizingLocation (SizingLocation loc) const |
return true if given SizingLocation is on right edge. | |
bool | isTopSizingLocation (SizingLocation loc) const |
return true if given SizingLocation is on top edge. | |
bool | isBottomSizingLocation (SizingLocation loc) const |
return true if given SizingLocation is on bottom edge. | |
void | addFrameWindowEvents (void) |
Add frame window specific events. | |
bool | closeClickHandler (const EventArgs &e) |
Method to respond to close button click events and fire our close event. | |
void | setCursorForPoint (const Point &pt) const |
Set the appropriate mouse cursor for the given window-relative pixel point. | |
virtual Rect | getSizingRect (void) const |
Return a Rect that describes, in window relative pixel co-ordinates, the outer edge of the sizing area for this window. | |
virtual bool | testClassName_impl (const String &class_name) const |
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy. | |
virtual void | onRollupToggled (WindowEventArgs &e) |
Event generated internally whenever the roll-up / shade state of the window changes. | |
virtual void | onCloseClicked (WindowEventArgs &e) |
Event generated internally whenever the close button is clicked. | |
virtual void | onMouseMove (MouseEventArgs &e) |
Handler called when the mouse cursor has been moved within this window's area. | |
virtual void | onMouseButtonDown (MouseEventArgs &e) |
Handler called when a mouse button has been depressed within this window's area. | |
virtual void | onMouseButtonUp (MouseEventArgs &e) |
Handler called when a mouse button has been released within this window's area. | |
virtual void | onCaptureLost (WindowEventArgs &e) |
Handler called when this window loses capture of mouse inputs. | |
virtual void | onTextChanged (WindowEventArgs &e) |
Handler called when the window's text is changed. | |
virtual void | onActivated (ActivationEventArgs &e) |
Handler called when this window has become the active window. | |
virtual void | onDeactivated (ActivationEventArgs &e) |
Handler called when this window has lost input focus and has been deactivated. | |
Protected Attributes | |
bool | d_frameEnabled |
true if window frame should be drawn. | |
bool | d_rollupEnabled |
true if roll-up of window is allowed. | |
bool | d_rolledup |
true if window is rolled up. | |
bool | d_sizingEnabled |
true if sizing is enabled for this window. | |
bool | d_beingSized |
true if window is being sized. | |
float | d_borderSize |
thickness of the sizing border around this window | |
Point | d_dragPoint |
point window is being dragged at. | |
Titlebar * | d_titlebar |
points to the title bar widget. | |
PushButton * | d_closeButton |
points to close button widget. | |
const Image * | d_nsSizingCursor |
North/South sizing cursor image. | |
const Image * | d_ewSizingCursor |
East/West sizing cursor image. | |
const Image * | d_nwseSizingCursor |
North-West/South-East cursor image. | |
const Image * | d_neswSizingCursor |
North-East/South-West cursor image. | |
bool | d_dragMovable |
true if the window will move when dragged by the title bar. |
|
|
Create a control based upon the PushButton base class, to be used at the close button for the window.
|
|
Create a control based upon the Titlebar base class to be used as the title bar for this window.
|
|
Return the current colour used for rendering the caption text.
|
|
Return a pointer to the currently set Image to be used for the east-west sizing mouse cursor.
|
|
Return a pointer to the currently set Image to be used for the northeast-southwest sizing mouse cursor.
|
|
Return a pointer to the currently set Image to be used for the north-south sizing mouse cursor.
|
|
Return a pointer to the currently set Image to be used for the northwest-southeast sizing mouse cursor.
|
|
check local pixel co-ordinate point 'pt' and return one of the SizingLocation enumerated values depending where the point falls on the sizing border.
|
|
Return the thickness of the sizing border.
|
|
Return the font being used for the title bar text.
|
|
Initialises the Window based object ready for use.
Reimplemented from CEGUI::Window. |
|
return true if given SizingLocation is on bottom edge.
|
|
Return whether this close button for this window is enabled.
|
|
Return whether this FrameWindow can be moved by dragging the title bar.
|
|
Return whether the frame for this window is enabled.
|
|
check if the given position would hit this window.
Reimplemented from CEGUI::Window. |
|
return true if given SizingLocation is on left edge.
|
|
return true if given SizingLocation is on right edge.
|
|
Return whether the window is currently rolled up (a.k.a shaded).
|
|
Return whether roll up (a.k.a shading) is enabled for this window.
|
|
Return whether this window is sizable. Note that this requires that the window have an enabled frame and that sizing itself is enabled.
|
|
Return whether the title bar for this window is enabled.
|
|
return true if given SizingLocation is on top edge.
|
|
move the window's bottom edge by 'delta'. The rest of the window does not move, thus this changes the size of the Window.
|
|
move the window's left edge by 'delta'. The rest of the window does not move, thus this changes the size of the Window.
|
|
move the window's right edge by 'delta'. The rest of the window does not move, thus this changes the size of the Window.
|
|
move the window's top edge by 'delta'. The rest of the window does not move, thus this changes the size of the Window.
|
|
Move the window by the pixel offsets specified in offset. This is intended for internal system use - it is the method by which the title bar moves the frame window.
|
|
Handler called when this window has become the active window.
Reimplemented from CEGUI::Window. |
|
Handler called when this window loses capture of mouse inputs.
Reimplemented from CEGUI::Window. |
|
Handler called when this window has lost input focus and has been deactivated.
Reimplemented from CEGUI::Window. |
|
Handler called when a mouse button has been depressed within this window's area.
Reimplemented from CEGUI::Window. |
|
Handler called when a mouse button has been released within this window's area.
Reimplemented from CEGUI::Window. |
|
Handler called when the mouse cursor has been moved within this window's area.
Reimplemented from CEGUI::Window. |
|
Handler called when the window's text is changed.
Reimplemented from CEGUI::Window. |
|
Sets the colour to be used for rendering the caption text.
|
|
Enables or disables the close button for the frame window.
|
|
Set whether this FrameWindow can be moved by dragging the title bar.
|
|
Set the image to be used for the east-west sizing mouse cursor.
|
|
Set the Image to be used for the east-west sizing mouse cursor.
|
|
Enables or disables the frame for this window.
|
|
Set the image to be used for the northeast-southwest sizing mouse cursor.
|
|
Set the Image to be used for the northeast-southwest sizing mouse cursor.
|
|
Set the image to be used for the north-south sizing mouse cursor.
|
|
Set the Image to be used for the north-south sizing mouse cursor.
|
|
Set the image to be used for the northwest-southeast sizing mouse cursor.
|
|
Set the Image to be used for the northwest-southeast sizing mouse cursor.
|
|
Enables or disables roll-up (shading) for this window.
|
|
Set the size of the sizing border for this window.
|
|
Enables or disables sizing for this window.
|
|
Enables or disables the title bar for the frame window.
|
|
Set the font to use for the title bar text.
|
|
Set the font to use for the title bar text.
|
|
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy.
Reimplemented from CEGUI::Window. |
|
Toggles the state of the window between rolled-up (shaded) and normal sizes. This requires roll-up to be enabled.
|