Crazy Eddie's GUI System
0.8.7
|
29 #ifndef _CEGUIFrameWindow_h_
30 #define _CEGUIFrameWindow_h_
33 #include "../Window.h"
36 # pragma warning(push)
37 # pragma warning(disable : 4251)
710 void addFrameWindowProperties(
void);
715 #if defined(_MSC_VER)
716 # pragma warning(pop)
719 #endif // end of guard _CEGUIFrameWindow_h_
void setNESWSizingCursorImage(const Image *image)
Set the Image to be used for the northeast-southwest sizing mouse cursor.
void setRollupEnabled(bool setting)
Enables or disables roll-up (shading) for this window.
virtual void initialiseComponents(void)
Initialises the Window based object ready for use.
static const String EventCloseClicked
Definition: widgets/FrameWindow.h:69
void setSizingBorderThickness(float pixels)
Set the size of the sizing border for this window.
Definition: widgets/FrameWindow.h:284
virtual void onMouseButtonUp(MouseEventArgs &e)
Handler called when a mouse button has been released within this window's area.
bool isDragMovingEnabled(void) const
Return whether this FrameWindow can be moved by dragging the title bar.
Definition: widgets/FrameWindow.h:309
@ SizingBottom
Position will size from the bottom.
Definition: widgets/FrameWindow.h:105
static const String WidgetTypeName
Window factory name.
Definition: widgets/FrameWindow.h:52
const Image * getNWSESizingCursorImage() const
Return a pointer to the currently set Image to be used for the northwest-southeast sizing mouse curso...
void setCloseButtonEnabled(bool setting)
Enables or disables the close button for the frame window.
bool isHit(const Vector2f &position, const bool) const
check if the given pixel position would hit this window.
Definition: widgets/FrameWindow.h:470
static const float DefaultSizingBorderSize
Default size for the sizing border (in pixels)
Definition: widgets/FrameWindow.h:84
virtual void onMouseMove(MouseEventArgs &e)
Handler called when the mouse cursor has been moved within this window's area.
virtual void onDeactivated(ActivationEventArgs &e)
Handler called when this window has lost input focus and has been deactivated.
virtual bool isHit(const Vector2f &position, const bool allow_disabled=false) const
check if the given pixel position would hit this window.
bool isTopSizingLocation(SizingLocation loc) const
return true if given SizingLocation is on top edge.
Definition: widgets/FrameWindow.h:610
void setEWSizingCursorImage(const String &name)
Set the image to be used for the east-west sizing mouse cursor.
bool moveBottomEdge(float delta, URect &out_area)
move the window's bottom edge by 'delta'. The rest of the window does not move, thus this changes the...
bool isLeftSizingLocation(SizingLocation loc) const
return true if given SizingLocation is on left edge.
Definition: widgets/FrameWindow.h:584
@ SizingNone
Position is not a sizing location.
Definition: widgets/FrameWindow.h:98
virtual ~FrameWindow(void)
Destructor for FramwWindow objects.
const Image * d_nwseSizingCursor
North-West/South-East cursor image.
Definition: widgets/FrameWindow.h:700
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1
bool isCloseButtonEnabled(void) const
Return whether this close button for this window is enabled.
virtual void onTextChanged(WindowEventArgs &e)
Handler called when the window's text is changed.
float d_borderSize
thickness of the sizing border around this window
Definition: widgets/FrameWindow.h:694
EventArgs based class that is used for objects passed to input event handlers concerning mouse input.
Definition: InputEvent.h:281
bool d_dragMovable
true if the window will move when dragged by the title bar.
Definition: widgets/FrameWindow.h:703
PushButton * getCloseButton() const
Return a pointer to the close button component widget for this FrameWindow.
static const String EventDragSizingEnded
Definition: widgets/FrameWindow.h:81
@ SizingTop
Position will size from the top.
Definition: widgets/FrameWindow.h:103
bool d_rollupEnabled
true if roll-up of window is allowed.
Definition: widgets/FrameWindow.h:688
void setNESWSizingCursorImage(const String &name)
Set the image to be used for the northeast-southwest sizing mouse cursor.
bool moveRightEdge(float delta, URect &out_area)
move the window's right edge by 'delta'. The rest of the window does not move, thus this changes the ...
static const String CloseButtonName
Widget name for the close button component.
Definition: widgets/FrameWindow.h:90
static const String TitlebarName
Widget name for the titlebar component.
Definition: widgets/FrameWindow.h:89
bool isSizingEnabled(void) const
Return whether this window is sizable. Note that this requires that the window have an enabled frame ...
Definition: widgets/FrameWindow.h:129
EventArgs based class that is used for objects passed to handlers triggered for events concerning som...
Definition: InputEvent.h:252
virtual void onRollupToggled(WindowEventArgs &e)
Event generated internally whenever the roll-up / shade state of the window changes.
void toggleRollup(void)
Toggles the state of the window between rolled-up (shaded) and normal sizes. This requires roll-up to...
bool isBottomSizingLocation(SizingLocation loc) const
return true if given SizingLocation is on bottom edge.
Definition: widgets/FrameWindow.h:623
void setNSSizingCursorImage(const String &name)
Set the image to be used for the north-south sizing mouse cursor.
static const String EventDragSizingStarted
Definition: widgets/FrameWindow.h:75
static const String EventRollupToggled
Definition: widgets/FrameWindow.h:63
Vector2f d_dragPoint
point window is being dragged at.
Definition: widgets/FrameWindow.h:695
const Image * d_ewSizingCursor
East/West sizing cursor image.
Definition: widgets/FrameWindow.h:699
virtual void onMouseButtonDown(MouseEventArgs &e)
Handler called when a mouse button has been depressed within this window's area.
@ SizingLeft
Position will size from the left.
Definition: widgets/FrameWindow.h:104
const Image * d_nsSizingCursor
North/South sizing cursor image.
Definition: widgets/FrameWindow.h:698
const Image * getNESWSizingCursorImage() const
Return a pointer to the currently set Image to be used for the northeast-southwest sizing mouse curso...
EventArgs based class that is used for Activated and Deactivated window events.
Definition: InputEvent.h:330
const Image * getNSSizingCursorImage() const
Return a pointer to the currently set Image to be used for the north-south sizing mouse cursor.
FrameWindow(const String &type, const String &name)
Constructor for FrameWindow objects.
void setNWSESizingCursorImage(const Image *image)
Set the Image to be used for the northwest-southeast sizing mouse cursor.
Titlebar * getTitlebar() const
Return a pointer to the Titlebar component widget for this FrameWindow.
void setRolledup(bool val)
Sets whether the window is currently rolled up (a.k.a shaded).
SizingLocation getSizingBorderAtPoint(const Vector2f &pt) const
check local pixel co-ordinate point 'pt' and return one of the SizingLocation enumerated values depen...
Abstract base class for a movable, sizable, window with a title-bar and a frame.
Definition: widgets/FrameWindow.h:49
@ SizingBottomRight
Position will size from the bottom right.
Definition: widgets/FrameWindow.h:102
void setCursorForPoint(const Vector2f &pt) const
Set the appropriate mouse cursor for the given window-relative pixel point.
void setTitleBarEnabled(bool setting)
Enables or disables the title bar for the frame window.
void setEWSizingCursorImage(const Image *image)
Set the Image to be used for the east-west sizing mouse cursor.
bool d_beingSized
true if window is being sized.
Definition: widgets/FrameWindow.h:693
bool moveTopEdge(float delta, URect &out_area)
move the window's top edge by 'delta'. The rest of the window does not move, thus this changes the si...
bool d_sizingEnabled
true if sizing is enabled for this window.
Definition: widgets/FrameWindow.h:692
bool isRightSizingLocation(SizingLocation loc) const
return true if given SizingLocation is on right edge.
Definition: widgets/FrameWindow.h:597
virtual void onDragSizingEnded(WindowEventArgs &e)
Handler called when drag-sizing of the FrameWindow ends.
bool closeClickHandler(const EventArgs &e)
Method to respond to close button click events and fire our close event.
virtual Rectf getSizingRect(void) const
Return a Rect that describes, in window relative pixel co-ordinates, the outer edge of the sizing are...
Definition: widgets/FrameWindow.h:644
bool moveLeftEdge(float delta, URect &out_area)
move the window's left edge by 'delta'. The rest of the window does not move, thus this changes the s...
virtual void onCaptureLost(WindowEventArgs &e)
Handler called when this window loses capture of mouse inputs.
SizingLocation
Enumeration that defines the set of possible locations for the mouse on a frame windows sizing border...
Definition: widgets/FrameWindow.h:97
bool isTitleBarEnabled(void) const
Return whether the title bar for this window is enabled.
An abstract base class providing common functionality and specifying the required interface for deriv...
Definition: Window.h:151
void setDragMovingEnabled(bool setting)
Set whether this FrameWindow can be moved by dragging the title bar.
void setSizingEnabled(bool setting)
Enables or disables sizing for this window.
@ SizingBottomLeft
Position will size from the bottom left.
Definition: widgets/FrameWindow.h:101
float getSizingBorderThickness(void) const
Return the thickness of the sizing border.
Definition: widgets/FrameWindow.h:197
@ SizingTopRight
Position will size from the top-right.
Definition: widgets/FrameWindow.h:100
static const String EventNamespace
Namespace for global events.
Definition: widgets/FrameWindow.h:51
virtual void onCloseClicked(WindowEventArgs &e)
Event generated internally whenever the close button is clicked.
void setFrameEnabled(bool setting)
Enables or disables the frame for this window.
@ SizingTopLeft
Position will size from the top-left.
Definition: widgets/FrameWindow.h:99
bool d_rolledup
true if window is rolled up.
Definition: widgets/FrameWindow.h:689
bool d_frameEnabled
true if window frame should be drawn.
Definition: widgets/FrameWindow.h:685
void setNSSizingCursorImage(const Image *image)
Set the Image to be used for the north-south sizing mouse cursor.
void offsetPixelPosition(const Vector2f &offset)
Move the window by the pixel offsets specified in offset.
String class used within the GUI system.
Definition: String.h:64
virtual void onActivated(ActivationEventArgs &e)
Handler called when this window has become the active window.
bool isFrameEnabled(void) const
Return whether the frame for this window is enabled.
Definition: widgets/FrameWindow.h:139
void setNWSESizingCursorImage(const String &name)
Set the image to be used for the northwest-southeast sizing mouse cursor.
bool isRollupEnabled(void) const
Return whether roll up (a.k.a shading) is enabled for this window.
Definition: widgets/FrameWindow.h:169
bool isRolledup(void) const
Return whether the window is currently rolled up (a.k.a shaded).
Definition: widgets/FrameWindow.h:187
Class representing the title bar for Frame Windows.
Definition: widgets/Titlebar.h:51
Interface for Image.
Definition: Image.h:161
virtual void onDragSizingStarted(WindowEventArgs &e)
Handler called when drag-sizing of the FrameWindow starts.
const Image * getEWSizingCursorImage() const
Return a pointer to the currently set Image to be used for the east-west sizing mouse cursor.
Base class used as the argument to all subscribers Event object.
Definition: EventArgs.h:51
const Image * d_neswSizingCursor
North-East/South-West cursor image.
Definition: widgets/FrameWindow.h:701