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

tabs expanded

This commit is contained in:
Uwe Rathmann 2021-03-03 08:27:08 +01:00
parent 634fde4621
commit 899936d8f9
3 changed files with 352 additions and 352 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
doc/classes/QskSkinHintStatus.dox
View File

@ -1,12 +1,12 @@
/*! /*!
\class QskSkinHintStatus QskSkinnable.h \class QskSkinHintStatus QskSkinnable.h
\ingroup Framework \ingroup Framework
QskSkinHintStatus provides the information how a lookup for a skin hint had been QskSkinHintStatus provides the information how a lookup for a skin hint had been
resolved and where the value has been found. resolved and where the value has been found.
\sa QskSkinnable::effectiveSkinHint() \sa QskSkinnable::effectiveSkinHint()
*/ */
/*! /*!
@ -16,57 +16,57 @@
The lookup had failed to find a valid hint The lookup had failed to find a valid hint
\var QskSkinHintStatus::Skinnable \var QskSkinHintStatus::Skinnable
The hint has been found in the local table of the skinnable The hint has been found in the local table of the skinnable
\sa QskSkinnable::hintTable() \sa QskSkinnable::hintTable()
\var QskSkinHintStatus::Skin \var QskSkinHintStatus::Skin
The hint has been found in the table of the skin The hint has been found in the table of the skin
\sa QskSkinnable::effectiveSkin(), QskSkin::hintTable() \sa QskSkinnable::effectiveSkin(), QskSkin::hintTable()
\var QskSkinHintStatus::Animator \var QskSkinHintStatus::Animator
The hint has been taken from an animator, that is in the process The hint has been taken from an animator, that is in the process
of interpolating between values of different states of interpolating between values of different states
\sa QskHintAnimator, QskSkinnable::setSkinState() \sa QskHintAnimator, QskSkinnable::setSkinState()
*/ */
/*! /*!
\var QskSkinHintStatus::source \var QskSkinHintStatus::source
Source, where the hint has been found Source, where the hint has been found
\sa QskSkinHintStatus::Source \sa QskSkinHintStatus::Source
*/ */
/*! /*!
\var QskSkinHintStatus::aspect \var QskSkinHintStatus::aspect
Resolved aspect, that lead to a successful match in one of the Resolved aspect, that lead to a successful match in one of the
available sources available sources
\sa QskAspect \sa QskAspect
\note The resolved apsect usually differs from the aspect that has been \note The resolved apsect usually differs from the aspect that has been
passed as input parameter for QskSkinnable::effectiveSkinHint() passed as input parameter for QskSkinnable::effectiveSkinHint()
*/ */
/*! /*!
\fn QskSkinHintStatus::QskSkinHintStatus \fn QskSkinHintStatus::QskSkinHintStatus
Initializes the status to be invalid, by setting the source Initializes the status to be invalid, by setting the source
to QskSkinHintStatus::NoSource to QskSkinHintStatus::NoSource
\sa isValid() \sa isValid()
*/ */
/*! /*!
\fn QskSkinHintStatus::isValid \fn QskSkinHintStatus::isValid
\return True, when having a source > QskSkinHintStatus::NoSource \return True, when having a source > QskSkinHintStatus::NoSource
*/ */

384
doc/classes/QskSkinnable.dox
View File

@ -1,48 +1,48 @@
/*! /*!
\class QskSkinnable QskSkinnable.h \class QskSkinnable QskSkinnable.h
\ingroup Framework \ingroup Framework
QskSkinnable is the base for all objects, that can be configured by skin hints QskSkinnable is the base for all objects, that can be configured by skin hints
and are displayed by a skinlet. The configuration from the skin can be overwritten by and are displayed by a skinlet. The configuration from the skin can be overwritten by
adding values to the local skin hint table - it is even possible to replace the adding values to the local skin hint table - it is even possible to replace the
skinlet individually. skinlet individually.
In most cases a skinnable is a QskControl, but conceptually it is In most cases a skinnable is a QskControl, but conceptually it is
possible to have controls, that consist of many skinnables. possible to have controls, that consist of many skinnables.
\sa QskSkin, QskSkinlet, QskControl, QskSkinHintTable \sa QskSkin, QskSkinlet, QskControl, QskSkinHintTable
*/ */
/*! \fn QskSkinnable::QskSkinnable() /*! \fn QskSkinnable::QskSkinnable()
Constructs a skinnable where all settings will be resolved from the skin Constructs a skinnable where all settings will be resolved from the skin
\sa effectiveSkin(), effectiveSkinlet, effectiveSkinHint \sa effectiveSkin(), effectiveSkinlet, effectiveSkinHint
*/ */
/*! \fn QskSkinnable::~QskSkinnable() /*! \fn QskSkinnable::~QskSkinnable()
Called when the skinnable is destroyed. Called when the skinnable is destroyed.
*/ */
/*! /*!
\fn void QskSkinnable::setSkinlet \fn void QskSkinnable::setSkinlet
\brief Set an individual skinlet to render/display the content \brief Set an individual skinlet to render/display the content
Usually all skinnables of the same type are rendered by the same instance Usually all skinnables of the same type are rendered by the same instance
of a skinlet. For rare situations it can be useful to assign a different skinlet. of a skinlet. For rare situations it can be useful to assign a different skinlet.
When QskSkinlet::isOwnedBySkinnable() is true, the skinlet will be deleted, When QskSkinlet::isOwnedBySkinnable() is true, the skinlet will be deleted,
when the skinnable is deleted or a different skinlet gets assigned. when the skinnable is deleted or a different skinlet gets assigned.
\param skinlet Skinlet to render/layout the skinnable. \param skinlet Skinlet to render/layout the skinnable.
\sa skinlet(), effectiveSkinlet(), resetSkinlet(), \sa skinlet(), effectiveSkinlet(), resetSkinlet(),
QskSkin::declareSkinlet, QskSkinlet::isOwnedBySkinnable() QskSkin::declareSkinlet, QskSkinlet::isOwnedBySkinnable()
\note Overriding the skinlet that has been registered in the skin \note Overriding the skinlet that has been registered in the skin
breaks the themeability of the skinnable. breaks the themeability of the skinnable.
*/ */
@ -63,7 +63,7 @@
QskControl to perform some additional steps before calling updateNode(), QskControl to perform some additional steps before calling updateNode(),
and provides a consistent parent node which subclasses can rely on. and provides a consistent parent node which subclasses can rely on.
The default implementation simply forwards the operation to the skinlet, The default implementation simply forwards the operation to the skinlet,
\param parentNode The parent of the nodes to be added in this method. \param parentNode The parent of the nodes to be added in this method.
@ -71,56 +71,56 @@
strategy to implement custom painting is to customize or replace strategy to implement custom painting is to customize or replace
the skinlet. the skinlet.
\sa QskSkinlet::updateSubNode() \sa QskSkinlet::updateSubNode()
*/ */
/*! /*!
\fn QskSkinnable::effectiveSkinHint \fn QskSkinnable::effectiveSkinHint
\brief Find the value for a specific aspect \brief Find the value for a specific aspect
If an animation is running for the given aspect its value will If an animation is running for the given aspect its value will
be returned as hint. Then effectiveSkinHint() tries to find a hint be returned as hint. Then effectiveSkinHint() tries to find a hint
in the local table and finally tries to resolve the aspect from the in the local table and finally tries to resolve the aspect from the
hint table of the skin. hint table of the skin.
\param aspect Initial aspect, to feed the skin hint lookup algorithm. \param aspect Initial aspect, to feed the skin hint lookup algorithm.
\param status Optional status information \param status Optional status information
\return Hint value, or an invalid QVariant if no value was found \return Hint value, or an invalid QVariant if no value was found
\sa effectiveSubcontrol(), effectivePlacement() \sa effectiveSubcontrol(), effectivePlacement()
*/ */
/*! \fn QskSkinnable::effectiveFont /*! \fn QskSkinnable::effectiveFont
Finds the font role for the given aspect and returns Finds the font role for the given aspect and returns
the corresponding font from the font table of the skin. the corresponding font from the font table of the skin.
\param aspect Unresolved aspect \param aspect Unresolved aspect
\return Font, corresponding to the resolved aspect \return Font, corresponding to the resolved aspect
\sa fontRoleHint(), effectiveSkinHint(), QskSkin::font() \sa fontRoleHint(), effectiveSkinHint(), QskSkin::font()
*/ */
/*! \fn QskSkinnable::effectiveGraphicFilter /*! \fn QskSkinnable::effectiveGraphicFilter
Finds the graphic role for the given aspect and returns Finds the graphic role for the given aspect and returns
the corresponding color filter from the skin the corresponding color filter from the skin
\param aspect Unresolved aspect \param aspect Unresolved aspect
\return Color filter, corresponding to the resolved aspect \return Color filter, corresponding to the resolved aspect
\sa graphicRoleHint(), effectiveSkinHint(), QskSkin::graphicFilter() \sa graphicRoleHint(), effectiveSkinHint(), QskSkin::graphicFilter()
*/ */
/*! \fn QskSkinnable::setAnimationHint /*! \fn QskSkinnable::setAnimationHint
Insert an animation hint into the local hint table Insert an animation hint into the local hint table
\param aspect Unresolved aspect \param aspect Unresolved aspect
\param hint Animation hint \param hint Animation hint
\sa animationHint(), effectiveAnimation() \sa animationHint(), effectiveAnimation()
*/ */
/*! \fn QskSkinnable::animationHint /*! \fn QskSkinnable::animationHint
@ -128,112 +128,112 @@
/*! \fn QskSkinnable::effectiveAnimation /*! \fn QskSkinnable::effectiveAnimation
Retrieve the configuration of the animator for reaching Retrieve the configuration of the animator for reaching
a specific state. a specific state.
\param type Metric, color or something else \param type Metric, color or something else
\param subControl Unsubstituted subControl \param subControl Unsubstituted subControl
\param state State bits \param state State bits
\param status If status != nullptr additional information \param status If status != nullptr additional information
about where the hint has been found is returned about where the hint has been found is returned
\return Value from the hint tables \return Value from the hint tables
\sa animationHint() \sa animationHint()
*/ */
/*! \fn QskSkinnable::setSkinHint /*! \fn QskSkinnable::setSkinHint
\brief Insert a hint into the local hint table \brief Insert a hint into the local hint table
Presentation, beheviour and layout of the scene graph nodes are Presentation, beheviour and layout of the scene graph nodes are
affected by specific attributes - skin hints - that are configured affected by specific attributes - skin hints - that are configured
in a table of the skin. Each skinnable has its own table in a table of the skin. Each skinnable has its own table
where these attributes can be overloaded. Hints from the local where these attributes can be overloaded. Hints from the local
table have precedence over those from the skin. table have precedence over those from the skin.
The subControl bits of the aspect might be substituted, depending on The subControl bits of the aspect might be substituted, depending on
the implementation of effectiveSubcontrol(). By inserting the hint the implementation of effectiveSubcontrol(). By inserting the hint
directly into the hintTable() the substitution can be avoided. directly into the hintTable() the substitution can be avoided.
\param aspect Unsubstituted aspect \param aspect Unsubstituted aspect
\param hint Hint, might be anything that fits into a QVariant \param hint Hint, might be anything that fits into a QVariant
and is understood by the skinlet consuming it. and is understood by the skinlet consuming it.
\sa effectiveSkinHint(), resetSkinHint(), hintTable(), QskSkinHintTableEditor() \sa effectiveSkinHint(), resetSkinHint(), hintTable(), QskSkinHintTableEditor()
*/ */
/*! \fn QskSkinnable::resetSkinHint /*! \fn QskSkinnable::resetSkinHint
\brief Remove a hint from the local hint table \brief Remove a hint from the local hint table
After removing the hint from the local table the hint will After removing the hint from the local table the hint will
be resolved fro the hint table of the skin. be resolved fro the hint table of the skin.
\param aspect Unsubstituted aspect \param aspect Unsubstituted aspect
\sa setSkinHint(), effectiveSkinHint() \sa setSkinHint(), effectiveSkinHint()
*/ */
/*! \fn QskSkinnable::effectivePlacement /*! \fn QskSkinnable::effectivePlacement
The placements bits are added to an unresolved aspect when The placements bits are added to an unresolved aspect when
inserting or looking up values in the hint table. inserting or looking up values in the hint table.
\return The default implementation returns QskAspect::NoPlacement; \return The default implementation returns QskAspect::NoPlacement;
\sa QskAspect::Placement, effectiveSkinHint() \sa QskAspect::Placement, effectiveSkinHint()
*/ */
/*! \fn QskSkinnable::hintStatus /*! \fn QskSkinnable::hintStatus
\param aspect Unresolved aspect \param aspect Unresolved aspect
\return Informations about how the aspect would be resolved \return Informations about how the aspect would be resolved
\sa effectiveSkinHint() \sa effectiveSkinHint()
*/ */
/*! \fn QskSkinnable::setSkinState /*! \fn QskSkinnable::setSkinState
Set the state bits of the skinnable Set the state bits of the skinnable
Depending on the state a skinnable might have different hints affecting Depending on the state a skinnable might have different hints affecting
its representation and/or behaviour. its representation and/or behaviour.
\param newState State bits \param newState State bits
\param animated If true, animators, that have been defined in the skin \param animated If true, animators, that have been defined in the skin
for newState will be started for newState will be started
\sa QskAspect \sa QskAspect
*/ */
/*! \fn QskSkinnable::setSkinStateFlag /*! \fn QskSkinnable::setSkinStateFlag
Set/Clear a state in the state bits Set/Clear a state in the state bits
\param stateFlag State bit \param stateFlag State bit
\param on true or false \param on true or false
\sa setSkinState(), skinState() \sa setSkinState(), skinState()
*/ */
/*! \fn QskSkinnable::skinState /*! \fn QskSkinnable::skinState
The state bits are added to an unresolved aspect when The state bits are added to an unresolved aspect when
inserting or looking up values in the hint table. inserting or looking up values in the hint table.
\return Current state \return Current state
\sa setSkinStateFlag(), setSkinState() \sa setSkinStateFlag(), setSkinState()
*/ */
/*! \fn QskSkinnable::skinStateAsPrintable() const /*! \fn QskSkinnable::skinStateAsPrintable() const
\return Current state as printable for debugging purposes \return Current state as printable for debugging purposes
\sa skinStateAsPrintable( QskAspect::State ) const \sa skinStateAsPrintable( QskAspect::State ) const
*/ */
/*! \fn QskSkinnable::skinStateAsPrintable( QskAspect::State ) const /*! \fn QskSkinnable::skinStateAsPrintable( QskAspect::State ) const
\param state State bits \param state State bits
\return state as printable for debugging purposes \return state as printable for debugging purposes
\note A pointer to an internal buffer is returned, that might be \note A pointer to an internal buffer is returned, that might be
@ -242,66 +242,66 @@
/*! \fn QskSkinnable::subControlRect /*! \fn QskSkinnable::subControlRect
\brief Calculate position and size of a subControl \brief Calculate position and size of a subControl
A convenience method that forwards the calculation to the skinlet A convenience method that forwards the calculation to the skinlet
\param contentsRect Bounding rectangle for laying out the nodes of the skinnable \param contentsRect Bounding rectangle for laying out the nodes of the skinnable
\param subControl Unsubstituted subcontrol \param subControl Unsubstituted subcontrol
\return Geometry for the subControl \return Geometry for the subControl
\sa effectiveSkinlet(), QskSkinlet::subControlRect(), QskControl::contentsRect() \sa effectiveSkinlet(), QskSkinlet::subControlRect(), QskControl::contentsRect()
*/ */
/*! \fn QskSkinnable::subControlContentsRect /*! \fn QskSkinnable::subControlContentsRect
\brief Calculate the inner rectangle subControl \brief Calculate the inner rectangle subControl
The inner rectangle a subcontrol is its geometry with paddings, indentations The inner rectangle a subcontrol is its geometry with paddings, indentations
being subtracted. F.e. the inner rectangle of QskPushButton::Panel is the being subtracted. F.e. the inner rectangle of QskPushButton::Panel is the
bounding rectangle for laying out the QskPushButton::Text and bounding rectangle for laying out the QskPushButton::Text and
QskPushButton::Graphic subcontrols. QskPushButton::Graphic subcontrols.
\param contentsRect Bounding rectangle for laying out the nodes of the skinnable \param contentsRect Bounding rectangle for laying out the nodes of the skinnable
\param subControl Unsubstituted subcontrol \param subControl Unsubstituted subcontrol
\return Geometry for contents inside the subControl \return Geometry for contents inside the subControl
\sa QskSkinlet::subControlRect(), innerBox() \sa QskSkinlet::subControlRect(), innerBox()
*/ */
/*! \fn QskSkinnable::outerBoxSize /*! \fn QskSkinnable::outerBoxSize
\brief Calculate the size, when being expanded by paddings, indentations \brief Calculate the size, when being expanded by paddings, indentations
Paddings, indentations depend on attributes for the given aspect. Paddings, indentations depend on attributes for the given aspect.
\param aspect Unresolved aspect \param aspect Unresolved aspect
\param innerBoxSize Size to be expanded \param innerBoxSize Size to be expanded
\return Expanded size \return Expanded size
The size hint for a "container" node usually depend on the hints of its The size hint for a "container" node usually depend on the hints of its
inner nodes. F.e the size hint for QskPushButton::Panel depends on the size hints of inner nodes. F.e the size hint for QskPushButton::Panel depends on the size hints of
QskPushButton::Text and QskPushButton::Graphic. QskPushButton::Text and QskPushButton::Graphic.
\sa innerBoxSize(), outerBox(), innerBox() \sa innerBoxSize(), outerBox(), innerBox()
*/ */
/*! \fn QskSkinnable::innerBoxSize /*! \fn QskSkinnable::innerBoxSize
\brief Calculate the size, with paddings, indentations being subtracted \brief Calculate the size, with paddings, indentations being subtracted
Paddings, indentations depend on attributes for the given aspect. Paddings, indentations depend on attributes for the given aspect.
\param aspect Unresolved aspect \param aspect Unresolved aspect
\param outerBoxSize Size to be shrunk \param outerBoxSize Size to be shrunk
\return Shrunk size \return Shrunk size
\sa outerBoxSize(), innerBox(), outerBox() \sa outerBoxSize(), innerBox(), outerBox()
*/ */
/*! \fn QskSkinnable::innerBox /*! \fn QskSkinnable::innerBox
\brief Calculate the rectangle, whith paddings, indentations being subtracted \brief Calculate the rectangle, whith paddings, indentations being subtracted
Paddings, indentations depend on attributes for the given aspect. Paddings, indentations depend on attributes for the given aspect.
@ -331,49 +331,49 @@
/*! \fn QskSkinnable::innerPadding /*! \fn QskSkinnable::innerPadding
\brief Calculate the padding from attributes for the given aspect \brief Calculate the padding from attributes for the given aspect
Beside padding hints, the radii of the shape might have an effect Beside padding hints, the radii of the shape might have an effect
\param aspect Unresolved aspect \param aspect Unresolved aspect
\param outerBoxSize Size of the box \param outerBoxSize Size of the box
\return Effective padding \return Effective padding
*/ */
/*! \fn QskSkinnable::effectiveSkinlet /*! \fn QskSkinnable::effectiveSkinlet
\return Skinlet that has been set with setSkinlet() - or the default \return Skinlet that has been set with setSkinlet() - or the default
skinlet from the skin, that had been registered for metaObject() skinlet from the skin, that had been registered for metaObject()
*/ */
/*! \fn QskSkinnable::effectiveSkin /*! \fn QskSkinnable::effectiveSkin
\return Almost always the current skin. The only exception is when manually \return Almost always the current skin. The only exception is when manually
setting a skinlet being created from a different skin. setting a skinlet being created from a different skin.
\sa QskSetup::skin(), QskSkinlet::skin() \sa QskSetup::skin(), QskSkinlet::skin()
*/ */
/*! \fn QskSkinnable::startTransition /*! \fn QskSkinnable::startTransition
Start a transition for a specific aspect, that interpolates Start a transition for a specific aspect, that interpolates
between 2 values. While the transition is in process a look up for between 2 values. While the transition is in process a look up for
the aspect will return the current value of the interpolation. the aspect will return the current value of the interpolation.
In most cases startTransition() is called automatically, when In most cases startTransition() is called automatically, when
the skinState() changes and am animation is found for the new the skinState() changes and am animation is found for the new
state. state.
\param aspect Unresolved aspect, only subcontrol substitution will be done \param aspect Unresolved aspect, only subcontrol substitution will be done
\param from Start value of the transition \param from Start value of the transition
\sa effectiveAnimation() \sa effectiveAnimation()
*/ */
/*! \fn QskSkinnable::effectiveSubcontrol /*! \fn QskSkinnable::effectiveSubcontrol
Subcontrol substitution is a mechanism, that is used when a variation of Subcontrol substitution is a mechanism, that is used when a variation of
an existing control needs to have skin hints, that can be configured an existing control needs to have skin hints, that can be configured
individually without having to reimplement a new skinlet. individually without having to reimplement a new skinlet.
@ -382,28 +382,28 @@
QskPushButton::Panel subcontrol gets substituted by a new subcontrol that QskPushButton::Panel subcontrol gets substituted by a new subcontrol that
is defined for the tool button. is defined for the tool button.
Subcontrol substitution is part of a concept that is known as Subcontrol substitution is part of a concept that is known as
\ref aspect resolving "aspect resolving". \ref aspect resolving "aspect resolving".
\param subControl Subcontrol \param subControl Subcontrol
\return Substituted subcontrol \return Substituted subcontrol
The default implementation is a no operation and does not substitute The default implementation is a no operation and does not substitute
*/ */
/*! \fn QskSkinnable::controlCast() /*! \fn QskSkinnable::controlCast()
Safe casting of the skinnable to a QskControl Safe casting of the skinnable to a QskControl
The operation is based on comparing metaObject() The operation is based on comparing metaObject()
with QskControl::staticMetaObject() ( similar to what qobject_cast() does ) with QskControl::staticMetaObject() ( similar to what qobject_cast() does )
\return Control if successful, or a nullptr otherwise \return Control if successful, or a nullptr otherwise
*/ */
/*! \fn QskSkinnable::controlCast() const /*! \fn QskSkinnable::controlCast() const
Safe casting of the skinnable to a QskControl Safe casting of the skinnable to a QskControl
The operation is based on comparing metaObject() The operation is based on comparing metaObject()
with QskControl::staticMetaObject() ( similar to what qobject_cast() does ) with QskControl::staticMetaObject() ( similar to what qobject_cast() does )
@ -413,31 +413,31 @@
/*! \fn QskSkinnable::owningControl /*! \fn QskSkinnable::owningControl
In most cases a skinnable is one of the base classes of QskControl and In most cases a skinnable is one of the base classes of QskControl and
the owning control is the derived control. But in case of a control, that the owning control is the derived control. But in case of a control, that
is built from several skinnables this pure virtual method needs to be implemented. is built from several skinnables this pure virtual method needs to be implemented.
\return QskControl, that is owner of the skinnable. In most \return QskControl, that is owner of the skinnable. In most
cases the skinnable is inherited cases the skinnable is inherited
*/ */
/*! \fn QskSkinnable::metaObject /*! \fn QskSkinnable::metaObject
\return Usually the metaObject of the owning control \return Usually the metaObject of the owning control
\sa owningControl() \sa owningControl()
*/ */
/*! \fn QskSkinnable::debug( QskAspect ) const /*! \fn QskSkinnable::debug( QskAspect ) const
Writes an aspect to qDebug() using the string conversions for metaObject() Writes an aspect to qDebug() using the string conversions for metaObject()
\param aspect Aspect to be printed \param aspect Aspect to be printed
\sa qskDebugAspect() \sa qskDebugAspect()
*/ */
/*! \fn QskSkinnable::debug( QskAspect::State ) const /*! \fn QskSkinnable::debug( QskAspect::State ) const
Writes a state to qDebug() using the string conversions for metaObject() Writes a state to qDebug() using the string conversions for metaObject()
\param state State to be printed \param state State to be printed
\sa qskDebugState() \sa qskDebugState()
@ -465,70 +465,70 @@
/*! \fn QskSkinnable::setColor( QskAspect, Qt::GlobalColor ) /*! \fn QskSkinnable::setColor( QskAspect, Qt::GlobalColor )
\brief Sets a color hint. \brief Sets a color hint.
QskAspect::Color will be added to aspect. QskAspect::Color will be added to aspect.
\param aspect Unresolved aspect \param aspect Unresolved aspect
\param color Color hint \param color Color hint
\sa setSkinHint(), QskAspect::Color \sa setSkinHint(), QskAspect::Color
*/ */
/*! \fn QskSkinnable::setColor( QskAspect, QRgb ) /*! \fn QskSkinnable::setColor( QskAspect, QRgb )
\brief Sets a color hint. \brief Sets a color hint.
QskAspect::Color will be added to aspect. QskAspect::Color will be added to aspect.
\param aspect Unresolved aspect \param aspect Unresolved aspect
\param rgb Color hint \param rgb Color hint
\sa setSkinHint(), QskAspect::Color \sa setSkinHint(), QskAspect::Color
*/ */
/*! \fn QskSkinnable::setColor( QskAspect, const QColor& ) /*! \fn QskSkinnable::setColor( QskAspect, const QColor& )
\brief Sets a color hint. \brief Sets a color hint.
QskAspect::Color will be added to aspect. QskAspect::Color will be added to aspect.
\param aspect Unresolved aspect \param aspect Unresolved aspect
\param color Color hint \param color Color hint
\sa setSkinHint(), QskAspect::Color \sa setSkinHint(), QskAspect::Color
*/ */
/*! \fn QskSkinnable::resetColor /*! \fn QskSkinnable::resetColor
\brief Removes a color hint from the local table \brief Removes a color hint from the local table
QskAspect::Color will be added to aspect. QskAspect::Color will be added to aspect.
\param aspect Unresolved aspect \param aspect Unresolved aspect
\return true, if an entry in the local hint table was found and removed. \return true, if an entry in the local hint table was found and removed.
\sa resetSkinHint(), setColor() \sa resetSkinHint(), setColor()
*/ */
/*! \fn QskSkinnable::color /*! \fn QskSkinnable::color
\brief Retrieves a color hint \brief Retrieves a color hint
QskAspect::Color will be added to aspect. QskAspect::Color will be added to aspect.
\param aspect Unresolved aspect \param aspect Unresolved aspect
\param status Optional status information \param status Optional status information
\return Color hint, or QColor() if no value has been found \return Color hint, or QColor() if no value has been found
\sa effectiveSkinHint(), setColor() \sa effectiveSkinHint(), setColor()
*/ */
/*! \fn QskSkinnable::setMetric /*! \fn QskSkinnable::setMetric
\brief Sets a metric hint \brief Sets a metric hint
QskAspect::Metric will be added to aspect. QskAspect::Metric will be added to aspect.
\param aspect Unresolved aspect \param aspect Unresolved aspect
\param metric Metric hint \param metric Metric hint
@ -538,7 +538,7 @@
/*! \fn QskSkinnable::resetMetric /*! \fn QskSkinnable::resetMetric
\brief Removes a metric hint from the local table \brief Removes a metric hint from the local table
QskAspect::Metric will be added to aspect. QskAspect::Metric will be added to aspect.
@ -555,9 +555,9 @@
QskAspect::Metric will be added to aspect. QskAspect::Metric will be added to aspect.
\param aspect Unresolved aspect \param aspect Unresolved aspect
\param status Optional status information \param status Optional status information
\return Metric, or 0 if no value was found \return Metric, or 0 if no value was found
\sa effectiveSkinHint(), setMetric() \sa effectiveSkinHint(), setMetric()
*/ */
@ -587,8 +587,8 @@
\brief Retrieves a flag hint \brief Retrieves a flag hint
\param aspect Unresolved aspect \param aspect Unresolved aspect
\param status Optional status information \param status Optional status information
\return Flag, or an invalid QVariant in case no value was found \return Flag, or an invalid QVariant in case no value was found
\sa effectiveSkinHint(), setFlag() \sa effectiveSkinHint(), setFlag()
*/ */
@ -670,7 +670,7 @@
/*! \fn QskSkinnable::setMarginHint( QskAspect, const QMarginsF& ) /*! \fn QskSkinnable::setMarginHint( QskAspect, const QMarginsF& )
\brief Sets a margin hint \brief Sets a margin hint
QskAspect::Metric | QskAspect::Margin will be added to aspect. QskAspect::Metric | QskAspect::Margin will be added to aspect.
@ -707,7 +707,7 @@
/*! \fn QskSkinnable::setPaddingHint( QskAspect, qreal ) /*! \fn QskSkinnable::setPaddingHint( QskAspect, qreal )
\brief Sets a padding hint \brief Sets a padding hint
QskAspect::Metric | QskAspect::Padding will be added to aspect. QskAspect::Metric | QskAspect::Padding will be added to aspect.
@ -719,7 +719,7 @@
/*! \fn QskSkinnable::setPaddingHint( QskAspect, const QMarginsF& ) /*! \fn QskSkinnable::setPaddingHint( QskAspect, const QMarginsF& )
\brief Sets a padding hint \brief Sets a padding hint
QskAspect::Metric | QskAspect::Padding will be added to aspect. QskAspect::Metric | QskAspect::Padding will be added to aspect.
@ -743,7 +743,7 @@
/*! \fn QskSkinnable::paddingHint /*! \fn QskSkinnable::paddingHint
\brief Retrieves a padding hint \brief Retrieves a padding hint
QskAspect::Metric | QskAspect::Padding will be added to aspect. QskAspect::Metric | QskAspect::Padding will be added to aspect.
@ -768,7 +768,7 @@
/*! \fn QskSkinnable::gradientHint /*! \fn QskSkinnable::gradientHint
\brief Retrieves a color hint as gradient \brief Retrieves a color hint as gradient
QskAspect::Color will be added to aspect. QskAspect::Color will be added to aspect.
@ -879,7 +879,7 @@
/*! \fn QskSkinnable::boxBorderColorsHint /*! \fn QskSkinnable::boxBorderColorsHint
\brief Retrieves border colors hint \brief Retrieves border colors hint
QskAspect::Color | QskAspect::Border will be added to aspect. QskAspect::Color | QskAspect::Border will be added to aspect.
@ -954,7 +954,7 @@
/*! \fn QskSkinnable::alignmentHint /*! \fn QskSkinnable::alignmentHint
\brief Retrieves an alignment hint \brief Retrieves an alignment hint
QskAspect::Flag | QskAspect::Alignment will be added to aspect. QskAspect::Flag | QskAspect::Alignment will be added to aspect.
@ -1016,7 +1016,7 @@
/*! \fn QskSkinnable::resetGraphicRoleHint /*! \fn QskSkinnable::resetGraphicRoleHint
\brief Removes a graphic role hint from the local table \brief Removes a graphic role hint from the local table
QskAspect::Flag | QskAspect::GraphicRole will be added to aspect. QskAspect::Flag | QskAspect::GraphicRole will be added to aspect.
@ -1041,25 +1041,25 @@
/*! \fn QskSkinnable::isTransitionAccepted /*! \fn QskSkinnable::isTransitionAccepted
\brief Additional check if an transition should be started \brief Additional check if an transition should be started
In certain situations a transition initiated from state depending hints In certain situations a transition initiated from state depending hints
needs to be avoided. needs to be avoided.
\param aspect Aspect \param aspect Aspect
\return true, when owningControl()->isInitiallyPainted() is true \return true, when owningControl()->isInitiallyPainted() is true
*/ */
/*! \fn QskSkinnable::hintTable() /*! \fn QskSkinnable::hintTable()
\brief Accessor for local skin hint table \brief Accessor for local skin hint table
Definitions in the local hint table have precedence over those from Definitions in the local hint table have precedence over those from
the table of the skin. Initially the local table is empty. the table of the skin. Initially the local table is empty.
\return Reference to the local hint table \return Reference to the local hint table
\sa setSkinHint(), QskSkinHintTableEditor \sa setSkinHint(), QskSkinHintTableEditor
*/ */
/*! \fn QskSkinnable::hintTable() const /*! \fn QskSkinnable::hintTable() const

268
doc/qskmodules.dox
View File

@ -1,179 +1,179 @@
/*! /*!
\defgroup Core Core \defgroup Core Core
\{ \{
\namespace QskNamespace \namespace QskNamespace
\class QskCorner \class QskCorner
\class QskGradient \class QskGradient
\class QskIntervalF \class QskIntervalF
\class QskMargins \class QskMargins
\class QskMetaFunction \class QskMetaFunction
\class QskMetaInvokable \class QskMetaInvokable
\class QskObjectCounter \class QskObjectCounter
\class QskRgbPalette \class QskRgbPalette
\class QskRgbValue \class QskRgbValue
\class QskScaleEngine \class QskScaleEngine
\class QskScaleTickmarks \class QskScaleTickmarks
\class QskSizePolicy \class QskSizePolicy
\} \}
\defgroup Graphic Graphic \defgroup Graphic Graphic
\{ \{
\class QskColorFilter \class QskColorFilter
\class QskGraphic \class QskGraphic
\class QskGraphicImageProvider \class QskGraphicImageProvider
\class QskGraphicIO \class QskGraphicIO
\class QskGraphicPaintEngine \class QskGraphicPaintEngine
\class QskGraphicProvider \class QskGraphicProvider
\class QskGraphicProviderMap \class QskGraphicProviderMap
\class QskGraphicTextureFactory \class QskGraphicTextureFactory
\class QskPainterCommand \class QskPainterCommand
\class QskStandardSymbol \class QskStandardSymbol
\} \}
\defgroup Framework Framework \defgroup Framework Framework
\{ \{
\class QskControl \class QskControl
\class QskEvent \class QskEvent
\class QskGesture \class QskGesture
\class QskGestureRecognizer \class QskGestureRecognizer
\class QskPanGestureRecognizer \class QskPanGestureRecognizer
\class QskQuick \class QskQuick
\class QskSetup \class QskSetup
\class QskShortcutMap \class QskShortcutMap
\class QskWindow \class QskWindow
\} \}
\defgroup Animation Animation \defgroup Animation Animation
\{ \{
\class QskAnimator \class QskAnimator
\class QskAnimationHint \class QskAnimationHint
\class QskFlickAnimator \class QskFlickAnimator
\class QskVariantAnimator \class QskVariantAnimator
\} \}
\defgroup Themeing Themeing \defgroup Themeing Themeing
\{ \{
\class QskBoxBorderColors \class QskBoxBorderColors
\class QskBoxBorderMetrics \class QskBoxBorderMetrics
\class QskBoxShapeMetrics \class QskBoxShapeMetrics
\class QskShadowMetrics \class QskShadowMetrics
\class QskSkinFactory \class QskSkinFactory
\class QskSkin \class QskSkin
\class QskSkinHintTable \class QskSkinHintTable
\class QskSkinlet \class QskSkinlet
\class QskSkinManager \class QskSkinManager
\class QskSkinnable \class QskSkinnable
\class QskSkinTransition \class QskSkinTransition
\class QskTextColors \class QskTextColors
\class QskTextOptions \class QskTextOptions
\} \}
\defgroup Controls Controls \defgroup Controls Controls
\{ \{
\class QskAbstractButton \class QskAbstractButton
\class QskBoundedControl \class QskBoundedControl
\class QskBoundedInput \class QskBoundedInput
\class QskBoundedRangeInput \class QskBoundedRangeInput
\class QskBoundedValueInput \class QskBoundedValueInput
\class QskBox \class QskBox
\class QskFocusIndicator \class QskFocusIndicator
\class QskGraphicLabel \class QskGraphicLabel
\class QskHintAnimator \class QskHintAnimator
\class QskInputGrabber \class QskInputGrabber
\class QskListView \class QskListView
\class QskPageIndicator \class QskPageIndicator
\class QskPopup \class QskPopup
\class QskProgressBar \class QskProgressBar
\class QskPushButton \class QskPushButton
\class QskScrollBox \class QskScrollBox
\class QskScrollView \class QskScrollView
\class QskSeparator \class QskSeparator
\class QskSimpleListBox \class QskSimpleListBox
\class QskSlider \class QskSlider
\class QskStatusIndicator \class QskStatusIndicator
\class QskTabButton \class QskTabButton
\class QskTextInput \class QskTextInput
\class QskTextLabel \class QskTextLabel
\} \}
\defgroup container Container \defgroup container Container
\{ \{
\class QskScrollArea \class QskScrollArea
\class QskSubWindowArea \class QskSubWindowArea
\class QskSubWindow \class QskSubWindow
\class QskTabBar \class QskTabBar
\class QskTabView \class QskTabView
\class QskGridBox \class QskGridBox
\class QskIndexedLayoutBox \class QskIndexedLayoutBox
\class QskLinearBox \class QskLinearBox
\class QskStackBox \class QskStackBox
\} \}
\defgroup Layouts Layouts \defgroup Layouts Layouts
\{ \{
\class QskGridLayoutEngine \class QskGridLayoutEngine
\class QskIndexedLayoutBox \class QskIndexedLayoutBox
\class QskLayoutChain \class QskLayoutChain
\class QskLayoutEngine2D \class QskLayoutEngine2D
\class QskLayoutHint \class QskLayoutHint
\class QskLinearLayoutEngine \class QskLinearLayoutEngine
\} \}
\defgroup Dialogs Dialogs \defgroup Dialogs Dialogs
\{ \{
\class QskDialogButtonBox \class QskDialogButtonBox
\class QskDialogButton \class QskDialogButton
\class QskDialog \class QskDialog
\class QskDialogSubWindow \class QskDialogSubWindow
\class QskDialogWindow \class QskDialogWindow
\class QskMessageSubWindow \class QskMessageSubWindow
\class QskMessageWindow \class QskMessageWindow
\class QskSelectionSubWindow \class QskSelectionSubWindow
\class QskSelectionWindow \class QskSelectionWindow
\class QskSimpleListBox \class QskSimpleListBox
\} \}
\defgroup Skinlets Skinlets \defgroup Skinlets Skinlets
\{ \{
\class QskBoxSkinlet \class QskBoxSkinlet
\class QskFocusIndicatorSkinlet \class QskFocusIndicatorSkinlet
\class QskGraphicLabelSkinlet \class QskGraphicLabelSkinlet
\class QskListViewSkinlet \class QskListViewSkinlet
\class QskPageIndicatorSkinlet \class QskPageIndicatorSkinlet
\class QskPopupSkinlet \class QskPopupSkinlet
\class QskPushButtonSkinlet \class QskPushButtonSkinlet
\class QskScrollViewSkinlet \class QskScrollViewSkinlet
\class QskSeparatorSkinlet \class QskSeparatorSkinlet
\class QskSliderSkinlet \class QskSliderSkinlet
\class QskStatusIndicatorSkinlet \class QskStatusIndicatorSkinlet
\class QskSubWindowAreaSkinlet \class QskSubWindowAreaSkinlet
\class QskSubWindowSkinlet \class QskSubWindowSkinlet
\class QskTabButtonSkinlet \class QskTabButtonSkinlet
\class QskTabViewSkinlet \class QskTabViewSkinlet
\class QskTextInputSkinlet \class QskTextInputSkinlet
\class QskTextLabelSkinlet \class QskTextLabelSkinlet
\class QskStandardSymbol \class QskStandardSymbol
\} \}
\defgroup Scenegraph Scenegraph \defgroup Scenegraph Scenegraph
\{ \{
\class QskBoxClipNode \class QskBoxClipNode
\class QskBoxNode \class QskBoxNode
\class QskBoxRendererColorMap \class QskBoxRendererColorMap
\class QskBoxRenderer \class QskBoxRenderer
\class QskGraphicNode \class QskGraphicNode
\class QskPaintedNode \class QskPaintedNode
\class QskPlainTextRenderer \class QskPlainTextRenderer
\class QskRichTextRenderer \class QskRichTextRenderer
\class QskScaleRenderer \class QskScaleRenderer
\class QskSGNode \class QskSGNode
\class QskTextNode \class QskTextNode
\class QskTextRenderer \class QskTextRenderer
\class QskTextureNode \class QskTextureNode
\class QskTextureRenderer \class QskTextureRenderer
\class QskTickmarksNode \class QskTickmarksNode
\class QskVertex \class QskVertex
\} \}
*/ */