ManaPlus
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes
WidgetGroup Class Referenceabstract

#include <widgetgroup.h>

Inheritance diagram for WidgetGroup:
Container WidgetListener ActionListener BasicContainer2 BasicContainer Widget WidgetDeathListener Widget2 RadioGroup TabStrip

Public Member Functions

virtual void addButton (const std::string &text, const std::string &tag, const bool pressed)
 
void action (const ActionEvent &event)
 
virtual void addWidget (Widget *const widget, const int spacing)
 
void clear ()
 
void widgetResized (const Event &event)
 
virtual WidgetcreateWidget (const std::string &name, const bool pressed) const =0
 
- 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)
 
void draw (Graphics *const graphics)
 
void safeDraw (Graphics *const graphics)
 
- 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)
 
Rect getChildrenArea ()
 
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)
 
- 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 ()
 
virtual void postInit ()
 
- 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 WidgetListener
virtual ~WidgetListener ()
 
virtual void widgetMoved (const Event &event)
 
virtual void widgetHidden (const Event &event)
 
virtual void widgetShown (const Event &event)
 
- Public Member Functions inherited from ActionListener
virtual ~ActionListener ()
 

Protected Member Functions

 WidgetGroup (const Widget2 *const widget, const std::string &group, const int height, const int spacing)
 
- 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 WidgetListener
 WidgetListener ()
 
- Protected Member Functions inherited from ActionListener
 ActionListener ()
 

Protected Attributes

int mSpacing
 
int mCount
 
std::string mGroup
 
- 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
 
FocusHandlermFocusHandler
 
FocusHandlermInternalFocusHandler
 
WidgetmParent
 
FontmCurrentFont
 
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
 
WidgetmWindow
 
Color mForegroundColor2
 

Private Attributes

int mLastX
 

Additional Inherited Members

- 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
 
- Static Protected Attributes inherited from Widget
static FontmGlobalFont = 0
 

Detailed Description

Definition at line 31 of file widgetgroup.h.

Constructor & Destructor Documentation

◆ WidgetGroup()

WidgetGroup::WidgetGroup ( const Widget2 *const  widget,
const std::string &  group,
const int  height,
const int  spacing 
)
protected

Definition at line 25 of file widgetgroup.cpp.

References Widget::addWidgetListener(), and Widget::setHeight().

28  :
29  Container(widget),
32  mSpacing(spacing),
33  mCount(0),
34  mGroup(group),
35  mLastX(spacing)
36 {
37  setHeight(height);
38  addWidgetListener(this);
39 }
std::string mGroup
Definition: widgetgroup.h:63
Container(const Widget2 *const widget)
Definition: container.cpp:29
void setHeight(const int height)
Definition: widget.cpp:139
void addWidgetListener(WidgetListener *const widgetListener)
Definition: widget.cpp:301

Member Function Documentation

◆ action()

void WidgetGroup::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
actionEventThe event of the action.

Implements ActionListener.

Definition at line 57 of file widgetgroup.cpp.

References Widget::mActionListeners.

Referenced by TabStrip::action().

58 {
59  for (ActionListenerIterator iter = mActionListeners.begin();
60  iter != mActionListeners.end(); ++iter)
61  {
62  (*iter)->action(event);
63  }
64 }
ActionListenerList mActionListeners
Definition: widget.h:1033
ActionListenerList::iterator ActionListenerIterator
Definition: widget.h:1038

◆ addButton()

void WidgetGroup::addButton ( const std::string &  text,
const std::string &  tag,
const bool  pressed 
)
virtual

Definition at line 41 of file widgetgroup.cpp.

References Widget::addActionListener(), addWidget(), createWidget(), Widget::mActionEventId, mSpacing, and Widget::setActionEventId().

Referenced by EquipmentWindow::addPage(), CharCreateDialog::CharCreateDialog(), InventoryWindow::InventoryWindow(), Setup_Input::Setup_Input(), and ShopWindow::ShopWindow().

44 {
45  if (text.empty() || tag.empty())
46  return;
47 
48  Widget *const widget = createWidget(text, pressed);
49  if (widget != nullptr)
50  {
51  widget->setActionEventId(mActionEventId + tag);
52  widget->addActionListener(this);
53  addWidget(widget, mSpacing);
54  }
55 }
virtual void addWidget(Widget *const widget, const int spacing)
Definition: widgetgroup.cpp:66
void addActionListener(ActionListener *const actionListener)
Definition: widget.cpp:251
void setActionEventId(const std::string &actionEventId)
Definition: widget.h:595
Definition: widget.h:97
virtual Widget * createWidget(const std::string &name, const bool pressed) const =0
std::string mActionEventId
Definition: widget.h:1105

◆ addWidget()

void WidgetGroup::addWidget ( Widget *const  widget,
const int  spacing 
)
virtual

Definition at line 66 of file widgetgroup.cpp.

References BasicContainer2::add(), Widget::getWidth(), mCount, mLastX, mSpacing, and Widget::setPosition().

Referenced by addButton().

68 {
69  if (widget == nullptr)
70  return;
71 
72  Container::add(widget);
73  widget->setPosition(mLastX, spacing);
74  mCount++;
75  mLastX += widget->getWidth() + 2 * mSpacing;
76 }
int getWidth() const
Definition: widget.h:220
virtual void add(Widget *const widget)
void setPosition(const int x, const int y)
Definition: widget.cpp:160

◆ clear()

void WidgetGroup::clear ( )
virtual

Clears the basic container from all widgets.

See also
remove, clear

Reimplemented from BasicContainer.

Definition at line 78 of file widgetgroup.cpp.

References BasicContainer::clear(), and mCount.

79 {
81 
82  mCount = 0;
83 }
virtual void clear()

◆ createWidget()

virtual Widget* WidgetGroup::createWidget ( const std::string &  name,
const bool  pressed 
) const
pure virtual

Implemented in TabStrip, and RadioGroup.

Referenced by addButton().

◆ widgetResized()

void WidgetGroup::widgetResized ( const Event event)
virtual

Invoked when a widget changes its size.

Parameters
eventDescribes the event.

Reimplemented from WidgetListener.

Definition at line 85 of file widgetgroup.cpp.

86 {
87 }

Field Documentation

◆ mCount

int WidgetGroup::mCount
protected

Definition at line 62 of file widgetgroup.h.

Referenced by addWidget(), clear(), RadioGroup::createWidget(), and TabStrip::createWidget().

◆ mGroup

std::string WidgetGroup::mGroup
protected

Definition at line 63 of file widgetgroup.h.

Referenced by RadioGroup::createWidget().

◆ mLastX

int WidgetGroup::mLastX
private

Definition at line 66 of file widgetgroup.h.

Referenced by addWidget().

◆ mSpacing

int WidgetGroup::mSpacing
protected

Definition at line 61 of file widgetgroup.h.

Referenced by addButton(), and addWidget().


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