GG

GG::StateButton Class Reference

This is a basic state button control. More...

#include <Button.h>

Inheritance diagram for GG::StateButton:
GG::TextControl GG::Control GG::Wnd

List of all members.

Signal Types

typedef boost::signal< void(bool)> CheckedSignalType

Structors

 StateButton (X x, Y y, X w, Y h, const std::string &str, const boost::shared_ptr< Font > &font, Flags< TextFormat > format, Clr color, Clr text_color=CLR_BLACK, Clr interior=CLR_ZERO, StateButtonStyle style=SBSTYLE_3D_XBOX, Flags< WndFlag > flags=INTERACTIVE)
 StateButton ()

Accessors

CheckedSignalType CheckedSignal
virtual Pt MinUsableSize () const
bool Checked () const
Clr InteriorColor () const
StateButtonStyle Style () const
Pt ButtonUpperLeft () const
Pt ButtonLowerRight () const
Pt TextUpperLeft () const

Mutators

virtual void Render ()
virtual void SizeMove (const Pt &ul, const Pt &lr)
void Reset ()
void SetCheck (bool b=true)
void SetButtonPosition (const Pt &ul, const Pt &lr)
void SetDefaultButtonPosition ()
virtual void SetColor (Clr c)
void SetInteriorColor (Clr c)
void SetStyle (StateButtonStyle bs)
virtual void DefineAttributes (WndEditor *editor)
virtual void LClick (const Pt &pt, Flags< ModKey > mod_keys)
void RepositionButton ()

Detailed Description

This is a basic state button control.

This class is for checkboxes and radio buttons, etc. The button/checkbox area is determined from the text height and format; the button height and width will be the text height, and the the button will be positioned to the left of the text and vertically the same as the text, unless the text is centered, in which case the button and text will be centered, and the button will appear above or below the text. Whenever there is not room to place the button and the text in the proper orientation because the entire control's size is too small, the button and text are positioned in their default spots (button on left, text on right, centered vertically).

Definition at line 148 of file Button.h.


Member Function Documentation

virtual Pt GG::StateButton::MinUsableSize ( ) const [virtual]

Returns the size of the minimum bounding box that can enclose the Wnd and still show all of its elements, plus enough room for interaction with those elements (if applicable). For example, a TextControl's MinUsableSize() is just the area of its text, and a Scroll's MinUsableSize() is the combined sizes of its up-button, down-button, and tab (plus a bit of room in which to drag the tab).

Reimplemented from GG::TextControl.

StateButtonStyle GG::StateButton::Style ( ) const

Returns the visual style of the button

See also:
StateButtonStyle
virtual void GG::StateButton::Render ( ) [virtual]

Draws this Wnd. Note that Wnds being dragged for a drag-and-drop operation are rendered twice -- once in-place as normal, once in the location of the drag operation, attached to the cursor. Such Wnds may wish to render themselves differently in those two cases. To determine which render is being performed, they can call GUI::GetGUI()->RenderingDragDropWnds().

Reimplemented from GG::TextControl.

virtual void GG::StateButton::SizeMove ( const Pt ul,
const Pt lr 
) [virtual]

Resizes and/or moves window to new upper-left and lower right boundaries.

Reimplemented from GG::TextControl.

void GG::StateButton::SetStyle ( StateButtonStyle  bs)

Sets the visual style of the button

See also:
StateButtonStyle
virtual void GG::StateButton::DefineAttributes ( WndEditor *  editor) [virtual]

Provides the attributes of this object that are appropriate for a user to edit in a WndEditor; see WndEditor for details.

Reimplemented from GG::TextControl.

virtual void GG::StateButton::LClick ( const Pt pt,
Flags< ModKey >  mod_keys 
) [protected, virtual]

Respond to release of left mouse button over this Wnd, if it was also originally depressed over this Wnd. A Wnd will receive an LButtonUp() message whenever a drag that started over its area ends over its area as well.

Reimplemented from GG::Wnd.


The documentation for this class was generated from the following file: