peranger/qskinny
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doxygen docs

Browse Source
This commit is contained in:
Uwe Rathmann 2021-03-04 09:15:19 +01:00
parent 93d34efa9a
commit 22e8e1aae4
2 changed files with 695 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

693
doc/classes/QskControl.dox
View File

@ -1,33 +1,672 @@
/*!
\class QskControl QskControl.h
\brief Base class of all Qsk controls
\ingroup Framework
QskControl is the base class for most visible Qsk controls.
\brief Base class of all controls
It re-establishes several concepts known from QWidget, that got lost
with QQuickItem:
- contentsRect()
- autoFillBackground()
- support of layout rules: sizeHint(), sizePolicy()
- locale and its propagation on the item tree
Even if QQuickItem is part of the public C++ API it has obviously been
designed for implementing custom items, but not for using them in C++
code. To support this use case a lot of trivial methods have been added.
For some reason the QQuick classes introduced proprietory notfier hooks
instead of using the well established and powerful concept of events.
QskControl tries to revert this decision by mapping notifications
to events, when possible.
The following events are currently implemented:
- QEvent::FontChange
- QEvent::PaletteChange
- QEvent::LocaleChange
- QEvent::LayoutDirectionChange
- QEvent::ContentsRectChange
- QEvent::LayoutRequest
\states Disabled, Hovered, Focused
*/
/*!
\enum QskControl::LayoutHint
\sa setLayoutHint(), testLayoutHint(), setLayoutHints(), layoutHints()
\var QskControl::RetainSizeWhenHidden
bla
\var QskControl::LayoutOutWhenHidden
bla
*/
/*!
\property QLocale QskControl::locale
\accessors locale(), setLocale(), resetLocale(), localeChanged()
*/
/*!
\property bool QskControl::autoFillBackground
\accessors autoFillBackground(), setAutoFillBackground()
\sa setBackgroundColor()
*/
/*!
\property bool QskControl::autoLayoutChildren
\accessors autoLayoutChildren(), setAutoLayoutChildren()
*/
/*!
\property Qt::FocusPolicy QskControl::focusPolicy
\accessors focusPolicy(), setFocusPolicy(), focusPolicyChanged()
*/
/*!
\property bool QskControl::wheelEnabled
\accessors isWheelEnabled(), setWheelEnabled(), wheelEnabledChanged()
*/
/*!
\property bool QskControl::visibleToLayout
\accessors isVisibleToLayout()
*/
/*!
\property QskMargins QskControl::margins
\accessors margins(), setMargins(), resetMargins(), marginsChanged()
*/
/*!
\property QskGradient QskControl::background
\accessors background(), setBackground(), resetBackground(), backgroundChanged()
*/
/*!
\property QskSizePolicy QskControl::sizePolicy
\accessors sizePolicy(), setSizePolicy()
*/
/*!
\property bool QskControl::autoLayoutChildren
\accessors autoLayoutChildren(), setAutoLayoutChildren()
*/
/*!
\property QSizeF QskControl::minimumSize
\accessors minimumSize(), setMinimumSize()
\sa effectiveSizeHint(), setExplicitSizeHint()
setMinimumWidth(), setMinimumHeight()
*/
/*!
\property QSizeF QskControl::maximumSize
\accessors maximumSize(), setMaximumSize()
\sa effectiveSizeHint(), setExplicitSizeHint()
setMaximumWidth(), setMaximumHeight()
*/
/*!
\property QSizeF QskControl::preferredSize
\accessors preferredSize(), setPreferredSize()
\sa effectiveSizeHint(), setExplicitSizeHint(),
setPreferredWidth(), setPreferredHeight()
*/
/*!
\property QSizeF QskControl::sizeConstraint
\accessors sizeConstraint()
*/
/*!
\fn QskControl::QskControl
bla
*/
/*!
\fn QskControl::~QskControl
bla
*/
/*!
\fn QskControl::setMargins( qreal )
bla
*/
/*!
\fn QskControl::setMargins( const QMarginsF& )
bla
*/
/*!
\fn QskControl::resetMargins
bla
*/
/*!
\fn QskControl::margins() const
bla
*/
/*!
\fn QskControl::setBackgroundColor
bla
*/
/*!
\fn QskControl::setBackground
bla
*/
/*!
\fn QskControl::resetBackground
bla
*/
/*!
\fn QskControl::background() const
bla
*/
/*!
\fn QskControl::contentsRect
bla
*/
/*!
\fn QskControl::layoutRect
bla
*/
/*!
\fn QskControl::layoutRectForSize
bla
*/
/*!
\fn QskControl::gestureRect
bla
*/
/*!
\fn QskControl::focusIndicatorRect
bla
*/
/*!
\fn QskControl::focusIndicatorClipRect
bla
*/
/*!
\fn QskControl::subControlRect( QskAspect::Subcontrol ) const
bla
*/
/*!
\fn QskControl::subControlRect( const QSizeF&, QskAspect::Subcontrol ) const
bla
*/
/*!
\fn QskControl::subControlContentsRect( QskAspect::Subcontrol ) const
bla
*/
/*!
\fn QskControl::subControlContentsRect( const QSizeF&, QskAspect::Subcontrol ) const
bla
*/
/*!
\fn QskControl::setAutoFillBackground
bla
*/
/*!
\fn QskControl::autoFillBackground() const
bla
*/
/*!
\fn QskControl::setAutoLayoutChildren
bla
*/
/*!
\fn QskControl::autoLayoutChildren() const
bla
*/
/*!
\fn QskControl::setWheelEnabled
bla
*/
/*!
\fn QskControl::isWheelEnabled
bla
*/
/*!
\fn QskControl::setFocusPolicy
bla
*/
/*!
\fn QskControl::focusPolicy() const
bla
*/
/*!
\fn QskControl::setSizePolicy( QskSizePolicy );
bla
*/
/*!
\fn QskControl::setSizePolicy( QskSizePolicy::Policy, QskSizePolicy::Policy )
bla
*/
/*!
\fn QskControl::setSizePolicy( Qt::Orientation, QskSizePolicy::Policy )
bla
*/
/*!
\fn QskControl::sizePolicy() const
bla
*/
/*!
\fn QskControl::sizePolicy( Qt::Orientation ) const
bla
*/
/*!
\fn QskControl::setLayoutAlignmentHint
bla
*/
/*!
\fn QskControl::layoutAlignmentHint
bla
*/
/*!
\fn QskControl::setLayoutHint
bla
*/
/*!
\fn QskControl::testLayoutHint
bla
*/
/*!
\fn QskControl::setLayoutHints
bla
*/
/*!
\fn QskControl::layoutHints
bla
*/
/*!
\fn QskControl::isVisibleToLayout
bla
*/
/*!
\fn QskControl::setMinimumSize( const QSizeF& )
bla
*/
/*!
\fn QskControl::setMinimumSize( qreal, qreal )
bla
*/
/*!
\fn QskControl::setMinimumWidth
bla
*/
/*!
\fn QskControl::setMinimumHeight
bla
*/
/*!
\fn QskControl::setMaximumSize( const QSizeF& )
bla
*/
/*!
\fn QskControl::setMaximumSize( qreal, qreal )
bla
*/
/*!
\fn QskControl::setMaximumWidth
bla
*/
/*!
\fn QskControl::setMaximumHeight
bla
*/
/*!
\fn QskControl::setPreferredSize( const QSizeF& )
bla
*/
/*!
\fn QskControl::setPreferredSize( qreal, qreal )
bla
*/
/*!
\fn QskControl::setPreferredWidth
bla
*/
/*!
\fn QskControl::setPreferredHeight
bla
*/
/*!
\fn QskControl::setFixedSize( const QSizeF& );
bla
*/
/*!
\fn QskControl::setFixedSize( qreal width, qreal height );
bla
*/
/*!
\fn QskControl::setFixedWidth
bla
*/
/*!
\fn QskControl::setFixedHeight
bla
*/
/*!
\fn QskControl::setExplicitSizeHint( Qt::SizeHint, const QSizeF& );
bla
*/
/*!
\fn QskControl::setExplicitSizeHint( Qt::SizeHint, qreal width, qreal height );
bla
*/
/*!
\fn QskControl::resetExplicitSizeHint
bla
*/
/*!
\fn QskControl::minimumSize() const;
bla
*/
/*!
\fn QskControl::maximumSize() const;
bla
*/
/*!
\fn QskControl::preferredSize() const;
bla
*/
/*!
\fn QskControl::explicitSizeHint
bla
*/
/*!
\fn QskControl::implicitSizeHint
bla
*/
/*!
\fn QskControl::sizeHint
bla
*/
/*!
\fn QskControl::heightForWidth
bla
*/
/*!
\fn QskControl::widthForHeight
bla
*/
/*!
\fn QskControl::effectiveSizeHint
bla
*/
/*!
\fn QskControl::sizeConstraint( Qt::SizeHint, const QSizeF& ) const
bla
*/
/*!
\fn QskControl::sizeConstraint() const
bla
*/
/*!
\fn QskControl::locale() const
bla
*/
/*!
\fn QskControl::resetLocale
bla
*/
/*!
\fn QskControl::subControls
bla
*/
/*!
\fn void QskControl::backgroundChanged
bla
*/
/*!
\fn void QskControl::marginsChanged
bla
*/
/*!
\fn void QskControl::focusIndicatorRectChanged
bla
*/
/*!
\fn void QskControl::localeChanged
bla
*/
/*!
\fn void QskControl::focusPolicyChanged
bla
*/
/*!
\fn void QskControl::wheelEnabledChanged
bla
*/
/*!
\fn void QskControl::setLocale
bla
*/
/*!
\fn bool QskControl::event
bla
*/
/*!
\fn virtual void QskControl::gestureEvent
bla
*/
/*!
\fn void QskControl::hoverEnterEvent
bla
*/
/*!
\fn void QskControl::hoverLeaveEvent
bla
*/
/*!
\fn bool QskControl::childMouseEventFilter
bla
*/
/*!
\fn virtual bool QskControl::gestureFilter
bla
*/
/*!
\fn void QskControl::itemChange
bla
*/
/*!
\fn void QskControl::geometryChange
bla
*/
/*!
\fn void QskControl::initSizePolicy
bla
*/
/*!
\fn virtual void QskControl::updateResources
bla
*/
/*!
\fn virtual void QskControl::updateLayout
bla
*/
/*!
\fn virtual QSizeF QskControl::contentsSizeHint
bla
*/
/*!
\fn virtual QSizeF QskControl::layoutSizeHint
bla
*/

40
doc/classes/QskQuickItem.dox
View File

@ -16,6 +16,9 @@
QskQuickItem implements a couple of modifications, that
can be en/disabled individually.
\sa updateFlags(), resetUpdateFlags()
testUpdateFlag(), setUpdateFlag(), resetUpdateFlag()
\var QskQuickItem::UpdateFlag QskQuickItem::DeferredUpdate
Creating of scene graph nodes is blocked when being invisible.
@ -78,12 +81,10 @@
\note This flag is useful when analyzing layouts.
\sa updateFlags(), resetUpdateFlags()
testUpdateFlag(), setUpdateFlag(), resetUpdateFlag()
*/
/*!
\var QskQuickItem::geometry
\property QskQuickItem::geometry
This property holds the geometry of the item relative to its parent item.
When changing the geometry, the item receives a QskEvent::GeometryChange event.
@ -92,7 +93,7 @@
*/
/*!
\var QskQuickItem::rect
\property QskQuickItem::rect
This property returns the internal geometry of the item.
It equals QRect(0, 0, width(), height() ).
@ -111,7 +112,7 @@
*/
/*!
\var QskQuickItem::tabFence
\property QskQuickItem::tabFence
The tabFence flag can be used to create local tab focus chains. It is usually
used in combination with QQuickItem::ItemIsFocusScope.
@ -124,7 +125,7 @@
*/
/*!
\var QskQuickItem::visibleToParent
\property QskQuickItem::visibleToParent
Flag indicating if an item would become visible if its parentItem() is shown.
The implementation relies on the internal explicitVisible flag, that has not
@ -141,7 +142,7 @@
*/
/*!
\var QskQuickItem::polishOnResize
\property QskQuickItem::polishOnResize
When polishOnResize is set QQuickItem::polish() will be called automatically
whenever the size of the item has been changed. This is usually necessary
@ -152,7 +153,7 @@
*/
/*!
\var QskQuickItem::initiallyPainted
\property QskQuickItem::initiallyPainted
Status flag indicating that there has already been a call
of QQuickItem::updatePaintNode() since the item has become visible.
@ -164,7 +165,7 @@
*/
/*!
\var QskQuickItem::hasChildItems
\property QskQuickItem::hasChildItems
A property indicating if the item has child items.
@ -172,7 +173,7 @@
*/
/*!
\var QskQuickItem::updateFlags
\property QskQuickItem::updateFlags
QskQuickItem offers several tweaks to the Qt/Quick update cycle,
that can be en/disabled individually.
@ -230,7 +231,7 @@
*/
/*!
\fn QskQuickItem::hasChildItems() const
\fn QskQuickItem::hasChildItems
\return true, if the item has child items
\sa hasChildItems
@ -707,3 +708,20 @@
\saqt QQuickItem::setVisible()
*/
/*!
\fn QskQuickItem::mouseUngrabEvent
Notification, that is overloaded for debuging purposes, without
doing anything beside calling the base class.
\saqt QQuickItem::mouseUngrabEvent
*/
/*!
\fn QskQuickItem::touchUngrabEvent
Notification, that is overloaded for debuging purposes, without
doing anything beside calling the base class.
\saqt QQuickItem::touchUngrabEvent
*/