Internal data structure used to store a Panel, its configuration, and current layout status. More...

Collaboration diagram for duds::ui::graphics::PriorityGridLayout::PanelStatus:

Public Member Functions
	PanelStatus ()=default

	PanelStatus (const PanelSptr &pspt, const GridLayoutConfig &conf)

	PanelStatus (const PanelSptr &pspt, GridLayoutConfig &&conf)

const GridSizeStep &	currentStep () const
	Returns the size-step selected by layout(). More...

GridLayoutConfig::Flags	flags () const
	Returns the configuration flags to use for rendering. More...

Public Attributes
GridLayoutConfig	config
	The panel's layout configuration. More...

ImageDimensions	dim
	The maximum dimensions allocated to the panel by layout(). More...

bool	hidden
	True to indicate that the panel will not be rendered. More...

ImageLocation	loc
	The location on the target image as determined by layout(). More...

PanelSptr	panel
	The Panel object. More...

int	sizeStep
	The index of the size-step to use for rendering the panel as selected by layout(). More...

Detailed Description

Internal data structure used to store a Panel, its configuration, and current layout status.

Definition at line 70 of file PriorityGridLayout.hpp.

Constructor & Destructor Documentation

◆ PanelStatus() [1/3]

duds::ui::graphics::PriorityGridLayout::PanelStatus::PanelStatus ( )

default

Referenced by duds::ui::graphics::PriorityGridLayout::add(), duds::ui::graphics::PriorityGridLayout::addOrReplace(), and flags().

◆ PanelStatus() [2/3]

duds::ui::graphics::PriorityGridLayout::PanelStatus::PanelStatus	(	const PanelSptr &	pspt,
		const GridLayoutConfig &	conf
	)

Definition at line 46 of file PriorityGridLayout.cpp.

◆ PanelStatus() [3/3]

duds::ui::graphics::PriorityGridLayout::PanelStatus::PanelStatus	(	const PanelSptr &	pspt,
		GridLayoutConfig &&	conf
	)

Definition at line 51 of file PriorityGridLayout.cpp.

Member Function Documentation

◆ currentStep()

const GridSizeStep& duds::ui::graphics::PriorityGridLayout::PanelStatus::currentStep ( ) const

inline

Returns the size-step selected by layout().

Precondition: The panel will be rendered; hidden is false.

Definition at line 101 of file PriorityGridLayout.hpp.

◆ flags()

GridLayoutConfig::Flags duds::ui::graphics::PriorityGridLayout::PanelStatus::flags ( ) const

inline

Returns the configuration flags to use for rendering.

The flags are formed by OR'ing the panel config flags and the current size-step flags.

Precondition: The panel will be rendered; hidden is false.

Definition at line 110 of file PriorityGridLayout.hpp.

Referenced by duds::ui::graphics::PriorityGridLayout::render().

Member Data Documentation

◆ config

GridLayoutConfig duds::ui::graphics::PriorityGridLayout::PanelStatus::config

The panel's layout configuration.

Definition at line 78 of file PriorityGridLayout.hpp.

Referenced by duds::ui::graphics::PriorityGridLayout::renderFill().

◆ dim

ImageDimensions duds::ui::graphics::PriorityGridLayout::PanelStatus::dim

The maximum dimensions allocated to the panel by layout().

Definition at line 82 of file PriorityGridLayout.hpp.

Referenced by duds::ui::graphics::PriorityGridLayout::render(), and duds::ui::graphics::PriorityGridLayout::renderFill().

◆ hidden

bool duds::ui::graphics::PriorityGridLayout::PanelStatus::hidden

True to indicate that the panel will not be rendered.

This can be from a hidden flag, or from exhausting all size-steps.

Definition at line 96 of file PriorityGridLayout.hpp.

◆ loc

ImageLocation duds::ui::graphics::PriorityGridLayout::PanelStatus::loc

The location on the target image as determined by layout().

Definition at line 86 of file PriorityGridLayout.hpp.

Referenced by duds::ui::graphics::PriorityGridLayout::render().

◆ panel

PanelSptr duds::ui::graphics::PriorityGridLayout::PanelStatus::panel

The Panel object.

Definition at line 74 of file PriorityGridLayout.hpp.

Referenced by duds::ui::graphics::PriorityGridLayout::remove(), and duds::ui::graphics::PriorityGridLayout::renderFill().

◆ sizeStep

int duds::ui::graphics::PriorityGridLayout::PanelStatus::sizeStep

The index of the size-step to use for rendering the panel as selected by layout().

Definition at line 91 of file PriorityGridLayout.hpp.

Referenced by currentStep(), and flags().

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

Public Member Functions

Public Attributes