GG

GG::MenuBar Class Reference

A menu bar control providing "browse" updates to user navigation of the menu. More...

#include <Menu.h>

Inheritance diagram for GG::MenuBar:
GG::Control GG::Wnd

List of all members.

Signal Types

typedef boost::signal< void(int)> BrowsedSignalType

Structors

 MenuBar (X x, Y y, X w, const boost::shared_ptr< Font > &font, Clr text_color=CLR_WHITE, Clr color=CLR_BLACK, Clr interior=CLR_SHADOW)
 MenuBar (X x, Y y, X w, const boost::shared_ptr< Font > &font, const MenuItem &m, Clr text_color=CLR_WHITE, Clr color=CLR_BLACK, Clr interior=CLR_SHADOW)
 MenuBar ()

Accessors

BrowsedSignalType BrowsedSignal
virtual Pt MinUsableSize () const
const MenuItemAllMenus () const
bool ContainsMenu (const std::string &str) const
std::size_t NumMenus () const
const MenuItemGetMenu (const std::string &str) const
const MenuItemGetMenu (std::size_t n) const
Clr BorderColor () const
Clr InteriorColor () const
Clr TextColor () const
Clr HiliteColor () const
Clr SelectedTextColor () const
const boost::shared_ptr< Font > & GetFont () const
const std::vector< TextControl * > & MenuLabels () const
std::size_t Caret () const

Mutators

virtual void Render ()
virtual void LButtonDown (const Pt &pt, Flags< ModKey > mod_keys)
virtual void MouseHere (const Pt &pt, Flags< ModKey > mod_keys)
virtual void MouseLeave ()
virtual void SizeMove (const Pt &ul, const Pt &lr)
MenuItemAllMenus ()
MenuItemGetMenu (const std::string &str)
MenuItemGetMenu (int n)
void AddMenu (const MenuItem &menu)
void SetBorderColor (Clr clr)
void SetInteriorColor (Clr clr)
void SetTextColor (Clr clr)
void SetHiliteColor (Clr clr)
void SetSelectedTextColor (Clr clr)
virtual void DefineAttributes (WndEditor *editor)

Detailed Description

A menu bar control providing "browse" updates to user navigation of the menu.

Whenever a menu item is selected, a signal is emitted which includes the ID of the selected item. It is recommended that the user attach each menu item to an appropriate function the will execute the actions associated with the menu item, rather than attaching all the items to a single slot which uses the int ID parameter to deduce the appropriate action. The int ID parameter is best used when there are several menu items that should execute the same code with different parameters. For instance, if a submenu contains a list of recently used files, each item that contains a filename might be attached to a Reopen(int) function, and the int can be used to determine which file from the list should be opened. If some action is to be taken as the user browses the menu items, such as displaying some visual cue to indicate the result of chosing a particular menu entry, you can attach a slot function to the BrowsedSignalType object returned by BrowsedSignal. Whenever the mouse moves to a new menu item, this signal is emitted with the ID number of the item under the cursor.

Definition at line 128 of file Menu.h.


Constructor & Destructor Documentation

GG::MenuBar::MenuBar ( X  x,
Y  y,
X  w,
const boost::shared_ptr< Font > &  font,
Clr  text_color = CLR_WHITE,
Clr  color = CLR_BLACK,
Clr  interior = CLR_SHADOW 
)

ctor

Ctor. Parameter m should contain the desired menu in its next_level member.


Member Function Documentation

virtual Pt GG::MenuBar::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::Wnd.

const MenuItem& GG::MenuBar::GetMenu ( const std::string &  str) const

returns a const reference to the top-level menu in the MenuBar whose label is str.

Note:
No check is made to ensure such a menu exists.
virtual void GG::MenuBar::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().

Implements GG::Control.

virtual void GG::MenuBar::LButtonDown ( const Pt pt,
Flags< ModKey >  mod_keys 
) [virtual]

Respond to left button down msg. A window receives this whenever any input device button changes from up to down while over the window.

Note:
If this Wnd was created with the REPEAT_BUTTON_DOWN flag, this method may be called multiple times during a single button press-release cycle.
See also:
GG::GUI

Reimplemented from GG::Wnd.

virtual void GG::MenuBar::MouseHere ( const Pt pt,
Flags< ModKey >  mod_keys 
) [virtual]

Respond to cursor moving about within the Wnd, or to cursor lingering within the Wnd for a long period of time. A MouseHere() message will not be generated the first time the cursor enters the window's area. In that case, a MouseEnter() message is generated.

Reimplemented from GG::Wnd.

virtual void GG::MenuBar::MouseLeave ( ) [virtual]

Respond to cursor leaving window's coords.

Reimplemented from GG::Wnd.

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

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

Reimplemented from GG::Wnd.

MenuItem& GG::MenuBar::GetMenu ( const std::string &  str)

Returns a reference to the top-level menu in the MenuBar whose label is str.

Note:
No check is made to ensure such a menu exists.
virtual void GG::MenuBar::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::Control.


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