Public Member Functions | Private Attributes
PopupList Class Reference

#include <popuplist.h>

Inheritance diagram for PopupList:
Popup FocusListener Container MouseListener WidgetListener BasicContainer2 BasicContainer Widget WidgetDeathListener Widget2

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)
ListModelgetListModel () 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)
WidgetgetWidgetAt (int x, int y)
void death (const Event &event)
WidgetfindFirstWidget (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
WidgetgetParent () 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 RectgetDimension () 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 ColorgetBaseColor () const
void setForegroundColor (const Color &color)
const ColorgetForegroundColor () const
void setBackgroundColor (const Color &color)
const ColorgetBackgroundColor () const
virtual void requestFocus ()
virtual void requestMoveToTop ()
virtual void requestMoveToBottom ()
FocusHandlergetFocusHandler ()
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)
FontgetFont () 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 FocusHandlergetInternalFocusHandler ()
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 ColorgetThemeColor (const ThemeColorIdT type, const unsigned int alpha) const A_INLINE
const ColorgetThemeCharColor (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)
WidgetgetWindow () 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

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 FontgetGloablFont ()
static void cleanGlobalFont ()
static bool widgetExists (const Widget *const widget)
static void distributeWindowResizeEvent ()
static WidgetcallPostInit (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
- 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
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
Color mForegroundColor2
- Static Protected Attributes inherited from Widget
static FontmGlobalFont = 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.

38  :
39  Popup("PopupList", "popuplist.xml"),
40  FocusListener(),
41  mListModel(listModel),
43  widget, listModel, "extendedlistbox.xml", 0) :
45  widget, listModel, "popuplistbox.xml")),
46  mScrollArea(new ScrollArea(this, mListBox, Opaque_false, std::string())),
47  mDropDown(widget),
48  mPressedIndex(-2),
49  mModal(modal)
50 {
51  mListBox->setMouseConsume(false);
53  mAllowLogic = false;
54  setFocusable(true);
58 }
void setDistributeMousePressed(const bool b)
Definition: listbox.h:141
ListBox * mListBox
Definition: popuplist.h:78
ScrollArea * mScrollArea
Definition: popuplist.h:79
int mPressedIndex
Definition: popuplist.h:81
ListModel * mListModel
Definition: popuplist.h:77
Modal mModal
Definition: popuplist.h:82
DropDown * mDropDown
Definition: popuplist.h:80
Popup(const std::string &name, std::string skin)
Definition: popup.cpp:40
int mPadding
Definition: popup.h:181
void setFocusable(const bool focusable)
Definition: widget.cpp:192
void setMouseConsume(const bool b)
Definition: widget.h:936
bool mAllowLogic
Definition: widget.h:1160
void setPosition(const int x, const int y)
Definition: widget.cpp:161
#define CREATEWIDGETR(type,...)
Definition: createwidget.h:36
const bool Opaque_false
Definition: opaque.h:30

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.

74 {
75  if (mParent != nullptr)
77  if (gui != nullptr)
80 }
void removeGlobalFocusListener(FocusListener *focusListener)
Definition: gui.cpp:1147
Widget * mParent
Definition: widget.h:1128
void removeKeyListener(KeyListener *const keyListener)
Definition: widget.cpp:277
void removeFocusListener(FocusListener *const focusListener)
Definition: widget.cpp:287
Gui * gui
Definition: gui.cpp:111

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.

131 {
132  const int pad2 = 2 * mPadding;
133  const int width = mDimension.width - pad2;
134  mScrollArea->setWidth(width);
136  mListBox->adjustSize();
137  mListBox->setWidth(width);
138 }
virtual void adjustSize()
Definition: listbox.cpp:374
int width
Definition: rect.h:219
int height
Definition: rect.h:224
void setWidth(int width)
void setHeight(int height)
void setWidth(const int width)
Definition: widget.cpp:133
Rect mDimension
Definition: widget.h:1101

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)

Called when a widget gains focus.

eventDiscribes the event.

Reimplemented from FocusListener.

Definition at line 166 of file popuplist.cpp.

167 {
168  const Widget *const source = event.getSource();
169  if (mVisible == Visible_false ||
170  source == this ||
171  source == mListBox ||
172  source == mScrollArea ||
173  source == mDropDown)
174  {
175  return;
176  }
178  if (mDropDown != nullptr)
181  if (mModal == Modal_true)
183 }
void updateSelection()
Definition: dropdown.cpp:557
Definition: widget.h:99
void setVisible(Visible visible)
Definition: widget.cpp:225
Visible mVisible
Definition: widget.h:963
virtual void releaseModalFocus()
Definition: widget.cpp:394
const bool Modal_true
Definition: modal.h:30
const bool Visible_false
Definition: visible.h:30

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)

Called when a widget loses focus.

eventDiscribes the event.

Reimplemented from FocusListener.

Definition at line 185 of file popuplist.cpp.

186 {
187  if (mDropDown != nullptr)
189 }

References mDropDown, and DropDown::updateSelection().

◆ getListModel()

ListModel* PopupList::getListModel ( ) const

◆ getSelected()

int PopupList::getSelected ( ) const

Definition at line 115 of file popuplist.cpp.

116 {
117  if (mListBox == nullptr)
118  return -1;
120  return mListBox->getSelected();
121 }
int getSelected() const
Definition: listbox.h:168

References ListBox::getSelected(), and mListBox.

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

◆ mousePressed()

void PopupList::mousePressed ( MouseEvent event)

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.

eventDescribes the event.

Reimplemented from MouseListener.

Definition at line 140 of file popuplist.cpp.

141 {
143  event.getY() + mPadding);
144  event.consume();
145 }
virtual int getSelectionByMouse(const int y) const
Definition: listbox.cpp:392
int getY() const
Definition: mouseevent.h:138

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

◆ mouseReleased()

void PopupList::mouseReleased ( MouseEvent event)

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

eventDescribes the event.

Reimplemented from MouseListener.

Definition at line 147 of file popuplist.cpp.

148 {
150  event.getY() + mPadding))
151  {
152  mPressedIndex = -2;
153  return;
154  }
156  mPressedIndex = -2;
157  if (event.getSource() == mScrollArea)
158  return;
159  if (mDropDown != nullptr)
162  if (mModal == Modal_true)
164 }
Widget * getSource() const
Definition: event.h:104

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

Reimplemented from Popup.

Definition at line 60 of file popuplist.cpp.

61 {
65  if (gui != nullptr)
69  addMouseListener(this);
70  adjustSize();
71 }
virtual void add(Widget *const widget)
void addGlobalFocusListener(FocusListener *focusListener)
Definition: gui.cpp:1142
void adjustSize()
Definition: popuplist.cpp:130
void postInit()
Definition: popup.h:177
void addMouseListener(MouseListener *const mouseListener)
Definition: widget.cpp:292
void addKeyListener(KeyListener *const keyListener)
Definition: widget.cpp:272

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.

124 {
125  if (mListBox != nullptr)
126  mListBox->setListModel(model);
127  mListModel = model;
128 }
void setListModel(ListModel *listModel)
Definition: listbox.cpp:428

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.

108 {
109  if (mListBox == nullptr)
110  return;
112  mListBox->setSelected(selected);
113 }
void setSelected(const int selected)
Definition: listbox.cpp:399

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.

83 {
84  int len = mListBox->getHeight() + 8;
85  if (len > 250)
86  len = 250;
87  setContentSize(mListBox->getWidth() + 8, len);
88  const int width = mDimension.width;
89  const int height = mDimension.height;
90  if (mainGraphics->mWidth < (x + width + 5))
91  x = mainGraphics->mWidth - width;
92  if (mainGraphics->mHeight < (y + height + 5))
93  y = mainGraphics->mHeight - height;
94  setPosition(x, y);
97  if (mModal == Modal_true)
99 }
int mWidth
Definition: graphics.h:484
int mHeight
Definition: graphics.h:485
void setContentSize(int width, int height)
Definition: popup.cpp:155
virtual void requestMoveToTop()
Definition: widget.cpp:213
void requestModalFocus()
Definition: widget.cpp:380
int getHeight() const
Definition: widget.h:240
int getWidth() const
Definition: widget.h:221
Graphics * mainGraphics
Definition: graphics.cpp:109
const bool Visible_true
Definition: visible.h:30

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)

Invoked when a widget changes its size.

eventDescribes the event.

Reimplemented from Popup.

Definition at line 101 of file popuplist.cpp.

102 {
103  Popup::widgetResized(event);
104  adjustSize();
105 }
void widgetResized(const Event &event)
Definition: popup.cpp:271

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

Field Documentation

◆ mDropDown

DropDown* PopupList::mDropDown

Definition at line 80 of file popuplist.h.

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

◆ mListBox

ListBox* PopupList::mListBox

◆ mListModel

ListModel* PopupList::mListModel

Definition at line 77 of file popuplist.h.

Referenced by getListModel(), and setListModel().

◆ mModal

Modal PopupList::mModal

Definition at line 82 of file popuplist.h.

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

◆ mPressedIndex

int PopupList::mPressedIndex

Definition at line 81 of file popuplist.h.

Referenced by mousePressed(), and mouseReleased().

◆ mScrollArea

ScrollArea* PopupList::mScrollArea

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: