$treeview $search $mathjax
Stratagus  2.2.7
$projectbrief
$projectbrief
$searchbox
-->
         _________ __                 __
        /   _____//  |_____________ _/  |______     ____  __ __  ______
        \_____  \\   __\_  __ \__  \\   __\__  \   / ___\|  |  \/  ___/
        /        \|  |  |  | \// __ \|  |  / __ \_/ /_/  >  |  /\___ \
       /_______  /|__|  |__|  (____  /__| (____  /\___  /|____//____  >
               \/                  \/          \//_____/            \/
    ______________________                           ______________________
                          T H E   W A R   B E G I N S
                   Stratagus - A free fantasy real time strategy game engine

gcn::ListBox Class Reference

#include <listbox.h>

Inheritance diagram for gcn::ListBox:

gcn::Widget gcn::MouseListener gcn::KeyListener

List of all members.


Public Member Functions

 ListBox ()
 ListBox (ListModel *listModel)
virtual ~ListBox ()
virtual int getSelected ()
virtual void setSelected (int selected)
virtual void setListModel (ListModel *listModel)
virtual ListModelgetListModel ()
virtual void adjustSize ()
virtual void draw (Graphics *graphics)
virtual void drawBorder (Graphics *graphics)
virtual void logic ()
virtual bool keyPress (const Key &key)
virtual void mousePress (int x, int y, int button)

Protected Attributes

ListModelmListModel
int mSelected

Detailed Description

A ListBox displaying a list in which elemets can be selected. Only one element can be selected at time. ListBox uses a ListModel to handle the list. To be able to use ListBox you must give ListBox an implemented ListModel which represents your list.

Constructor & Destructor Documentation

gcn::ListBox::ListBox (  ) 

Constructor.

gcn::ListBox::ListBox ( ListModel listModel  ) 

Constructor.

Parameters:
listModel the ListModel to use.

virtual gcn::ListBox::~ListBox (  )  [inline, virtual]

Destructor.


Member Function Documentation

int gcn::ListBox::getSelected (  )  [virtual]

Gets the ListModel index of the selected element.

Returns:
the ListModel index of the selected element.

void gcn::ListBox::setSelected ( int  selected  )  [virtual]

Sets the ListModel index of the selected element.

Parameters:
selected the ListModel index of the selected element.

void gcn::ListBox::setListModel ( ListModel listModel  )  [virtual]

Sets the ListModel to use.

Parameters:
listModel the ListModel to use.

ListModel * gcn::ListBox::getListModel (  )  [virtual]

Gets the ListModel used.

Returns:
the ListModel used.

void gcn::ListBox::adjustSize (  )  [virtual]

Adjusts the size of the ListBox to fit the font used.

void gcn::ListBox::draw ( Graphics graphics  )  [virtual]

Draws the Widget. It is called by the parent widget when it is time for the Widget to draw itself. The graphics object is set up so that all drawing is relative to the Widget, i.e coordinate (0,0) is the top-left corner of the Widget. It is not possible to draw outside of a Widgets dimension.

Parameters:
graphics a Graphics object to draw with.

Implements gcn::Widget.

void gcn::ListBox::drawBorder ( Graphics  )  [virtual]

Draws a the Widget border. A border is drawn around a Widget. The width and height of the border is therefore the Widgets height+2*bordersize. Think of a painting that has a certain size, the border surrounds the painting.

Parameters:
graphics a Graphics object to draw with.

Reimplemented from gcn::Widget.

void gcn::ListBox::logic (  )  [virtual]

Called for all Widgets in the gui each time Gui::logic is called. You can do logic stuff here like playing an animation.

See also:
Gui

Reimplemented from gcn::Widget.

bool gcn::ListBox::keyPress ( const Key  )  [virtual]

Called if a key is pressed when the widget has keyboard focus. If a key is held down the widget will generate multiple key presses.

Parameters:
key the key pressed.

Reimplemented from gcn::KeyListener.

void gcn::ListBox::mousePress ( int  ,
int  ,
int   
) [virtual]

Called when a mouse button is pressed when the mouse is in the Widget area or if the Widget has focus.

NOTE: A mouse press is NOT equal to a mouse click. Use mouseClickMessage to check for mouse clicks.

Parameters:
x the x coordinate of the mouse relative to the Widget itself.
y the y coordinate of the mouse relative to the Widget itself.
button the button pressed.

Reimplemented from gcn::MouseListener.


Member Data Documentation

int gcn::ListBox::mSelected [protected]


The documentation for this class was generated from the following files:
(C) Copyright 1998-2012 by The Stratagus Project under the GNU General Public License.
All trademarks and copyrights on this page are owned by their respective owners.