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