castor3d::Layout::Item Struct Reference

#include <Layout.hpp>

Classes
union	Value

Public Types
enum	Type { eControl = 0 , eSpacer = 1 }

Public Member Functions
	Item (Control &c, LayoutItemFlags f, OnControlChangedConnection o) noexcept
	Item (Spacer &s) noexcept
auto	isControl () const noexcept
auto	control () const noexcept
auto	flags () const noexcept
auto	isSpacer () const noexcept
auto	spacer () const noexcept
C3D_API castor::Size	getPaddedSize () const noexcept
auto	hAlign () const noexcept
auto	vAlign () const noexcept
auto	expand () const noexcept
auto	reserveSpaceIfHidden () const noexcept
uint32_t	padding (uint32_t i) const noexcept
uint32_t	paddingSize (uint32_t i) const noexcept

Member Enumeration Documentation

Type

enum castor3d::Layout::Item::Type

Enumerator
eControl
eSpacer

Constructor & Destructor Documentation

Item() [1/2]

castor3d::Layout::Item::Item ( Control & c, LayoutItemFlags f, OnControlChangedConnection o )

inlineexplicitnoexcept

Creates a control item.

Parameters

[in]	c	The item control.
[in]	f	The item flags.
[in]	o	The connection to the control changed signal.

References eControl.

Item() [2/2]

castor3d::Layout::Item::Item ( Spacer & s )

inlineexplicitnoexcept

Creates a spacer item.

Parameters

[in]

s

The item spacer.

References eSpacer.

Member Function Documentation

control()

auto castor3d::Layout::Item::control ( ) const

inlinenoexcept

Returns

The control if this item is a control, nullptr if not.

References castor3d::Layout::Item::Value::control, and isControl().

Here is the call graph for this function:

expand()

auto castor3d::Layout::Item::expand ( ) const

inlinenoexcept

Returns

The item expand status.

References flags().

Here is the call graph for this function:

flags()

auto castor3d::Layout::Item::flags ( ) const

inlinenoexcept

Returns

The item flags.

Referenced by expand(), hAlign(), padding(), paddingSize(), reserveSpaceIfHidden(), and vAlign().

Here is the caller graph for this function:

getPaddedSize()

C3D_API castor::Size castor3d::Layout::Item::getPaddedSize ( ) const

noexcept

Returns

The size including padding.

hAlign()

auto castor3d::Layout::Item::hAlign ( ) const

inlinenoexcept

Returns

The item horizontal alignment.

References flags().

Here is the call graph for this function:

isControl()

auto castor3d::Layout::Item::isControl ( ) const

inlinenoexcept

Returns

true if this item is a control, nullptr if not.

References eControl.

Referenced by control().

Here is the caller graph for this function:

isSpacer()

auto castor3d::Layout::Item::isSpacer ( ) const

inlinenoexcept

Returns

true if this item is a spacer, nullptr if not.

References eSpacer.

Referenced by spacer().

Here is the caller graph for this function:

padding()

uint32_t castor3d::Layout::Item::padding ( uint32_t i ) const

inlinenoexcept

Returns

The padding value at given index.

References flags().

Here is the call graph for this function:

paddingSize()

uint32_t castor3d::Layout::Item::paddingSize ( uint32_t i ) const

inlinenoexcept

Returns

The padding size at given index.

References flags().

Here is the call graph for this function:

reserveSpaceIfHidden()

auto castor3d::Layout::Item::reserveSpaceIfHidden ( ) const

inlinenoexcept

Returns

The item reserve space if hidden status.

References flags().

Here is the call graph for this function:

spacer()

auto castor3d::Layout::Item::spacer ( ) const

inlinenoexcept

Returns

The spacer if this item is a spacer, nullptr if not.

References isSpacer(), and castor3d::Layout::Item::Value::spacer.

Here is the call graph for this function:

vAlign()

auto castor3d::Layout::Item::vAlign ( ) const

inlinenoexcept

Returns

The item vertical alignment.

References flags().

Here is the call graph for this function:

---

The documentation for this struct was generated from the following file:

• Castor3D/Gui/Layout/Layout.hpp