qskinny/doc/classes/QskIndexedLayoutBox.dox

70 lines
1.7 KiB
Plaintext
Raw Normal View History

2020-12-08 11:02:57 +01:00
/*!
2020-12-12 14:05:09 +01:00
\class QskIndexedLayoutBox QskIndexedLayoutBox.h
2020-12-08 11:02:57 +01:00
\brief Base class of layouts with index ordered elements
*/
2020-12-12 14:05:09 +01:00
/*!
\property bool QskIndexedLayoutBox::autoAddChildren
2020-12-08 11:02:57 +01:00
2020-12-12 14:05:09 +01:00
\brief Flag controlling whether to automatically append children to the layout.
2020-12-08 11:02:57 +01:00
2020-12-12 14:05:09 +01:00
When autoAddChildren is enabled new children are automatically
appended to the layout. Otherwise items have to be inserted
manually using addItem() or insertItem().
2020-12-08 11:02:57 +01:00
2020-12-12 14:05:09 +01:00
\note Children being transparent for positioners are ignored
2020-12-08 11:02:57 +01:00
2020-12-12 14:05:09 +01:00
\accessors autoAddChildren(), setAutoAddChildren(), autoAddChildrenChanged()
*/
2020-12-08 11:02:57 +01:00
2020-12-12 14:05:09 +01:00
/*!
\fn QskIndexedLayoutBox::QskIndexedLayoutBox( QQuickItem* )
2020-12-08 11:02:57 +01:00
2020-12-12 14:05:09 +01:00
\brief Constructor
2020-12-08 11:02:57 +01:00
2020-12-12 14:05:09 +01:00
Create a layout having autoAddChildren set to false.
2020-12-08 11:02:57 +01:00
2020-12-12 14:05:09 +01:00
\param parent Parent item
*/
2020-12-08 11:02:57 +01:00
2020-12-12 14:05:09 +01:00
/*!
\fn QskIndexedLayoutBox::~QskIndexedLayoutBox()
\brief Destructor
*/
2020-12-08 11:02:57 +01:00
2020-12-12 14:05:09 +01:00
/*!
\fn void QskIndexedLayoutBox::autoAddChildrenChanged()
2020-12-08 11:02:57 +01:00
2020-12-12 14:05:09 +01:00
The autoAddChildren property has changed
\sa setAutoAddChildren(), autoAddChildren()
*/
2020-12-08 11:02:57 +01:00
2020-12-12 14:05:09 +01:00
/*!
\fn void QskIndexedLayoutBox::setAutoAddChildren( bool on )
2020-12-08 11:02:57 +01:00
2020-12-12 14:05:09 +01:00
\brief En/Disable auto appending of children
2020-12-08 11:02:57 +01:00
2020-12-12 14:05:09 +01:00
When autoAddChildren() is enabled new children are automatically
appended to the layout. Otherwise items have to be inserted
manually using addItem() or insertItem().
2020-12-08 11:02:57 +01:00
2020-12-12 14:05:09 +01:00
\param on When true autoAddChildren is enabled
2020-12-08 11:02:57 +01:00
2020-12-12 14:05:09 +01:00
\note Existing children, that have not been inserted before
remain being not seen by the layout.
*/
2020-12-08 11:02:57 +01:00
2020-12-12 14:05:09 +01:00
/*!
\fn bool QskIndexedLayoutBox::autoAddChildren() const
\return Value of the \ref autoAddChildren property
*/
2020-12-08 11:02:57 +01:00
2020-12-12 14:05:09 +01:00
/*!
\fn void QskIndexedLayoutBox::itemChange( QQQuickItem *::ItemChange, const QQQuickItem *::ItemChangeData & )
2020-12-08 11:02:57 +01:00
2020-12-12 14:05:09 +01:00
Checking ItemChildAddedChange/ItemChildRemovedChange changes to
implement the \ref autoAddChildren mode
2020-12-08 11:02:57 +01:00
2020-12-12 14:05:09 +01:00
\sa autoAddChildren
*/