#include <basiccontainer2.h>

Inheritance diagram for BasicContainer2:

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

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

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

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

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

Detailed Description

An implementation of a container able to contain other widgets. A widget's position in the container is relative to the container itself and not the screen. A container is the most common widget to use as the Gui's top widget as makes the Gui able to contain more than one widget.

See also: Gui::setTop

Definition at line 80 of file basiccontainer2.h.

Constructor & Destructor Documentation

◆ BasicContainer2()

BasicContainer2::BasicContainer2 ( const Widget2 *const widget )

explicit

Constructor. A container is opauqe as default, if you want a none opaque container call setQpaque(false).

See also: setOpaque, isOpaque

Definition at line 75 of file basiccontainer2.cpp.

                                                             :
     BasicContainer(widget),
     mOpaque(Opaque_true)
 {
 }

◆ ~BasicContainer2()

BasicContainer2::~BasicContainer2 ( )

Destructor.

Definition at line 81 of file basiccontainer2.cpp.

82 {

83 }

Member Function Documentation

◆ add()

void BasicContainer2::add ( Widget *const widget )

virtual

Adds a widget to the container.

Parameters

widget The widget to add.

See also: remove, clear

Reimplemented in HorizontContainer, and FlowContainer.

Definition at line 113 of file basiccontainer2.cpp.

 {
     // +++ need move all add() calls from constructors
     // and after this method can be deleted
     // and virtual moved to basiccontainer
     BasicContainer::add(widget);
 }

References BasicContainer::add().

Referenced by FlowContainer::add(), HorizontContainer::add(), VertContainer::add2(), WindowMenu::addButton(), Pincode::addButtons(), TabbedArea::addTab(), WidgetGroup::addWidget(), ChangeEmailDialog::ChangeEmailDialog(), CharacterViewNormal::CharacterViewNormal(), CharacterViewSmall::CharacterViewSmall(), CharCreateDialog::CharCreateDialog(), NpcDialog::createSkinControls(), Game::Game(), BuySellDialog::init(), OkDialog::OkDialog(), LayoutHelper::place(), Window::place(), Popup::Popup(), BeingPopup::postInit(), ItemPopup::postInit(), PopupMenu::postInit(), SkillPopup::postInit(), SpeechBubble::postInit(), SpellPopup::postInit(), TextBoxPopup::postInit(), TextPopup::postInit(), PopupList::postInit(), ChatWindow::postInit(), ClanWindow::postInit(), ConfirmDialog::postInit(), DebugWindow::postInit(), EditDialog::postInit(), EmoteWindow::postInit(), EquipmentWindow::postInit(), SetupWindow::postInit(), WhoIsOnline::postInit(), SliderList::postInit2(), CharCreateDialog::setAttributes(), TabbedArea::setSelectedTab(), StatsPage::StatsPage(), StatsPageBasic::StatsPageBasic(), MiniStatusWindow::updateBars(), WindowMenu::updateButtons(), StatsClanTab::updateClan(), RelationClanTab::updateClan(), and Window::Window().

◆ addXY()

void BasicContainer2::addXY	(	Widget *const	widget,
		const int	x,
		const int	y
	)

Adds a widget to the container and also specifies the widget's position in the container. The position is relative to the container and not relative to the screen.

Parameters

widget	The widget to add.
x	The x coordinate for the widget.
y	The y coordinate for the widget.

See also: remove, clear

Definition at line 121 of file basiccontainer2.cpp.

 {
     if (widget == nullptr)
         return;
     widget->setPosition(x, y);
     BasicContainer::add(widget);
 }

References BasicContainer::add(), Widget::setPosition(), x, and y.

Referenced by Desktop::postInit().

◆ draw()

void BasicContainer2::draw ( Graphics *const graphics )

virtual

Draws the widget. It is called by the parent widget when it is time for the widget to draw itself. The graphics object is set up so that all drawing is relative to the widget, i.e coordinate (0,0) is the top left corner of the widget. It is not possible to draw outside of a widget's dimension.

Parameters

graphics aA graphics object to draw with.

Implements Widget.

Reimplemented in Viewport, Viewport, OutfitWindow, MiniStatusWindow, Minimap, EquipmentWindow, CutInWindow, ConnectionDialog, ChatWindow, Window, SliderList, Popup, Desktop, and DebugWindow.

Definition at line 85 of file basiccontainer2.cpp.

 {
     BLOCK_START("BasicContainer2::draw")
     if (mOpaque == Opaque_true)
     {
         graphics->setColor(mBaseColor);
         graphics->fillRectangle(Rect(0, 0,
             mDimension.width, mDimension.height));
     }
  
     drawChildren(graphics);
     BLOCK_END("BasicContainer2::draw")
 }

References BLOCK_END, BLOCK_START, BasicContainer::drawChildren(), Graphics::fillRectangle(), Rect::height, Widget::mBaseColor, Widget::mDimension, mOpaque, Opaque_true, Graphics::setColor(), and Rect::width.

Referenced by Desktop::draw(), SliderList::draw(), Viewport::draw(), and SliderList::safeDraw().

◆ isOpaque()

bool BasicContainer2::isOpaque ( ) const

inline

Checks if the container is opaque or not.

Returns: True if the container is opaque, false otherwise.

See also: setOpaque

Definition at line 119 of file basiccontainer2.h.

120 { return mOpaque == Opaque_true; }

References mOpaque, and Opaque_true.

◆ safeDraw()

void BasicContainer2::safeDraw ( Graphics *const graphics )

virtual

Implements Widget.

Reimplemented in Viewport, Viewport, OutfitWindow, MiniStatusWindow, Minimap, EquipmentWindow, CutInWindow, ConnectionDialog, ChatWindow, Window, SliderList, Popup, Desktop, and DebugWindow.

Definition at line 99 of file basiccontainer2.cpp.

 {
     BLOCK_START("BasicContainer2::draw")
     if (mOpaque == Opaque_true)
     {
         graphics->setColor(mBaseColor);
         graphics->fillRectangle(Rect(0, 0,
             mDimension.width, mDimension.height));
     }
  
     safeDrawChildren(graphics);
     BLOCK_END("BasicContainer2::draw")
 }

References BLOCK_END, BLOCK_START, Graphics::fillRectangle(), Rect::height, Widget::mBaseColor, Widget::mDimension, mOpaque, Opaque_true, BasicContainer::safeDrawChildren(), Graphics::setColor(), and Rect::width.

◆ setOpaque()

void BasicContainer2::setOpaque ( Opaque opaque )

inline

Sets the container to be opaque or not. If the container is opaque its background will be drawn, if it's not opaque its background will not be drawn, and thus making the container completely transparent.

NOTE: This is not the same as to set visibility. A non visible container will not itself nor will it draw its content.

Parameters

opaque True if the container should be opaque, false otherwise.

See also: isOpaque

Definition at line 110 of file basiccontainer2.h.

111 { mOpaque = opaque; }

References mOpaque.

Referenced by Container::Container(), Pincode::Pincode(), TabbedArea::postInit(), Gui::postInit(), Setup_Colors::Setup_Colors(), SetupTab::SetupTab(), and Viewport::Viewport().

Field Documentation

◆ mOpaque

Opaque BasicContainer2::mOpaque

protected

True if the container is opaque, false otherwise.

Definition at line 153 of file basiccontainer2.h.

Referenced by draw(), isOpaque(), safeDraw(), and setOpaque().

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BasicContainer2()

◆ ~BasicContainer2()

Member Function Documentation

◆ add()

◆ addXY()

◆ draw()

◆ isOpaque()

◆ safeDraw()

◆ setOpaque()

Field Documentation

◆ mOpaque