Crazy Eddie's GUI System  0.8.4
CEGUI::Titlebar Class Reference

Class representing the title bar for Frame Windows. More...

+ Inheritance diagram for CEGUI::Titlebar:
+ Collaboration diagram for CEGUI::Titlebar:

List of all members.

Public Member Functions

bool isDraggingEnabled (void) const
 Return whether this title bar will respond to dragging.
void setDraggingEnabled (bool setting)
 Set whether this title bar widget will respond to dragging.
bool isDragged () const
 Checks whether the title bar widget is being dragged at the moment.
const Vector2fgetDragPoint () const
 Gets the point at which the title bar widget is/was being dragged.
 Titlebar (const String &type, const String &name)
 Constructor for Titlebar base class.
virtual ~Titlebar (void)
 Destructor for Titlebar base class.

Static Public Attributes

static const String EventNamespace
 Namespace for global events.
static const String WidgetTypeName
 Window factory name.

Protected Member Functions

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 onMouseDoubleClicked (MouseEventArgs &e)
 Handler called when a mouse button has been double-clicked within this window's area.
virtual void onCaptureLost (WindowEventArgs &e)
 Handler called when this window loses capture of mouse inputs.
virtual void onFontChanged (WindowEventArgs &e)
 Handler called when the window's font is changed.
virtual void onDraggingModeChanged (WindowEventArgs &)
 Event handler called when the 'draggable' state for the title bar is changed.

Protected Attributes

bool d_dragging
 set to true when the window is being dragged.
Vector2f d_dragPoint
 Point at which we are being dragged.
bool d_dragEnabled
 true when dragging for the widget is enabled.
Rectf d_oldCursorArea
 Used to backup cursor restraint area.

Detailed Description

Class representing the title bar for Frame Windows.


Member Function Documentation

bool CEGUI::Titlebar::isDraggingEnabled ( void  ) const

Return whether this title bar will respond to dragging.

Returns:
true if the title bar will respond to dragging, false if the title bar will not respond.
virtual void CEGUI::Titlebar::onCaptureLost ( WindowEventArgs e) [protected, virtual]

Handler called when this window loses capture of mouse inputs.

Parameters:
eWindowEventArgs 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.

virtual void CEGUI::Titlebar::onDraggingModeChanged ( WindowEventArgs ) [inline, protected, virtual]

Event handler called when the 'draggable' state for the title bar is changed.

Note that this is for 'internal' use at the moment and as such does not add or fire a public Event that can be subscribed to.

virtual void CEGUI::Titlebar::onFontChanged ( WindowEventArgs e) [protected, virtual]

Handler called when the window's font is changed.

Parameters:
eWindowEventArgs 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.

virtual void CEGUI::Titlebar::onMouseButtonDown ( MouseEventArgs e) [protected, virtual]

Handler called when a mouse button has been depressed within this window's area.

Parameters:
eMouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::Window.

virtual void CEGUI::Titlebar::onMouseButtonUp ( MouseEventArgs e) [protected, virtual]

Handler called when a mouse button has been released within this window's area.

Parameters:
eMouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::Window.

virtual void CEGUI::Titlebar::onMouseDoubleClicked ( MouseEventArgs e) [protected, virtual]

Handler called when a mouse button has been double-clicked within this window's area.

Parameters:
eMouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::Window.

virtual void CEGUI::Titlebar::onMouseMove ( MouseEventArgs e) [protected, virtual]

Handler called when the mouse cursor has been moved within this window's area.

Parameters:
eMouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::Window.

void CEGUI::Titlebar::setDraggingEnabled ( bool  setting)

Set whether this title bar widget will respond to dragging.

Parameters:
settingtrue if the title bar should respond to being dragged, false if it should not respond.
Returns:
Nothing.
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends