GG
Public Types

GG::DropDownList Class Reference

Displays a single choice, and allows the user to select items from a drop-down list. More...

#include <DropDownList.h>

Inheritance diagram for GG::DropDownList:
GG::Control GG::Wnd

List of all members.

Public Types

typedef ListBox::Row Row

Signal Types

typedef boost::signal< void(iterator)> SelChangedSignalType

Structors

 DropDownList (X x, Y y, X w, Y h, Y drop_ht, Clr color, Flags< WndFlag > flags=INTERACTIVE)
 ~DropDownList ()
 DropDownList ()

Accessors

SelChangedSignalType SelChangedSignal
iterator CurrentItem () const
std::size_t CurrentItemIndex () const
std::size_t IteratorToIndex (iterator it) const
iterator IndexToIterator (std::size_t n) const
bool Empty () const
const_iterator begin () const
const_iterator end () const
const_reverse_iterator rbegin () const
const_reverse_iterator rend () const
const RowGetRow (std::size_t n) const
bool Selected (iterator it) const
bool Selected (std::size_t n) const
Clr InteriorColor () const
Y DropHeight () const
Flags< ListBoxStyle > Style () const
std::size_t NumRows () const
std::size_t NumCols () const
std::size_t SortCol () const
X ColWidth (std::size_t n) const
Alignment ColAlignment (std::size_t n) const
Alignment RowAlignment (iterator it) const
virtual Pt ClientUpperLeft () const
virtual Pt ClientLowerRight () const

Mutators

virtual void Render ()
virtual void SizeMove (const Pt &ul, const Pt &lr)
virtual void SetColor (Clr c)
iterator Insert (Row *row, iterator it)
iterator Insert (Row *row)
RowErase (iterator it)
void Clear ()
iterator begin ()
iterator end ()
reverse_iterator rbegin ()
reverse_iterator rend ()
RowGetRow (std::size_t n)
void Select (iterator it)
void Select (std::size_t n)
void SetInteriorColor (Clr c)
void SetDropHeight (Y h)
void SetStyle (Flags< ListBoxStyle > s)
void SetNumCols (std::size_t n)
void SetSortCol (std::size_t n)
void SetColWidth (std::size_t n, X w)
void LockColWidths ()
void UnLockColWidths ()
void SetColAlignment (std::size_t n, Alignment align)
void SetRowAlignment (iterator it, Alignment align)
virtual void DefineAttributes (WndEditor *editor)
virtual void LClick (const Pt &pt, Flags< ModKey > mod_keys)
virtual void KeyPress (Key key, boost::uint32_t key_code_point, Flags< ModKey > mod_keys)
ListBoxLB ()

Detailed Description

Displays a single choice, and allows the user to select items from a drop-down list.

DropDownList is similar to GG::ListBox, but has significant restrictions over the functionality of GG::ListBox. Specifically, all list items must have the same height, and there is no dragging or dropping. Though any Control-derived object may be placed in an item cell, the items are only interactive in the drop-down list; the currently selected item is displayed only. Most of the ListBox interface is duplicated in DropDownList. Though you can still set the alignment, etc. of individual rows, as in ListBox, the currently-selected row will have the same alignment, etc. when displayed in the control in its unopened state. Note that this may look quite ugly.

Definition at line 52 of file DropDownList.h.


Member Typedef Documentation

This is a single item in a dropdown list.

See also:
See GG::ListBox for details.

Definition at line 56 of file DropDownList.h.


Constructor & Destructor Documentation

GG::DropDownList::DropDownList ( X  x,
Y  y,
X  w,
Y  h,
Y  drop_ht,
Clr  color,
Flags< WndFlag >  flags = INTERACTIVE 
)

basic ctor. DropDownList retains ownership of lb, if it is non-null.


Member Function Documentation

const Row& GG::DropDownList::GetRow ( std::size_t  n) const

returns a const reference to the row at index n; not range-checked.

Note:
This function is O(n).
Flags<ListBoxStyle> GG::DropDownList::Style ( ) const

Returns the style flags of the list

See also:
GG::ListBoxStyle
std::size_t GG::DropDownList::SortCol ( ) const

Returns the index of the column used to sort items, when sorting is enabled.

Note:
The sort column is not range checked when it is set by the user; it may be >= NumCols().
virtual Pt GG::DropDownList::ClientUpperLeft ( ) const [virtual]

Returns upper-left corner of window's client area in screen coordinates (or of the entire area, if no client area is specified). Virtual because different windows have different shapes (and so ways of calculating client area).

Reimplemented from GG::Wnd.

virtual Pt GG::DropDownList::ClientLowerRight ( ) const [virtual]

Returns (one pixel past) lower-right corner of window's client area in screen coordinates (or of the entire area, if no client area is specified). Virtual because different windows have different shapes (and so ways of calculating client area).

Reimplemented from GG::Wnd.

virtual void GG::DropDownList::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.

iterator GG::DropDownList::Insert ( Row row,
iterator  it 
)

Insertion sorts row into a sorted list, or inserts into an unsorted list before it; returns index of insertion point. This Row becomes the property of the DropDownList and should not be deleted or inserted into any other DropDownLists

iterator GG::DropDownList::Insert ( Row row)

Insertion sorts row into a sorted list, or inserts into an unsorted list at the end of the list; returns index of insertion point. This Row becomes the property of the DropDownList and should not be deleted or inserted into any other DropDownLists

Row& GG::DropDownList::GetRow ( std::size_t  n)

returns a reference to the Row at row index n; not range-checked.

Note:
This function is O(n).
void GG::DropDownList::SetStyle ( Flags< ListBoxStyle >  s)

sets the style flags for the list to s (invalidates currently selected item).

See also:
GG::ListBoxStyle
void GG::DropDownList::LockColWidths ( )

Fixes the column widths; by default, an empty list will take on the number of columns of its first added row.

Note:
The number of columns and their widths may still be set via SetNumCols() and SetColWidth() after this function has been called.
void GG::DropDownList::UnLockColWidths ( )

Allows the number of columns to be determined by the first row added to an empty ListBox

virtual void GG::DropDownList::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.

virtual void GG::DropDownList::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.

virtual void GG::DropDownList::KeyPress ( Key  key,
boost::uint32_t  key_code_point,
Flags< ModKey >  mod_keys 
) [protected, virtual]

Respond to down-keystrokes (focus window only). A window may receive KeyPress() messages passed up to it from its children. For instance, Control-derived classes pass KeyPress() messages to their Parent() windows by default.

Note:
Though mouse clicks consist of a press and a release, all Control classes by default respond immediately to KeyPress(), not KeyRelease(); in fact, by default no Wnd class does anything at all on a KeyRelease event.
key_code_point will be zero if Unicode support is unavailable.

Reimplemented from GG::Control.


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