#include <popuplist.h>

Inheritance diagram for PopupList:

Public Member Functions
	PopupList (DropDown const widget, ListModel const listModel, const bool extended, const Modal modal)

	~PopupList ()

void	postInit ()

void	show (int x, int y)

void	widgetResized (const Event &event)

void	setSelected (const int selected)

int	getSelected () const

void	setListModel (ListModel *const model)

ListModel *	getListModel () const

void	adjustSize ()

void	focusGained (const Event &event)

void	focusLost (const Event &event)

void	mousePressed (MouseEvent &event)

void	mouseReleased (MouseEvent &event)

Public Member Functions inherited from Popup
	Popup (const std::string &name, std::string skin)

	~Popup ()

void	draw (Graphics *const graphics)

void	safeDraw (Graphics *const graphics)

void	setContentSize (int width, int height)

void	setLocationRelativeTo (const Widget *const widget)

void	mouseMoved (MouseEvent &event)

void	setMinWidth (const int width)

int	getMinWidth () const

void	setMinHeight (const int height)

int	getMinHeight () const

void	setMaxWidth (const int width)

int	getMaxWidth () const

void	setMaxHeight (const int height)

int	getMaxHeight () const

int	getPadding () const

void	setPadding (int padding)

void	setPopupName (const std::string &name)

const std::string &	getPopupName () const

void	scheduleDelete ()

Rect	getChildrenArea ()

void	position (const int x, const int y)

void	hide ()

void	widgetMoved (const Event &event)

bool	isPopupVisible () const

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

	~Container ()

bool	safeRemove (Widget *const widget)

void	removeControls ()

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

	~BasicContainer2 ()

void	setOpaque (Opaque opaque)

bool	isOpaque () const

virtual void	add (Widget *const widget)

void	addXY (Widget *const widget, const int x, const int y)

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 ()

virtual void	drawFrame (Graphics *graphics)

virtual void	safeDrawFrame (Graphics *graphics)

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 ()

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 MouseListener
virtual	~MouseListener ()

virtual void	mouseEntered (MouseEvent &event)

virtual void	mouseExited (MouseEvent &event)

virtual void	mouseClicked (MouseEvent &event)

virtual void	mouseWheelMovedUp (MouseEvent &event)

virtual void	mouseWheelMovedDown (MouseEvent &event)

virtual void	mouseDragged (MouseEvent &event)

Public Member Functions inherited from WidgetListener
virtual	~WidgetListener ()

virtual void	widgetHidden (const Event &event)

virtual void	widgetShown (const Event &event)

Public Member Functions inherited from FocusListener
virtual	~FocusListener ()

Private Attributes
ListModel *	mListModel

ListBox *	mListBox

ScrollArea *	mScrollArea

DropDown *	mDropDown

int	mPressedIndex

Modal	mModal

Additional Inherited Members
Static Public Member Functions inherited from Popup
static void	setWindowContainer (WindowContainer *const windowContainer)

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

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 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 MouseListener
	MouseListener ()

Protected Member Functions inherited from WidgetListener
	WidgetListener ()

Protected Member Functions inherited from FocusListener
	FocusListener ()

Protected Attributes inherited from Popup
int	mPadding

Skin *	mSkin

Protected Attributes inherited from BasicContainer2
Opaque	mOpaque

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 inherited from Widget
static Font *	mGlobalFont = 0

Detailed Description

Definition at line 38 of file popuplist.h.

Constructor & Destructor Documentation

◆ PopupList()

PopupList::PopupList	(	DropDown *const	widget,
		ListModel *const	listModel,
		const bool	extended,
		const Modal	modal
	)

Definition at line 35 of file popuplist.cpp.

                                         :
     Popup("PopupList", "popuplist.xml"),
     FocusListener(),
     mListModel(listModel),
     mListBox(isExtended ? CREATEWIDGETR(ExtendedListBox,
         widget, listModel, "extendedlistbox.xml", 0) :
         CREATEWIDGETR(ListBox,
         widget, listModel, "popuplistbox.xml")),
     mScrollArea(new ScrollArea(this, mListBox, Opaque_false, std::string())),
     mDropDown(widget),
     mPressedIndex(-2),
     mModal(modal)
 {
     mListBox->setMouseConsume(false);
     mScrollArea->setMouseConsume(false);
     mAllowLogic = false;
     setFocusable(true);
  
     mListBox->setDistributeMousePressed(true);
     mScrollArea->setPosition(mPadding, mPadding);
 }

References Widget::mAllowLogic, mListBox, Popup::mPadding, mScrollArea, ListBox::setDistributeMousePressed(), Widget::setFocusable(), Widget::setMouseConsume(), and Widget::setPosition().

◆ ~PopupList()

PopupList::~PopupList ( )

Definition at line 73 of file popuplist.cpp.

 {
     if (mParent != nullptr)
         mParent->removeFocusListener(this);
     if (gui != nullptr)
         gui->removeGlobalFocusListener(this);
     removeKeyListener(mDropDown);
 }

References gui, mDropDown, Widget::mParent, Widget::removeFocusListener(), Gui::removeGlobalFocusListener(), and Widget::removeKeyListener().

Member Function Documentation

◆ adjustSize()

void PopupList::adjustSize ( )

Definition at line 130 of file popuplist.cpp.

 {
     const int pad2 = 2 * mPadding;
     const int width = mDimension.width - pad2;
     mScrollArea->setWidth(width);
     mScrollArea->setHeight(mDimension.height - pad2);
     mListBox->adjustSize();
     mListBox->setWidth(width);
 }

References ListBox::adjustSize(), Rect::height, Widget::mDimension, mListBox, Popup::mPadding, mScrollArea, ScrollArea::setHeight(), Widget::setWidth(), ScrollArea::setWidth(), and Rect::width.

Referenced by DropDown::DropDown(), postInit(), and widgetResized().

◆ focusGained()

void PopupList::focusGained ( const Event & event )

virtual

Called when a widget gains focus.

Parameters

event Discribes the event.

Reimplemented from FocusListener.

Definition at line 166 of file popuplist.cpp.

 {
     const Widget *const source = event.getSource();
     if (mVisible == Visible_false ||
         source == this ||
         source == mListBox ||
         source == mScrollArea ||
         source == mDropDown)
     {
         return;
     }
  
     if (mDropDown != nullptr)
         mDropDown->updateSelection();
     setVisible(Visible_false);
     if (mModal == Modal_true)
         releaseModalFocus();
 }

References mDropDown, mListBox, mModal, Modal_true, mScrollArea, Widget::mVisible, Widget::releaseModalFocus(), Widget::setVisible(), DropDown::updateSelection(), and Visible_false.

◆ focusLost()

void PopupList::focusLost ( const Event & event )

virtual

Called when a widget loses focus.

Parameters

event Discribes the event.

Reimplemented from FocusListener.

Definition at line 185 of file popuplist.cpp.

 {
     if (mDropDown != nullptr)
         mDropDown->updateSelection();
 }

References mDropDown, and DropDown::updateSelection().

◆ getListModel()

ListModel* PopupList::getListModel ( ) const

inline

Definition at line 63 of file popuplist.h.

64 { return mListModel; }

References mListModel.

Referenced by DropDown::draw(), DropDown::getListModel(), DropDown::getSelectedString(), DropDown::keyPressed(), and DropDown::setSelectedString().

◆ getSelected()

int PopupList::getSelected ( ) const

Definition at line 115 of file popuplist.cpp.

 {
     if (mListBox == nullptr)
         return -1;
  
     return mListBox->getSelected();
 }

References ListBox::getSelected(), and mListBox.

Referenced by DropDown::draw(), DropDown::DropDown(), DropDown::getSelected(), and DropDown::setListModel().

◆ mousePressed()

void PopupList::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 140 of file popuplist.cpp.

 {
     mPressedIndex = mListBox->getSelectionByMouse(
         event.getY() + mPadding);
     event.consume();
 }

References ListBox::getSelectionByMouse(), MouseEvent::getY(), mListBox, Popup::mPadding, and mPressedIndex.

◆ mouseReleased()

void PopupList::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 147 of file popuplist.cpp.

 {
     if (mPressedIndex != mListBox->getSelectionByMouse(
         event.getY() + mPadding))
     {
         mPressedIndex = -2;
         return;
     }
  
     mPressedIndex = -2;
     if (event.getSource() == mScrollArea)
         return;
     if (mDropDown != nullptr)
         mDropDown->updateSelection();
     setVisible(Visible_false);
     if (mModal == Modal_true)
         releaseModalFocus();
 }

References ListBox::getSelectionByMouse(), Event::getSource(), MouseEvent::getY(), mDropDown, mListBox, mModal, Modal_true, Popup::mPadding, mPressedIndex, mScrollArea, Widget::releaseModalFocus(), Widget::setVisible(), DropDown::updateSelection(), and Visible_false.

◆ postInit()

void PopupList::postInit ( )

virtual

Reimplemented from Popup.

Definition at line 60 of file popuplist.cpp.

 {
     Popup::postInit();
     add(mScrollArea);
  
     if (gui != nullptr)
         gui->addGlobalFocusListener(this);
  
     addKeyListener(mDropDown);
     addMouseListener(this);
     adjustSize();
 }

References BasicContainer2::add(), Gui::addGlobalFocusListener(), Widget::addKeyListener(), Widget::addMouseListener(), adjustSize(), gui, mDropDown, mScrollArea, and Popup::postInit().

◆ setListModel()

void PopupList::setListModel ( ListModel *const model )

Definition at line 123 of file popuplist.cpp.

 {
     if (mListBox != nullptr)
         mListBox->setListModel(model);
     mListModel = model;
 }

References mListBox, mListModel, and ListBox::setListModel().

Referenced by DropDown::setListModel().

◆ setSelected()

void PopupList::setSelected ( const int selected )

Definition at line 107 of file popuplist.cpp.

 {
     if (mListBox == nullptr)
         return;
  
     mListBox->setSelected(selected);
 }

References mListBox, and ListBox::setSelected().

Referenced by DropDown::DropDown(), DropDown::setListModel(), and DropDown::setSelected().

◆ show()

void PopupList::show	(	int	x,
		int	y
	)

Definition at line 82 of file popuplist.cpp.

 {
     int len = mListBox->getHeight() + 8;
     if (len > 250)
         len = 250;
     setContentSize(mListBox->getWidth() + 8, len);
     const int width = mDimension.width;
     const int height = mDimension.height;
     if (mainGraphics->mWidth < (x + width + 5))
         x = mainGraphics->mWidth - width;
     if (mainGraphics->mHeight < (y + height + 5))
         y = mainGraphics->mHeight - height;
     setPosition(x, y);
     setVisible(Visible_true);
     requestMoveToTop();
     if (mModal == Modal_true)
         requestModalFocus();
 }

References Widget::getHeight(), Widget::getWidth(), Rect::height, mainGraphics, Widget::mDimension, Graphics::mHeight, mListBox, mModal, Modal_true, Graphics::mWidth, Widget::requestModalFocus(), Widget::requestMoveToTop(), Popup::setContentSize(), Widget::setPosition(), Widget::setVisible(), Visible_true, Rect::width, x, and y.

Referenced by DropDown::dropDown().

◆ widgetResized()

void PopupList::widgetResized ( const Event & event )

virtual

Invoked when a widget changes its size.

Parameters

event Describes the event.

Reimplemented from Popup.

Definition at line 101 of file popuplist.cpp.

 {
     Popup::widgetResized(event);
     adjustSize();
 }

References adjustSize(), and Popup::widgetResized().

Field Documentation

◆ mDropDown

DropDown* PopupList::mDropDown

private

Definition at line 80 of file popuplist.h.

Referenced by focusGained(), focusLost(), mouseReleased(), postInit(), and ~PopupList().

◆ mListBox

ListBox* PopupList::mListBox

private

Definition at line 78 of file popuplist.h.

Referenced by adjustSize(), focusGained(), getSelected(), mousePressed(), mouseReleased(), PopupList(), setListModel(), setSelected(), and show().

◆ mListModel

ListModel* PopupList::mListModel

private

Definition at line 77 of file popuplist.h.

Referenced by getListModel(), and setListModel().

◆ mModal

Modal PopupList::mModal

private

Definition at line 82 of file popuplist.h.

Referenced by focusGained(), mouseReleased(), and show().

◆ mPressedIndex

int PopupList::mPressedIndex

private

Definition at line 81 of file popuplist.h.

Referenced by mousePressed(), and mouseReleased().

◆ mScrollArea

ScrollArea* PopupList::mScrollArea

private

Definition at line 79 of file popuplist.h.

Referenced by adjustSize(), focusGained(), mouseReleased(), PopupList(), and postInit().

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

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PopupList()

◆ ~PopupList()

Member Function Documentation

◆ adjustSize()

◆ focusGained()

◆ focusLost()

◆ getListModel()

◆ getSelected()

◆ mousePressed()

◆ mouseReleased()

◆ postInit()

◆ setListModel()

◆ setSelected()

◆ show()

◆ widgetResized()

Field Documentation

◆ mDropDown

◆ mListBox

◆ mListModel

◆ mModal

◆ mPressedIndex

◆ mScrollArea