LayoutHelper Class Reference

#include <layouthelper.h>

Inheritance diagram for LayoutHelper:

Public Member Functions
	LayoutHelper (BasicContainer2 *const container)
	~LayoutHelper ()
const Layout &	getLayout () const A_CONST
void	reflowLayout (int w, int h)
LayoutCell &	place (const int x, const int y, Widget *const wg, const int w, const int h)
ContainerPlacer	getPlacer (const int x, const int y)
void	widgetResized (const Event &event)
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
Layout	mLayout
BasicContainer2 *	mContainer

Additional Inherited Members
Protected Member Functions inherited from WidgetListener
	WidgetListener ()

Detailed Description

A helper class for adding a layout to a Guichan container widget. The layout will register itself as a widget listener and relayout the widgets in the container dynamically on resize.

Definition at line 39 of file layouthelper.h.

Constructor & Destructor Documentation

LayoutHelper()

LayoutHelper::LayoutHelper ( BasicContainer2 *const  container )

explicit

Constructor.

Definition at line 31 of file layouthelper.cpp.

                                                           :
    WidgetListener(),
    mLayout(),
    mContainer(container)
{
    if (mContainer != nullptr)
        mContainer->addWidgetListener(this);
}

References Widget::addWidgetListener(), and mContainer.

~LayoutHelper()

LayoutHelper::~LayoutHelper

(

)

Destructor.

Definition at line 40 of file layouthelper.cpp.

{
    if (mContainer != nullptr)
        mContainer->removeWidgetListener(this);
}

References mContainer, and Widget::removeWidgetListener().

Member Function Documentation

getLayout()

const Layout & LayoutHelper::getLayout

(

)

const

Gets the layout handler.

Definition at line 46 of file layouthelper.cpp.

{
    return mLayout;
}

References mLayout.

Referenced by StatsClanTab::updateClan(), and RelationClanTab::updateClan().

getPlacer()

ContainerPlacer LayoutHelper::getPlacer	(	const int	x,
		const int	y
	)

Returns a proxy for adding widgets in an inner table of the layout.

Definition at line 60 of file layouthelper.cpp.

{
    return ContainerPlacer(mContainer, &mLayout.at(x, y));
}

References LayoutCell::at(), mContainer, mLayout, x, and y.

Referenced by ChangeDisplay::ChangeDisplay(), CharacterDisplay::CharacterDisplay(), DerDisplay::DerDisplay(), InfoClanTab::InfoClanTab(), MapDebugTab::MapDebugTab(), NetDebugTab::NetDebugTab(), Setup_Audio::Setup_Audio(), Setup_Chat::Setup_Chat(), Setup_Colors::Setup_Colors(), Setup_Input::Setup_Input(), Setup_Joystick::Setup_Joystick(), Setup_Misc::Setup_Misc(), Setup_Mods::Setup_Mods(), Setup_Perfomance::Setup_Perfomance(), Setup_Players::Setup_Players(), Setup_Quick::Setup_Quick(), Setup_Relations::Setup_Relations(), Setup_Theme::Setup_Theme(), Setup_Touch::Setup_Touch(), Setup_Video::Setup_Video(), Setup_Visual::Setup_Visual(), StatDebugTab::StatDebugTab(), and TargetDebugTab::TargetDebugTab().

place()

LayoutCell & LayoutHelper::place	(	const int	x,
		const int	y,
		Widget *const	wg,
		const int	w,
		const int	h
	)

Adds a widget to the container and sets it at given cell.

Definition at line 51 of file layouthelper.cpp.

{
    if (mContainer != nullptr)
        mContainer->add(wg);
    return mLayout.place(wg, x, y, w, h);
}

References BasicContainer2::add(), mContainer, mLayout, LayoutCell::place(), x, and y.

reflowLayout()

void LayoutHelper::reflowLayout	(	int	w,
		int	h
	)

Computes the position of the widgets according to the current layout. Resizes the managed container so that the layout fits.

Note

This function is meant to be called with fixed-size containers.

Parameters

w	if non-zero, force the container to this width.
h	if non-zero, force the container to this height.

Definition at line 65 of file layouthelper.cpp.

{
    mLayout.reflow(w, h);
    if (mContainer != nullptr)
        mContainer->setSize(w, h);
}

References mContainer, mLayout, Layout::reflow(), and Widget::setSize().

widgetResized()

void LayoutHelper::widgetResized ( const Event &  event )

virtual

Called whenever the managed container changes size.

Reimplemented from WidgetListener.

Definition at line 72 of file layouthelper.cpp.

{
    if (mContainer == nullptr)
        return;
    const Rect area = mContainer->getChildrenArea();
    int w = area.width;
    int h = area.height;
    mLayout.reflow(w, h);
}

References BasicContainer::getChildrenArea(), Rect::height, mContainer, mLayout, Layout::reflow(), and Rect::width.

Field Documentation

mContainer

BasicContainer2* LayoutHelper::mContainer

private

Managed container

Definition at line 93 of file layouthelper.h.

Referenced by getPlacer(), LayoutHelper(), place(), reflowLayout(), widgetResized(), and ~LayoutHelper().

mLayout

Layout LayoutHelper::mLayout

private

Layout handler

Definition at line 92 of file layouthelper.h.

Referenced by getLayout(), getPlacer(), place(), reflowLayout(), and widgetResized().

---

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

• src/gui/widgets/layouthelper.h (986a3bf)
• src/gui/widgets/layouthelper.cpp (986a3bf)