_________ __                 __
        /   _____//  |_____________ _/  |______     ____  __ __  ______
        \_____  \\   __\_  __ \__  \\   __\__  \   / ___\|  |  \/  ___/
        /        \|  |  |  | \// __ \|  |  / __ \_/ /_/  >  |  /\___ \
       /_______  /|__|  |__|  (____  /__| (____  /\___  /|____//____  >
               \/                  \/          \//_____/            \/
    ______________________                           ______________________
                          T H E   W A R   B E G I N S
                   Stratagus - A free fantasy real time strategy game engine
List of all members
ListBoxWidget Class Reference

#include <widgets.h>

Inheritance diagram for ListBoxWidget:
gcn::ScrollArea gcn::BasicContainer gcn::MouseListener gcn::Widget ImageListBoxWidget

widgets.cpp - The stratagus ui widgets.

 ListBoxWidget (unsigned int width, unsigned int height)
 
void setList (lua_State *lua, lua_Object *lo)
 
void setSelected (int i)
 
int getSelected () const
 
virtual void setBackgroundColor (const gcn::Color &color)
 
virtual void setFont (gcn::Font *font)
 
virtual void addActionListener (gcn::ActionListener *actionListener)
 

Additional Inherited Members

- Public Types inherited from gcn::ScrollArea
enum  { SHOW_ALWAYS, SHOW_NEVER, SHOW_AUTO }
 
- Public Member Functions inherited from gcn::ScrollArea
 ScrollArea ()
 
 ScrollArea (Widget *content)
 
 ScrollArea (Widget *content, unsigned int hPolicy, unsigned int vPolicy)
 
virtual ~ScrollArea ()
 
virtual void setContent (Widget *widget)
 
virtual Widget * getContent ()
 
virtual void setHorizontalScrollPolicy (unsigned int hPolicy)
 
virtual unsigned int getHorizontalScrollPolicy ()
 
virtual void setVerticalScrollPolicy (unsigned int vPolicy)
 
virtual unsigned int getVerticalScrollPolicy ()
 
virtual void setScrollPolicy (unsigned int hPolicy, unsigned int vPolicy)
 
virtual void scrollToBottom ()
 
virtual void scrollToTop ()
 
virtual void setVerticalScrollAmount (int vScroll)
 
virtual int getVerticalScrollAmount ()
 
virtual void setHorizontalScrollAmount (int hScroll)
 
virtual int getHorizontalScrollAmount ()
 
virtual void setScrollAmount (int hScroll, int vScroll)
 
virtual int getHorizontalMaxScroll ()
 
virtual int getVerticalMaxScroll ()
 
virtual void setScrollbarWidth (int width)
 
virtual int getScrollbarWidth ()
 
virtual void scrollToRectangle (const Rectangle &rectangle)
 
virtual void draw (Graphics *graphics)
 
virtual void drawBorder (Graphics *graphics)
 
virtual void logic ()
 
virtual void _mouseInputMessage (const MouseInput &mouseInput)
 
virtual void _mouseOutMessage ()
 
virtual void _setFocusHandler (FocusHandler *focusHandler)
 
virtual void _announceDeath (Widget *widget)
 
virtual void getDrawSize (int &width, int &height, Widget *widget)
 
virtual void moveToBottom (Widget *widget)
 
virtual void moveToTop (Widget *widget)
 
virtual void mousePress (int x, int y, int button)
 
virtual void mouseRelease (int x, int y, int button)
 
virtual void mouseMotion (int x, int y)
 
virtual void mouseWheelUp (int x, int y)
 
virtual void mouseWheelDown (int x, int y)
 
- Public Member Functions inherited from gcn::BasicContainer
virtual ~BasicContainer ()
 
bool isParentOfWidget (Widget *widget)
 
- Public Member Functions inherited from gcn::Widget
 Widget ()
 
virtual ~Widget ()
 
virtual BasicContainer * getParent () const
 
virtual void setWidth (int width)
 
virtual int getWidth () const
 
virtual void setHeight (int height)
 
virtual int getHeight () const
 
virtual void setSize (int width, int height)
 
virtual void setX (int x)
 
virtual int getX () const
 
virtual void setY (int y)
 
virtual int getY () const
 
virtual void setPosition (int x, int y)
 
virtual void setDimension (const Rectangle &dimension)
 
virtual void setBorderSize (unsigned int borderSize)
 
virtual unsigned int getBorderSize () const
 
virtual const Rectangle & getDimension () const
 
virtual void setFocusable (bool focusable)
 
virtual bool isFocusable () const
 
virtual bool hasFocus () const
 
virtual void setEnabled (bool enabled)
 
virtual bool isEnabled () const
 
virtual void lostFocus ()
 
virtual void gotFocus ()
 
virtual bool hasMouse () const
 
virtual void setVisible (bool visible)
 
virtual bool isVisible () const
 
virtual void setBaseColor (const Color &color)
 
virtual const Color & getBaseColor () const
 
virtual void setForegroundColor (const Color &color)
 
virtual const Color & getForegroundColor () const
 
virtual const Color & getBackgroundColor () const
 
virtual void setDisabledColor (const Color &color)
 
virtual const Color & getDisabledColor () const
 
virtual bool _keyInputMessage (const KeyInput &keyInput)
 
virtual void hotKeyPress ()
 
virtual void hotKeyRelease ()
 
virtual void _mouseInMessage ()
 
virtual void requestFocus ()
 
virtual void requestMoveToTop ()
 
virtual void requestMoveToBottom ()
 
virtual FocusHandler * _getFocusHandler ()
 
virtual void removeActionListener (ActionListener *actionListener)
 
virtual void addMouseListener (MouseListener *mouseListener)
 
virtual void removeMouseListener (MouseListener *mouseListener)
 
virtual void addKeyListener (KeyListener *keyListener)
 
virtual void removeKeyListener (KeyListener *keyListener)
 
virtual void setEventId (const std::string &eventId)
 
virtual const std::string & getEventId () const
 
virtual void getAbsolutePosition (int &x, int &y) const
 
virtual void _setParent (BasicContainer *parent)
 
Font * getFont () const
 
virtual void fontChanged ()
 
virtual int getHotKey () const
 
virtual void setHotKey (const int key)
 
virtual void setHotKey (const char *key)
 
virtual bool isTabInEnabled () const
 
virtual void setTabInEnabled (bool enabled)
 
virtual bool isTabOutEnabled () const
 
virtual void setTabOutEnabled (bool enabled)
 
virtual bool isDragged () const
 
virtual void requestModalFocus ()
 
virtual void releaseModalFocus ()
 
virtual bool hasModalFocus () const
 
virtual void setDirty (bool dirty)
 
virtual bool getDirty () const
 
- Public Member Functions inherited from gcn::MouseListener
virtual ~MouseListener ()
 
virtual void mouseIn ()
 
virtual void mouseOut ()
 
virtual void mouseClick (int, int, int, int)
 
- Static Public Member Functions inherited from gcn::Widget
static void setGlobalFont (Font *font)
 
static bool widgetExists (const Widget *widget)
 
- Protected Types inherited from gcn::Widget
typedef std::list< MouseListener * > MouseListenerList
 
typedef MouseListenerList::iterator MouseListenerIterator
 
typedef std::list< KeyListener * > KeyListenerList
 
typedef KeyListenerList::iterator KeyListenerIterator
 
typedef std::list< ActionListener * > ActionListenerList
 
typedef ActionListenerList::iterator ActionListenerIterator
 
- Protected Member Functions inherited from gcn::ScrollArea
virtual void drawUpButton (Graphics *graphics)
 
virtual void drawDownButton (Graphics *graphics)
 
virtual void drawLeftButton (Graphics *graphics)
 
virtual void drawRightButton (Graphics *graphics)
 
virtual void drawContent (Graphics *graphics)
 
virtual void drawVBar (Graphics *graphics)
 
virtual void drawHBar (Graphics *graphics)
 
virtual void drawVMarker (Graphics *graphics)
 
virtual void drawHMarker (Graphics *graphics)
 
virtual void checkPolicies ()
 
virtual Rectangle getUpButtonDimension ()
 
virtual Rectangle getDownButtonDimension ()
 
virtual Rectangle getLeftButtonDimension ()
 
virtual Rectangle getRightButtonDimension ()
 
virtual Rectangle getContentDimension ()
 
virtual Rectangle getVerticalBarDimension ()
 
virtual Rectangle getHorizontalBarDimension ()
 
virtual Rectangle getVerticalMarkerDimension ()
 
virtual Rectangle getHorizontalMarkerDimension ()
 
- Protected Member Functions inherited from gcn::Widget
void generateAction ()
 
- Protected Member Functions inherited from gcn::MouseListener
 MouseListener ()
 
- Protected Attributes inherited from gcn::ScrollArea
Widget * mContent
 
int mVScroll
 
int mHScroll
 
int mScrollbarWidth
 
unsigned int mHPolicy
 
unsigned int mVPolicy
 
bool mVBarVisible
 
bool mHBarVisible
 
bool mUpButtonPressed
 
bool mDownButtonPressed
 
bool mLeftButtonPressed
 
bool mRightButtonPressed
 
bool mVerticalMarkerPressed
 
int mVerticalMarkerMousePosition
 
bool mHorizontalMarkerPressed
 
int mHorizontalMarkerMousePosition
 
- Protected Attributes inherited from gcn::Widget
MouseListenerList mMouseListeners
 
KeyListenerList mKeyListeners
 
ActionListenerList mActionListeners
 
Color mForegroundColor
 
Color mBackgroundColor
 
Color mBaseColor
 
Color mDisabledColor
 
FocusHandler * mFocusHandler
 
BasicContainer * mParent
 
Rectangle mDimension
 
unsigned int mBorderSize
 
std::string mEventId
 
int mClickTimeStamp
 
int mClickCount
 
int mClickButton
 
bool mHasMouse
 
bool mFocusable
 
bool mVisible
 
bool mTabIn
 
bool mTabOut
 
bool mEnabled
 
Font * mCurrentFont
 
int mHotKey
 
bool mDirty
 
- Static Protected Attributes inherited from gcn::Widget
static DefaultFont mDefaultFont
 
static Font * mGlobalFont = NULL
 
static std::list< Widget * > mWidgets
 

Constructor & Destructor Documentation

◆ ListBoxWidget()

ListBoxWidget::ListBoxWidget ( unsigned int  width,
unsigned int  height 
)

ListBoxWidget constructor.

Todo:
Size should be parametrable, maybe remove default constructor?

Member Function Documentation

◆ addActionListener()

void ListBoxWidget::addActionListener ( gcn::ActionListener *  actionListener)
virtual

Add an action listener

Reimplemented from gcn::Widget.

Reimplemented in ImageListBoxWidget.

◆ getSelected()

int ListBoxWidget::getSelected ( ) const

Gets the ListModel index of the selected element.

Returns
The ListModel index of the selected element.
See also
gcn::ListBox

◆ setBackgroundColor()

void ListBoxWidget::setBackgroundColor ( const gcn::Color &  color)
virtual

Set background color of the ListBoxWidget.

Parameters
colorColor to set.

Reimplemented from gcn::Widget.

Reimplemented in ImageListBoxWidget.

◆ setFont()

void ListBoxWidget::setFont ( gcn::Font *  font)
virtual

Set font of the ListBox.

Parameters
fontFont to set.

Reimplemented from gcn::Widget.

Reimplemented in ImageListBoxWidget.

◆ setList()

void ListBoxWidget::setList ( lua_State *  lua,
lua_Object *  lo 
)

Set the list

◆ setSelected()

void ListBoxWidget::setSelected ( int  selected)

Sets the ListModel index of the selected element.

Parameters
selectedThe ListModel index of the selected element.
See also
gcn::ListBox
The documentation for this class was generated from the following files:
Generated on Wed Aug 10 2022 20:03:33 for Stratagus by doxygen 1.8.17
(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.