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 | initialiseComponents (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 | 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 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 pixel position would hit this window. | |
Titlebar * | getTitlebar () const |
Return a pointer to the Titlebar component widget for this FrameWindow. | |
PushButton * | getCloseButton () const |
Return a pointer to the close button component widget for this FrameWindow. | |
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 | WidgetTypeName |
Window factory name. | |
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). | |
static const String | TitlebarNameSuffix |
Widget name suffix for the titlebar component. | |
static const String | CloseButtonNameSuffix |
Widget name suffix for the close button component. | |
Protected Member Functions | |
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. | |
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 hierarchy. | |
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. | |
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. |
Enumeration that defines the set of possible locations for the mouse on a frame windows sizing border.
PushButton * CEGUI::FrameWindow::getCloseButton | ( | ) | const |
Return a pointer to the close button component widget for this FrameWindow.
UnknownObjectException | Thrown if the close button component does not exist. |
References CloseButtonNameSuffix, and CEGUI::Window::getName().
Referenced by initialiseComponents(), isCloseButtonEnabled(), and setCloseButtonEnabled().
const Image * CEGUI::FrameWindow::getEWSizingCursorImage | ( | ) | const |
Return a pointer to the currently set Image to be used for the east-west sizing mouse cursor.
References d_ewSizingCursor.
const Image * CEGUI::FrameWindow::getNESWSizingCursorImage | ( | ) | const |
Return a pointer to the currently set Image to be used for the northeast-southwest sizing mouse cursor.
References d_neswSizingCursor.
const Image * CEGUI::FrameWindow::getNSSizingCursorImage | ( | ) | const |
Return a pointer to the currently set Image to be used for the north-south sizing mouse cursor.
References d_nsSizingCursor.
const Image * CEGUI::FrameWindow::getNWSESizingCursorImage | ( | ) | const |
Return a pointer to the currently set Image to be used for the northwest-southeast sizing mouse cursor.
References d_nwseSizingCursor.
FrameWindow::SizingLocation CEGUI::FrameWindow::getSizingBorderAtPoint | ( | const Point & | pt | ) | const [protected] |
check local pixel co-ordinate point 'pt' and return one of the SizingLocation enumerated values depending where the point falls on the sizing border.
pt | Point object describing, in pixels, the window relative offset to check. |
References d_borderSize, CEGUI::Rect::d_bottom, CEGUI::Rect::d_left, CEGUI::Rect::d_right, CEGUI::Rect::d_top, CEGUI::Vector2::d_x, CEGUI::Vector2::d_y, getSizingRect(), isFrameEnabled(), CEGUI::Rect::isPointInRect(), isSizingEnabled(), SizingBottom, SizingBottomLeft, SizingBottomRight, SizingLeft, SizingNone, SizingRight, SizingTop, SizingTopLeft, and SizingTopRight.
Referenced by onMouseButtonDown(), onMouseMove(), and setCursorForPoint().
float CEGUI::FrameWindow::getSizingBorderThickness | ( | void | ) | const [inline] |
Return the thickness of the sizing border.
Titlebar * CEGUI::FrameWindow::getTitlebar | ( | ) | const |
Return a pointer to the Titlebar component widget for this FrameWindow.
UnknownObjectException | Thrown if the Titlebar component does not exist. |
References CEGUI::Window::getName(), and TitlebarNameSuffix.
Referenced by CEGUI::FalagardFrameWindow::getUnclippedInnerRect(), initialiseComponents(), isTitleBarEnabled(), onActivated(), onDeactivated(), onTextChanged(), CEGUI::FalagardFrameWindow::render(), setDragMovingEnabled(), and setTitleBarEnabled().
void CEGUI::FrameWindow::initialiseComponents | ( | void | ) | [virtual] |
Initialises the Window based object ready for use.
Reimplemented from CEGUI::Window.
References closeClickHandler(), d_dragMovable, CEGUI::Window::d_text, CEGUI::PushButton::EventClicked, getCloseButton(), getTitlebar(), CEGUI::Window::performChildWindowLayout(), CEGUI::Titlebar::setDraggingEnabled(), CEGUI::Window::setText(), and CEGUI::EventSet::subscribeEvent().
bool CEGUI::FrameWindow::isBottomSizingLocation | ( | SizingLocation | loc | ) | const [inline, protected] |
return true if given SizingLocation is on bottom edge.
loc | SizingLocation value to be checked. |
Referenced by onMouseMove().
bool CEGUI::FrameWindow::isCloseButtonEnabled | ( | void | ) | const |
Return whether this close button for this window is enabled.
References getCloseButton(), and CEGUI::Window::isDisabled().
bool CEGUI::FrameWindow::isDragMovingEnabled | ( | void | ) | const [inline] |
Return whether this FrameWindow can be moved by dragging the title bar.
bool CEGUI::FrameWindow::isFrameEnabled | ( | void | ) | const [inline] |
Return whether the frame for this window is enabled.
Referenced by getSizingBorderAtPoint(), CEGUI::FalagardFrameWindow::getUnclippedInnerRect(), and CEGUI::FalagardFrameWindow::render().
bool CEGUI::FrameWindow::isHit | ( | const Point & | position | ) | const [inline, virtual] |
check if the given pixel position would hit this window.
position | Vector2 object describing the position to check. The position describes a pixel offset from the top-left corner of the display. |
Reimplemented from CEGUI::Window.
References CEGUI::Window::isHit().
bool CEGUI::FrameWindow::isLeftSizingLocation | ( | SizingLocation | loc | ) | const [inline, protected] |
return true if given SizingLocation is on left edge.
loc | SizingLocation value to be checked. |
Referenced by onMouseMove().
bool CEGUI::FrameWindow::isRightSizingLocation | ( | SizingLocation | loc | ) | const [inline, protected] |
return true if given SizingLocation is on right edge.
loc | SizingLocation value to be checked. |
Referenced by onMouseMove().
bool CEGUI::FrameWindow::isRolledup | ( | void | ) | const [inline] |
Return whether the window is currently rolled up (a.k.a shaded).
Referenced by CEGUI::FalagardFrameWindow::getUnclippedInnerRect(), CEGUI::FalagardFrameWindow::render(), and setRollupEnabled().
bool CEGUI::FrameWindow::isRollupEnabled | ( | void | ) | const [inline] |
Return whether roll up (a.k.a shading) is enabled for this window.
Referenced by toggleRollup().
bool CEGUI::FrameWindow::isSizingEnabled | ( | void | ) | const [inline] |
Return whether this window is sizable. Note that this requires that the window have an enabled frame and that sizing itself is enabled.
Referenced by getSizingBorderAtPoint(), onMouseButtonDown(), and onMouseMove().
bool CEGUI::FrameWindow::isTitleBarEnabled | ( | void | ) | const |
Return whether the title bar for this window is enabled.
References getTitlebar(), and CEGUI::Window::isDisabled().
bool CEGUI::FrameWindow::isTopSizingLocation | ( | SizingLocation | loc | ) | const [inline, protected] |
return true if given SizingLocation is on top edge.
loc | SizingLocation value to be checked. |
Referenced by onMouseMove().
void CEGUI::FrameWindow::moveBottomEdge | ( | float | delta | ) | [protected] |
move the window's bottom edge by 'delta'. The rest of the window does not move, thus this changes the size of the Window.
delta | float value that specifies the amount to move the window edge, and in which direction. Positive values make window larger. |
References CEGUI::UDim::asAbsolute(), CEGUI::Window::d_area, d_dragPoint, CEGUI::Size::d_height, CEGUI::URect::d_max, CEGUI::Window::d_maxSize, CEGUI::URect::d_min, CEGUI::Window::d_minSize, CEGUI::UDim::d_offset, CEGUI::Window::d_pixelSize, CEGUI::Window::d_vertAlign, CEGUI::Vector2::d_y, CEGUI::UVector2::d_y, CEGUI::Renderer::getHeight(), CEGUI::System::getRenderer(), CEGUI::System::getSingleton(), CEGUI::URect::getSize(), CEGUI::Window::setArea_impl(), CEGUI::VA_BOTTOM, and CEGUI::VA_CENTRE.
Referenced by onMouseMove().
void CEGUI::FrameWindow::moveLeftEdge | ( | float | delta | ) | [protected] |
move the window's left edge by 'delta'. The rest of the window does not move, thus this changes the size of the Window.
delta | float value that specifies the amount to move the window edge, and in which direction. Positive values make window smaller. |
References CEGUI::UDim::asAbsolute(), CEGUI::Window::d_area, CEGUI::Window::d_horzAlign, CEGUI::URect::d_max, CEGUI::Window::d_maxSize, CEGUI::URect::d_min, CEGUI::Window::d_minSize, CEGUI::UDim::d_offset, CEGUI::Window::d_pixelSize, CEGUI::Size::d_width, CEGUI::UVector2::d_x, CEGUI::System::getRenderer(), CEGUI::System::getSingleton(), CEGUI::URect::getSize(), CEGUI::Renderer::getWidth(), CEGUI::HA_CENTRE, CEGUI::HA_LEFT, CEGUI::HA_RIGHT, and CEGUI::Window::setArea_impl().
Referenced by onMouseMove().
void CEGUI::FrameWindow::moveRightEdge | ( | float | delta | ) | [protected] |
move the window's right edge by 'delta'. The rest of the window does not move, thus this changes the size of the Window.
delta | float value that specifies the amount to move the window edge, and in which direction. Positive values make window larger. |
References CEGUI::UDim::asAbsolute(), CEGUI::Window::d_area, d_dragPoint, CEGUI::Window::d_horzAlign, CEGUI::URect::d_max, CEGUI::Window::d_maxSize, CEGUI::URect::d_min, CEGUI::Window::d_minSize, CEGUI::UDim::d_offset, CEGUI::Window::d_pixelSize, CEGUI::Size::d_width, CEGUI::Vector2::d_x, CEGUI::UVector2::d_x, CEGUI::System::getRenderer(), CEGUI::System::getSingleton(), CEGUI::URect::getSize(), CEGUI::Renderer::getWidth(), CEGUI::HA_CENTRE, CEGUI::HA_RIGHT, and CEGUI::Window::setArea_impl().
Referenced by onMouseMove().
void CEGUI::FrameWindow::moveTopEdge | ( | float | delta | ) | [protected] |
move the window's top edge by 'delta'. The rest of the window does not move, thus this changes the size of the Window.
delta | float value that specifies the amount to move the window edge, and in which direction. Positive values make window smaller. |
References CEGUI::UDim::asAbsolute(), CEGUI::Window::d_area, CEGUI::Size::d_height, CEGUI::URect::d_max, CEGUI::Window::d_maxSize, CEGUI::URect::d_min, CEGUI::Window::d_minSize, CEGUI::UDim::d_offset, CEGUI::Window::d_pixelSize, CEGUI::Window::d_vertAlign, CEGUI::UVector2::d_y, CEGUI::Renderer::getHeight(), CEGUI::System::getRenderer(), CEGUI::System::getSingleton(), CEGUI::URect::getSize(), CEGUI::Window::setArea_impl(), CEGUI::VA_BOTTOM, CEGUI::VA_CENTRE, and CEGUI::VA_TOP.
Referenced by onMouseMove().
void CEGUI::FrameWindow::offsetPixelPosition | ( | const Vector2 & | offset | ) |
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.
offset | Vector2 object containing the offsets to apply (offsets are in screen pixels). |
References CEGUI::Window::d_area, CEGUI::Vector2::d_x, CEGUI::Vector2::d_y, CEGUI::URect::getPosition(), and CEGUI::Window::setPosition().
void CEGUI::FrameWindow::onActivated | ( | ActivationEventArgs & | e | ) | [protected, virtual] |
Handler called when this window has become the active window.
e | ActivationEventArgs class whose 'otherWindow' field is set to the window that previously was active, or NULL for none. |
Reimplemented from CEGUI::Window.
References getTitlebar(), and CEGUI::Window::requestRedraw().
void CEGUI::FrameWindow::onCaptureLost | ( | WindowEventArgs & | e | ) | [protected, virtual] |
Handler called when this window loses capture of mouse inputs.
e | WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'. |
Reimplemented from CEGUI::Window.
References d_beingSized, and CEGUI::EventArgs::handled.
void CEGUI::FrameWindow::onDeactivated | ( | ActivationEventArgs & | e | ) | [protected, virtual] |
Handler called when this window has lost input focus and has been deactivated.
e | ActivationEventArgs object whose 'otherWindow' field is set to the window that has now become active, or NULL for none. |
Reimplemented from CEGUI::Window.
References getTitlebar(), and CEGUI::Window::requestRedraw().
void CEGUI::FrameWindow::onMouseButtonDown | ( | MouseEventArgs & | e | ) | [protected, virtual] |
Handler called when a mouse button has been depressed within this window's area.
e | MouseEventArgs object. All fields are valid. |
Reimplemented from CEGUI::Window.
References CEGUI::MouseEventArgs::button, CEGUI::Window::captureInput(), d_beingSized, d_dragPoint, getSizingBorderAtPoint(), CEGUI::EventArgs::handled, isSizingEnabled(), CEGUI::LeftButton, CEGUI::MouseEventArgs::position, CEGUI::CoordConverter::screenToWindow(), and SizingNone.
void CEGUI::FrameWindow::onMouseButtonUp | ( | MouseEventArgs & | e | ) | [protected, virtual] |
Handler called when a mouse button has been released within this window's area.
e | MouseEventArgs object. All fields are valid. |
Reimplemented from CEGUI::Window.
References CEGUI::MouseEventArgs::button, CEGUI::EventArgs::handled, CEGUI::Window::isCapturedByThis(), CEGUI::LeftButton, and CEGUI::Window::releaseInput().
void CEGUI::FrameWindow::onMouseMove | ( | MouseEventArgs & | e | ) | [protected, virtual] |
Handler called when the mouse cursor has been moved within this window's area.
e | MouseEventArgs object. All fields are valid. |
Reimplemented from CEGUI::Window.
References d_beingSized, d_dragPoint, CEGUI::Vector2::d_x, CEGUI::Vector2::d_y, CEGUI::System::getSingleton(), getSizingBorderAtPoint(), CEGUI::EventArgs::handled, isBottomSizingLocation(), isLeftSizingLocation(), isRightSizingLocation(), isSizingEnabled(), isTopSizingLocation(), moveBottomEdge(), moveLeftEdge(), moveRightEdge(), moveTopEdge(), CEGUI::MouseEventArgs::position, CEGUI::CoordConverter::screenToWindow(), and setCursorForPoint().
void CEGUI::FrameWindow::onTextChanged | ( | WindowEventArgs & | e | ) | [protected, virtual] |
Handler called when the window's text is changed.
e | WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'. |
Reimplemented from CEGUI::Window.
References CEGUI::Window::d_text, getTitlebar(), CEGUI::Window::performChildWindowLayout(), and CEGUI::Window::setText().
void CEGUI::FrameWindow::setCloseButtonEnabled | ( | bool | setting | ) |
Enables or disables the close button for the frame window.
setting | Set to true to enable the close button (if one is attached), or false to disable the close button. |
References getCloseButton(), CEGUI::Window::setEnabled(), and CEGUI::Window::setVisible().
void CEGUI::FrameWindow::setDragMovingEnabled | ( | bool | setting | ) |
Set whether this FrameWindow can be moved by dragging the title bar.
setting | true if the Window should move when the user drags the title bar, false if the window should not move. |
References d_dragMovable, getTitlebar(), and CEGUI::Titlebar::setDraggingEnabled().
Set the image to be used for the east-west sizing mouse cursor.
imageset | String holding the name of the Imageset containing the Image to be used. | |
image | String holding the name of the Image to be used. |
UnknownObjectException | thrown if either imageset or image refer to non-existant entities. |
References d_ewSizingCursor, CEGUI::Imageset::getImage(), and CEGUI::Image::getImageset().
void CEGUI::FrameWindow::setEWSizingCursorImage | ( | const Image * | image | ) |
Set the Image to be used for the east-west sizing mouse cursor.
image | Pointer to an Image object, or 0 for none. |
References d_ewSizingCursor.
void CEGUI::FrameWindow::setFrameEnabled | ( | bool | setting | ) |
Enables or disables the frame for this window.
setting | set to true to enable the frame for this window, or false to disable the frame for this window. |
References d_frameEnabled, and CEGUI::Window::requestRedraw().
Set the image to be used for the northeast-southwest sizing mouse cursor.
imageset | String holding the name of the Imageset containing the Image to be used. | |
image | String holding the name of the Image to be used. |
UnknownObjectException | thrown if either imageset or image refer to non-existant entities. |
References d_neswSizingCursor, CEGUI::Imageset::getImage(), and CEGUI::Image::getImageset().
void CEGUI::FrameWindow::setNESWSizingCursorImage | ( | const Image * | image | ) |
Set the Image to be used for the northeast-southwest sizing mouse cursor.
image | Pointer to an Image object, or 0 for none. |
References d_neswSizingCursor.
Set the image to be used for the north-south sizing mouse cursor.
imageset | String holding the name of the Imageset containing the Image to be used. | |
image | String holding the name of the Image to be used. |
UnknownObjectException | thrown if either imageset or image refer to non-existant entities. |
References d_nsSizingCursor, CEGUI::Imageset::getImage(), and CEGUI::Image::getImageset().
void CEGUI::FrameWindow::setNSSizingCursorImage | ( | const Image * | image | ) |
Set the Image to be used for the north-south sizing mouse cursor.
image | Pointer to an Image object, or 0 for none. |
References d_nsSizingCursor.
Set the image to be used for the northwest-southeast sizing mouse cursor.
imageset | String holding the name of the Imageset containing the Image to be used. | |
image | String holding the name of the Image to be used. |
UnknownObjectException | thrown if either imageset or image refer to non-existant entities. |
References d_nwseSizingCursor, CEGUI::Imageset::getImage(), and CEGUI::Image::getImageset().
void CEGUI::FrameWindow::setNWSESizingCursorImage | ( | const Image * | image | ) |
Set the Image to be used for the northwest-southeast sizing mouse cursor.
image | Pointer to an Image object, or 0 for none. |
References d_nwseSizingCursor.
void CEGUI::FrameWindow::setRollupEnabled | ( | bool | setting | ) |
Enables or disables roll-up (shading) for this window.
setting | Set to true to enable roll-up for the frame window, or false to disable roll-up. |
References d_rollupEnabled, isRolledup(), and toggleRollup().
void CEGUI::FrameWindow::setSizingBorderThickness | ( | float | pixels | ) | [inline] |
Set the size of the sizing border for this window.
pixels | float value specifying the thickness for the sizing border in screen pixels. |
void CEGUI::FrameWindow::setSizingEnabled | ( | bool | setting | ) |
Enables or disables sizing for this window.
setting | set to true to enable sizing (also requires frame to be enabled), or false to disable sizing. |
References d_sizingEnabled.
void CEGUI::FrameWindow::setTitleBarEnabled | ( | bool | setting | ) |
Enables or disables the title bar for the frame window.
setting | set to true to enable the title bar (if one is attached), or false to disable the title bar. |
References getTitlebar(), CEGUI::Window::setEnabled(), and CEGUI::Window::setVisible().
virtual bool CEGUI::FrameWindow::testClassName_impl | ( | const String & | class_name | ) | const [inline, protected, virtual] |
Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.
class_name | The class name that is to be checked. |
Reimplemented from CEGUI::Window.
References CEGUI::Window::testClassName_impl().
void CEGUI::FrameWindow::toggleRollup | ( | void | ) |
Toggles the state of the window between rolled-up (shaded) and normal sizes. This requires roll-up to be enabled.
References d_rolledup, CEGUI::System::getSingleton(), isRollupEnabled(), onRollupToggled(), and CEGUI::System::updateWindowContainingMouse().
Referenced by setRollupEnabled().