duds::ui::graphics::GridSizeStep Struct Reference

A single size-step used by a PriorityGridLayout to place a Panel. More...

#include <GridLayoutConfig.hpp>

Collaboration diagram for duds::ui::graphics::GridSizeStep:

Public Member Functions
	GridSizeStep ()=default
	Default constructor; does nothing. More...
constexpr	GridSizeStep (const ImageDimensions &id, const GridLocation &gl, const GridLayoutConfig::Flags flg)
	Constructs a new GridSizeStep with the given values. More...
constexpr	GridSizeStep (const ImageDimensions &id, const GridLocation &gl)
	Constructs a new GridSizeStep with the given values, and cleared (0) configuration flags. More...
void	center ()
	Sets all the positioning flags to indicate the panel should be centered horizontally and vertically. More...
void	centerHoriz ()
	Sets the horizontal positioning flags to indicate the panel should be centered. More...
void	centerVert ()
	Sets the vertcal positioning flags to indicate the panel should be centered. More...
void	hide ()
	Sets the flag to hide the panel. More...
void	justifyDown ()
	Sets the vertcal positioning flags to indicate the panel should be justified to the bottom edge. More...
void	justifyLeft ()
	Sets the horizontal positioning flags to indicate the panel should be justified to the left edge. More...
void	justifyRight ()
	Sets the horizontal positioning flags to indicate the panel should be justified to the right edge. More...
void	justifyUp ()
	Sets the vertcal positioning flags to indicate the panel should be justified to the top edge. More...
void	show ()
	Clear the flag to show the panel. More...

Public Attributes
GridLayoutConfig::Flags	flags
	Configuration flags that are OR'd with the flags in GridLayoutConfig to produce the final configuration options. More...
GridLocation	loc
	The location within the grid to place the Panel. More...
ImageDimensions	minDim
	The minimum size required for the Panel for this size-step. More...

Detailed Description

A single size-step used by a PriorityGridLayout to place a Panel.

Author

Jeff Jackowski

Definition at line 288 of file GridLayoutConfig.hpp.

Constructor & Destructor Documentation

GridSizeStep() [1/3]

duds::ui::graphics::GridSizeStep::GridSizeStep ( )

default

Default constructor; does nothing.

GridSizeStep() [2/3]

constexpr duds::ui::graphics::GridSizeStep::GridSizeStep ( const ImageDimensions &  id, const GridLocation &  gl, const GridLayoutConfig::Flags  flg  )

inline

Constructs a new GridSizeStep with the given values.

Parameters

id	The minimum dimensions for the size-step.
gl	The grid location for the size-step.
flg	The configuration flags.

Definition at line 319 of file GridLayoutConfig.hpp.

GridSizeStep() [3/3]

constexpr duds::ui::graphics::GridSizeStep::GridSizeStep ( const ImageDimensions &  id, const GridLocation &  gl  )

inline

Constructs a new GridSizeStep with the given values, and cleared (0) configuration flags.

Parameters

id	The minimum dimensions for the size-step.
gl	The grid location for the size-step.

Definition at line 330 of file GridLayoutConfig.hpp.

Member Function Documentation

center()

void duds::ui::graphics::GridSizeStep::center ( )

inline

Sets all the positioning flags to indicate the panel should be centered horizontally and vertically.

Definition at line 392 of file GridLayoutConfig.hpp.

centerHoriz()

void duds::ui::graphics::GridSizeStep::centerHoriz ( )

inline

Sets the horizontal positioning flags to indicate the panel should be centered.

Definition at line 355 of file GridLayoutConfig.hpp.

centerVert()

void duds::ui::graphics::GridSizeStep::centerVert ( )

inline

Sets the vertcal positioning flags to indicate the panel should be centered.

Definition at line 382 of file GridLayoutConfig.hpp.

hide()

void duds::ui::graphics::GridSizeStep::hide ( )

inline

Sets the flag to hide the panel.

Definition at line 401 of file GridLayoutConfig.hpp.

justifyDown()

void duds::ui::graphics::GridSizeStep::justifyDown ( )

inline

Sets the vertcal positioning flags to indicate the panel should be justified to the bottom edge.

Definition at line 372 of file GridLayoutConfig.hpp.

justifyLeft()

void duds::ui::graphics::GridSizeStep::justifyLeft ( )

inline

Sets the horizontal positioning flags to indicate the panel should be justified to the left edge.

This is the default configuration.

Definition at line 338 of file GridLayoutConfig.hpp.

justifyRight()

void duds::ui::graphics::GridSizeStep::justifyRight ( )

inline

Sets the horizontal positioning flags to indicate the panel should be justified to the right edge.

Definition at line 345 of file GridLayoutConfig.hpp.

justifyUp()

void duds::ui::graphics::GridSizeStep::justifyUp ( )

inline

Sets the vertcal positioning flags to indicate the panel should be justified to the top edge.

This is the default configuration.

Definition at line 365 of file GridLayoutConfig.hpp.

show()

void duds::ui::graphics::GridSizeStep::show ( )

inline

Clear the flag to show the panel.

Definition at line 407 of file GridLayoutConfig.hpp.

Member Data Documentation

flags

GridLayoutConfig::Flags duds::ui::graphics::GridSizeStep::flags

Configuration flags that are OR'd with the flags in GridLayoutConfig to produce the final configuration options.

If the flag PanelHidden is set, this size-step will not be considered, but other size-steps for the panel will still be considered.

Definition at line 308 of file GridLayoutConfig.hpp.

loc

GridLocation duds::ui::graphics::GridSizeStep::loc

The location within the grid to place the Panel.

The rows are handled independently of each other, so columns may not line up between rows. Unused locations take up no space; rows with no columns do not appear, and columns with no panels do not cause a gap.

Definition at line 300 of file GridLayoutConfig.hpp.

minDim

ImageDimensions duds::ui::graphics::GridSizeStep::minDim

The minimum size required for the Panel for this size-step.

A larger area may be assigned than the minimum.

Definition at line 293 of file GridLayoutConfig.hpp.

---

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

• GridLayoutConfig.hpp