CEGUI::TabButton Class Reference

Base class for TabButtons. A TabButton based class is used internally as the button that appears at the top of a TabControl widget to select the active tab pane. More...

Inheritance diagram for CEGUI::TabButton:

Inheritance graph
[legend]
Collaboration diagram for CEGUI::TabButton:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 TabButton (const String &type, const String &name)
 Constructor for base TabButton class.
virtual ~TabButton (void)
 Destructor for TabButton class.
virtual void setSelected (bool selected)
 Set whether this tab button is selected or not.
bool isSelected (void) const
 Return whether this tab button is selected or not.
void setTargetWindow (Window *wnd)
 Set the target window which is the content pane which this button is covering.
WindowgetTargetWindow (void)
 Get the target window which is the content pane which this button is covering.

Static Public Attributes

static const String EventNamespace
 Namespace for global events.
static const String WidgetTypeName
 Window factory name.
static const String EventClicked
 The button was clicked.
static const String EventDragged
 Attempt to drag the button with middle button.
static const String EventScrolled
 Scroll wheel activated on top of the button.

Protected Member Functions

virtual void onClicked (WindowEventArgs &e)
 handler invoked internally when the button is clicked.
virtual void onMouseButtonUp (MouseEventArgs &e)
 Handler called when a mouse button has been released 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 onMouseWheel (MouseEventArgs &e)
 Handler called when the mouse wheel (z-axis) position changes within this window's area.
virtual void onMouseMove (MouseEventArgs &e)
 Handler called when the mouse cursor has been moved within this window's area.
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.

Protected Attributes

bool d_selected
 Is this button selected?
bool d_dragging
 In drag mode or not.
Windowd_targetWindow
 The target window which this button is representing.


Detailed Description

Base class for TabButtons. A TabButton based class is used internally as the button that appears at the top of a TabControl widget to select the active tab pane.

Member Function Documentation

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

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

Parameters:
e MouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::ButtonBase.

References CEGUI::MouseEventArgs::button, CEGUI::Window::captureInput(), d_dragging, EventDragged, EventNamespace, CEGUI::EventSet::fireEvent(), CEGUI::EventArgs::handled, and CEGUI::MiddleButton.

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

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

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

Parameters:
e MouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::ButtonBase.

References d_dragging, EventDragged, EventNamespace, CEGUI::EventSet::fireEvent(), and CEGUI::EventArgs::handled.

Referenced by onMouseWheel().

void CEGUI::TabButton::onMouseWheel ( MouseEventArgs e  )  [protected, virtual]

Handler called when the mouse wheel (z-axis) position changes within this window's area.

Parameters:
e MouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::Window.

References EventNamespace, EventScrolled, CEGUI::EventSet::fireEvent(), and onMouseMove().

virtual bool CEGUI::TabButton::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.

Parameters:
class_name The class name that is to be checked.
Returns:
true if this window was inherited from class_name. false if not.

Reimplemented from CEGUI::ButtonBase.

References CEGUI::ButtonBase::testClassName_impl().


Generated on Thu Nov 27 20:34:38 2008 for Crazy Eddies GUI System by  doxygen 1.5.7.1