LayoutCell Class Reference

#include <layoutcell.h>

Inheritance diagram for LayoutCell:

Public Types
enum	Alignment { LEFT = 0 , RIGHT , CENTER , FILL }
enum	{ NONE = 0 , WIDGET , ARRAY }

Public Member Functions
virtual	~LayoutCell ()
LayoutCell &	setPadding (int p)
int	getVPadding () const
int	getHPadding () const
LayoutCell &	setVPadding (int p)
LayoutCell &	setHPadding (int p)
LayoutCell &	setHAlign (const Alignment a)
LayoutCell &	setVAlign (const Alignment a)
LayoutCell &	at (const int x, const int y)
LayoutCell &	place (Widget *const wg, const int x, const int y, const int w, const int h)
void	matchColWidth (const int n1, const int n2)
void	setColWidth (const int n, const int w)
void	setRowHeight (const int n, const int h)
void	extend (const int x, const int y, const int w, const int h)
void	computeSizes ()
void	setType (int t)
int	getWidth () const
int	getHeight () const
void	setWidth (const int w)
void	setHeight (const int h)

Static Public Attributes
static LayoutCell	emptyCell

Private Member Functions
	LayoutCell ()
	LayoutCell (LayoutCell const &)
LayoutCell &	operator= (LayoutCell const &)
LayoutArray &	getArray ()
void	reflow (int nx, int ny, int nw, int nh)

Private Attributes
union {
Widget *   mWidget
LayoutArray *   mArray
};
int	mSize [2]
int	mHPadding
int	mVPadding
int	mExtent [2]
Alignment	mAlign [2]
int	mNbFill [2]
int	mType

Friends
class	Layout
class	LayoutArray

Detailed Description

This class describes the formatting of a widget in the cell of a layout table. Horizontally, a widget can either fill the width of the cell (minus the cell padding), or it can retain its size and be flushed left, or flush right, or centered in the cell. The process is similar for the vertical alignment, except that top is represented by LEFT and bottom by RIGHT.

Definition at line 39 of file layoutcell.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
NONE
WIDGET
ARRAY

Definition at line 149 of file layoutcell.h.

        {
            NONE = 0,
            WIDGET,
            ARRAY
        };

Alignment

enum LayoutCell::Alignment

Enumerator
LEFT
RIGHT
CENTER
FILL

Definition at line 47 of file layoutcell.h.

        {
            LEFT = 0,
            RIGHT,
            CENTER,
            FILL
        };

Constructor & Destructor Documentation

~LayoutCell()

LayoutCell::~LayoutCell ( )

virtual

Definition at line 36 of file layoutcell.cpp.

{
    if (mType == ARRAY)
        delete2(mArray)
}

References ARRAY, delete2, mArray, and mType.

LayoutCell() [1/2]

LayoutCell::LayoutCell ( )

inlineprivate

Definition at line 159 of file layoutcell.h.

                     :
            mWidget(nullptr),
            mHPadding(0),
            mVPadding(0),
            mType(NONE)
        {
            mExtent[0] = 0;
            mExtent[1] = 0;
            mAlign[0] = LEFT;
            mAlign[1] = LEFT;
            mNbFill[0] = 0;
            mNbFill[1] = 0;
            mSize[0] = 0;
            mSize[1] = 0;
        }

References LEFT, mAlign, mExtent, mNbFill, and mSize.

LayoutCell() [2/2]

LayoutCell::LayoutCell ( LayoutCell const &  )

explicitprivate

Member Function Documentation

at()

LayoutCell & LayoutCell::at	(	const int	x,
		const int	y
	)

See also

LayoutArray::at

Definition at line 106 of file layoutcell.cpp.

{
    return getArray().at(x, y, 1, 1);
}

References LayoutArray::at(), getArray(), x, and y.

Referenced by ContainerPlacer::at(), and LayoutHelper::getPlacer().

computeSizes()

void LayoutCell::computeSizes

(

)

Sets the minimum widths and heights of this cell and of all the inner cells.

Definition at line 79 of file layoutcell.cpp.

{
    if (mType != ARRAY)
        return;
 
    STD_VECTOR <STD_VECTOR <LayoutCell *> >::const_iterator
        i = mArray->mCells.begin();
    const STD_VECTOR <STD_VECTOR <LayoutCell *> >::const_iterator
        i_end = mArray->mCells.end();
    while (i != i_end)
    {
        STD_VECTOR <LayoutCell *>::const_iterator j = i->begin();
        while (j != i->end())
        {
            LayoutCell *const cell = *j;
            if ((cell != nullptr) && cell->mType == ARRAY)
                cell->computeSizes();
 
            ++j;
        }
        ++i;
    }
 
    mSize[0] = mArray->getSize(0);
    mSize[1] = mArray->getSize(1);
}

References ARRAY, computeSizes(), LayoutArray::getSize(), mArray, LayoutArray::mCells, mSize, and mType.

Referenced by computeSizes(), and Layout::reflow().

extend()

void LayoutCell::extend	(	const int	x,
		const int	y,
		const int	w,
		const int	h
	)

See also

LayoutArray::extend.

Definition at line 133 of file layoutcell.cpp.

{
    getArray().extend(x, y, w, h);
}

References LayoutArray::extend(), getArray(), x, and y.

Referenced by TradeWindow::TradeWindow().

getArray()

LayoutArray & LayoutCell::getArray ( )

private

Returns the embedded array. Creates it if the cell does not contain anything yet. Aborts if it contains a widget.

Definition at line 42 of file layoutcell.cpp.

{
    if (mType == WIDGET)
        return tempArray;
    if (mType == ARRAY)
    {
        if (mArray == nullptr)
            return tempArray;
        return *mArray;
    }
 
    mArray = new LayoutArray;
    mType = ARRAY;
    mExtent[0] = 1;
    mExtent[1] = 1;
    mHPadding = 0;
    mVPadding = 0;
    mAlign[0] = FILL;
    mAlign[1] = FILL;
    return *mArray;
}

References ARRAY, FILL, LayoutArray, mAlign, mArray, mExtent, mHPadding, mType, mVPadding, tempArray, and WIDGET.

Referenced by at(), extend(), Layout::Layout(), matchColWidth(), place(), setColWidth(), and setRowHeight().

getHeight()

int LayoutCell::getHeight ( ) const

inline

Definition at line 140 of file layoutcell.h.

        { return mExtent[1]; }

References mExtent.

getHPadding()

int LayoutCell::getHPadding ( ) const

inline

Definition at line 66 of file layoutcell.h.

        { return mHPadding; }

References mHPadding.

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

getVPadding()

int LayoutCell::getVPadding ( ) const

inline

Definition at line 63 of file layoutcell.h.

        { return mVPadding; }

References mVPadding.

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

getWidth()

int LayoutCell::getWidth ( ) const

inline

Definition at line 137 of file layoutcell.h.

        { return mExtent[0]; }

References mExtent.

Referenced by InventoryWindow::widgetResized().

matchColWidth()

void LayoutCell::matchColWidth	(	const int	n1,
		const int	n2
	)

See also

LayoutArray::matchColWidth

Definition at line 118 of file layoutcell.cpp.

{
    getArray().matchColWidth(n1, n2);
}

References getArray(), and LayoutArray::matchColWidth().

Referenced by InfoClanTab::InfoClanTab(), MapDebugTab::MapDebugTab(), NetDebugTab::NetDebugTab(), and TargetDebugTab::TargetDebugTab().

operator=()

LayoutCell& LayoutCell::operator= ( LayoutCell const &  )

private

place()

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

See also

LayoutArray::place

Definition at line 111 of file layoutcell.cpp.

{
    return getArray().place(wg, x, y, w, h);
}

References getArray(), LayoutArray::place(), x, and y.

Referenced by ContainerPlacer::operator()(), LayoutHelper::place(), and Window::place().

reflow()

void LayoutCell::reflow ( int  nx, int  ny, int  nw, int  nh  )

private

See also

LayoutArray::reflow

Definition at line 64 of file layoutcell.cpp.

{
    if (mType == NONE)
        return;
 
    nx += mHPadding;
    ny += mVPadding;
    nw -= 2 * mHPadding;
    nh -= 2 * mVPadding;
    if (mType == ARRAY)
        mArray->reflow(nx, ny, nw, nh);
    else
        mWidget->setDimension(Rect(nx, ny, nw, nh));
}

References ARRAY, mArray, mHPadding, mType, mVPadding, mWidget, NONE, LayoutArray::reflow(), and Widget::setDimension().

Referenced by LayoutArray::reflow(), and Layout::reflow().

setColWidth()

void LayoutCell::setColWidth	(	const int	n,
		const int	w
	)

See also

LayoutArray::setColWidth

Definition at line 123 of file layoutcell.cpp.

{
    getArray().setColWidth(n, w);
}

References getArray(), and LayoutArray::setColWidth().

Referenced by OutfitWindow::OutfitWindow(), and TradeWindow::TradeWindow().

setHAlign()

LayoutCell& LayoutCell::setHAlign ( const Alignment  a )

inline

Sets the horizontal alignment of the cell content.

Definition at line 84 of file layoutcell.h.

        { mAlign[0] = a; return *this; }

References mAlign.

Referenced by ConnectionDialog::ConnectionDialog(), and LoginDialog::LoginDialog().

setHeight()

void LayoutCell::setHeight ( const int  h )

inline

Definition at line 146 of file layoutcell.h.

        { mExtent[1] = h; }

References mExtent.

setHPadding()

LayoutCell& LayoutCell::setHPadding ( int  p )

inline

Sets the horisontal padding around the cell content.

Definition at line 78 of file layoutcell.h.

        { mHPadding = p; return *this; }

References mHPadding.

setPadding()

LayoutCell& LayoutCell::setPadding ( int  p )

inline

Sets the padding around the cell content.

Definition at line 60 of file layoutcell.h.

        { mHPadding = p; mVPadding = p; return *this; }

References mHPadding, and mVPadding.

Referenced by ChangePasswordDialog::ChangePasswordDialog(), DidYouKnowWindow::DidYouKnowWindow(), EditServerDialog::EditServerDialog(), HelpWindow::HelpWindow(), InventoryWindow::InventoryWindow(), KillStats::KillStats(), Layout::Layout(), ServerDialog::ServerDialog(), ServerInfoWindow::ServerInfoWindow(), Layout::setMargin(), ShortcutWindow::ShortcutWindow(), StatusWindow::StatusWindow(), TradeWindow::TradeWindow(), and WorldSelectDialog::WorldSelectDialog().

setRowHeight()

void LayoutCell::setRowHeight	(	const int	n,
		const int	h
	)

See also

LayoutArray::setRowHeight

Definition at line 128 of file layoutcell.cpp.

{
    getArray().setRowHeight(n, h);
}

References getArray(), and LayoutArray::setRowHeight().

Referenced by NpcDialog::buildLayout(), DidYouKnowWindow::DidYouKnowWindow(), HelpWindow::HelpWindow(), BuyDialog::init(), InventoryWindow::InventoryWindow(), MailWindow::MailWindow(), OutfitWindow::OutfitWindow(), SellDialog::postInit(), TextSelectDialog::postInit(), QuestsWindow::QuestsWindow(), ServerDialog::ServerDialog(), ServerInfoWindow::ServerInfoWindow(), ShopWindow::ShopWindow(), ShortcutWindow::ShortcutWindow(), StatusWindow::StatusWindow(), TradeWindow::TradeWindow(), UpdaterWindow::UpdaterWindow(), and WorldSelectDialog::WorldSelectDialog().

setType()

void LayoutCell::setType ( int  t )

inline

Definition at line 134 of file layoutcell.h.

        { mType = t; }

References mType.

Referenced by InventoryWindow::widgetResized().

setVAlign()

LayoutCell& LayoutCell::setVAlign ( const Alignment  a )

inline

Sets the vertical alignment of the cell content.

Definition at line 90 of file layoutcell.h.

        { mAlign[1] = a; return *this; }

References mAlign.

setVPadding()

LayoutCell& LayoutCell::setVPadding ( int  p )

inline

Sets the vertical padding around the cell content.

Definition at line 72 of file layoutcell.h.

        { mVPadding = p; return *this; }

References mVPadding.

setWidth()

void LayoutCell::setWidth ( const int  w )

inline

Definition at line 143 of file layoutcell.h.

        { mExtent[0] = w; }

References mExtent.

Referenced by InventoryWindow::widgetResized().

Friends And Related Function Documentation

Layout

friend class Layout

friend

Definition at line 41 of file layoutcell.h.

LayoutArray

friend class LayoutArray

friend

Definition at line 42 of file layoutcell.h.

Referenced by getArray().

Field Documentation

union { ... }

emptyCell

LayoutCell LayoutCell::emptyCell

static

Definition at line 156 of file layoutcell.h.

Referenced by ContainerPlacer::operator()().

mAlign

Alignment LayoutCell::mAlign[2]

private

Definition at line 200 of file layoutcell.h.

Referenced by getArray(), LayoutCell(), LayoutArray::place(), setHAlign(), and setVAlign().

mArray

LayoutArray* LayoutCell::mArray

Definition at line 182 of file layoutcell.h.

Referenced by computeSizes(), getArray(), reflow(), and ~LayoutCell().

mExtent

int LayoutCell::mExtent[2]

private

Definition at line 199 of file layoutcell.h.

Referenced by LayoutArray::extend(), getArray(), getHeight(), LayoutArray::getSizes(), getWidth(), LayoutCell(), LayoutArray::place(), setHeight(), and setWidth().

mHPadding

int LayoutCell::mHPadding

private

Definition at line 197 of file layoutcell.h.

Referenced by getArray(), getHPadding(), LayoutArray::place(), Layout::reflow(), reflow(), setHPadding(), and setPadding().

mNbFill

int LayoutCell::mNbFill[2]

private

Definition at line 201 of file layoutcell.h.

Referenced by LayoutCell().

mSize

int LayoutCell::mSize[2]

private

Definition at line 196 of file layoutcell.h.

Referenced by computeSizes(), LayoutArray::getSizes(), LayoutCell(), LayoutArray::place(), and Layout::reflow().

mType

int LayoutCell::mType

private

Definition at line 202 of file layoutcell.h.

Referenced by computeSizes(), getArray(), LayoutArray::getSizes(), LayoutArray::place(), LayoutArray::reflow(), reflow(), setType(), and ~LayoutCell().

mVPadding

int LayoutCell::mVPadding

private

Definition at line 198 of file layoutcell.h.

Referenced by getArray(), LayoutArray::getSizes(), getVPadding(), LayoutArray::place(), Layout::reflow(), reflow(), setPadding(), and setVPadding().

mWidget

Widget* LayoutCell::mWidget

Definition at line 181 of file layoutcell.h.

Referenced by LayoutArray::place(), and reflow().

---

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

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