qskinny/doc/classes/QskSkinHintStatus.dox

73 lines
1.6 KiB
Plaintext
Raw Normal View History

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