30 #ifndef _CEGUIFrameWindow_h_
31 #define _CEGUIFrameWindow_h_
33 #include "../CEGUIBase.h"
34 #include "../CEGUIWindow.h"
35 #include "CEGUIFrameWindowProperties.h"
39 # pragma warning(push)
40 # pragma warning(disable : 4251)
122 virtual void initialiseComponents(
void);
152 bool isTitleBarEnabled(
void)
const;
162 bool isCloseButtonEnabled(
void)
const;
205 void setSizingEnabled(
bool setting);
218 void setFrameEnabled(
bool setting);
231 void setTitleBarEnabled(
bool setting);
244 void setCloseButtonEnabled(
bool setting);
257 void setRollupEnabled(
bool setting);
267 void toggleRollup(
void);
295 void offsetPixelPosition(
const Vector2& offset);
318 void setDragMovingEnabled(
bool setting);
329 const Image* getNSSizingCursorImage()
const;
339 const Image* getEWSizingCursorImage()
const;
349 const Image* getNWSESizingCursorImage()
const;
359 const Image* getNESWSizingCursorImage()
const;
371 void setNSSizingCursorImage(
const Image* image);
383 void setEWSizingCursorImage(
const Image* image);
395 void setNWSESizingCursorImage(
const Image* image);
407 void setNESWSizingCursorImage(
const Image* image);
424 void setNSSizingCursorImage(
const String& imageset,
const String& image);
441 void setEWSizingCursorImage(
const String& imageset,
const String& image);
458 void setNWSESizingCursorImage(
const String& imageset,
const String& image);
475 void setNESWSizingCursorImage(
const String& imageset,
const String& image);
533 bool moveLeftEdge(
float delta,
URect& out_area);
543 bool moveRightEdge(
float delta,
URect& out_area);
553 bool moveTopEdge(
float delta,
URect& out_area);
563 bool moveBottomEdge(
float delta,
URect& out_area);
579 SizingLocation getSizingBorderAtPoint(
const Point& pt)
const;
638 bool closeClickHandler(
const EventArgs& e);
645 void setCursorForPoint(
const Point& pt)
const;
667 if (class_name==
"FrameWindow")
return true;
753 void addFrameWindowProperties(
void);
758 #if defined(_MSC_VER)
759 # pragma warning(pop)
762 #endif // end of guard _CEGUIFrameWindow_h_
bool d_rolledup
true if window is rolled up.
Definition: CEGUIFrameWindow.h:715
Property to access the setting for whether the user is able to roll-up / shade the window...
Definition: CEGUIFrameWindowProperties.h:163
Position will size from the left.
Definition: CEGUIFrameWindow.h:107
bool d_rollupEnabled
true if roll-up of window is allowed.
Definition: CEGUIFrameWindow.h:714
static const String WidgetTypeName
Window factory name.
Definition: CEGUIFrameWindow.h:55
Class used as a two dimensional vector (aka a Point)
Definition: CEGUIVector.h:45
static const String TitlebarNameSuffix
Widget name suffix for the titlebar component.
Definition: CEGUIFrameWindow.h:92
Property to access the E-W (left/right) sizing cursor image.
Definition: CEGUIFrameWindowProperties.h:285
bool d_sizingEnabled
true if sizing is enabled for this window.
Definition: CEGUIFrameWindow.h:718
Area rectangle class built using unified dimensions (UDims).
Definition: CEGUIUDim.h:245
Position will size from the bottom left.
Definition: CEGUIFrameWindow.h:104
Class that represents a single Image of an Imageset.
Definition: CEGUIImage.h:57
Position will size from the top-right.
Definition: CEGUIFrameWindow.h:103
Base class used as the argument to all subscribers Event object.
Definition: CEGUIEventArgs.h:52
static const float DefaultSizingBorderSize
Default size for the sizing border (in pixels)
Definition: CEGUIFrameWindow.h:87
static const String EventNamespace
Namespace for global events.
Definition: CEGUIFrameWindow.h:54
const Image * d_nwseSizingCursor
North-West/South-East cursor image.
Definition: CEGUIFrameWindow.h:726
bool isRolledup(void) const
Return whether the window is currently rolled up (a.k.a shaded).
Definition: CEGUIFrameWindow.h:182
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 h...
Definition: CEGUIWindow.h:3928
static const String EventDragSizingStarted
Definition: CEGUIFrameWindow.h:78
Property to access the setting for the sizing border thickness.
Definition: CEGUIFrameWindowProperties.h:240
SizingLocation
Enumeration that defines the set of possible locations for the mouse on a frame windows sizing border...
Definition: CEGUIFrameWindow.h:100
void setSizingBorderThickness(float pixels)
Set the size of the sizing border for this window.
Definition: CEGUIFrameWindow.h:280
Property to access the setting for whether the window frame will be displayed.
Definition: CEGUIFrameWindowProperties.h:85
bool d_beingSized
true if window is being sized.
Definition: CEGUIFrameWindow.h:719
bool isRightSizingLocation(SizingLocation loc) const
return true if given SizingLocation is on right edge.
Definition: CEGUIFrameWindow.h:605
Point d_dragPoint
point window is being dragged at.
Definition: CEGUIFrameWindow.h:721
Property to access the N-S (up-down) sizing cursor image.
Definition: CEGUIFrameWindowProperties.h:263
static const String CloseButtonNameSuffix
Widget name suffix for the close button component.
Definition: CEGUIFrameWindow.h:93
Property to access the state of the sizable setting for the FrameWindow.
Definition: CEGUIFrameWindowProperties.h:59
bool isDragMovingEnabled(void) const
Return whether this FrameWindow can be moved by dragging the title bar.
Definition: CEGUIFrameWindow.h:305
Position will size from the bottom right.
Definition: CEGUIFrameWindow.h:105
Position will size from the top.
Definition: CEGUIFrameWindow.h:106
Class representing the title bar for Frame Windows.
Definition: CEGUITitlebar.h:52
Property to access the roll-up / shade state of the window.
Definition: CEGUIFrameWindowProperties.h:189
Position is not a sizing location.
Definition: CEGUIFrameWindow.h:101
float d_borderSize
thickness of the sizing border around this window
Definition: CEGUIFrameWindow.h:720
bool d_dragMovable
true if the window will move when dragged by the title bar.
Definition: CEGUIFrameWindow.h:729
static const String EventCloseClicked
Definition: CEGUIFrameWindow.h:72
virtual Rect getSizingRect(void) const
Return a Rect that describes, in window relative pixel co-ordinates, the outer edge of the sizing are...
Definition: CEGUIFrameWindow.h:652
float getSizingBorderThickness(void) const
Return the thickness of the sizing border.
Definition: CEGUIFrameWindow.h:192
An abstract base class providing common functionality and specifying the required interface for deriv...
Definition: CEGUIWindow.h:138
Abstract base class for a movable, sizable, window with a title-bar and a frame.
Definition: CEGUIFrameWindow.h:51
bool isSizingEnabled(void) const
Return whether this window is sizable. Note that this requires that the window have an enabled frame ...
Definition: CEGUIFrameWindow.h:132
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 h...
Definition: CEGUIFrameWindow.h:665
bool d_frameEnabled
true if window frame should be drawn.
Definition: CEGUIFrameWindow.h:711
Position will size from the top-left.
Definition: CEGUIFrameWindow.h:102
const Image * d_ewSizingCursor
East/West sizing cursor image.
Definition: CEGUIFrameWindow.h:725
bool isFrameEnabled(void) const
Return whether the frame for this window is enabled.
Definition: CEGUIFrameWindow.h:142
static const String EventDragSizingEnded
Definition: CEGUIFrameWindow.h:84
Property to access the NW-SE diagonal sizing cursor image.
Definition: CEGUIFrameWindowProperties.h:307
EventArgs based class that is used for objects passed to handlers triggered for events concerning som...
Definition: CEGUIInputEvent.h:245
Property to access the setting for whether the window title-bar will be enabled (or displayed dependi...
Definition: CEGUIFrameWindowProperties.h:111
Property to access the setting for whether the user may drag the window around by its title bar...
Definition: CEGUIFrameWindowProperties.h:215
EventArgs based class that is used for objects passed to input event handlers concerning mouse input...
Definition: CEGUIInputEvent.h:274
bool isBottomSizingLocation(SizingLocation loc) const
return true if given SizingLocation is on bottom edge.
Definition: CEGUIFrameWindow.h:631
static const String EventRollupToggled
Definition: CEGUIFrameWindow.h:66
bool isLeftSizingLocation(SizingLocation loc) const
return true if given SizingLocation is on left edge.
Definition: CEGUIFrameWindow.h:592
Position will size from the bottom.
Definition: CEGUIFrameWindow.h:108
bool isTopSizingLocation(SizingLocation loc) const
return true if given SizingLocation is on top edge.
Definition: CEGUIFrameWindow.h:618
Property to access the NE-SW diagonal sizing cursor image.
Definition: CEGUIFrameWindowProperties.h:329
bool isRollupEnabled(void) const
Return whether roll up (a.k.a shading) is enabled for this window.
Definition: CEGUIFrameWindow.h:172
const Image * d_nsSizingCursor
North/South sizing cursor image.
Definition: CEGUIFrameWindow.h:724
const Image * d_neswSizingCursor
North-East/South-West cursor image.
Definition: CEGUIFrameWindow.h:727
EventArgs based class that is used for Activated and Deactivated window events.
Definition: CEGUIInputEvent.h:323
Class encapsulating operations on a Rectangle.
Definition: CEGUIRect.h:44
virtual bool isHit(const Vector2 &position, const bool allow_disabled=false) const
check if the given pixel position would hit this window.
String class used within the GUI system.
Definition: CEGUIString.h:57
bool isHit(const Point &position, const bool) const
check if the given pixel position would hit this window.
Definition: CEGUIFrameWindow.h:478