#include <dropdown.h>

Inheritance diagram for DropDown:

Public Member Functions
	DropDown (const Widget2 const widget, ListModel const listModel, const bool extended, const Modal modal, ActionListener *const listener, const std::string &eventId)

	~DropDown ()

void	updateAlpha ()

void	draw (Graphics *const graphics)

void	safeDraw (Graphics *const graphics)

void	drawFrame (Graphics *const graphics)

void	safeDrawFrame (Graphics *const graphics)

void	keyPressed (KeyEvent &event)

void	mousePressed (MouseEvent &event)

void	mouseReleased (MouseEvent &event)

void	mouseDragged (MouseEvent &event)

void	mouseWheelMovedUp (MouseEvent &event)

void	mouseWheelMovedDown (MouseEvent &event)

void	setSelectedString (const std::string &str)

std::string	getSelectedString () const

void	valueChanged (const SelectionEvent &event)

void	updateSelection ()

void	adjustHeight ()

void	dropDown ()

void	foldUp ()

void	hideDrop (bool event)

int	getSelected () const

void	setSelected (int selected)

void	setListModel (ListModel *const listModel)

ListModel *	getListModel ()

void	addSelectionListener (SelectionListener *listener)

void	removeSelectionListener (SelectionListener *selectionListener)

Rect	getChildrenArea ()

void	action (const ActionEvent &actionEvent)

void	distributeValueChangedEvent ()

Public Member Functions inherited from ActionListener
virtual	~ActionListener ()

Public Member Functions inherited from BasicContainer
	BasicContainer (const Widget2 *const widget)

	~BasicContainer ()

void	showWidgetPart (Widget *const widget, const Rect &area)

void	moveToTop (Widget *const widget)

void	moveToBottom (Widget *const widget)

void	focusNext ()

void	focusPrevious ()

void	logic ()

void	setFocusHandler (FocusHandler *const focusHandler)

void	setInternalFocusHandler (FocusHandler *const focusHandler)

Widget *	getWidgetAt (int x, int y)

void	death (const Event &event)

Widget *	findFirstWidget (const std::set< Widget * > &list)

void	add (Widget *const widget)

virtual void	remove (Widget *const widget)

virtual void	clear ()

Public Member Functions inherited from Widget
	Widget (const Widget2 *const widget)

	~Widget ()

void	setFrameSize (const unsigned int frameSize)

unsigned int	getFrameSize () const

Widget *	getParent () const

void	setWidth (const int width)

int	getWidth () const

void	setHeight (const int height)

int	getHeight () const

void	setSize (const int width, const int height)

void	setX (const int x)

int	getX () const

void	setY (const int y)

int	getY () const

void	setPosition (const int x, const int y)

void	setDimension (const Rect &dimension)

const Rect &	getDimension () const

void	setFocusable (const bool focusable)

bool	isFocusable () const

virtual bool	isFocused () const

void	setEnabled (const bool enabled)

bool	isEnabled () const

void	setVisible (Visible visible)

bool	isVisible () const

void	setBaseColor (const Color &color)

const Color &	getBaseColor () const

void	setForegroundColor (const Color &color)

const Color &	getForegroundColor () const

void	setBackgroundColor (const Color &color)

const Color &	getBackgroundColor () const

virtual void	requestFocus ()

virtual void	requestMoveToTop ()

virtual void	requestMoveToBottom ()

FocusHandler *	getFocusHandler ()

void	addActionListener (ActionListener *const actionListener)

void	removeActionListener (ActionListener *const actionListener)

void	addDeathListener (WidgetDeathListener *const deathListener)

void	removeDeathListener (WidgetDeathListener *const deathListener)

void	addMouseListener (MouseListener *const mouseListener)

void	removeMouseListener (MouseListener *const mouseListener)

void	addKeyListener (KeyListener *const keyListener)

void	removeKeyListener (KeyListener *const keyListener)

void	addFocusListener (FocusListener *const focusListener)

void	removeFocusListener (FocusListener *const focusListener)

void	addWidgetListener (WidgetListener *const widgetListener)

void	removeWidgetListener (WidgetListener *const widgetListener)

void	setActionEventId (const std::string &actionEventId)

const std::string &	getActionEventId () const

virtual void	getAbsolutePosition (int &x, int &y) const

virtual void	setParent (Widget *parent)

Font *	getFont () const

void	setFont (Font *const font)

virtual void	fontChanged ()

bool	isTabInEnabled () const

void	setTabInEnabled (const bool enabled)

bool	isTabOutEnabled () const

void	setTabOutEnabled (const bool enabled)

void	requestModalFocus ()

virtual void	requestModalMouseInputFocus ()

virtual void	releaseModalFocus ()

virtual void	releaseModalMouseInputFocus ()

virtual bool	isModalFocused () const

virtual bool	isModalMouseInputFocused () const

const std::list< MouseListener * > &	getMouseListeners () const A_CONST

const std::list< KeyListener * > &	getKeyListeners () const A_CONST

const std::list< FocusListener * > &	getFocusListeners () const A_CONST

virtual FocusHandler *	getInternalFocusHandler ()

void	setInternalFocusHandler (FocusHandler *const internalFocusHandler)

void	setId (const std::string &id)

const std::string &	getId () const

virtual void	showPart (const Rect &rectangle)

bool	isAllowLogic () const

void	setMouseConsume (const bool b)

bool	isMouseConsume () const

void	setRedraw (const bool b)

virtual bool	isSelectable () const

void	setSelectable (const bool selectable)

void	windowResized ()

virtual void	postInit ()

Public Member Functions inherited from Widget2
virtual	~Widget2 ()

const Color &	getThemeColor (const ThemeColorIdT type, const unsigned int alpha) const A_INLINE

const Color &	getThemeCharColor (const signed char c, bool &valid) const A_INLINE

virtual void	setWidget2 (const Widget2 *const widget)

void	setPalette (int palette)

void	checkPalette ()

void	setForegroundColor2 (const Color &color)

Widget *	getWindow () const

virtual void	setWindow (Widget *const window)

Public Member Functions inherited from WidgetDeathListener
virtual	~WidgetDeathListener ()

Public Member Functions inherited from KeyListener
virtual	~KeyListener ()

virtual void	keyReleased (KeyEvent &event)

Public Member Functions inherited from MouseListener
virtual	~MouseListener ()

virtual void	mouseEntered (MouseEvent &event)

virtual void	mouseExited (MouseEvent &event)

virtual void	mouseClicked (MouseEvent &event)

virtual void	mouseMoved (MouseEvent &event)

Public Member Functions inherited from FocusListener
virtual	~FocusListener ()

virtual void	focusGained (const Event &event)

virtual void	focusLost (const Event &event)

Public Member Functions inherited from SelectionListener
virtual	~SelectionListener ()

Protected Types
typedef std::list< SelectionListener * >	SelectionListenerList

typedef SelectionListenerList::iterator	SelectionListenerIterator

Protected Types inherited from BasicContainer
typedef std::vector< Widget * >	WidgetList

typedef WidgetList::iterator	WidgetListIterator

typedef WidgetList::const_iterator	WidgetListConstIterator

typedef WidgetList::reverse_iterator	WidgetListReverseIterator

typedef WidgetList::const_reverse_iterator	WidgetListCReverseIterator

Protected Types inherited from 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

typedef std::list< WidgetDeathListener * >	WidgetDeathListenerList

typedef WidgetDeathListenerList::iterator	WidgetDeathListenerIterator

typedef std::list< FocusListener * >	FocusListenerList

typedef FocusListenerList::iterator	FocusListenerIterator

typedef std::list< WidgetListener * >	WidgetListenerList

typedef WidgetListenerList::iterator	WidgetListenerIterator

Protected Member Functions
void	drawButton (Graphics *const graphics)

Protected Member Functions inherited from ActionListener
	ActionListener ()

Protected Member Functions inherited from BasicContainer
virtual void	drawChildren (Graphics *const graphics)

virtual void	safeDrawChildren (Graphics *const graphics)

virtual void	logicChildren ()

Protected Member Functions inherited from Widget
void	distributeActionEvent ()

void	distributeResizedEvent ()

void	distributeMovedEvent ()

void	distributeHiddenEvent ()

void	distributeShownEvent ()

Protected Member Functions inherited from Widget2
	Widget2 (const Widget2 *const widget)

Protected Member Functions inherited from WidgetDeathListener
	WidgetDeathListener ()

Protected Member Functions inherited from KeyListener
	KeyListener ()

Protected Member Functions inherited from MouseListener
	MouseListener ()

Protected Member Functions inherited from FocusListener
	FocusListener ()

Protected Member Functions inherited from SelectionListener
	SelectionListener ()

Protected Attributes
PopupList *	mPopup

Color	mShadowColor

Color	mHighlightColor

int	mPadding

int	mImagePadding

int	mSpacing

int	mFoldedUpHeight

SelectionListenerList	mSelectionListeners

bool	mExtended

bool	mDroppedDown

bool	mPushed

bool	mIsDragged

Protected Attributes inherited from BasicContainer
WidgetList	mWidgets

WidgetList	mLogicWidgets

Protected Attributes inherited from Widget
MouseListenerList	mMouseListeners

KeyListenerList	mKeyListeners

ActionListenerList	mActionListeners

WidgetDeathListenerList	mDeathListeners

FocusListenerList	mFocusListeners

WidgetListenerList	mWidgetListeners

Color	mForegroundColor

Color	mBackgroundColor

Color	mBaseColor

Rect	mDimension

std::string	mActionEventId

std::string	mId

FocusHandler *	mFocusHandler

FocusHandler *	mInternalFocusHandler

Widget *	mParent

Font *	mCurrentFont

unsigned int	mFrameSize

bool	mFocusable

bool	mTabIn

bool	mTabOut

bool	mEnabled

bool	mAllowLogic

bool	mMouseConsume

bool	mRedraw

bool	mSelectable

Protected Attributes inherited from Widget2
int	mPaletteOffset

Widget *	mWindow

Color	mForegroundColor2

Static Protected Attributes
static int	instances = 0

static Image *	buttons [2][2]

static ImageRect	skinRect

static float	mAlpha = 1.0

static Skin *	mSkin = 0

Static Protected Attributes inherited from Widget
static Font *	mGlobalFont = 0

Additional Inherited Members
Static Public Member Functions inherited from Widget
static void	setGlobalFont (Font *const font)

static Font *	getGloablFont ()

static void	cleanGlobalFont ()

static bool	widgetExists (const Widget *const widget)

static void	distributeWindowResizeEvent ()

static Widget *	callPostInit (Widget *const widget)

Data Fields inherited from Widget
Visible	mVisible

Detailed Description

A drop down box from which you can select different values.

A ListModel provides the contents of the drop down. To be able to use DropDown you must give DropDown an implemented ListModel which represents your list.

Definition at line 51 of file dropdown.h.

Member Typedef Documentation

◆ SelectionListenerIterator

typedef SelectionListenerList::iterator DropDown::SelectionListenerIterator

protected

Definition at line 152 of file dropdown.h.

◆ SelectionListenerList

typedef std::list<SelectionListener*> DropDown::SelectionListenerList

protected

Definition at line 150 of file dropdown.h.

Constructor & Destructor Documentation

◆ DropDown()

DropDown::DropDown	(	const Widget2 *const	widget,
		ListModel *const	listModel,
		const bool	extended,
		const Modal	modal,
		ActionListener *const	listener,
		const std::string &	eventId
	)

Definition at line 56 of file dropdown.cpp.

                                              :
     ActionListener(),
     BasicContainer(widget),
     KeyListener(),
     MouseListener(),
     FocusListener(),
     SelectionListener(),
     mPopup(CREATEWIDGETR(PopupList, this, listModel, isExtended, modal)),
     mShadowColor(getThemeColor(ThemeColorId::DROPDOWN_SHADOW, 255U)),
     mHighlightColor(getThemeColor(ThemeColorId::HIGHLIGHT, 255U)),
     mPadding(1),
     mImagePadding(2),
     mSpacing(0),
     mFoldedUpHeight(0),
     mSelectionListeners(),
     mExtended(isExtended),
     mDroppedDown(false),
     mPushed(false),
     mIsDragged(false)
 {
     mAllowLogic = false;
     mFrameSize = 2;
     mForegroundColor2 = getThemeColor(ThemeColorId::DROPDOWN_OUTLINE, 255U);
  
     mPopup->setHeight(100);
  
     // Initialize graphics
     if (instances == 0 && (theme != nullptr))
     {
         // Load the background skin
         for (int i = 0; i < 2; i ++)
         {
             Skin *const skin = theme->load(dropdownFiles[i],
                 "dropdown.xml",
                 true,
                 Theme::getThemePath());
             if (skin != nullptr)
             {
                 if (i == 0)
                     mSkin = skin;
                 const ImageRect &rect = skin->getBorder();
                 for (int f = 0; f < 2; f ++)
                 {
                     if (rect.grid[f] != nullptr)
                     {
                         rect.grid[f]->incRef();
                         buttons[f][i] = rect.grid[f];
                         buttons[f][i]->setAlpha(mAlpha);
                     }
                     else
                     {
                         buttons[f][i] = nullptr;
                     }
                 }
                 if (i != 0)
                     theme->unload(skin);
             }
             else
             {
                 for (int f = 0; f < 2; f ++)
                     buttons[f][i] = nullptr;
             }
         }
  
         // get the border skin
         theme->loadRect(skinRect, "dropdown_background.xml", "", 0, 8);
     }
  
     instances++;
  
     setWidth(100);
     setFocusable(true);
     setListModel(listModel);
  
     if (mPopup->getSelected() < 0)
         mPopup->setSelected(0);
  
     addMouseListener(this);
     addKeyListener(this);
     addFocusListener(this);
  
     adjustHeight();
 //    mPopup->setForegroundColorAll(getThemeColor(ThemeColorId::DROPDOWN,
 //        255U),
 //        getThemeColor(ThemeColorId::DROPDOWN_OUTLINE, 255U));
     mForegroundColor = getThemeColor(ThemeColorId::DROPDOWN, 255U);
     mForegroundColor2 = getThemeColor(ThemeColorId::DROPDOWN_OUTLINE, 255U);
  
     if (!eventId.empty())
         setActionEventId(eventId);
  
     if (listener != nullptr)
         addActionListener(listener);
  
     mPopup->adjustSize();
  
     if (mSkin != nullptr)
     {
         mSpacing = mSkin->getOption("spacing");
         mFrameSize = CAST_U32(mSkin->getOption("frameSize"));
         mPadding = mSkin->getPadding();
         mImagePadding = mSkin->getOption("imagePadding");
     }
     adjustHeight();
 }

References Widget::addActionListener(), Widget::addFocusListener(), Widget::addKeyListener(), Widget::addMouseListener(), adjustHeight(), PopupList::adjustSize(), buttons, CAST_U32, dropdownFiles, Skin::getBorder(), Skin::getOption(), Skin::getPadding(), PopupList::getSelected(), Widget2::getThemeColor(), Theme::getThemePath(), ImageRect::grid, instances, anonymous_namespace{itemlinkhandler.cpp}::listener, Theme::load(), Theme::loadRect(), Widget::mAllowLogic, mAlpha, Widget::mForegroundColor, Widget2::mForegroundColor2, Widget::mFrameSize, mImagePadding, mPadding, mPopup, mSkin, mSpacing, Widget::setActionEventId(), Widget::setFocusable(), Widget::setHeight(), setListModel(), PopupList::setSelected(), Widget::setWidth(), skinRect, theme, and Theme::unload().

◆ ~DropDown()

DropDown::~DropDown ( )

Definition at line 167 of file dropdown.cpp.

 {
     if (gui != nullptr)
         gui->removeDragged(this);
  
     instances--;
     if (instances == 0)
     {
         for (int f = 0; f < 2; f ++)
         {
             for (int i = 0; i < 2; i ++)
             {
                 if (buttons[f][i] != nullptr)
                     buttons[f][i]->decRef();
             }
         }
         if (theme != nullptr)
         {
             theme->unload(mSkin);
             Theme::unloadRect(skinRect, 0, 8);
         }
     }
 }

References buttons, gui, instances, mSkin, Gui::removeDragged(), skinRect, theme, Theme::unload(), and Theme::unloadRect().

Member Function Documentation

◆ action()

void DropDown::action ( const ActionEvent & actionEvent )

virtual

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

Parameters

actionEvent The event of the action.

Implements ActionListener.

Definition at line 535 of file dropdown.cpp.

 {
     foldUp();
     distributeActionEvent();
 }

References Widget::distributeActionEvent(), and foldUp().

◆ addSelectionListener()

void DropDown::addSelectionListener ( SelectionListener * listener )

Definition at line 565 of file dropdown.cpp.

 {
     mSelectionListeners.push_back(selectionListener);
 }

References mSelectionListeners.

◆ adjustHeight()

void DropDown::adjustHeight ( )

Definition at line 470 of file dropdown.cpp.

 {
     setHeight(getFont()->getHeight() + 2 * mPadding);
 }

References Widget::getFont(), Widget::getHeight(), mPadding, and Widget::setHeight().

Referenced by dropDown(), DropDown(), foldUp(), setListModel(), Setup_Relations::Setup_Relations(), Setup_Theme::Setup_Theme(), and Setup_Relations::updateAll().

◆ distributeValueChangedEvent()

void DropDown::distributeValueChangedEvent ( )

Definition at line 575 of file dropdown.cpp.

 {
     for (SelectionListenerIterator iter = mSelectionListeners.begin();
           iter != mSelectionListeners.end();
           ++iter)
     {
         SelectionEvent event(this);
         (*iter)->valueChanged(event);
     }
 }

References mSelectionListeners.

Referenced by updateSelection().

◆ draw()

void DropDown::draw ( Graphics *const 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 widget's dimension.

Parameters

graphics aA graphics object to draw with.

Implements Widget.

Definition at line 217 of file dropdown.cpp.

 {
     BLOCK_START("DropDown::draw")
     int h;
  
     if (mDroppedDown)
         h = mFoldedUpHeight;
     else
         h = mDimension.height;
  
     updateAlpha();
  
     const unsigned int alpha = CAST_U32(mAlpha * 255.0F);
     mHighlightColor.a = alpha;
     mShadowColor.a = alpha;
  
     ListModel *const model = mPopup->getListModel();
     if ((model != nullptr) && mPopup->getSelected() >= 0)
     {
         Font *const font = getFont();
         if (mExtended)
         {
             const int sel = mPopup->getSelected();
             ExtendedListModel *const model2
                 = static_cast<ExtendedListModel *>(model);
             const Image *const image = model2->getImageAt(sel);
             if (image == nullptr)
             {
                 font->drawString(graphics,
                     mForegroundColor,
                     mForegroundColor2,
                     model->getElementAt(sel),
                     mPadding, mPadding);
             }
             else
             {
                 graphics->drawImage(image,
                     mImagePadding,
                     (mDimension.height - image->getHeight()) / 2 + mPadding);
                 font->drawString(graphics,
                     mForegroundColor,
                     mForegroundColor2,
                     model->getElementAt(sel),
                     image->getWidth() + mImagePadding + mSpacing, mPadding);
             }
         }
         else
         {
             font->drawString(graphics,
                 mForegroundColor,
                 mForegroundColor2,
                 model->getElementAt(mPopup->getSelected()),
                 mPadding, mPadding);
         }
     }
  
     if (isFocused())
     {
         const int pad = 2 * mPadding;
         graphics->setColor(mHighlightColor);
         graphics->drawRectangle(Rect(mPadding, mPadding,
             mDimension.width - h - pad, h - pad));
     }
  
     drawButton(graphics);
  
     if (mDroppedDown)
     {
         // Draw two lines separating the ListBox with selected
         // element view.
         const int w = mDimension.width;
         graphics->setColor(mHighlightColor);
         graphics->drawLine(0, h, w, h);
         graphics->setColor(mShadowColor);
         graphics->drawLine(0, h + 1, w, h + 1);
     }
     BLOCK_END("DropDown::draw")
 }

References Color::a, BLOCK_END, BLOCK_START, CAST_U32, drawButton(), Graphics::drawImage(), Graphics::drawLine(), Graphics::drawRectangle(), Font::drawString(), ListModel::getElementAt(), Widget::getFont(), ExtendedListModel::getImageAt(), PopupList::getListModel(), PopupList::getSelected(), Rect::height, Widget::isFocused(), mAlpha, Widget::mDimension, mDroppedDown, mExtended, mFoldedUpHeight, Widget::mForegroundColor, Widget2::mForegroundColor2, mHighlightColor, mImagePadding, mPadding, mPopup, mShadowColor, mSpacing, Graphics::setColor(), updateAlpha(), and Rect::width.

Referenced by safeDraw().

◆ drawButton()

void DropDown::drawButton ( Graphics *const graphics )

protected

Draws the button with the little down arrow.

Parameters

graphics a Graphics object to draw with.

Definition at line 323 of file dropdown.cpp.

 {
     Image *const image = buttons[mDroppedDown][mPushed];
     if (image != nullptr)
     {
         const int height = mDroppedDown ? mFoldedUpHeight : mDimension.height;
         graphics->drawImage(image,
             mDimension.width - image->getWidth() - mImagePadding,
             (height - image->getHeight()) / 2);
     }
 }

References buttons, Graphics::drawImage(), Rect::height, Widget::mDimension, mDroppedDown, mFoldedUpHeight, mImagePadding, mPushed, and Rect::width.

Referenced by draw().

◆ drawFrame()

void DropDown::drawFrame ( Graphics *const graphics )

virtual

Called when a widget is given a chance to draw a frame around itself. The frame is not considered a part of the widget, it only allows a frame to be drawn around the widget, thus a frame will never be included when calculating if a widget should receive events from user input. Also a widget's frame will never be included when calculating a widget's position.

The size of the frame is calculated using the widget's frame size. If a widget has a frame size of 10 pixels than the area the drawFrame function can draw to will be the size of the widget with an additional extension of 10 pixels in each direction.

An example when drawFrame is a useful function is if a widget needs a glow around itself.

Parameters

graphics A graphics object to draw with.

See also: setFrameSize, getFrameSize

Reimplemented from Widget.

Definition at line 301 of file dropdown.cpp.

 {
     BLOCK_START("DropDown::drawFrame")
     const int bs2 = CAST_S32(getFrameSize());
     const Rect &rect = mDimension;
     graphics->drawImageRect(0, 0,
         rect.width + bs2, rect.height + bs2,
         skinRect);
     BLOCK_END("DropDown::drawFrame")
 }

References BLOCK_END, BLOCK_START, CAST_S32, Graphics::drawImageRect(), Widget::getFrameSize(), Rect::height, Widget::mDimension, skinRect, and Rect::width.

◆ dropDown()

void DropDown::dropDown ( )

Definition at line 475 of file dropdown.cpp.

 {
     if (!mDroppedDown)
     {
         if (mParent == nullptr)
             return;
         mDroppedDown = true;
         mFoldedUpHeight = getHeight();
         adjustHeight();
  
         int x = 0;
         int y = 0;
         getAbsolutePosition(x, y);
         const int frame = CAST_S32(mParent->getFrameSize());
         const int pad = mPopup->getPadding();
         const int pad2 = pad * 2;
  
         // here width should be adjusted on some other parameters
         mPopup->setWidth(mDimension.width - pad2 + 8);
         mPopup->show(x - mPadding - frame - 1, y + mDimension.height);
         mPopup->requestMoveToTop();
         mPopup->requestFocus();
     }
 }

References adjustHeight(), CAST_S32, Widget::getAbsolutePosition(), Widget::getFrameSize(), Widget::getHeight(), Popup::getPadding(), Rect::height, Widget::mDimension, mDroppedDown, mFoldedUpHeight, mPadding, Widget::mParent, mPopup, Widget::requestFocus(), Widget::requestMoveToTop(), Widget::setWidth(), PopupList::show(), Rect::width, x, and y.

Referenced by keyPressed(), and mousePressed().

◆ foldUp()

void DropDown::foldUp ( )

Definition at line 500 of file dropdown.cpp.

 {
     if (mDroppedDown)
     {
         mDroppedDown = false;
         adjustHeight();
     }
 }

References adjustHeight(), and mDroppedDown.

Referenced by action(), mousePressed(), and mouseReleased().

◆ getChildrenArea()

Rect DropDown::getChildrenArea ( )

virtual

Gets the area of the widget occupied by the widget's children. By default this method returns an empty rectangle as not all widgets are containers. If you want to make a container this method should return the area where the children resides. This method is used when drawing children of a widget when computing clip rectangles for the children.

An example of a widget that overloads this method is ScrollArea. A ScrollArea has a view of its contant and that view is the children area. The size of a ScrollArea's children area might vary depending on if the scroll bars of the ScrollArea is shown or not.

Returns: The area of the widget occupied by the widget's children.

See also: BasicContainer; BasicContainer::getChildrenArea; BasicContainer::drawChildren

Reimplemented from BasicContainer.

Definition at line 541 of file dropdown.cpp.

 {
     if (mDroppedDown)
     {
         // Calculate the children area (with the one pixel border in mind)
         return Rect(1, mFoldedUpHeight + 1,
             mDimension.width - 2, mDimension.height - mFoldedUpHeight - 2);
     }
  
     return Rect();
 }

References Rect::height, Widget::mDimension, mDroppedDown, mFoldedUpHeight, and Rect::width.

◆ getListModel()

ListModel * DropDown::getListModel ( )

Definition at line 530 of file dropdown.cpp.

 {
     return mPopup->getListModel();
 }

References PopupList::getListModel(), and mPopup.

◆ getSelected()

int DropDown::getSelected ( ) const

◆ getSelectedString()

std::string DropDown::getSelectedString ( ) const

Definition at line 461 of file dropdown.cpp.

 {
     ListModel *const listModel = mPopup->getListModel();
     if (listModel == nullptr)
         return "";
  
     return listModel->getElementAt(getSelected());
 }

References ListModel::getElementAt(), PopupList::getListModel(), getSelected(), and mPopup.

Referenced by Setup_Theme::action(), and TextCommandEditor::save().

◆ hideDrop()

void DropDown::hideDrop ( bool event )

Definition at line 378 of file dropdown.cpp.

 {
     if (event)
         distributeActionEvent();
     mPopup->setVisible(Visible_false);
 }

References Widget::distributeActionEvent(), mPopup, Widget::setVisible(), and Visible_false.

Referenced by mousePressed(), InventoryWindow::setVisible(), InventoryWindow::~InventoryWindow(), and LoginDialog::~LoginDialog().

◆ keyPressed()

void DropDown::keyPressed ( KeyEvent & event )

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

event Discribes the event.

Reimplemented from KeyListener.

Definition at line 335 of file dropdown.cpp.

 {
     if (event.isConsumed())
         return;
  
     const InputActionT actionId = event.getActionId();
     PRAGMA45(GCC diagnostic push)
     PRAGMA45(GCC diagnostic ignored "-Wswitch-enum")
     switch (actionId)
     {
         case InputAction::GUI_SELECT:
         case InputAction::GUI_SELECT2:
             dropDown();
             break;
  
         case InputAction::GUI_UP:
             setSelected(getSelected() - 1);
             break;
  
         case InputAction::GUI_DOWN:
             setSelected(getSelected() + 1);
             break;
  
         case InputAction::GUI_HOME:
             setSelected(0);
             break;
  
         case InputAction::GUI_END:
             if (mPopup->getListModel() != nullptr)
             {
                 setSelected(mPopup->getListModel()->
                     getNumberOfElements() - 1);
             }
             break;
  
         default:
             return;
     }
     PRAGMA45(GCC diagnostic pop)
  
     event.consume();
 }

References dropDown(), PopupList::getListModel(), getSelected(), InputAction::GUI_DOWN, InputAction::GUI_END, InputAction::GUI_HOME, InputAction::GUI_SELECT, InputAction::GUI_SELECT2, InputAction::GUI_UP, InputGuiEvent::isConsumed(), mPopup, PRAGMA45(), and setSelected().

◆ mouseDragged()

void DropDown::mouseDragged ( MouseEvent & event )

virtual

Called when the mouse has moved and the mouse has previously been pressed on the widget.

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 427 of file dropdown.cpp.

 {
     mIsDragged = true;
     event.consume();
 }

References mIsDragged.

◆ mousePressed()

void DropDown::mousePressed ( MouseEvent & event )

virtual

Called when a mouse button has been pressed on the widget area.

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

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 385 of file dropdown.cpp.

 {
     event.consume();
     // If we have a mouse press on the widget.
     if (event.getButton() == MouseButton::LEFT
         && !mDroppedDown && event.getSource() == this)
     {
         mPushed = true;
         dropDown();
     }
     else
     {
         mPushed = false;
         foldUp();
         hideDrop(true);
     }
 }

References dropDown(), foldUp(), MouseEvent::getButton(), Event::getSource(), hideDrop(), MouseButton::LEFT, mDroppedDown, and mPushed.

◆ mouseReleased()

void DropDown::mouseReleased ( MouseEvent & event )

virtual

Called when a mouse button has been released on the widget area.

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 403 of file dropdown.cpp.

 {
     if (mIsDragged)
         mPushed = false;
  
     const MouseButtonT button = event.getButton();
     const int x = event.getX();
     const int y = event.getY();
     // Released outside of widget. Can happen when we have modal
     // input focus.
     if ((0 > y || y >= mDimension.height || x < 0 || x >= mDimension.width)
         && button == MouseButton::LEFT)
     {
         if (mIsDragged)
             foldUp();
     }
     else if (button == MouseButton::LEFT)
     {
         mPushed = false;
     }
  
     mIsDragged = false;
 }

References foldUp(), Rect::height, MouseButton::LEFT, Widget::mDimension, mIsDragged, mPushed, Rect::width, x, and y.

◆ mouseWheelMovedDown()

void DropDown::mouseWheelMovedDown ( MouseEvent & event )

virtual

Called when the mouse wheel has moved down on the widget area.

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 439 of file dropdown.cpp.

 {
     setSelected(getSelected() + 1);
     event.consume();
 }

References getSelected(), and setSelected().

◆ mouseWheelMovedUp()

void DropDown::mouseWheelMovedUp ( MouseEvent & event )

virtual

Called when the mouse wheel has moved up on the widget area.

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 433 of file dropdown.cpp.

 {
     setSelected(getSelected() - 1);
     event.consume();
 }

References getSelected(), and setSelected().

◆ removeSelectionListener()

void DropDown::removeSelectionListener ( SelectionListener * selectionListener )

Definition at line 570 of file dropdown.cpp.

 {
     mSelectionListeners.remove(listener);
 }

References anonymous_namespace{itemlinkhandler.cpp}::listener, and mSelectionListeners.

◆ safeDraw()

void DropDown::safeDraw ( Graphics *const graphics )

virtual

Implements Widget.

Definition at line 296 of file dropdown.cpp.

 {
     DropDown::draw(graphics);
 }

References draw().

◆ safeDrawFrame()

void DropDown::safeDrawFrame ( Graphics *const graphics )

virtual

Reimplemented from Widget.

Definition at line 312 of file dropdown.cpp.

 {
     BLOCK_START("DropDown::drawFrame")
     const int bs2 = CAST_S32(getFrameSize());
     const Rect &rect = mDimension;
     graphics->drawImageRect(0, 0,
         rect.width + bs2, rect.height + bs2,
         skinRect);
     BLOCK_END("DropDown::drawFrame")
 }

References BLOCK_END, BLOCK_START, CAST_S32, Graphics::drawImageRect(), Widget::getFrameSize(), Rect::height, Widget::mDimension, skinRect, and Rect::width.

◆ setListModel()

void DropDown::setListModel ( ListModel *const listModel )

Definition at line 520 of file dropdown.cpp.

 {
     mPopup->setListModel(listModel);
  
     if (mPopup->getSelected() < 0)
         mPopup->setSelected(0);
  
     adjustHeight();
 }

References adjustHeight(), PopupList::getSelected(), mPopup, PopupList::setListModel(), and PopupList::setSelected().

Referenced by DropDown().

◆ setSelected()

void DropDown::setSelected ( int selected )

Definition at line 514 of file dropdown.cpp.

 {
     if (selected >= 0)
         mPopup->setSelected(selected);
 }

References mPopup, and PopupList::setSelected().

Referenced by Setup_Joystick::action(), Setup_Video::action(), Setup_Theme::apply(), Setup_Video::cancel(), ChatWindow::ChatWindow(), SetupItemDropDown::createControls(), SetupItemDropDownStr::createControls(), SetupActionDropDown::createControls(), EditServerDialog::EditServerDialog(), BuyDialog::init(), InventoryWindow::InventoryWindow(), keyPressed(), LoginDialog::LoginDialog(), mouseWheelMovedDown(), mouseWheelMovedUp(), PlayerTableModel::playerRelationsUpdated(), Setup_Relations::reset(), setSelectedString(), Setup_Joystick::Setup_Joystick(), Setup_Relations::Setup_Relations(), Setup_Theme::Setup_Theme(), Setup_Video::Setup_Video(), TextCommandEditor::TextCommandEditor(), SetupItemDropDown::toWidget(), SetupItemDropDownStr::toWidget(), SetupActionDropDown::toWidget(), and Setup_Relations::updateAll().

◆ setSelectedString()

void DropDown::setSelectedString ( const std::string & str )

Definition at line 445 of file dropdown.cpp.

 {
     ListModel *const listModel = mPopup->getListModel();
     if (listModel == nullptr)
         return;
  
     for (int f = 0; f < listModel->getNumberOfElements(); f ++)
     {
         if (listModel->getElementAt(f) == str)
         {
             setSelected(f);
             break;
         }
     }
 }

References ListModel::getElementAt(), PopupList::getListModel(), ListModel::getNumberOfElements(), mPopup, and setSelected().

Referenced by LoginDialog::LoginDialog(), Setup_Theme::Setup_Theme(), and TextCommandEditor::TextCommandEditor().

◆ updateAlpha()

void DropDown::updateAlpha ( )

Update the alpha value to the graphic components.

Definition at line 191 of file dropdown.cpp.

 {
     const float alpha = std::max(settings.guiAlpha,
         theme->getMinimumOpacity());
  
     if (mAlpha != alpha)
     {
         mAlpha = alpha;
  
         if (buttons[0][0] != nullptr)
             buttons[0][0]->setAlpha(mAlpha);
         if (buttons[0][1] != nullptr)
             buttons[0][1]->setAlpha(mAlpha);
         if (buttons[1][0] != nullptr)
             buttons[1][0]->setAlpha(mAlpha);
         if (buttons[1][1] != nullptr)
             buttons[1][1]->setAlpha(mAlpha);
  
         for (int a = 0; a < 9; a++)
         {
             if (skinRect.grid[a] != nullptr)
                 skinRect.grid[a]->setAlpha(mAlpha);
         }
     }
 }

References buttons, Theme::getMinimumOpacity(), ImageRect::grid, Settings::guiAlpha, mAlpha, settings, skinRect, and theme.

Referenced by draw().

◆ updateSelection()

void DropDown::updateSelection ( )

Definition at line 557 of file dropdown.cpp.

 {
     mDroppedDown = false;
     mPushed = false;
     distributeActionEvent();
     distributeValueChangedEvent();
 }

References Widget::distributeActionEvent(), distributeValueChangedEvent(), mDroppedDown, and mPushed.

Referenced by PopupList::focusGained(), PopupList::focusLost(), and PopupList::mouseReleased().

◆ valueChanged()

void DropDown::valueChanged ( const SelectionEvent & event )

virtual

Called when the value of a selection has been changed in a Widget. It is used to be able to recieve a notification that a value has been changed.

Parameters

event The event of the value change.

Reimplemented from SelectionListener.

Definition at line 553 of file dropdown.cpp.

554 {

555 }

Field Documentation

◆ buttons

Image * DropDown::buttons

staticprotected

Definition at line 161 of file dropdown.h.

Referenced by drawButton(), DropDown(), updateAlpha(), and ~DropDown().

◆ instances

int DropDown::instances = 0

staticprotected

Definition at line 160 of file dropdown.h.

Referenced by DropDown(), and ~DropDown().

◆ mAlpha

float DropDown::mAlpha = 1.0

staticprotected

Definition at line 163 of file dropdown.h.

Referenced by draw(), DropDown(), and updateAlpha().

◆ mDroppedDown

bool DropDown::mDroppedDown

protected

Definition at line 155 of file dropdown.h.

Referenced by draw(), drawButton(), dropDown(), foldUp(), getChildrenArea(), mousePressed(), and updateSelection().

◆ mExtended

bool DropDown::mExtended

protected

Definition at line 154 of file dropdown.h.

Referenced by draw().

◆ mFoldedUpHeight

int DropDown::mFoldedUpHeight

protected

Definition at line 148 of file dropdown.h.

Referenced by draw(), drawButton(), dropDown(), and getChildrenArea().

◆ mHighlightColor

Color DropDown::mHighlightColor

protected

Definition at line 144 of file dropdown.h.

Referenced by draw().

◆ mImagePadding

int DropDown::mImagePadding

protected

Definition at line 146 of file dropdown.h.

Referenced by draw(), drawButton(), and DropDown().

◆ mIsDragged

bool DropDown::mIsDragged

protected

Definition at line 157 of file dropdown.h.

Referenced by mouseDragged(), and mouseReleased().

◆ mPadding

int DropDown::mPadding

protected

Definition at line 145 of file dropdown.h.

Referenced by adjustHeight(), draw(), dropDown(), and DropDown().

◆ mPopup

PopupList* DropDown::mPopup

protected

Definition at line 142 of file dropdown.h.

Referenced by draw(), dropDown(), DropDown(), getListModel(), getSelected(), getSelectedString(), hideDrop(), keyPressed(), setListModel(), setSelected(), and setSelectedString().

◆ mPushed

bool DropDown::mPushed

protected

Definition at line 156 of file dropdown.h.

Referenced by drawButton(), mousePressed(), mouseReleased(), and updateSelection().

◆ mSelectionListeners

SelectionListenerList DropDown::mSelectionListeners

protected

Definition at line 151 of file dropdown.h.

Referenced by addSelectionListener(), distributeValueChangedEvent(), and removeSelectionListener().

◆ mShadowColor

Color DropDown::mShadowColor

protected

Definition at line 143 of file dropdown.h.

Referenced by draw().

◆ mSkin

Skin * DropDown::mSkin = 0

staticprotected

Definition at line 164 of file dropdown.h.

Referenced by DropDown(), and ~DropDown().

◆ mSpacing

int DropDown::mSpacing

protected

Definition at line 147 of file dropdown.h.

Referenced by draw(), and DropDown().

◆ skinRect

ImageRect DropDown::skinRect

staticprotected

Definition at line 162 of file dropdown.h.

Referenced by drawFrame(), DropDown(), safeDrawFrame(), updateAlpha(), and ~DropDown().

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

src/gui/widgets/dropdown.h (986a3bf)
src/gui/widgets/dropdown.cpp (986a3bf)

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SelectionListenerIterator

◆ SelectionListenerList

Constructor & Destructor Documentation

◆ DropDown()

◆ ~DropDown()

Member Function Documentation

◆ action()

◆ addSelectionListener()

◆ adjustHeight()

◆ distributeValueChangedEvent()

◆ draw()

◆ drawButton()

◆ drawFrame()

◆ dropDown()

◆ foldUp()

◆ getChildrenArea()

◆ getListModel()

◆ getSelected()

◆ getSelectedString()

◆ hideDrop()

◆ keyPressed()

◆ mouseDragged()

◆ mousePressed()

◆ mouseReleased()

◆ mouseWheelMovedDown()

◆ mouseWheelMovedUp()

◆ removeSelectionListener()

◆ safeDraw()

◆ safeDrawFrame()

◆ setListModel()

◆ setSelected()

◆ setSelectedString()

◆ updateAlpha()

◆ updateSelection()

◆ valueChanged()

Field Documentation

◆ buttons

◆ instances

◆ mAlpha

◆ mDroppedDown

◆ mExtended

◆ mFoldedUpHeight

◆ mHighlightColor

◆ mImagePadding

◆ mIsDragged

◆ mPadding

◆ mPopup

◆ mPushed

◆ mSelectionListeners

◆ mShadowColor

◆ mSkin

◆ mSpacing

◆ skinRect