DDAutoPinConfig Class Reference

Class for building "auto pin" config, to be passed to DumbDisplay::configAutoPin(). More...

#include <__dd_misc_layout.h>

Public Member Functions
	DDAutoPinConfig (char dir, int nestedDepth=5)
	DDAutoPinConfig (DDAutoPinGroupHeader header, int nestedDepth=5)
DDAutoPinConfig &	beginGroup (char dir)
DDAutoPinConfig &	beginGroup (DDAutoPinGroupHeader header)
DDAutoPinConfig &	endGroup ()
	end a begun group, returning to the previous level of nesting
DDAutoPinConfig &	beginPaddedGroup (char dir, int left, int top, int right, int bottom)
DDAutoPinConfig &	endPaddedGroup ()
	end begun padded group
DDAutoPinConfig &	addLayer (DDLayer *layer)
	add a layer to the current level
DDAutoPinConfig &	addLayer (DDLayer &layer)
	add a layer to the current level
DDAutoPinConfig &	addLayer (DDLayerHandle layerHandle)
	add a layer to the current level
DDAutoPinConfig &	addPaddedLayer (DDLayer *layer, int left, int top, int right, int bottom)
DDAutoPinConfig &	addPaddedLayer (DDLayer &layer, int left, int top, int right, int bottom)
DDAutoPinConfig &	addPaddedLayer (DDLayerHandle layerHandle, int left, int top, int right, int bottom)
DDAutoPinConfig &	addSpacer (int width, int height)
DDAutoPinConfig &	addRemainingGroup (char dir)
const String &	build ()
	build the "auto pin" config string, to be passed to DumbDisplay::configAutoPin()

Detailed Description

Class for building "auto pin" config, to be passed to DumbDisplay::configAutoPin().

Since

v0.9.7-r2

Constructor & Destructor Documentation

DDAutoPinConfig() [1/2]

DDAutoPinConfig::DDAutoPinConfig ( char  dir, int  nestedDepth = 5  )

inline

Parameters

dir	directory of layers at the top level; can be 'H' for horizontal, 'V' for vertical and 'S' for stacked
nestedDepth	maximum depth of nesting; default is 5

DDAutoPinConfig() [2/2]

DDAutoPinConfig::DDAutoPinConfig ( DDAutoPinGroupHeader  header, int  nestedDepth = 5  )

inline

Parameters

header	group header
nestedDepth	maximum depth of nesting; default is 5

Member Function Documentation

addPaddedLayer() [1/3]

DDAutoPinConfig & DDAutoPinConfig::addPaddedLayer ( DDLayer &  layer, int  left, int  top, int  right, int  bottom  )

inline

add a layer, with specified padding

Parameters

left	left padding (% of the contained area width)
top	top padding (% of the contained area height)
right	right padding (% of the contained area width)
bottom	bottom padding (% of the contained area height)

addPaddedLayer() [2/3]

DDAutoPinConfig & DDAutoPinConfig::addPaddedLayer ( DDLayer *  layer, int  left, int  top, int  right, int  bottom  )

inline

add a layer, with specified padding

Parameters

left	left padding (% of the contained area width)
top	top padding (% of the contained area height)
right	right padding (% of the contained area width)
bottom	bottom padding (% of the contained area height)

addPaddedLayer() [3/3]

DDAutoPinConfig & DDAutoPinConfig::addPaddedLayer ( DDLayerHandle  layerHandle, int  left, int  top, int  right, int  bottom  )

inline

add a layer, with specified padding

Parameters

left	left padding (% of the contained area width)
top	top padding (% of the contained area height)
right	right padding (% of the contained area width)
bottom	bottom padding (% of the contained area height)

addRemainingGroup()

DDAutoPinConfig & DDAutoPinConfig::addRemainingGroup ( char  dir )

inline

add the layout direction for the layers not included

Parameters

dir	'H' / 'V' / 'S

addSpacer()

DDAutoPinConfig & DDAutoPinConfig::addSpacer ( int  width, int  height  )

inline

add spacer, which is a placeholder layer with the specified size

Parameters

width	width of the placeholder layer
height	height of the placeholder layer

beginGroup() [1/2]

DDAutoPinConfig & DDAutoPinConfig::beginGroup ( char  dir )

inline

begin a layer group, creating a new level of nesting

Parameters

dir	directory of layers at the new level; can be 'H' for horizontal, 'V' for vertical and 'S' for stacked

beginGroup() [2/2]

DDAutoPinConfig & DDAutoPinConfig::beginGroup ( DDAutoPinGroupHeader  header )

inline

begin a layer group, creating a new level of nesting

Parameters

dir	directory of layers at the new level; can be 'H' for horizontal, 'V' for vertical and 'S' for stacked

beginPaddedGroup()

DDAutoPinConfig & DDAutoPinConfig::beginPaddedGroup ( char  dir, int  left, int  top, int  right, int  bottom  )

inline

begin a layer group, with specified padding

Parameters

dir	directory of layers at the new level; can be 'H' for horizontal, 'V' for vertical and 'S' for stacked
left	left padding (% of the contained area width)
top	top padding (% of the contained area height)
right	right padding (% of the contained area width)
bottom	bottom padding (% of the contained area height)