#include <QskIndexedLayoutBox.h>

Detailed Description

Base class of layouts with index ordered elements.

Definition at line 11 of file QskIndexedLayoutBox.h.

Inheritance diagram for QskIndexedLayoutBox:

Properties
bool	autoAddChildren
	Flag controlling whether to automatically append children to the layout.

Properties inherited from QskBox
bool	panel

QskBoxBorderMetrics	borderMetrics

QskBoxBorderColors	borderColors

QskGradient	setFillGradient

QskMargins	padding

Properties inherited from QskControl
QLocale	locale

QskAspect::Section	section

bool	autoLayoutChildren

bool	visibleToLayout

QskMargins	margins

QskGradient	background

QskSizePolicy	sizePolicy

QskPlacementPolicy	placementPolicy

QSizeF	minimumSize

QSizeF	maximumSize

QSizeF	preferredSize

QSizeF	sizeConstraint

Properties inherited from QskItem
QRectF	geometry

QRectF	rect

bool	tabFence

bool	polishOnResize

bool	polishOnParentResize

Qt::FocusPolicy	focusPolicy

bool	wheelEnabled

bool	visibleToParent

bool	hasChildItems

bool	initiallyPainted

UpdateFlags	updateFlags

Public Member Functions
	QskIndexedLayoutBox (QQuickItem *parent=nullptr)
	Constructor.

	~QskIndexedLayoutBox () override
	Destructor.

void	setAutoAddChildren (bool on=true)
	En/Disable auto appending of children.

bool	autoAddChildren () const

Public Member Functions inherited from QskBox
	QskBox (QQuickItem *parent=nullptr)

	QskBox (bool hasPanel, QQuickItem *parent=nullptr)

void	setPanel (bool)

bool	hasPanel () const

QskBoxBorderMetrics	borderMetrics () const

void	setBorderMetrics (const QskBoxBorderMetrics &)

void	resetBorderMetrics ()

QskBoxBorderColors	borderColors () const

void	setBorderColors (const QskBoxBorderColors &)

void	resetBorderColors ()

QskGradient	fillGradient () const

void	setFillGradient (const QskGradient &)

void	resetFillGradient ()

void	setPadding (qreal)

void	setPadding (const QMarginsF &)

void	resetPadding ()

QMarginsF	padding () const

QRectF	layoutRectForSize (const QSizeF &) const override

Public Member Functions inherited from QskControl
	QskControl (QQuickItem *parent=nullptr)

	~QskControl () override

void	setMargins (qreal)

void	setMargins (qreal, qreal, qreal, qreal)

void	setMargins (const QMarginsF &)

void	resetMargins ()

QMarginsF	margins () const

void	setBackground (const QskGradient &)

void	resetBackground ()

QskGradient	background () const

void	setBackgroundColor (const QColor &)

QRectF	contentsRect () const

QRectF	layoutRect () const

virtual QRectF	focusIndicatorRect () const

virtual QRectF	focusIndicatorClipRect () const

QRectF	subControlRect (QskAspect::Subcontrol) const

QRectF	subControlRect (const QSizeF &, QskAspect::Subcontrol) const

QRectF	subControlContentsRect (QskAspect::Subcontrol) const

QRectF	subControlContentsRect (const QSizeF &, QskAspect::Subcontrol) const

void	setAutoLayoutChildren (bool)

bool	autoLayoutChildren () const

void	setSection (QskAspect::Section)

void	resetSection ()

QskAspect::Section	section () const override final

void	setSizePolicy (QskSizePolicy)

void	setSizePolicy (QskSizePolicy::Policy, QskSizePolicy::Policy)

void	setSizePolicy (Qt::Orientation, QskSizePolicy::Policy)

QskSizePolicy	sizePolicy () const

QskSizePolicy::Policy	sizePolicy (Qt::Orientation) const

void	setLayoutAlignmentHint (Qt::Alignment)

Qt::Alignment	layoutAlignmentHint () const

void	setPlacementPolicy (QskPlacementPolicy)

void	setPlacementPolicy (QskPlacementPolicy::Policy, QskPlacementPolicy::Policy)

void	setPlacementPolicy (Qsk::Visibilities, QskPlacementPolicy::Policy)

void	resetPlacementPolicy ()

QskPlacementPolicy	placementPolicy () const

QskPlacementPolicy::Policy	placementPolicy (Qsk::Visibility) const

QskPlacementPolicy::Policy	effectivePlacementPolicy () const

bool	isVisibleToLayout () const

void	setMinimumSize (const QSizeF &)

void	setMinimumSize (qreal width, qreal height)

void	setMinimumWidth (qreal width)

void	setMinimumHeight (qreal height)

void	setMaximumSize (const QSizeF &)

void	setMaximumSize (qreal width, qreal height)

void	setMaximumWidth (qreal width)

void	setMaximumHeight (qreal height)

void	setPreferredSize (const QSizeF &)

void	setPreferredSize (qreal width, qreal height)

void	setPreferredWidth (qreal width)

void	setPreferredHeight (qreal height)

void	setFixedSize (const QSizeF &)

void	setFixedSize (qreal width, qreal height)

void	setFixedWidth (qreal width)

void	setFixedHeight (qreal height)

void	setExplicitSizeHint (Qt::SizeHint, const QSizeF &)

void	setExplicitSizeHint (Qt::SizeHint, qreal width, qreal height)

void	resetExplicitSizeHint (Qt::SizeHint)

QSizeF	minimumSize () const

QSizeF	maximumSize () const

QSizeF	preferredSize () const

QSizeF	explicitSizeHint (Qt::SizeHint) const

QSizeF	implicitSizeHint (Qt::SizeHint, const QSizeF &constraint) const

QSizeF	sizeHint () const

qreal	heightForWidth (qreal width) const

qreal	widthForHeight (qreal height) const

QSizeF	effectiveSizeHint (Qt::SizeHint, const QSizeF &constraint=QSizeF()) const

QSizeF	sizeConstraint (Qt::SizeHint, const QSizeF &constraint=QSizeF()) const

QSizeF	sizeConstraint () const

QLocale	locale () const

void	resetLocale ()

QVector< QskAspect::Subcontrol >	subControls () const

QRectF	subControlRect (const QRectF &, QskAspect::Subcontrol) const
	Calculate position and size of a subControl.

QRectF	subControlContentsRect (const QRectF &, QskAspect::Subcontrol) const
	Calculate the inner rectangle for subControl.

Public Member Functions inherited from QskItem
const char *	className () const

bool	isVisibleTo (const QQuickItem *) const

bool	isVisibleToParent () const

bool	hasChildItems () const

QRectF	rect () const

QSizeF	implicitSize () const

void	setGeometry (qreal x, qreal y, qreal width, qreal height)

void	setGeometry (const QPointF &, const QSizeF &)

QRectF	geometry () const

void	setPosition (qreal x, qreal y)

void	setSize (qreal width, qreal height)

void	setPolishOnResize (bool)

bool	polishOnResize () const

void	setPolishOnParentResize (bool)

bool	polishOnParentResize () const

void	setFocusPolicy (Qt::FocusPolicy)

Qt::FocusPolicy	focusPolicy () const

void	setTabFence (bool)

bool	isTabFence () const

void	setWheelEnabled (bool)

bool	isWheelEnabled () const

void	setLayoutMirroring (bool on, bool childrenInherit=false)

void	resetLayoutMirroring ()

bool	layoutMirroring () const

void	resetUpdateFlags ()

UpdateFlags	updateFlags () const

void	setUpdateFlag (UpdateFlag, bool on=true)

void	resetUpdateFlag (UpdateFlag)

bool	testUpdateFlag (UpdateFlag) const

void	classBegin () override

void	componentComplete () override

void	releaseResources () override

bool	isPolishScheduled () const

bool	isUpdateNodeScheduled () const

bool	isInitiallyPainted () const

bool	maybeUnresized () const

Public Member Functions inherited from QskSkinnable
	QskSkinnable ()

virtual	~QskSkinnable ()

void	setSkinlet (const QskSkinlet *)
	Set an individual skinlet to render/display the content.

const QskSkinlet *	skinlet () const

QFont	effectiveFont (QskAspect) const

qreal	effectiveFontHeight (QskAspect) const

QskColorFilter	effectiveGraphicFilter (QskAspect::Subcontrol) const

void	setSubcontrolProxy (QskAspect::Subcontrol, QskAspect::Subcontrol proxy)

void	resetSubcontrolProxy (QskAspect::Subcontrol)

QskAspect::Subcontrol	subcontrolProxy (QskAspect::Subcontrol) const

bool	setAnimationHint (QskAspect, QskAnimationHint)

QskAnimationHint	animationHint (QskAspect, QskSkinHintStatus *=nullptr) const

bool	hasAnimationHint (QskAspect) const

bool	setSkinHint (QskAspect, const QVariant &)
	Insert a hint into the local hint table.

bool	resetSkinHint (QskAspect)
	Remove a hint from the local hint table.

bool	moveSkinHint (QskAspect, const QVariant &)

bool	moveSkinHint (QskAspect, const QVariant &, const QVariant &)

QskAnimationHint	effectiveAnimation (QskAspect::Type, QskAspect::Subcontrol, QskAspect::States, QskSkinHintStatus *status=nullptr) const

QVariant	effectiveSkinHint (QskAspect, QskSkinHintStatus *=nullptr) const
	Find the value for a specific aspect.

virtual QskAspect::Variation	effectiveVariation () const

QskSkinHintStatus	hintStatus (QskAspect) const

QRectF	subControlRect (const QRectF &, QskAspect::Subcontrol) const
	Calculate position and size of a subControl.

QRectF	subControlContentsRect (const QRectF &, QskAspect::Subcontrol) const
	Calculate the inner rectangle for subControl.

QSizeF	outerBoxSize (QskAspect, const QSizeF &innerBoxSize) const
	Calculate the size, when being expanded by paddings, indentations.

QSizeF	innerBoxSize (QskAspect, const QSizeF &outerBoxSize) const
	Calculate the size, with paddings, indentations being subtracted.

QRectF	innerBox (QskAspect, const QRectF &outerBox) const
	Calculate the rectangle, whith paddings, indentations being subtracted.

QRectF	outerBox (QskAspect, const QRectF &innerBox) const
	Calculate the rectangle, when being expanded by paddings, indentations.

QMarginsF	innerPadding (QskAspect, const QSizeF &) const
	Calculate the padding from attributes for the given aspect.

const QskSkinlet *	effectiveSkinlet () const

QskSkin *	effectiveSkin () const

void	startTransition (QskAspect, QskAnimationHint, const QVariant &from, const QVariant &to)

void	startTransition (QskAspect, int index, QskAnimationHint, const QVariant &from, const QVariant &to)

QskAspect::Subcontrol	effectiveSubcontrol (QskAspect::Subcontrol) const

QskControl *	controlCast ()

const QskControl *	controlCast () const

virtual const QMetaObject *	metaObject () const =0

void	debug (QskAspect) const

void	debug (QskAspect::State) const

void	debug (QDebug, QskAspect) const

void	debug (QDebug, QskAspect::State) const

void	setSkinStates (QskAspect::States)

void	setSkinStateFlag (QskAspect::State, bool on=true)

void	addSkinStates (QskAspect::States)

void	clearSkinStates (QskAspect::States)

bool	hasSkinState (QskAspect::State) const

QskAspect::States	skinStates () const

const char *	skinStatesAsPrintable () const

const char *	skinStatesAsPrintable (QskAspect::States) const

bool	setColor (QskAspect, Qt::GlobalColor)
	Sets a color hint.

bool	setColor (QskAspect, QRgb)
	Sets a color hint.

bool	setColor (QskAspect, const QColor &)
	Sets a color hint.

bool	moveColor (QskAspect, Qt::GlobalColor)

bool	moveColor (QskAspect, QRgb)

bool	moveColor (QskAspect, const QColor &)

bool	resetColor (QskAspect)
	Removes a color hint from the local table.

QColor	color (QskAspect, QskSkinHintStatus *=nullptr) const
	Retrieves a color hint.

bool	setMetric (QskAspect, qreal)
	Sets a metric hint.

bool	moveMetric (QskAspect, qreal)

bool	resetMetric (QskAspect)
	Removes a metric hint from the local table.

qreal	metric (QskAspect, QskSkinHintStatus *=nullptr) const
	Retrieves a metric hint.

bool	setFlagHint (QskAspect, int flag)
	Sets a flag hint.

template<typename T >
T	flagHint (QskAspect, T=T()) const
	Retrieves a flag hint.

bool	setPositionHint (QskAspect, qreal)

bool	movePositionHint (QskAspect, qreal)

bool	movePositionHint (QskAspect, qreal from, qreal to)

bool	resetPositionHint (QskAspect)

qreal	positionHint (QskAspect, QskSkinHintStatus *=nullptr) const

bool	setStrutSizeHint (QskAspect, const QSizeF &)
	Sets a metric hint.

bool	setStrutSizeHint (QskAspect, qreal width, qreal height)
	Sets a strut size hint.

bool	resetStrutSizeHint (QskAspect)
	Removes a strut size hint from the local table.

QSizeF	strutSizeHint (QskAspect, QskSkinHintStatus *=nullptr) const
	Retrieves a strut size hint.

bool	setMarginHint (QskAspect, qreal)
	Sets a margin hint.

bool	setMarginHint (QskAspect, const QMarginsF &)
	Sets a margin hint.

bool	resetMarginHint (QskAspect)
	Removes a margin hint from the local table.

QMarginsF	marginHint (QskAspect, QskSkinHintStatus *=nullptr) const
	Retrieves a margin hint.

bool	setPaddingHint (QskAspect, qreal)
	Sets a padding hint.

bool	setPaddingHint (QskAspect, const QMarginsF &)
	Sets a padding hint.

bool	resetPaddingHint (QskAspect)
	Removes a padding hint from the local table.

QMarginsF	paddingHint (QskAspect, QskSkinHintStatus *=nullptr) const
	Retrieves a padding hint.

bool	setGradientHint (QskAspect, const QskGradient &)
	Sets a gradient as color hint.

QskGradient	gradientHint (QskAspect, QskSkinHintStatus *=nullptr) const
	Retrieves a color hint as gradient.

bool	setBoxShapeHint (QskAspect, const QskBoxShapeMetrics &)
	Sets a shape hint.

bool	resetBoxShapeHint (QskAspect)
	Removes a shape hint from the local table.

QskBoxShapeMetrics	boxShapeHint (QskAspect, QskSkinHintStatus *=nullptr) const
	Retrieves a shape hint.

bool	setBoxBorderMetricsHint (QskAspect, const QskBoxBorderMetrics &)
	Sets a border metrics hint.

bool	resetBoxBorderMetricsHint (QskAspect)
	Removes a border metrics hint from the local table.

QskBoxBorderMetrics	boxBorderMetricsHint (QskAspect, QskSkinHintStatus *=nullptr) const
	Retrieves a border hint.

bool	setBoxBorderColorsHint (QskAspect, const QskBoxBorderColors &)
	Sets a border colors hint.

bool	resetBoxBorderColorsHint (QskAspect)
	Removes a border colors hint from the local table.

QskBoxBorderColors	boxBorderColorsHint (QskAspect, QskSkinHintStatus *=nullptr) const
	Retrieves border colors hint.

bool	setShadowMetricsHint (QskAspect, const QskShadowMetrics &)

bool	resetShadowMetricsHint (QskAspect)

QskShadowMetrics	shadowMetricsHint (QskAspect, QskSkinHintStatus *=nullptr) const

bool	setShadowColorHint (QskAspect, const QColor &)

bool	resetShadowColorHint (QskAspect)

QColor	shadowColorHint (QskAspect, QskSkinHintStatus *=nullptr) const

QskBoxHints	boxHints (QskAspect) const

bool	setArcMetricsHint (QskAspect, const QskArcMetrics &)

bool	resetArcMetricsHint (QskAspect)

QskArcMetrics	arcMetricsHint (QskAspect, QskSkinHintStatus *=nullptr) const

bool	setStippleMetricsHint (QskAspect, const QskStippleMetrics &)

bool	resetStippleMetricsHint (QskAspect)

QskStippleMetrics	stippleMetricsHint (QskAspect, QskSkinHintStatus *=nullptr) const

bool	setSpacingHint (QskAspect, qreal)
	Sets a spacing hint.

bool	resetSpacingHint (QskAspect)
	Removes a spacing hint from the local table.

qreal	spacingHint (QskAspect, QskSkinHintStatus *=nullptr) const
	Retrieves a spacing hint.

bool	setAlignmentHint (QskAspect, Qt::Alignment)
	Sets an alignment hint.

bool	resetAlignmentHint (QskAspect)
	Removes an alignment hint from the local table.

Qt::Alignment	alignmentHint (QskAspect, Qt::Alignment=Qt::Alignment()) const
	Retrieves an alignment hint.

bool	setTextOptionsHint (QskAspect, const QskTextOptions &)

bool	resetTextOptionsHint (QskAspect)

QskTextOptions	textOptionsHint (QskAspect, QskSkinHintStatus *=nullptr) const

bool	setFontRoleHint (QskAspect, const QskFontRole &)
	Sets a font role hint.

bool	resetFontRoleHint (QskAspect)
	Removes a font role hint from the local table.

QskFontRole	fontRoleHint (QskAspect, QskSkinHintStatus *=nullptr) const
	Retrieves a font role hint.

bool	setGraphicRoleHint (QskAspect, int role)
	Sets a graphic role hint.

bool	resetGraphicRoleHint (QskAspect)
	Removes a graphic role hint from the local table.

int	graphicRoleHint (QskAspect, QskSkinHintStatus *=nullptr) const
	A Retrieves a graphic role hint.

bool	setSymbolHint (const QskAspect, const QskGraphic &)

bool	resetSymbolHint (const QskAspect)

QskGraphic	symbolHint (const QskAspect, QskSkinHintStatus *=nullptr) const

const QskSkinHintTable &	hintTable () const
	Accessor for local skin hint table.

bool	startHintTransitions (QskAspect::States, QskAspect::States, int index=-1)

bool	startHintTransitions (const QVector< QskAspect::Subcontrol > &, QskAspect::States, QskAspect::States, int index=-1)

const QskHintAnimator *	runningHintAnimator (QskAspect, int index=-1) const

Signals
void	autoAddChildrenChanged ()

Signals inherited from QskBox
void	panelChanged (bool)

void	borderMetricsChanged (const QskBoxBorderMetrics &)

void	borderColorsChanged (const QskBoxBorderColors &)

void	fillGradientChanged (const QskGradient &)

void	paddingChanged (const QMarginsF &)

Signals inherited from QskControl
void	backgroundChanged ()

void	sectionChanged (QskAspect::Section)

void	marginsChanged (const QMarginsF &)

void	focusIndicatorRectChanged ()

void	localeChanged (const QLocale &)

Signals inherited from QskItem
void	wheelEnabledChanged (bool)

void	focusPolicyChanged (Qt::FocusPolicy)

void	itemFlagsChanged ()

void	updateFlagsChanged (UpdateFlags)

Protected Member Functions
void	itemChange (ItemChange, const ItemChangeData &) override

void	reparentItem (QQuickItem *)

void	unparentItem (QQuickItem *)

Protected Member Functions inherited from QskControl
bool	event (QEvent *) override

virtual void	gestureEvent (QskGestureEvent *)

void	hoverEnterEvent (QHoverEvent *) override

void	hoverLeaveEvent (QHoverEvent *) override

bool	childMouseEventFilter (QQuickItem , QEvent ) override

void	itemChange (ItemChange, const ItemChangeData &) override

void	geometryChange (const QRectF &, const QRectF &) override

void	initSizePolicy (QskSizePolicy::Policy, QskSizePolicy::Policy)

virtual void	updateResources ()

virtual void	updateLayout ()

virtual QSizeF	contentsSizeHint (Qt::SizeHint, const QSizeF &) const

virtual QSizeF	layoutSizeHint (Qt::SizeHint, const QSizeF &) const

Protected Member Functions inherited from QskItem
	QskItem (QskItemPrivate &, QQuickItem *=nullptr)

bool	event (QEvent *) override

virtual void	changeEvent (QEvent *)

virtual void	geometryChangeEvent (QskGeometryChangeEvent *)

virtual void	windowChangeEvent (QskWindowChangeEvent *)

void	mouseUngrabEvent () override

void	touchUngrabEvent () override

void	itemChange (ItemChange, const ItemChangeData &) override

void	geometryChange (const QRectF &, const QRectF &) override

virtual void	aboutToShow ()

Protected Member Functions inherited from QskSkinnable
virtual void	updateNode (QSGNode *)

virtual bool	isTransitionAccepted (QskAspect) const
	Additional check if an transition should be started.

virtual QskAspect::Subcontrol	substitutedSubcontrol (QskAspect::Subcontrol) const

QskSkinHintTable &	hintTable ()
	Accessor for local skin hint table.

Additional Inherited Members
Public Types inherited from QskItem
enum	UpdateFlag { DeferredUpdate = 1 << 0 , DeferredPolish = 1 << 1 , DeferredLayout = 1 << 2 , CleanupOnVisibility = 1 << 3 , PreferRasterForTextures = 1 << 4 , DebugForceBackground = 1 << 7 }

Static Public Attributes inherited from QskBox
static const QskAspect::Subcontrol	Panel

Static Public Attributes inherited from QskControl
static const QskAspect::Subcontrol	Background

static const QskAspect::State	Disabled

static const QskAspect::State	Hovered

static const QskAspect::State	Focused

Public Slots inherited from QskControl
void	setLocale (const QLocale &)

Public Slots inherited from QskItem
void	setGeometry (const QRectF &)

void	show ()

void	hide ()

void	setHidden (bool)

void	setDisabled (bool)

void	resetImplicitSize ()

Constructor & Destructor Documentation

◆ QskIndexedLayoutBox()

QskIndexedLayoutBox::QskIndexedLayoutBox ( QQuickItem * parent = nullptr )

explicit

Constructor.

Create a layout having autoAddChildren set to false.

Parameters

parent Parent item

Definition at line 22 of file QskIndexedLayoutBox.cpp.

◆ ~QskIndexedLayoutBox()

QskIndexedLayoutBox::~QskIndexedLayoutBox ( )

override

Destructor.

Definition at line 29 of file QskIndexedLayoutBox.cpp.

Member Function Documentation

◆ autoAddChildren()

bool QskIndexedLayoutBox::autoAddChildren ( ) const

Returns: Value of the autoAddChildren property

Definition at line 42 of file QskIndexedLayoutBox.cpp.

◆ autoAddChildrenChanged

void QskIndexedLayoutBox::autoAddChildrenChanged ( )

signal

The autoAddChildren property has changed

See also: setAutoAddChildren(), autoAddChildren()

◆ itemChange()

void QskIndexedLayoutBox::itemChange	(	ItemChange	,
		const ItemChangeData &
	)

overrideprotected

Checking ItemChildAddedChange/ItemChildRemovedChange changes to implement the autoAddChildren mode

See also: autoAddChildren

Definition at line 47 of file QskIndexedLayoutBox.cpp.

◆ reparentItem()

void QskIndexedLayoutBox::reparentItem ( QQuickItem * item )

protected

Definition at line 89 of file QskIndexedLayoutBox.cpp.

◆ setAutoAddChildren()

void QskIndexedLayoutBox::setAutoAddChildren ( bool on = true )

En/Disable auto appending of children.

When autoAddChildren() is enabled new children are automatically appended to the layout. Otherwise items have to be inserted manually using addItem() or insertItem().

Parameters

on	When true autoAddChildren is enabled

Note: Existing children, that have not been inserted before remain being not seen by the layout.

Definition at line 33 of file QskIndexedLayoutBox.cpp.

◆ unparentItem()

void QskIndexedLayoutBox::unparentItem ( QQuickItem * item )

protected

Definition at line 102 of file QskIndexedLayoutBox.cpp.

Property Documentation

◆ autoAddChildren

bool QskIndexedLayoutBox::autoAddChildren

readwrite

Flag controlling whether to automatically append children to the layout.

When autoAddChildren is enabled new children are automatically appended to the layout. Otherwise items have to be inserted manually using addItem() or insertItem().

Note: Children being transparent for positioners are ignored

Access functions:: autoAddChildren(), setAutoAddChildren(), autoAddChildrenChanged()

Definition at line 15 of file QskIndexedLayoutBox.h.