spk::ResizableElement::SizeHint Class Reference

Holds minimal, desired, and maximal size generators. More...

#include <spk_resizable_element.hpp>

Collaboration diagram for spk::ResizableElement::SizeHint:

Public Types
using	Generator = CachedData<Vector2UInt>::Generator
	Generator type used to compute size hints.

Public Member Functions
	SizeHint (Generator p_minimalGenerator, Generator p_desiredGenerator, Generator p_maximalGenerator)
	Builds size hints with generator callbacks.
void	configure (Generator p_minimalGenerator, Generator p_desiredGenerator, Generator p_maximalGenerator)
	Configures all size hint generators.
void	configureMinimalGenerator (Generator p_generator)
	Configures the minimal size generator.
void	configureDesiredGenerator (Generator p_generator)
	Configures the desired size generator.
void	configureMaximalGenerator (Generator p_generator)
	Configures the maximal size generator.
void	release ()
	Releases all cached size hint values.
void	releaseMinimal ()
	Releases cached minimal size.
void	releaseDesired ()
	Releases cached desired size.
void	releaseMaximal ()
	Releases cached maximal size.
void	setMinimal (const Vector2UInt &p_minimalValue)
	Sets the minimal size override.
void	setDesired (const Vector2UInt &p_desiredValue)
	Sets the desired size override.
void	setMaximal (const Vector2UInt &p_maximalValue)
	Sets the maximal size override.
const Vector2UInt &	minimal () const
	Returns the minimal size.
const Vector2UInt &	desired () const
	Returns the desired size.
const Vector2UInt &	maximal () const
	Returns the maximal size.

Detailed Description

Holds minimal, desired, and maximal size generators.

Constructor & Destructor Documentation

SizeHint()

spk::ResizableElement::SizeHint::SizeHint	(	Generator	p_minimalGenerator,
		Generator	p_desiredGenerator,
		Generator	p_maximalGenerator )

Builds size hints with generator callbacks.

Parameters

p_minimalGenerator	Minimal size generator.
p_desiredGenerator	Desired size generator.
p_maximalGenerator	Maximal size generator.

Member Function Documentation

configure()

void spk::ResizableElement::SizeHint::configure	(	Generator	p_minimalGenerator,
		Generator	p_desiredGenerator,
		Generator	p_maximalGenerator )

Configures all size hint generators.

Parameters

p_minimalGenerator	Minimal size generator.
p_desiredGenerator	Desired size generator.
p_maximalGenerator	Maximal size generator.

Here is the call graph for this function:

configureDesiredGenerator()

void spk::ResizableElement::SizeHint::configureDesiredGenerator

(

Generator

p_generator

)

Configures the desired size generator.

Parameters

p_generator

Desired size generator.

Here is the caller graph for this function:

configureMaximalGenerator()

void spk::ResizableElement::SizeHint::configureMaximalGenerator

(

Generator

p_generator

)

Configures the maximal size generator.

Parameters

p_generator

Maximal size generator.

Here is the caller graph for this function:

configureMinimalGenerator()

void spk::ResizableElement::SizeHint::configureMinimalGenerator

(

Generator

p_generator

)

Configures the minimal size generator.

Parameters

p_generator

Minimal size generator.

Here is the caller graph for this function:

desired()

const spk::Vector2UInt & spk::ResizableElement::SizeHint::desired

(

)

const

Returns the desired size.

Returns

Desired size.

maximal()

const spk::Vector2UInt & spk::ResizableElement::SizeHint::maximal

(

)

const

Returns the maximal size.

Returns

Maximal size.

minimal()

const spk::Vector2UInt & spk::ResizableElement::SizeHint::minimal

(

)

const

Returns the minimal size.

Returns

Minimal size.

Here is the caller graph for this function:

setDesired()

void spk::ResizableElement::SizeHint::setDesired

(

const Vector2UInt &

p_desiredValue

)

Sets the desired size override.

Parameters

p_desiredValue

Desired size.

setMaximal()

void spk::ResizableElement::SizeHint::setMaximal

(

const Vector2UInt &

p_maximalValue

)

Sets the maximal size override.

Parameters

p_maximalValue

Maximal size.

setMinimal()

void spk::ResizableElement::SizeHint::setMinimal

(

const Vector2UInt &

p_minimalValue

)

Sets the minimal size override.

Parameters

p_minimalValue

Minimal size.

---

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

• includes/structure/widget/spk_resizable_element.hpp
• srcs/structure/widget/spk_resizable_element.cpp