doxygen docs
This commit is contained in:
parent
81bcc64637
commit
bf6409b3a8
@ -275,33 +275,101 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/*! \fn QskSkinnable::debug( QskAspect ) const
|
/*! \fn QskSkinnable::debug( QskAspect ) const
|
||||||
|
|
||||||
|
Writes an aspect to qDebug() using the string conversions for metaObject()
|
||||||
|
|
||||||
|
\param aspect Aspect to be printed
|
||||||
|
\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()
|
||||||
|
|
||||||
|
\param state State to be printed
|
||||||
|
\sa qskDebugState()
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*! \fn QskSkinnable::debug( QDebug, QskAspect ) const
|
/*! \fn QskSkinnable::debug( QDebug, QskAspect ) const
|
||||||
|
|
||||||
|
Writes an aspect to a stream using the string conversions for metaObject()
|
||||||
|
|
||||||
|
\param debug Debug stream
|
||||||
|
\param aspect Aspect to be printed
|
||||||
|
|
||||||
|
\sa qskDebugAspect()
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*! \fn QskSkinnable::debug( QDebug, QskAspect::State ) const
|
/*! \fn QskSkinnable::debug( QDebug, QskAspect::State ) const
|
||||||
|
|
||||||
|
Writes a state to a stream using the string conversions for metaObject()
|
||||||
|
|
||||||
|
\param debug Debug stream
|
||||||
|
\param state State to be printed
|
||||||
|
|
||||||
|
\sa qskDebugState()
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*! \fn QskSkinnable::setSkinState
|
/*! \fn QskSkinnable::setSkinState
|
||||||
|
|
||||||
|
Set the state bits of the skinnable
|
||||||
|
|
||||||
|
Depending on the state a skinnable might have different hints affecting
|
||||||
|
its representation and/or behaviour.
|
||||||
|
|
||||||
|
\param newState State bits
|
||||||
|
\param animated If true, animators, that have been defined in the skin
|
||||||
|
for newState will be started
|
||||||
|
|
||||||
|
\sa QskAspect
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*! \fn QskSkinnable::setSkinStateFlag
|
/*! \fn QskSkinnable::setSkinStateFlag
|
||||||
|
|
||||||
|
Set/Clear a state in the state bits
|
||||||
|
|
||||||
|
\param stateFlag State bit
|
||||||
|
\param on true or false
|
||||||
|
|
||||||
|
\sa setSkinState(), skinState()
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*! \fn QskSkinnable::setColor( QskAspect, Qt::GlobalColor )
|
/*! \fn QskSkinnable::setColor( QskAspect, Qt::GlobalColor )
|
||||||
|
|
||||||
|
\code setSkinHint( aspect | QskAspect::Color, QVariant::fromValue( QColor( color ) ) ); \endcode
|
||||||
|
|
||||||
|
\param aspect Unresolved aspect
|
||||||
|
\param color Color hint
|
||||||
|
|
||||||
|
\sa setSkinHint()
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*! \fn QskSkinnable::setColor( QskAspect, QRgb )
|
/*! \fn QskSkinnable::setColor( QskAspect, QRgb )
|
||||||
|
|
||||||
|
\code setSkinHint( aspect | QskAspect::Color, QVariant::fromValue( QColor::fromRgba( rgb ) ) ); \endcode
|
||||||
|
|
||||||
|
\param aspect Unresolved aspect
|
||||||
|
\param rgb Color hint
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*! \fn QskSkinnable::setColor( QskAspect, const QColor& )
|
/*! \fn QskSkinnable::setColor( QskAspect, const QColor& )
|
||||||
|
|
||||||
|
\code setSkinHint( aspect | QskAspect::Color, QVariant::fromValue( color ) ); \endcode
|
||||||
|
|
||||||
|
\param aspect Unresolved aspect
|
||||||
|
\param color Color hint
|
||||||
|
|
||||||
|
\sa setSkinHint()
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*! \fn QskSkinnable::resetColor
|
/*! \fn QskSkinnable::resetColor
|
||||||
|
|
||||||
|
\code return resetSkinHint( aspect | QskAspect::Color ); \endcode
|
||||||
|
|
||||||
|
\param aspect Unresolved aspect
|
||||||
|
\return true, if an entry in the local hint table was found and removed.
|
||||||
|
|
||||||
|
\sa resetSkinHint()
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*! \fn QskSkinnable::color
|
/*! \fn QskSkinnable::color
|
||||||
|
@ -93,10 +93,6 @@ class QSK_EXPORT QskSkinnable
|
|||||||
|
|
||||||
QskSkinHintStatus hintStatus( QskAspect ) const;
|
QskSkinHintStatus hintStatus( QskAspect ) const;
|
||||||
|
|
||||||
QskAspect::State skinState() const;
|
|
||||||
const char* skinStateAsPrintable() const;
|
|
||||||
const char* skinStateAsPrintable( QskAspect::State ) const;
|
|
||||||
|
|
||||||
QRectF subControlRect( const QRectF&, QskAspect::Subcontrol ) const;
|
QRectF subControlRect( const QRectF&, QskAspect::Subcontrol ) const;
|
||||||
QRectF subControlContentsRect( const QRectF&, QskAspect::Subcontrol ) const;
|
QRectF subControlContentsRect( const QRectF&, QskAspect::Subcontrol ) const;
|
||||||
|
|
||||||
@ -130,6 +126,11 @@ class QSK_EXPORT QskSkinnable
|
|||||||
void setSkinState( QskAspect::State, bool animated = true );
|
void setSkinState( QskAspect::State, bool animated = true );
|
||||||
void setSkinStateFlag( QskAspect::State, bool on = true );
|
void setSkinStateFlag( QskAspect::State, bool on = true );
|
||||||
|
|
||||||
|
QskAspect::State skinState() const;
|
||||||
|
|
||||||
|
const char* skinStateAsPrintable() const;
|
||||||
|
const char* skinStateAsPrintable( QskAspect::State ) const;
|
||||||
|
|
||||||
// type aware methods for accessing skin hints
|
// type aware methods for accessing skin hints
|
||||||
|
|
||||||
bool setColor( QskAspect, Qt::GlobalColor );
|
bool setColor( QskAspect, Qt::GlobalColor );
|
||||||
|
Loading…
x
Reference in New Issue
Block a user