$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::DropDown Class Reference

#include <dropdown.h>

Inheritance diagram for gcn::DropDown:

gcn::BasicContainer gcn::MouseListener gcn::KeyListener gcn::ActionListener gcn::Widget DropDownWidget

List of all members.


Public Member Functions

 DropDown ()
 DropDown (ListModel *listModel)
 DropDown (ListModel *listModel, ScrollArea *scrollArea, ListBox *listBox)
virtual ~DropDown ()
virtual int getSelected ()
virtual void setSelected (int selected)
virtual void setListModel (ListModel *listModel)
virtual ListModelgetListModel ()
virtual void setScrollArea (ScrollArea *scrollArea)
virtual ScrollAreagetScrollArea ()
virtual void setListBox (ListBox *listBox)
virtual ListBoxgetListBox ()
virtual void adjustHeight ()
virtual void draw (Graphics *graphics)
virtual void drawBorder (Graphics *graphics)
virtual bool _keyInputMessage (const KeyInput &keyInput)
virtual void logic ()
virtual void _mouseInputMessage (const MouseInput &mouseInput)
virtual void lostFocus ()
virtual void setBaseColor (const Color &color)
virtual void setBackgroundColor (const Color &color)
virtual void setForegroundColor (const Color &color)
virtual void moveToTop (Widget *widget)
virtual void moveToBottom (Widget *widget)
virtual void _announceDeath (Widget *widget)
virtual void getDrawSize (int &width, int &height, Widget *widget)
virtual void action (const std::string &eventId)
virtual bool keyPress (const Key &key)
virtual void mousePress (int x, int y, int button)
virtual void mouseRelease (int x, int y, int button)
virtual void setFont (Font *font)
virtual bool getDirty () const

Protected Member Functions

virtual void drawButton (Graphics *graphics)
virtual void dropDown ()
virtual void foldUp ()

Protected Attributes

bool mDroppedDown
bool mPushed
int mOldH
ScrollAreamScrollArea
ListBoxmListBox
ScrollAreamDefaultScrollArea
ListBoxmDefaultListBox
FocusHandler mFocusHandler

Detailed Description

A drop down box from which you can select different values. It is one of the most complicated Widgets you will find in Guichan. For drawing the DroppedDown box it uses one ScrollArea and one ListBox. It also uses an internal FocusHandler to handle the focus of the internal ScollArea and ListBox. DropDown uses a ListModel to handle the list. To be able to use DropDown you must give DropDown an implemented ListModel which represents your list.

Constructor & Destructor Documentation

gcn::DropDown::DropDown (  ) 

Constructor.

gcn::DropDown::DropDown ( ListModel listModel  ) 

Contructor.

Parameters:
listModel the ListModel to use.
See also:
ListModel.

gcn::DropDown::DropDown ( ListModel listModel,
ScrollArea scrollArea,
ListBox listBox 
)

Contructor.

Parameters:
listModel the ListModel to use.
scrollArea the ScrollArea to use.
listBox the listBox to use.
See also:
ListModel, ScrollArea, ListBox.

gcn::DropDown::~DropDown (  )  [virtual]

Destructor.


Member Function Documentation

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

Gets the index int the ListModel of the selected element.

Returns:
the selected element.

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

Sets the ListModel index of the selected element.

Parameters:
selected the ListModel index of the selected element.

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

Sets the ListModel to use.

Parameters:
listModel the ListModel to use.

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

Gets the ListModel used.

Returns:
the ListModel used.

void gcn::DropDown::setScrollArea ( ScrollArea scrollArea  )  [virtual]

Sets the ScrollArea to use.

Parameters:
scrollArea the ScrollArea to use.

ScrollArea * gcn::DropDown::getScrollArea (  )  [virtual]

Gets the ScrollArea used.

Returns:
the ScrollArea used.

void gcn::DropDown::setListBox ( ListBox listBox  )  [virtual]

Sets the ListBox to use.

Parameters:
listBox the ListBox to use.

ListBox * gcn::DropDown::getListBox (  )  [virtual]

Gets the ListBox used.

Returns:
the ListBox used.

void gcn::DropDown::adjustHeight (  )  [virtual]

Adjusts the height of the DropDown fitting it's parents height.

void gcn::DropDown::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::DropDown::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.

bool gcn::DropDown::_keyInputMessage ( const KeyInput keyInput  )  [virtual]

Called when a Widget recieves a KeyInput.

WARNING: This function is used internally to handle all key messages. Don't call or overload it unless you know what you are doing.

Parameters:
keyInput the KeyInput message.

Reimplemented from gcn::Widget.

void gcn::DropDown::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.

void gcn::DropDown::_mouseInputMessage ( const MouseInput mouseInput  )  [virtual]

Called when a Widget recieves a MouseInput.

WARNING: This function is used internally to handle all mouse messages. Don't call or overload it unless you know what you are doing.

Parameters:
mouseInput the MouseInput message.

Reimplemented from gcn::Widget.

void gcn::DropDown::lostFocus (  )  [virtual]

Called if the Widget loses focus.

Reimplemented from gcn::Widget.

void gcn::DropDown::setBaseColor ( const Color color  )  [virtual]

Sets the base color. The base color is the background color for many Widgets like the Button and Contianer Widgets.

Parameters:
color the baseground Color.

Reimplemented from gcn::Widget.

void gcn::DropDown::setBackgroundColor ( const Color color  )  [virtual]

Sets the background color.

Parameters:
color the background Color.

Reimplemented from gcn::Widget.

void gcn::DropDown::setForegroundColor ( const Color color  )  [virtual]

Sets the foreground color.

Parameters:
color the foreground Color.

Reimplemented from gcn::Widget.

void gcn::DropDown::moveToTop ( Widget widget  )  [virtual]

Moves a Widget to the top of the BasicContainer. The widget will be drawn above all other Widgets in the BasicContainer.

Parameters:
widget the Widget to move.

Implements gcn::BasicContainer.

void gcn::DropDown::moveToBottom ( Widget widget  )  [virtual]

Moves a widget to the bottom of the BasicContainer. The Widget will be drawn below all other Widgets in the BasicContainer.

Parameters:
widget the Widget to move.

Implements gcn::BasicContainer.

void gcn::DropDown::_announceDeath ( Widget widget  )  [virtual]

Called when a child of the BasicContainer gets destroyed.

Parameters:
widget the destroyed Widget.

Implements gcn::BasicContainer.

void gcn::DropDown::getDrawSize ( int &  width,
int &  height,
Widget widget 
) [virtual]

Gets the drawing space size a Widget has in the BasicContainer. It may not be the same size as the Widgets width and height.

NOTE: Size is not checked recursively all the way back to the top Widget. If the BasicContainer itself is clipped, the size may be inaccurate.

Parameters:
width the width the Widget's draw space has.
height the height the Widget's draw space has.
widget the Widget calling the function.

Implements gcn::BasicContainer.

void gcn::DropDown::action ( const std::string &  eventId  )  [virtual]

Called whan an action is recieved from a Widget. It is used to be able to recieve a notification that an action has occured.

Parameters:
eventId the identifier of the Widget.

Implements gcn::ActionListener.

bool gcn::DropDown::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::DropDown::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.

void gcn::DropDown::mouseRelease ( int  ,
int  ,
int   
) [virtual]

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

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 released.

Reimplemented from gcn::MouseListener.

void gcn::DropDown::setFont ( Font font  )  [virtual]

Sets the font. If font is NULL, the global font will be used.

Parameters:
font the Font.

Reimplemented from gcn::Widget.

bool gcn::DropDown::getDirty (  )  const [virtual]

Reimplemented from gcn::Widget.

void gcn::DropDown::drawButton ( Graphics graphics  )  [protected, virtual]

Draws the button with the little down arrow.

Parameters:
graphics a Graphics object to draw with.

void gcn::DropDown::dropDown (  )  [protected, virtual]

Sets the DropDown Widget to dropped-down mode.

void gcn::DropDown::foldUp (  )  [protected, virtual]

Sets the DropDown Widget to folded-up mode.


Member Data Documentation

bool gcn::DropDown::mDroppedDown [protected]

bool gcn::DropDown::mPushed [protected]

int gcn::DropDown::mOldH [protected]

Reimplemented from gcn::Widget.


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.