ManaPlus
Public Member Functions | Protected Member Functions | Protected Attributes
SetupTabScroll Class Reference

#include <setuptabscroll.h>

Inheritance diagram for SetupTabScroll:
SetupTab Container ActionListener WidgetListener BasicContainer2 BasicContainer Widget WidgetDeathListener Widget2 Setup_Audio Setup_Chat Setup_Misc Setup_Mods Setup_Perfomance Setup_Players Setup_Quick Setup_Touch Setup_Visual

Public Member Functions

 SetupTabScroll (const Widget2 *const widget)
 
 ~SetupTabScroll ()
 
void addControl (SetupItem *const widget)
 
void addControl (SetupItem *const widget, const std::string &event)
 
VertContainergetContainer () const
 
void apply ()
 
void cancel ()
 
void externalUpdated ()
 
void externalUnloaded ()
 
void action (const ActionEvent &event)
 
int getPreferredFirstItemSize () const
 
void widgetResized (const Event &event)
 
void reread (const std::string &name)
 
void clear ()
 
const std::set< SetupItem * > & getAllItems () const
 
- Public Member Functions inherited from SetupTab
const std::string & getName () 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)
 
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 ActionListener
virtual ~ActionListener ()
 
- 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)
 

Protected Member Functions

void removeItems ()
 
- Protected Member Functions inherited from SetupTab
 SetupTab (const Widget2 *const widget)
 
void setName (const std::string &name)
 
- 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 ActionListener
 ActionListener ()
 
- Protected Member Functions inherited from WidgetListener
 WidgetListener ()
 

Protected Attributes

VertContainermContainer
 
ScrollAreamScroll
 
std::map< std::string, SetupItem * > mItems
 
std::set< SetupItem * > mAllItems
 
int mPreferredFirstItemSize
 
- 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
 

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 32 of file setuptabscroll.h.

Constructor & Destructor Documentation

◆ SetupTabScroll()

SetupTabScroll::SetupTabScroll ( const Widget2 *const  widget)
explicit

Definition at line 31 of file setuptabscroll.cpp.

References mContainer, mScroll, ScrollArea::setHorizontalScrollPolicy(), Widget::setSelectable(), ScrollArea::setVerticalScrollPolicy(), ScrollArea::SHOW_AUTO, and ScrollArea::SHOW_NEVER.

31  :
32  SetupTab(widget),
33  mContainer(new VertContainer(this, 25, false, 8)),
34  mScroll(new ScrollArea(this, mContainer, Opaque_false, std::string())),
35  mItems(),
36  mAllItems(),
38 {
41  mScroll->setSelectable(false);
42  mContainer->setSelectable(false);
43 }
std::map< std::string, SetupItem * > mItems
SetupTab(const Widget2 *const widget)
Definition: setuptab.cpp:27
void setVerticalScrollPolicy(const ScrollPolicy vPolicy)
void setSelectable(const bool selectable)
Definition: widget.h:947
int mPreferredFirstItemSize
const bool Opaque_false
Definition: opaque.h:29
ScrollArea * mScroll
VertContainer * mContainer
std::set< SetupItem * > mAllItems
void setHorizontalScrollPolicy(const ScrollPolicy hPolicy)

◆ ~SetupTabScroll()

SetupTabScroll::~SetupTabScroll ( )

Definition at line 45 of file setuptabscroll.cpp.

References delete2, mContainer, mScroll, and removeItems().

46 {
47  mScroll = nullptr;
49  removeItems();
50 }
#define delete2(var)
Definition: delete2.h:24
ScrollArea * mScroll
VertContainer * mContainer

Member Function Documentation

◆ action()

void SetupTabScroll::action ( const ActionEvent actionEvent)
inlinevirtual

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 56 of file setuptabscroll.h.

57  { }

◆ addControl() [1/2]

void SetupTabScroll::addControl ( SetupItem *const  widget)

Definition at line 73 of file setuptabscroll.cpp.

References SetupItem::getActionEventId(), mAllItems, and mItems.

Referenced by SetupButtonItem::createControls(), SetupQuickItem::createControls(), SetupActionDropDown::createControls(), SetupItemCheckBox::createControls(), SetupItemTextField::createControls(), SetupItemIntTextField::createControls(), SetupItemLabel::createControls(), SetupItemDropDown::createControls(), SetupItemDropDownStr::createControls(), SetupItemSlider::createControls(), SetupItemSlider2::createControls(), and SetupItemSliderList::createControls().

74 {
75  if (widget == nullptr)
76  return;
77  const std::string actionId = widget->getActionEventId();
78  if (!actionId.empty())
79  {
80  const std::map<std::string, SetupItem*>::iterator iter
81  = mItems.find(actionId);
82  if (iter != mItems.end())
83  {
84  delete (*iter).second;
85  mItems.erase(iter);
86  }
87  mItems[actionId] = widget;
88  }
89  mAllItems.insert(widget);
90 }
std::map< std::string, SetupItem * > mItems
virtual std::string getActionEventId() const
Definition: setupitem.cpp:154
std::set< SetupItem * > mAllItems

◆ addControl() [2/2]

void SetupTabScroll::addControl ( SetupItem *const  widget,
const std::string &  event 
)

Definition at line 92 of file setuptabscroll.cpp.

References mAllItems, and mItems.

94 {
95  const std::map<std::string, SetupItem*>::iterator iter
96  = mItems.find(event);
97  if (iter != mItems.end())
98  {
99  delete (*iter).second;
100  mItems.erase(iter);
101  }
102  mItems[event] = widget;
103  mAllItems.insert(widget);
104 }
std::map< std::string, SetupItem * > mItems
std::set< SetupItem * > mAllItems

◆ apply()

void SetupTabScroll::apply ( )
virtual

Called when the Apply button is pressed in the setup window.

Implements SetupTab.

Definition at line 106 of file setuptabscroll.cpp.

References mItems.

Referenced by Setup_Chat::apply(), Setup_Mods::apply(), Setup_Audio::apply(), Setup_Players::apply(), Setup_Misc::apply(), Setup_Visual::apply(), and getContainer().

107 {
108  for (std::map<std::string, SetupItem*>::const_iterator
109  iter = mItems.begin(), iter_end = mItems.end();
110  iter != iter_end; ++ iter)
111  {
112  if ((*iter).second != nullptr)
113  (*iter).second->apply((*iter).first);
114  }
115 }
std::map< std::string, SetupItem * > mItems

◆ cancel()

void SetupTabScroll::cancel ( )
virtual

Called when the Cancel button is pressed in the setup window.

Implements SetupTab.

Definition at line 117 of file setuptabscroll.cpp.

References mItems.

Referenced by getContainer().

118 {
119  for (std::map<std::string, SetupItem*>::const_iterator
120  iter = mItems.begin(), iter_end = mItems.end();
121  iter != iter_end; ++ iter)
122  {
123  if ((*iter).second != nullptr)
124  (*iter).second->cancel((*iter).first);
125  }
126 }
std::map< std::string, SetupItem * > mItems

◆ clear()

void SetupTabScroll::clear ( )
virtual

Clears the basic container from all widgets.

See also
remove, clear

Reimplemented from BasicContainer.

Definition at line 66 of file setuptabscroll.cpp.

References VertContainer::clear(), mContainer, Container::removeControls(), and removeItems().

Referenced by Setup_Mods::externalUnloaded(), Setup_Mods::externalUpdated(), and getPreferredFirstItemSize().

67 {
68  removeItems();
70  mContainer->clear();
71 }
void removeControls()
Definition: container.cpp:42
VertContainer * mContainer

◆ externalUnloaded()

void SetupTabScroll::externalUnloaded ( )
virtual

Reimplemented from SetupTab.

Definition at line 140 of file setuptabscroll.cpp.

References SetupItem::externalUnloaded(), SetupItem::isMainConfig(), MainConfig_false, and mItems.

Referenced by getContainer().

141 {
142  for (std::map<std::string, SetupItem*>::const_iterator
143  iter = mItems.begin(), iter_end = mItems.end();
144  iter != iter_end; ++ iter)
145  {
146  SetupItem *const widget = (*iter).second;
147  if ((widget != nullptr) && widget->isMainConfig() == MainConfig_false)
148  widget->externalUnloaded((*iter).first);
149  }
150 }
std::map< std::string, SetupItem * > mItems
virtual void externalUnloaded(const std::string &eventName)
Definition: setupitem.cpp:193
MainConfig isMainConfig() const
Definition: setupitem.h:96
const bool MainConfig_false
Definition: mainconfig.h:29

◆ externalUpdated()

void SetupTabScroll::externalUpdated ( )
virtual

Reimplemented from SetupTab.

Definition at line 128 of file setuptabscroll.cpp.

References SetupItem::externalUpdated(), SetupItem::isMainConfig(), MainConfig_false, and mItems.

Referenced by getContainer().

129 {
130  for (std::map<std::string, SetupItem*>::const_iterator
131  iter = mItems.begin(), iter_end = mItems.end();
132  iter != iter_end; ++ iter)
133  {
134  SetupItem *const widget = (*iter).second;
135  if ((widget != nullptr) && widget->isMainConfig() == MainConfig_false)
136  widget->externalUpdated((*iter).first);
137  }
138 }
std::map< std::string, SetupItem * > mItems
virtual void externalUpdated(const std::string &eventName)
Definition: setupitem.cpp:187
MainConfig isMainConfig() const
Definition: setupitem.h:96
const bool MainConfig_false
Definition: mainconfig.h:29

◆ getAllItems()

const std::set<SetupItem*>& SetupTabScroll::getAllItems ( ) const
inline

Definition at line 68 of file setuptabscroll.h.

References mAllItems, and removeItems().

Referenced by Setup_Mods::saveMods().

69  { return mAllItems; }
std::set< SetupItem * > mAllItems

◆ getContainer()

VertContainer* SetupTabScroll::getContainer ( ) const
inline

◆ getPreferredFirstItemSize()

int SetupTabScroll::getPreferredFirstItemSize ( ) const
inline

Definition at line 59 of file setuptabscroll.h.

References clear(), mPreferredFirstItemSize, reread(), and widgetResized().

Referenced by SetupItem::fixFirstItemSize().

60  { return mPreferredFirstItemSize; }
int mPreferredFirstItemSize

◆ removeItems()

void SetupTabScroll::removeItems ( )
protected

Definition at line 52 of file setuptabscroll.cpp.

References mAllItems, and mItems.

Referenced by clear(), getAllItems(), and ~SetupTabScroll().

53 {
54  std::set<SetupItem*>::iterator it = mAllItems.begin();
55  const std::set<SetupItem*>::iterator it_end = mAllItems.end();
56  while (it != it_end)
57  {
58  delete *it;
59  ++ it;
60  }
61  mAllItems.clear();
62 
63  mItems.clear();
64 }
std::map< std::string, SetupItem * > mItems
std::set< SetupItem * > mAllItems

◆ reread()

void SetupTabScroll::reread ( const std::string &  name)

Definition at line 158 of file setuptabscroll.cpp.

References ServerCommandType::item, mItems, and SetupItem::rereadValue().

Referenced by Setup_Chat::externalUpdated(), Setup_Misc::externalUpdated(), Setup_Players::externalUpdated(), and getPreferredFirstItemSize().

159 {
160  SetupItem *const item = mItems[name + "Event"];
161  if (item != nullptr)
162  item->rereadValue();
163 }
std::map< std::string, SetupItem * > mItems
virtual void rereadValue()
Definition: setupitem.cpp:206

◆ widgetResized()

void SetupTabScroll::widgetResized ( const Event event)
virtual

Invoked when a widget changes its size.

Parameters
eventDescribes the event.

Reimplemented from WidgetListener.

Definition at line 152 of file setuptabscroll.cpp.

References Widget::getHeight(), Widget::getWidth(), mScroll, ScrollArea::setHeight(), and ScrollArea::setWidth().

Referenced by getPreferredFirstItemSize().

153 {
154  mScroll->setWidth(getWidth() - 12);
155  mScroll->setHeight(getHeight() - 12 - 12);
156 }
int getWidth() const
Definition: widget.h:220
void setWidth(int width)
void setHeight(int height)
int getHeight() const
Definition: widget.h:239
ScrollArea * mScroll

Field Documentation

◆ mAllItems

std::set<SetupItem*> SetupTabScroll::mAllItems
protected

Definition at line 77 of file setuptabscroll.h.

Referenced by addControl(), getAllItems(), and removeItems().

◆ mContainer

VertContainer* SetupTabScroll::mContainer
protected

Definition at line 74 of file setuptabscroll.h.

Referenced by clear(), getContainer(), SetupTabScroll(), and ~SetupTabScroll().

◆ mItems

std::map<std::string, SetupItem*> SetupTabScroll::mItems
protected

◆ mPreferredFirstItemSize

int SetupTabScroll::mPreferredFirstItemSize
protected

Definition at line 78 of file setuptabscroll.h.

Referenced by getPreferredFirstItemSize(), and Setup_Visual::Setup_Visual().

◆ mScroll

ScrollArea* SetupTabScroll::mScroll
protected

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