Public Member Functions | Private Types | Private Attributes
WindowContainer Class Reference

#include <windowcontainer.h>

Inheritance diagram for WindowContainer:
Container BasicContainer2 BasicContainer Widget WidgetDeathListener Widget2 Viewport Viewport

Public Member Functions

 WindowContainer (const Widget2 *const widget)
void slowLogic ()
void scheduleDelete (Widget *const widget)
void adjustAfterResize (const int oldScreenWidth, const int oldScreenHeight)
void moveWidgetAfter (Widget *const before, Widget *const widget)
- 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)
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 ()
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 ()

Private Types

typedef std::vector< Widget * > Widgets
typedef Widgets::iterator WidgetIterator

Private Attributes

Widgets mDeathList
std::set< Widget * > mDeathSet

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

A window container. This container adds functionality for more convenient widget (windows in particular) destruction.

Definition at line 35 of file windowcontainer.h.

Member Typedef Documentation

◆ WidgetIterator

typedef Widgets::iterator WindowContainer::WidgetIterator

Definition at line 69 of file windowcontainer.h.

◆ Widgets

typedef std::vector<Widget*> WindowContainer::Widgets

List of widgets that are scheduled to be deleted.

Definition at line 68 of file windowcontainer.h.

Constructor & Destructor Documentation

◆ WindowContainer()

WindowContainer::WindowContainer ( const Widget2 *const  widget)

Definition at line 36 of file windowcontainer.cpp.

36  :
37  Container(widget),
38  mDeathList(),
39  mDeathSet()
40 {
41 }
Container(const Widget2 *const widget)
Definition: container.cpp:30
std::set< Widget * > mDeathSet

Member Function Documentation

◆ adjustAfterResize()

void WindowContainer::adjustAfterResize ( const int  oldScreenWidth,
const int  oldScreenHeight 

Ensures that all visible windows are on the screen after the screen has been resized.

Definition at line 67 of file windowcontainer.cpp.

69 {
71  {
72  if (Window *const window = dynamic_cast<Window*>(*i))
73  window->adjustPositionAfterResize(oldScreenWidth, oldScreenHeight);
74  }
75 }
WidgetList::iterator WidgetListIterator
WidgetList mWidgets
Definition: window.h:102
#define FOR_EACH(type, iter, array)
Definition: foreach.h:25

References FOR_EACH, and BasicContainer::mWidgets.

◆ moveWidgetAfter()

void WindowContainer::moveWidgetAfter ( Widget *const  before,
Widget *const  widget 

Definition at line 77 of file windowcontainer.cpp.

79 {
80  const WidgetListIterator widgetIter = std::find(
81  mWidgets.begin(), mWidgets.end(), widget);
83  if (widgetIter != mWidgets.end())
84  {
85  WidgetListIterator afterIter = std::find(
86  mWidgets.begin(), mWidgets.end(), after);
88  if (afterIter != mWidgets.end())
89  {
90  ++ afterIter;
91  mWidgets.erase(widgetIter);
92  mWidgets.insert(afterIter, widget);
93  }
94  }
96  const WidgetListIterator widgetIter2 = std::find(
97  mLogicWidgets.begin(), mLogicWidgets.end(), widget);
99  if (widgetIter2 != mLogicWidgets.end())
100  {
101  WidgetListIterator afterIter = std::find(
102  mLogicWidgets.begin(), mLogicWidgets.end(), after);
104  if (afterIter != mLogicWidgets.end())
105  {
106  ++ afterIter;
107  mLogicWidgets.erase(widgetIter2);
108  mLogicWidgets.insert(afterIter, widget);
109  }
110  }
111 }
WidgetList mLogicWidgets
bool find(const std::string &key)

References AttributesEnum::find(), BasicContainer::mLogicWidgets, and BasicContainer::mWidgets.

Referenced by SpeechBubble::requestMoveToBackground().

◆ scheduleDelete()

void WindowContainer::scheduleDelete ( Widget *const  widget)

Schedule a widget for deletion. It will be deleted at the start of the next logic update.

Definition at line 50 of file windowcontainer.cpp.

51 {
52  if (widget == nullptr)
53  return;
55  if (mDeathSet.find(widget) == mDeathSet.end())
56  {
57  mDeathList.push_back(widget);
58  mDeathSet.insert(widget);
59  }
60  else
61  {
62  reportAlways("double adding pointer %p for deletion in scheduleDelete",
63  static_cast<void*>(widget))
64  }
65 }
#define reportAlways(...)
Definition: checkutils.h:253

References mDeathList, mDeathSet, and reportAlways.

Referenced by ChannelTab::handleCommand(), WhisperTab::handleCommand(), Popup::scheduleDelete(), and Window::scheduleDelete().

◆ slowLogic()

void WindowContainer::slowLogic ( )

Definition at line 43 of file windowcontainer.cpp.

44 {
46  mDeathList.clear();
47  mDeathSet.clear();
48 }
void delete_all(Container &c)
Definition: dtor.h:56

References delete_all(), mDeathList, and mDeathSet.

Referenced by Client::gameClear(), Gui::slowLogic(), and Gui::~Gui().

Field Documentation

◆ mDeathList

Widgets WindowContainer::mDeathList

Definition at line 70 of file windowcontainer.h.

Referenced by scheduleDelete(), and slowLogic().

◆ mDeathSet

std::set<Widget*> WindowContainer::mDeathSet

Definition at line 71 of file windowcontainer.h.

Referenced by scheduleDelete(), and slowLogic().

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