#include <basiccontainer.h>

Inheritance diagram for BasicContainer:

Public Member Functions
	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)

Widget *	getWidgetAt (int x, int y)

void	death (const Event &event)

Widget *	findFirstWidget (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	draw (Graphics *const graphics)=0

virtual void	safeDraw (Graphics *const graphics)=0

virtual void	drawFrame (Graphics *graphics)

virtual void	safeDrawFrame (Graphics *graphics)

void	setFrameSize (const unsigned int frameSize)

unsigned int	getFrameSize () const

Widget *	getParent () 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 Rect &	getDimension () 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 Color &	getBaseColor () const

void	setForegroundColor (const Color &color)

const Color &	getForegroundColor () const

void	setBackgroundColor (const Color &color)

const Color &	getBackgroundColor () const

virtual void	requestFocus ()

virtual void	requestMoveToTop ()

virtual void	requestMoveToBottom ()

FocusHandler *	getFocusHandler ()

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)

Font *	getFont () 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 FocusHandler *	getInternalFocusHandler ()

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 Color &	getThemeColor (const ThemeColorIdT type, const unsigned int alpha) const A_INLINE

const Color &	getThemeCharColor (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)

Widget *	getWindow () const

virtual void	setWindow (Widget *const window)

Public Member Functions inherited from WidgetDeathListener
virtual	~WidgetDeathListener ()

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

FocusHandler *	mFocusHandler

FocusHandler *	mInternalFocusHandler

Widget *	mParent

Font *	mCurrentFont

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

Widget *	mWindow

Color	mForegroundColor2

Additional Inherited Members
Static Public Member Functions inherited from Widget
static void	setGlobalFont (Font *const font)

static Font *	getGloablFont ()

static void	cleanGlobalFont ()

static bool	widgetExists (const Widget *const widget)

static void	distributeWindowResizeEvent ()

static Widget *	callPostInit (Widget *const widget)

Data Fields inherited from Widget
Visible	mVisible

Static Protected Attributes inherited from Widget
static Font *	mGlobalFont = 0

Detailed Description

A base class for containers. The class implements the most common things for a container. If you are implementing a container, consider inheriting from this class.

See also: Container

Definition at line 79 of file basiccontainer.h.

Member Typedef Documentation

◆ WidgetList

typedef std::vector<Widget *> BasicContainer::WidgetList

protected

Typedef.

Definition at line 184 of file basiccontainer.h.

◆ WidgetListConstIterator

typedef WidgetList::const_iterator BasicContainer::WidgetListConstIterator

protected

Typedef.

Definition at line 194 of file basiccontainer.h.

◆ WidgetListCReverseIterator

typedef WidgetList::const_reverse_iterator BasicContainer::WidgetListCReverseIterator

protected

Typedef.

Definition at line 204 of file basiccontainer.h.

◆ WidgetListIterator

typedef WidgetList::iterator BasicContainer::WidgetListIterator

protected

Typedef.

Definition at line 189 of file basiccontainer.h.

◆ WidgetListReverseIterator

typedef WidgetList::reverse_iterator BasicContainer::WidgetListReverseIterator

protected

Typedef.

Definition at line 199 of file basiccontainer.h.

Constructor & Destructor Documentation

◆ BasicContainer()

BasicContainer::BasicContainer ( const Widget2 *const widget )

inlineexplicit

Definition at line 83 of file basiccontainer.h.

                                                                       :
             Widget(widget),
             WidgetDeathListener(),
             mWidgets(),
             mLogicWidgets()
         { }

◆ ~BasicContainer()

BasicContainer::~BasicContainer ( )

Destructor

Definition at line 76 of file basiccontainer.cpp.

 {
     // +++ virtual method call
     clear();
 }

References clear().

Member Function Documentation

◆ add()

void BasicContainer::add ( Widget *const widget )

Adds a widget to the basic container.

Parameters

widget The widget to add.

See also: remove, clear

Definition at line 260 of file basiccontainer.cpp.

 {
     if (widget == nullptr)
         return;
     mWidgets.push_back(widget);
     if (widget->isAllowLogic())
         mLogicWidgets.push_back(widget);
  
     if (mInternalFocusHandler == nullptr)
         widget->setFocusHandler(getFocusHandler());
     else
         widget->setFocusHandler(mInternalFocusHandler);
  
     widget->setParent(this);
     widget->addDeathListener(this);
 }

Referenced by BasicContainer2::add(), BasicContainer2::addXY(), TabbedArea::enableScrollButtons(), Tab::init(), TabbedArea::postInit(), and ScrollArea::setContent().

◆ clear()

void BasicContainer::clear ( )

virtual

Clears the basic container from all widgets.

See also: remove, clear

Reimplemented in TradeWindow, MailWindow, WidgetGroup, VertContainer, SetupTabScroll, HorizontContainer, and PopupMenu.

Definition at line 303 of file basiccontainer.cpp.

 {
     FOR_EACH (WidgetListConstIterator, iter, mWidgets)
     {
         Widget *restrict const widget = *iter;
         widget->setFocusHandler(nullptr);
         widget->setWindow(nullptr);
         widget->setParent(nullptr);
         widget->removeDeathListener(this);
     }
  
     mWidgets.clear();
     mLogicWidgets.clear();
 }

References FOR_EACH, mLogicWidgets, mWidgets, and restrict.

Referenced by HorizontContainer::clear(), VertContainer::clear(), WidgetGroup::clear(), Window::clearLayout(), TabbedArea::removeTab(), ScrollArea::setContent(), and ~BasicContainer().

◆ death()

void BasicContainer::death ( const Event & event )

virtual

Called when a widget dies. It is used to be able to recieve a notification when a death of a widget occurs.

Parameters

event The event of the death.

Implements WidgetDeathListener.

Reimplemented in TabbedArea.

Definition at line 134 of file basiccontainer.cpp.

 {
     const WidgetListIterator iter = std::find(mWidgets.begin(),
         mWidgets.end(), event.getSource());
     if (iter != mWidgets.end())
         mWidgets.erase(iter);
  
     const WidgetListIterator iter2 = std::find(mLogicWidgets.begin(),
         mLogicWidgets.end(), event.getSource());
     if (iter2 != mLogicWidgets.end())
         mLogicWidgets.erase(iter2);
 }

References AttributesEnum::find().

Referenced by TabbedArea::death().

◆ drawChildren()

void BasicContainer::drawChildren ( Graphics *const graphics )

protectedvirtual

Draws the children widgets of the basic container.

Parameters

graphics A graphics object to draw with.

Reimplemented in WindowMenu.

Definition at line 318 of file basiccontainer.cpp.

 {
     BLOCK_START("BasicContainer::drawChildren")
     graphics->pushClipArea(getChildrenArea());
  
     FOR_EACH (WidgetListConstIterator, iter, mWidgets)
     {
         Widget *restrict const widget = *iter;
         if (widget->mVisible == Visible_true)
         {
             // If the widget has a frame,
             // draw it before drawing the widget
             if (widget->mFrameSize > 0)
             {
                 Rect rec = widget->mDimension;
                 const int frame = CAST_S32(widget->mFrameSize);
                 const int frame2 = frame * 2;
                 rec.x -= frame;
                 rec.y -= frame;
                 rec.width += frame2;
                 rec.height += frame2;
                 graphics->pushClipArea(rec);
                 BLOCK_START("BasicContainer::drawChildren 1")
                 widget->drawFrame(graphics);
                 BLOCK_END("BasicContainer::drawChildren 1")
                 graphics->popClipArea();
             }
  
             graphics->pushClipArea(widget->mDimension);
             BLOCK_START("BasicContainer::drawChildren 2")
             widget->draw(graphics);
             BLOCK_END("BasicContainer::drawChildren 2")
             graphics->popClipArea();
         }
     }
  
     graphics->popClipArea();
     BLOCK_END("BasicContainer::drawChildren")
 }

References BLOCK_END, BLOCK_START, CAST_S32, FOR_EACH, Rect::height, restrict, Visible_true, Rect::width, Rect::x, and Rect::y.

Referenced by BasicContainer2::draw(), Popup::draw(), ScrollArea::draw(), TabbedArea::draw(), Tab::draw(), Window::draw(), ConnectionDialog::draw(), MiniStatusWindow::draw(), and WindowMenu::drawChildren().

◆ findFirstWidget()

Widget * BasicContainer::findFirstWidget ( const std::set< Widget * > & list )

Definition at line 444 of file basiccontainer.cpp.

 {
     FOR_EACHR (WidgetListReverseIterator, iter, mWidgets)
     {
         if (list.find(*iter) != list.end())
             return *iter;
     }
     return nullptr;
 }

References FOR_EACHR.

Referenced by InventoryWindow::getFirstVisible().

◆ focusNext()

void BasicContainer::focusNext ( )

virtual

Focuses the next widget in the widget.

See also: moveToBottom

Reimplemented from Widget.

Definition at line 152 of file basiccontainer.cpp.

 {
     WidgetListConstIterator it;
  
     for (it = mWidgets.begin(); it != mWidgets.end(); ++ it)
     {
         if ((*it)->isFocused())
             break;
     }
  
     const WidgetListConstIterator end = it;
  
     if (it == mWidgets.end())
         it = mWidgets.begin();
  
     ++ it;
  
     for ( ; it != end; ++ it)
     {
         if (it == mWidgets.end())
             it = mWidgets.begin();
  
         if ((*it)->isFocusable())
         {
             (*it)->requestFocus();
             return;
         }
     }
 }

References mWidgets.

◆ focusPrevious()

void BasicContainer::focusPrevious ( )

virtual

Focuses the previous widget in the widget.

See also: moveToBottom

Reimplemented from Widget.

Definition at line 182 of file basiccontainer.cpp.

 {
     WidgetListReverseIterator it;
  
     for (it = mWidgets.rbegin(); it != mWidgets.rend(); ++ it)
     {
         if ((*it)->isFocused())
             break;
     }
  
     const WidgetListReverseIterator end = it;
  
     ++ it;
  
     if (it == mWidgets.rend())
         it = mWidgets.rbegin();
  
     for ( ; it != end; ++ it)
     {
         if (it == mWidgets.rend())
             it = mWidgets.rbegin();
  
         if ((*it)->isFocusable())
         {
             (*it)->requestFocus();
             return;
         }
     }
 }

References mWidgets.

◆ getChildrenArea()

Rect BasicContainer::getChildrenArea ( )

virtual

Gets the area of the widget occupied by the widget's children. By default this method returns an empty rectangle as not all widgets are containers. If you want to make a container this method should return the area where the children resides. This method is used when drawing children of a widget when computing clip rectangles for the children.

An example of a widget that overloads this method is ScrollArea. A ScrollArea has a view of its contant and that view is the children area. The size of a ScrollArea's children area might vary depending on if the scroll bars of the ScrollArea is shown or not.

Returns: The area of the widget occupied by the widget's children.

See also: BasicContainer; BasicContainer::getChildrenArea; BasicContainer::drawChildren

Reimplemented from Widget.

Reimplemented in MiniStatusWindow, Window, ScrollArea, Popup, and DropDown.

Definition at line 147 of file basiccontainer.cpp.

 {
     return Rect(0, 0, mDimension.width, mDimension.height);
 }

References Rect::height, Widget::mDimension, and Rect::width.

Referenced by LayoutHelper::widgetResized().

◆ getWidgetAt()

Widget * BasicContainer::getWidgetAt	(	int	x,
		int	y
	)

virtual

Gets a widget from a certain position in the widget. This function is used to decide which gets mouse input, thus it can be overloaded to change that behaviour.

NOTE: This always returns NULL if the widget is not a container.

Parameters

x	The x coordinate of the widget to get.
y	The y coordinate of the widget to get.

Returns: The widget at the specified coodinate, NULL if no widget is found.

Reimplemented from Widget.

Reimplemented in ScrollArea.

Definition at line 212 of file basiccontainer.cpp.

 {
     const Rect r = getChildrenArea();
  
     if (!r.isPointInRect(x, y))
         return nullptr;
  
     x -= r.x;
     y -= r.y;
  
     for (WidgetListReverseIterator it = mWidgets.rbegin();
          it != mWidgets.rend(); ++ it)
     {
         const Widget *restrict const widget = *it;
         if (widget->isVisible() &&
             widget->getDimension().isPointInRect(x, y))
         {
             return *it;
         }
     }
  
     return nullptr;
 }

References Rect::isPointInRect(), restrict, Rect::x, x, Rect::y, and y.

Referenced by TabbedArea::mousePressed().

◆ logic()

void BasicContainer::logic ( )

virtual

Called for all widgets in the gui each time Gui::logic is called. You can do logic stuff here like playing an animation.

See also: Gui::logic

Reimplemented from Widget.

Reimplemented in Viewport, Viewport, WhoIsOnline, UpdaterWindow, ServerDialog, NpcDialog, MiniStatusWindow, CutInWindow, CharCreateDialog, TargetDebugTab, StatDebugTab, NetDebugTab, MapDebugTab, DebugTab, TabbedArea, and ScrollArea.

Definition at line 236 of file basiccontainer.cpp.

 {
     BLOCK_START("BasicContainer::logic")
     if (mVisible == Visible_false)
     {
         BLOCK_END("BasicContainer::logic")
         return;
     }
     logicChildren();
     BLOCK_END("BasicContainer::logic")
 }

References BLOCK_END, BLOCK_START, logicChildren(), Widget::mVisible, and Visible_false.

Referenced by ChatWindow::addTab(), MiniStatusWindow::logic(), NpcDialog::logic(), ServerDialog::logic(), and ClanWindow::slowLogic().

◆ logicChildren()

void BasicContainer::logicChildren ( )

protectedvirtual

Calls logic for the children widgets of the basic container.

Definition at line 399 of file basiccontainer.cpp.

 {
     BLOCK_START("BasicContainer::logicChildren")
     FOR_EACH (WidgetListConstIterator, iter, mLogicWidgets)
         (*iter)->logic();
     BLOCK_END("BasicContainer::logicChildren")
 }

References BLOCK_END, BLOCK_START, FOR_EACH, and mLogicWidgets.

Referenced by logic(), and TabbedArea::logic().

◆ moveToBottom()

void BasicContainer::moveToBottom ( Widget *const widget )

virtual

Moves a widget in this widget to the bottom of this widget. The moved widget will be drawn below all other widgets in this widget.

Parameters

widget The widget to move to the bottom.

See also: moveToTop

Reimplemented from Widget.

Definition at line 110 of file basiccontainer.cpp.

 {
     if (widget == nullptr)
     {
         reportAlways("BasicContainer::moveToBottom empty widget.")
         return;
     }
     const WidgetListIterator iter = std::find(mWidgets.begin(),
         mWidgets.end(), widget);
     if (iter != mWidgets.end())
     {
         mWidgets.erase(iter);
         mWidgets.insert(mWidgets.begin(), widget);
     }
  
     const WidgetListIterator iter2 = std::find(mLogicWidgets.begin(),
         mLogicWidgets.end(), widget);
     if (iter2 != mLogicWidgets.end())
     {
         mLogicWidgets.erase(iter2);
         mLogicWidgets.insert(mLogicWidgets.begin(), widget);
     }
 }

References AttributesEnum::find(), and reportAlways.

◆ moveToTop()

void BasicContainer::moveToTop ( Widget *const widget )

virtual

Moves a widget to the top of this widget. The moved widget will be drawn above all other widgets in this widget.

Parameters

widget The widget to move to the top.

See also: moveToBottom

Reimplemented from Widget.

Definition at line 82 of file basiccontainer.cpp.

 {
     if (widget == nullptr)
     {
         reportAlways("BasicContainer::moveToTop empty widget.")
         return;
     }
  
     FOR_EACH (WidgetListIterator, iter, mWidgets)
     {
         if (*iter == widget)
         {
             mWidgets.erase(iter);
             mWidgets.push_back(widget);
             break;
         }
     }
     FOR_EACH (WidgetListIterator, iter, mLogicWidgets)
     {
         if (*iter == widget)
         {
             mLogicWidgets.erase(iter);
             mLogicWidgets.push_back(widget);
             return;
         }
     }
 }

References FOR_EACH, and reportAlways.

◆ remove()

void BasicContainer::remove ( Widget *const widget )

virtual

Removes a widget from the basic container.

Parameters

widget The widget to remove.

See also: add, clear

Definition at line 277 of file basiccontainer.cpp.

 {
     if (widget == nullptr)
         return;
     FOR_EACH (WidgetListIterator, iter, mWidgets)
     {
         if (*iter == widget)
         {
             mWidgets.erase(iter);
             widget->setFocusHandler(nullptr);
             widget->setWindow(nullptr);
             widget->setParent(nullptr);
             widget->removeDeathListener(this);
             break;
         }
     }
     FOR_EACH (WidgetListIterator, iter, mLogicWidgets)
     {
         if (*iter == widget)
         {
             mLogicWidgets.erase(iter);
             return;
         }
     }
 }

References FOR_EACH.

Referenced by StatsClanTab::clearLabels(), RelationClanTab::clearLabels(), TabbedArea::enableScrollButtons(), TabbedArea::removeTab(), Container::safeRemove(), CharCreateDialog::setAttributes(), TabbedArea::setSelectedTab(), MiniStatusWindow::updateBars(), and TabbedArea::~TabbedArea().

◆ safeDrawChildren()

void BasicContainer::safeDrawChildren ( Graphics *const graphics )

protectedvirtual

Reimplemented in WindowMenu.

Definition at line 358 of file basiccontainer.cpp.

 {
     BLOCK_START("BasicContainer::drawChildren")
     graphics->pushClipArea(getChildrenArea());
  
     FOR_EACH (WidgetListConstIterator, iter, mWidgets)
     {
         Widget *restrict const widget = *iter;
         if (widget->mVisible == Visible_true)
         {
             // If the widget has a frame,
             // draw it before drawing the widget
             if (widget->mFrameSize > 0)
             {
                 Rect rec = widget->mDimension;
                 const int frame = CAST_S32(widget->mFrameSize);
                 const int frame2 = frame * 2;
                 rec.x -= frame;
                 rec.y -= frame;
                 rec.width += frame2;
                 rec.height += frame2;
                 graphics->pushClipArea(rec);
                 BLOCK_START("BasicContainer::drawChildren 1")
                 widget->safeDrawFrame(graphics);
                 BLOCK_END("BasicContainer::drawChildren 1")
                 graphics->popClipArea();
             }
  
             graphics->pushClipArea(widget->mDimension);
             BLOCK_START("BasicContainer::drawChildren 2")
             widget->safeDraw(graphics);
             BLOCK_END("BasicContainer::drawChildren 2")
             graphics->popClipArea();
         }
     }
  
     graphics->popClipArea();
     BLOCK_END("BasicContainer::drawChildren")
 }

References BLOCK_END, BLOCK_START, CAST_S32, FOR_EACH, Rect::height, restrict, Visible_true, Rect::width, Rect::x, and Rect::y.

Referenced by BasicContainer2::safeDraw(), Popup::safeDraw(), ScrollArea::safeDraw(), TabbedArea::safeDraw(), Tab::safeDraw(), Window::safeDraw(), ConnectionDialog::safeDraw(), MiniStatusWindow::safeDraw(), and WindowMenu::safeDrawChildren().

◆ setFocusHandler()

void BasicContainer::setFocusHandler ( FocusHandler *const focusHandler )

virtual

Sets the focus handler to be used.

WARNING: This function is used internally and should not be called or overloaded unless you know what you are doing.

Parameters

focusHandler The focus handler to use.

See also: getFocusHandler

Reimplemented from Widget.

Definition at line 248 of file basiccontainer.cpp.

 {
     Widget::setFocusHandler(focusHandler);
  
     if (mInternalFocusHandler != nullptr)
         return;
  
     FOR_EACH (WidgetListConstIterator, iter, mWidgets)
         (*iter)->setFocusHandler(focusHandler);
 }

References FOR_EACH, and Widget::setFocusHandler().

◆ setInternalFocusHandler()

void BasicContainer::setInternalFocusHandler ( FocusHandler *const focusHandler )

Definition at line 431 of file basiccontainer.cpp.

 {
     Widget::setInternalFocusHandler(focusHandler);
  
     FocusHandler *const restrict handler = mInternalFocusHandler != nullptr ?
         mInternalFocusHandler : getFocusHandler();
     FOR_EACH (WidgetListConstIterator, iter, mWidgets)
     {
         (*iter)->setFocusHandler(handler);
     }
 }

References FOR_EACH, restrict, and Widget::setInternalFocusHandler().

◆ showWidgetPart()

void BasicContainer::showWidgetPart	(	Widget *const	widget,
		const Rect &	area
	)

virtual

Shows a certain part of a widget in the basic container. Used when widgets want a specific part to be visible in its parent. An example is a TextArea that wants a specific part of its text to be visible when a TextArea is a child of a ScrollArea.

Parameters

widget	The widget whom wants a specific part of itself to be visible.
area	The rectangle to be visible.

Reimplemented from Widget.

Reimplemented in ScrollArea.

Definition at line 407 of file basiccontainer.cpp.

 {
     if (widget == nullptr)
         return;
  
     const Rect widgetArea = getChildrenArea();
  
     const int x = widget->mDimension.x;
     const int y = widget->mDimension.y;
     const int ax = area.x + x;
     const int ay = area.y + y;
  
     if (ax < 0)
         widget->setX(-area.x);
     else if (ax + area.width > widgetArea.width)
         widget->setX(widgetArea.width - area.x - area.width);
  
     if (ay < 0)
         widget->setY(-area.y);
     else if (ay + area.height > widgetArea.height)
         widget->setY(widgetArea.height - area.y - area.height);
 }

References Rect::height, Rect::width, x, and y.

Referenced by ScrollArea::showWidgetPart().

Field Documentation

◆ mLogicWidgets

WidgetList BasicContainer::mLogicWidgets

protected

Definition at line 211 of file basiccontainer.h.

Referenced by clear(), logicChildren(), and WindowContainer::moveWidgetAfter().

◆ mWidgets

WidgetList BasicContainer::mWidgets

protected

Holds all widgets of the basic container.

Definition at line 209 of file basiccontainer.h.

Referenced by TabStrip::action(), WindowContainer::adjustAfterResize(), clear(), TabStrip::createWidget(), focusNext(), focusPrevious(), ScrollArea::getContent(), ScrollArea::getHorizontalMarkerDimension(), ScrollArea::getVerticalMarkerDimension(), WindowContainer::moveWidgetAfter(), TabStrip::nextTab(), TabStrip::prevTab(), Container::removeControls(), Window::resizeToContent(), Container::safeRemove(), Window::widgetHidden(), FlowContainer::widgetResized(), and Window::~Window().

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

src/gui/widgets/basiccontainer.h (986a3bf)
src/gui/widgets/basiccontainer.cpp (986a3bf)

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ WidgetList

◆ WidgetListConstIterator

◆ WidgetListCReverseIterator

◆ WidgetListIterator

◆ WidgetListReverseIterator

Constructor & Destructor Documentation

◆ BasicContainer()

◆ ~BasicContainer()

Member Function Documentation

◆ add()

◆ clear()

◆ death()

◆ drawChildren()

◆ findFirstWidget()

◆ focusNext()

◆ focusPrevious()

◆ getChildrenArea()

◆ getWidgetAt()

◆ logic()

◆ logicChildren()

◆ moveToBottom()

◆ moveToTop()

◆ remove()

◆ safeDrawChildren()

◆ setFocusHandler()

◆ setInternalFocusHandler()

◆ showWidgetPart()

Field Documentation

◆ mLogicWidgets

◆ mWidgets