ManaPlus
Public Member Functions | Private Attributes
FlowContainer Class Reference

#include <flowcontainer.h>

Inheritance diagram for FlowContainer:
Container WidgetListener BasicContainer2 BasicContainer Widget WidgetDeathListener Widget2

Public Member Functions

 FlowContainer (const Widget2 *const widget, const int boxWidth, const int boxHeight)
 
void widgetResized (const Event &event)
 
int getBoxWidth () const
 
int getBoxHeight () const
 
void add (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
 
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 ()
 
- 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)
 

Private Attributes

int mBoxWidth
 
int mBoxHeight
 
int mGridWidth
 
int mGridHeight
 

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 Member Functions inherited from WidgetListener
 WidgetListener ()
 
- 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
 
- Static Protected Attributes inherited from Widget
static FontmGlobalFont = 0
 

Detailed Description

A container that arranges its contents like words on a page.

Definition at line 36 of file flowcontainer.h.

Constructor & Destructor Documentation

◆ FlowContainer()

FlowContainer::FlowContainer ( const Widget2 *const  widget,
const int  boxWidth,
const int  boxHeight 
)

Constructor. Initializes the shortcut container.

Definition at line 26 of file flowcontainer.cpp.

References Widget::addWidgetListener(), mBoxHeight, and mBoxWidth.

28  :
29  Container(widget),
31  mBoxWidth(boxWidth),
32  mBoxHeight(boxHeight),
33  mGridWidth(1),
34  mGridHeight(1)
35 {
36  addWidgetListener(this);
37  if (mBoxWidth == 0)
38  mBoxWidth = 1;
39  if (mBoxHeight == 0)
40  mBoxHeight = 1;
41 }
Container(const Widget2 *const widget)
Definition: container.cpp:29
void addWidgetListener(WidgetListener *const widgetListener)
Definition: widget.cpp:301

Member Function Documentation

◆ add()

void FlowContainer::add ( Widget *const  widget)
virtual

Adds a widget to the container.

Parameters
widgetThe widget to add.
See also
remove, clear

Reimplemented from BasicContainer2.

Definition at line 89 of file flowcontainer.cpp.

References BasicContainer2::add(), mBoxHeight, mBoxWidth, Widget::setSize(), and widgetResized().

Referenced by getBoxHeight().

90 {
91  if (widget == nullptr)
92  return;
93 
94  Container::add(widget);
95  widget->setSize(mBoxWidth, mBoxHeight);
96  widgetResized(Event(nullptr));
97 }
void setSize(const int width, const int height)
Definition: widget.cpp:366
virtual void add(Widget *const widget)
Definition: event.h:77
void widgetResized(const Event &event)

◆ getBoxHeight()

int FlowContainer::getBoxHeight ( ) const
inline

Definition at line 58 of file flowcontainer.h.

References add(), and mBoxHeight.

59  { return mBoxHeight; }

◆ getBoxWidth()

int FlowContainer::getBoxWidth ( ) const
inline

Definition at line 55 of file flowcontainer.h.

References mBoxWidth.

56  { return mBoxWidth; }

◆ widgetResized()

void FlowContainer::widgetResized ( const Event event)
virtual

Invoked when a widget changes its size. This is used to determine the new height of the container.

Reimplemented from WidgetListener.

Definition at line 43 of file flowcontainer.cpp.

References CAST_S32, Widget::getHeight(), Widget::getWidth(), mBoxHeight, mBoxWidth, mGridHeight, mGridWidth, BasicContainer::mWidgets, Widget::setHeight(), Widget::setWidth(), and x.

Referenced by add().

44 {
45  if (getWidth() < mBoxWidth)
46  {
48  return;
49  }
50 
51  const int itemCount = CAST_S32(mWidgets.size());
52 
53  if (mBoxWidth == 0)
54  mGridWidth = getWidth();
55  else
57 
58  if (mGridWidth < 1)
59  mGridWidth = 1;
60 
61  mGridHeight = itemCount / mGridWidth;
62 
63  if (itemCount % mGridWidth != 0 || mGridHeight < 1)
64  ++mGridHeight;
65 
66  int height = mGridHeight * mBoxHeight;
67 
68  if (getHeight() != height)
69  {
70  setHeight(height);
71  return;
72  }
73 
74  int i = 0;
75  height = 0;
76  for (WidgetList::const_iterator it = mWidgets.begin();
77  it != mWidgets.end(); ++it)
78  {
79  const int x = i % mGridWidth * mBoxWidth;
80  (*it)->setPosition(x, height);
81 
82  i++;
83 
84  if (i % mGridWidth == 0)
85  height += mBoxHeight;
86  }
87 }
int getWidth() const
Definition: widget.h:220
void setWidth(const int width)
Definition: widget.cpp:132
#define CAST_S32
Definition: cast.h:29
void setHeight(const int height)
Definition: widget.cpp:139
int getHeight() const
Definition: widget.h:239
WidgetList mWidgets

Field Documentation

◆ mBoxHeight

int FlowContainer::mBoxHeight
private

Definition at line 65 of file flowcontainer.h.

Referenced by add(), FlowContainer(), getBoxHeight(), and widgetResized().

◆ mBoxWidth

int FlowContainer::mBoxWidth
private

Definition at line 64 of file flowcontainer.h.

Referenced by add(), FlowContainer(), getBoxWidth(), and widgetResized().

◆ mGridHeight

int FlowContainer::mGridHeight
private

Definition at line 66 of file flowcontainer.h.

Referenced by widgetResized().

◆ mGridWidth

int FlowContainer::mGridWidth
private

Definition at line 66 of file flowcontainer.h.

Referenced by widgetResized().


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