QskSkinnable

More…

#include <QskSkinnable.h>

Inherited by QskControl

Public Functions

Protected Functions

Detailed Description

class QskSkinnable;

See: QskSkin, QskSkinlet, QskControl, QskSkinHintTable

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 adding values to the local skin hint table - it is even possible to replace the skinlet individually.

In most cases a skinnable is a QskControl, but conceptually it is possible to have controls, that consist of many skinnables.

Public Functions Documentation

function QskSkinnable

QskSkinnable()

See: effectiveSkin(), effectiveSkinlet, effectiveSkinHint

Constructs a skinnable where all settings will be resolved from the skin

function ~QskSkinnable

virtual ~QskSkinnable()

Called when the skinnable is destroyed.

function setSkinlet

void setSkinlet(
    const QskSkinlet * skinlet
)

Set an individual skinlet to render/display the content.

Parameters:

• skinlet Skinlet to render/layout the skinnable.

See: skinlet(), effectiveSkinlet(), resetSkinlet(), QskSkin::declareSkinlet, QskSkinlet::isOwnedBySkinnable()

Note: Overriding the skinlet that has been registered in the skin breaks the themeability of the skinnable.

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.

When QskSkinlet::isOwnedBySkinnable() is true, the skinlet will be deleted, when the skinnable is deleted or a different skinlet gets assigned.

function skinlet

const QskSkinlet * skinlet() const

See: setSkinlet(), effectiveSkinlet(), effectiveSkin()

Return: Skinlet, that has been assigned by setSkinlet(). Usually the skinnable is coupled to a default skinlet from the skin and the result is a nullptr.

function effectiveFont

QFont effectiveFont(
    QskAspect aspect
) const

Parameters:

• aspect Unresolved aspect

See: fontRoleHint(), effectiveSkinHint(), QskSkin::font()

Return: Font, corresponding to the resolved aspect

Finds the font role for the given aspect and returns the corresponding font from the font table of the skin.

function effectiveGraphicFilter

QskColorFilter effectiveGraphicFilter(
    QskAspect aspect
) const

Parameters:

• aspect Unresolved aspect

See: graphicRoleHint(), effectiveSkinHint(), QskSkin::graphicFilter()

Return: Color filter, corresponding to the resolved aspect

Finds the graphic role for the given aspect and returns the corresponding color filter from the skin

function setSubcontrolProxy

void setSubcontrolProxy(
    QskAspect::Subcontrol subControl,
    QskAspect::Subcontrol proxy
)

function resetSubcontrolProxy

void resetSubcontrolProxy(
    QskAspect::Subcontrol subcontrol
)

function subcontrolProxy

QskAspect::Subcontrol subcontrolProxy(
    QskAspect::Subcontrol subControl
) const

function setAnimationHint

bool setAnimationHint(
    QskAspect aspect,
    QskAnimationHint hint
)

Parameters:

• aspect Unresolved aspect
• hint Animation hint

See: animationHint(), effectiveAnimation()

Insert an animation hint into the local hint table

function animationHint

QskAnimationHint animationHint(
    QskAspect aspect,
    QskSkinHintStatus * status =nullptr
) const

Parameters:

• aspect Unresolved aspect
• status If status != nullptr additional information about where the hint has been found is returned

See: effectiveSkinHint()

Retrieve the configuration of the animator for the current state.

function setSkinHint

bool setSkinHint(
    QskAspect aspect,
    const QVariant & hint
)

Insert a hint into the local hint table.

Parameters:

• aspect Unsubstituted aspect
• hint Hint, might be anything that fits into a QVariant and is understood by the skinlet consuming it.

See: effectiveSkinHint(), resetSkinHint(), hintTable(), QskSkinHintTableEditor()

Presentation, beheviour and layout of the scene graph nodes are affected by specific attributes - skin hints - that are configured in a table of the skin. Each skinnable has its own table where these attributes can be overloaded. Hints from the local table have precedence over those from the skin.

The subControl bits of the aspect might be substituted, depending on the implementation of effectiveSubcontrol(). By inserting the hint directly into the hintTable() the substitution can be avoided.

function resetSkinHint

bool resetSkinHint(
    QskAspect aspect
)

Remove a hint from the local hint table.

Parameters:

• aspect Unsubstituted aspect

See: setSkinHint(), effectiveSkinHint()

After removing the hint from the local table the hint will be resolved fro the hint table of the skin.

function effectiveAnimation

QskAnimationHint effectiveAnimation(
    QskAspect::Type type,
    QskAspect::Subcontrol subControl,
    QskAspect::States states,
    QskSkinHintStatus * status =nullptr
) const

Parameters:

• type Metric, color or something else
• subControl Unsubstituted subControl
• state State bits
• status If status != nullptr additional information about where the hint has been found is returned

See: animationHint()

Return: Value from the hint tables

Retrieve the configuration of the animator for reaching a specific state.

function effectiveSkinHint

QVariant effectiveSkinHint(
    QskAspect aspect,
    QskSkinHintStatus * status =nullptr
) const

Find the value for a specific aspect.

Parameters:

• aspect Initial aspect, to feed the skin hint lookup algorithm.
• status Optional status information

See: effectiveSubcontrol(), effectivePlacement()

Return: Hint value, or an invalid QVariant if no value was found

If an animation is running for the given aspect its value will be returned as hint. Then effectiveSkinHint() tries to find a hint in the local table and finally tries to resolve the aspect from the hint table of the skin.

function effectivePlacement

virtual QskAspect::Placement effectivePlacement() const

See: QskAspect::Placement, effectiveSkinHint()

Return: The default implementation returns QskAspect::NoPlacement;

Reimplemented by: QskSeparator::effectivePlacement

The placements bits are added to an unresolved aspect when inserting or looking up values in the hint table.

function hintStatus

QskSkinHintStatus hintStatus(
    QskAspect aspect
) const

Parameters:

• aspect Unresolved aspect

See: effectiveSkinHint()

Return: Informations about how the aspect would be resolved

function subControlRect

QRectF subControlRect(
    const QRectF & contentsRect,
    QskAspect::Subcontrol subControl
) const

Calculate position and size of a subControl.

Parameters:

• contentsRect Bounding rectangle for laying out the nodes of the skinnable
• subControl Unsubstituted subcontrol

See: effectiveSkinlet(), QskSkinlet::subControlRect(), QskControl::contentsRect()

Return: Geometry for the subControl

A convenience method that forwards the calculation to the skinlet

function subControlContentsRect

QRectF subControlContentsRect(
    const QRectF & contentsRect,
    QskAspect::Subcontrol subControl
) const

Calculate the inner rectangle for subControl.

Parameters:

• contentsRect Bounding rectangle for laying out the nodes of the skinnable
• subControl Unsubstituted subcontrol

See: QskSkinlet::subControlRect(), innerBox()

Return: Geometry for contents inside the subControl

The inner rectangle a subcontrol is its geometry with paddings, indentations being subtracted. F.e. the inner rectangle of QskPushButton::Panel is the bounding rectangle for laying out the QskPushButton::Text and QskPushButton::Graphic subcontrols.

function outerBoxSize

QSizeF outerBoxSize(
    QskAspect aspect,
    const QSizeF & innerBoxSize
) const

Calculate the size, when being expanded by paddings, indentations.

Parameters:

• aspect Unresolved aspect
• innerBoxSize Size to be expanded

See: innerBoxSize(), outerBox(), innerBox()

Return: Expanded size

Paddings, indentations depend on attributes for the given aspect.

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 QskPushButton::Text and QskPushButton::Graphic.

function innerBoxSize

QSizeF innerBoxSize(
    QskAspect aspect,
    const QSizeF & outerBoxSize
) const

Calculate the size, with paddings, indentations being subtracted.

Parameters:

• aspect Unresolved aspect
• outerBoxSize Size to be shrunk

See: outerBoxSize(), innerBox(), outerBox()

Return: Shrunk size

Paddings, indentations depend on attributes for the given aspect.

function innerBox

QRectF innerBox(
    QskAspect aspect,
    const QRectF & outerBox
) const

Calculate the rectangle, whith paddings, indentations being subtracted.

Parameters:

• aspect Unresolved aspect
• outerBox Rectangle to be shrunk

See: innerBoxSize(), outerBox()

Return: Shrunk rectangle

Paddings, indentations depend on attributes for the given aspect.

function outerBox

QRectF outerBox(
    QskAspect aspect,
    const QRectF & innerBox
) const

Calculate the rectangle, when being expanded by paddings, indentations.

Parameters:

• aspect Unresolved aspect
• innerBox Rectangle to be expanded

See: outerBoxSize(), innerBox()

Return: Expanded rectangle

Paddings, indentations depend on attributes for the given aspect.

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 QskPushButton::Text and QskPushButton::Graphic.

function innerPadding

QMarginsF innerPadding(
    QskAspect aspect,
    const QSizeF & outerBoxSize
) const

Calculate the padding from attributes for the given aspect.

Parameters:

• aspect Unresolved aspect
• outerBoxSize Size of the box

Return: Effective padding

Beside padding hints, the radii of the shape might have an effect

function effectiveSkinlet

const QskSkinlet * effectiveSkinlet() const

Return: Skinlet that has been set with setSkinlet() - or the default skinlet from the skin, that had been registered for metaObject()

function effectiveSkin

QskSkin * effectiveSkin() const

See: QskSetup::skin(), QskSkinlet::skin()

Return: Almost always the current skin. The only exception is when manually setting a skinlet being created from a different skin.

function startTransition

void startTransition(
    QskAspect aspect,
    QskAnimationHint animationHint,
    QVariant from,
    QVariant to
)

Parameters:

• aspect Unresolved aspect, only subcontrol substitution will be done
• from Start value of the transition

See: effectiveAnimation()

Start a transition for a specific aspect, that interpolates between 2 values. While the transition is in process a look up for the aspect will return the current value of the interpolation.

In most cases startTransition() is called automatically, when the skinState() changes and am animation is found for the new state.

function effectiveSubcontrol

QskAspect::Subcontrol effectiveSubcontrol(
    QskAspect::Subcontrol subControl
) const

Parameters:

• subControl Subcontrol

Return: Substituted subcontrol

Subcontrol substitution is a mechanism, that is used when a variation of an existing control needs to have skin hints, that can be configured individually without having to reimplement a new skinlet.

F.e. a button on a toolbar is often flat with a hovering effect. In this case a tool button could be derived from QskPushButton, where the QskPushButton::Panel subcontrol gets substituted by a new subcontrol that is defined for the tool button.

Subcontrol substitution is part of a concept that is known as aspect resolving “aspect resolving”.

The default implementation is a no operation and does not substitute

function controlCast

QskControl * controlCast()

Return: Control if successful, or a nullptr otherwise

Safe casting of the skinnable to a QskControl

The operation is based on comparing metaObject() with QskControl::staticMetaObject() ( similar to what qobject_cast() does )

function controlCast

const QskControl * controlCast() const

Return: Control if successful, or a nullptr otherwise

Safe casting of the skinnable to a QskControl

The operation is based on comparing metaObject() with QskControl::staticMetaObject() ( similar to what qobject_cast() does )

function owningControl

virtual QskControl * owningControl() const =0

Return: QskControl, that is owner of the skinnable. In most cases the skinnable is inherited

Reimplemented by: QskControl::owningControl

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 is built from several skinnables this pure virtual method needs to be implemented.

function metaObject

virtual const QMetaObject * metaObject() const =0

See: owningControl()

Return: Usually the metaObject of the owning control

function debug

void debug(
    QskAspect aspect
) const

Parameters:

• aspect Aspect to be printed

See: qskDebugAspect()

Writes an aspect to qDebug() using the string conversions for metaObject()

function debug

void debug(
    QskAspect::State state
) const

Parameters:

• state State to be printed

See: qskDebugState()

Writes a state to qDebug() using the string conversions for metaObject()

function debug

void debug(
    QDebug debug,
    QskAspect aspect
) const

Parameters:

• debug Debug stream
• aspect Aspect to be printed

See: qskDebugAspect()

Writes an aspect to a stream using the string conversions for metaObject()

function debug

void debug(
    QDebug debug,
    QskAspect::State state
) const

Parameters:

• debug Debug stream
• state State to be printed

See: qskDebugState()

Writes a state to a stream using the string conversions for metaObject()

function setSkinStates

void setSkinStates(
    QskAspect::States newStates
)

function setSkinStateFlag

void setSkinStateFlag(
    QskAspect::State stateFlag,
    bool on =true
)

Parameters:

• stateFlag State bit
• on true or false

See: setSkinState(), skinState()

Set/Clear a state in the state bits

function addSkinStates

void addSkinStates(
    QskAspect::States states
)

function clearSkinStates

void clearSkinStates(
    QskAspect::States states
)

function replaceSkinStates

void replaceSkinStates(
    QskAspect::States newStates
)

function hasSkinState

bool hasSkinState(
    QskAspect::State state
) const

function skinStates

QskAspect::States skinStates() const

function skinStatesAsPrintable

const char * skinStatesAsPrintable() const

function skinStatesAsPrintable

const char * skinStatesAsPrintable(
    QskAspect::States states
) const

function setColor

bool setColor(
    QskAspect aspect,
    Qt::GlobalColor color
)

Sets a color hint.

Parameters:

• aspect Unresolved aspect
• color Color hint

See: setSkinHint(), QskAspect::Color

QskAspect::Color will be added to aspect.

function setColor

bool setColor(
    QskAspect aspect,
    QRgb rgb
)

Sets a color hint.

Parameters:

• aspect Unresolved aspect
• rgb Color hint

See: setSkinHint(), QskAspect::Color

QskAspect::Color will be added to aspect.

function setColor

bool setColor(
    QskAspect aspect,
    const QColor & color
)

Sets a color hint.

Parameters:

• aspect Unresolved aspect
• color Color hint

See: setSkinHint(), QskAspect::Color

QskAspect::Color will be added to aspect.

function resetColor

inline bool resetColor(
    QskAspect aspect
)

Removes a color hint from the local table.

Parameters:

• aspect Unresolved aspect

See: resetSkinHint(), setColor()

Return: true, if an entry in the local hint table was found and removed.

QskAspect::Color will be added to aspect.

function color

QColor color(
    QskAspect aspect,
    QskSkinHintStatus * status =nullptr
) const

Retrieves a color hint.

Parameters:

• aspect Unresolved aspect
• status Optional status information

See: effectiveSkinHint(), setColor()

Return: Color hint, or QColor() if no value has been found

QskAspect::Color will be added to aspect.

function setMetric

bool setMetric(
    QskAspect aspect,
    qreal metric
)

Sets a metric hint.

Parameters:

• aspect Unresolved aspect
• metric Metric hint

See: setSkinHint(), QskAspect::Metric

QskAspect::Metric will be added to aspect.

function resetMetric

inline bool resetMetric(
    QskAspect aspect
)

Removes a metric hint from the local table.

Parameters:

• aspect Unresolved aspect

See: resetSkinHint(), setMetric()

Return: true, if an entry in the local hint table was found and removed.

QskAspect::Metric will be added to aspect.

function metric

qreal metric(
    QskAspect aspect,
    QskSkinHintStatus * status =nullptr
) const

Retrieves a metric hint.

Parameters:

• aspect Unresolved aspect
• status Optional status information

See: effectiveSkinHint(), setMetric()

Return: Metric, or 0 if no value was found

QskAspect::Metric will be added to aspect.

function setFlagHint

bool setFlagHint(
    QskAspect aspect,
    int flag
)

Sets a flag hint.

Parameters:

• aspect Unresolved aspect
• flag Flag hint

See: setSkinHint(), QskAspect::Flag

function resetFlagHint

inline bool resetFlagHint(
    QskAspect aspect
)

Removes a flag hint from the local table.

Parameters:

• aspect Unresolved aspect

See: resetSkinHint(), setFlag()

Return: true, if an entry in the local hint table was found and removed.

function flagHint

int flagHint(
    QskAspect aspect
) const

Retrieves a flag hint.

Parameters:

• aspect Unresolved aspect
• status Optional status information

See: effectiveSkinHint(), setFlag()

Return: Flag, or an invalid QVariant in case no value was found

function flagHint

template <typename T >
inline T flagHint(
    QskAspect aspect,
    T defaultValue =T()
) const

Retrieves a flag hint.

Parameters:

• aspect Unresolved aspect
• defaultValue Default result, when no entry can be found in the hint tables

See: resetSkinHint(), setFlag()

Return: Flag - or defaultValue if no value had been found

function setStrutSizeHint

bool setStrutSizeHint(
    QskAspect aspect,
    const QSizeF & size
)

Sets a metric hint.

Parameters:

• aspect Unresolved aspect
• size Strut size hint

See: setSkinHint(), QskAspect::Metric, QskAspect::StrutSize

function setStrutSizeHint

bool setStrutSizeHint(
    QskAspect aspect,
    qreal width,
    qreal height
)

Sets a strut size hint.

Parameters:

• aspect Unresolved aspect
• width Width of the strut size
• height Height of the strut size

See: setSkinHint(), QskAspect::Metric, QskAspect::StrutSize

function resetStrutSizeHint

bool resetStrutSizeHint(
    QskAspect aspect
)

Removes a strut size hint from the local table.

Parameters:

• aspect Unresolved aspect

See: resetSkinHint(), setStrutSizeHint()

Return: true, if an entry in the local hint table was found and removed.

function strutSizeHint

QSizeF strutSizeHint(
    QskAspect aspect,
    QskSkinHintStatus * status =nullptr
) const

Retrieves a strut size hint.

Parameters:

• aspect Unresolved aspect
• status Optional status information

See: effectiveSkinHint(), setStrutSizeHint()

Return: Strut size, or QSizeF() if no value was found

function setMarginHint

bool setMarginHint(
    QskAspect aspect,
    qreal margins
)

Sets a margin hint.

Parameters:

• aspect Unresolved aspect
• margin Margin

See: setSkinHint(), QskAspect::Metric, QskAspect::Margin

function setMarginHint

bool setMarginHint(
    QskAspect aspect,
    const QMarginsF & margins
)

Sets a margin hint.

Parameters:

• aspect Unresolved aspect
• margin Margin

See: setSkinHint(), QskAspect::Metric, QskAspect::Margin

function resetMarginHint

bool resetMarginHint(
    QskAspect aspect
)

Removes a margin hint from the local table.

Parameters:

• aspect Unresolved aspect

See: resetSkinHint(), setMarginHint()

Return: true, if an entry in the local hint table was found and removed.

function marginHint

QMarginsF marginHint(
    QskAspect aspect,
    QskSkinHintStatus * status =nullptr
) const

Retrieves a margin hint.

Parameters:

• aspect Unresolved aspect
• status Optional status information

See: effectiveSkinHint(), setMarginHint()

Return: margin, or QMarginsF() if no value was found

function setPaddingHint

bool setPaddingHint(
    QskAspect aspect,
    qreal padding
)

Sets a padding hint.

Parameters:

• aspect Unresolved aspect
• padding Padding

See: setSkinHint(), QskAspect::Metric, QskAspect::Padding

function setPaddingHint

bool setPaddingHint(
    QskAspect aspect,
    const QMarginsF & padding
)

Sets a padding hint.

Parameters:

• aspect Unresolved aspect
• padding Padding

See: setSkinHint(), QskAspect::Metric, QskAspect::Padding

function resetPaddingHint

bool resetPaddingHint(
    QskAspect aspect
)

Removes a padding hint from the local table.

Parameters:

• aspect Unresolved aspect

See: resetSkinHint(), setPaddingHint()

Return: true, if an entry in the local hint table was found and removed.

function paddingHint

QMarginsF paddingHint(
    QskAspect aspect,
    QskSkinHintStatus * status =nullptr
) const

Retrieves a padding hint.

Parameters:

• aspect Unresolved aspect
• status Optional status information

See: effectiveSkinHint(), setPaddingHint()

Return: padding, or QMarginsF() if no value was found

function setGradientHint

bool setGradientHint(
    QskAspect aspect,
    const QskGradient & gradient
)

Sets a gradient as color hint.

Parameters:

• aspect Unresolved aspect
• gradient Gradint

See: setSkinHint(), QskAspect::Color

QskAspect::Color will be added to aspect.

function gradientHint

QskGradient gradientHint(
    QskAspect aspect,
    QskSkinHintStatus * status =nullptr
) const

Retrieves a color hint as gradient.

Parameters:

• aspect Unresolved aspect
• status Optional status information

See: effectiveSkinHint(), setGradientHint()

Return: gradient, or QskGraient() if no value was found

QskAspect::Color will be added to aspect.

function setBoxShapeHint

bool setBoxShapeHint(
    QskAspect aspect,
    const QskBoxShapeMetrics & shape
)

Sets a shape hint.

Parameters:

• aspect Unresolved aspect
• shape Shape

See: setSkinHint(), QskAspect::Metric, QskAspect::Shape

function resetBoxShapeHint

bool resetBoxShapeHint(
    QskAspect aspect
)

Removes a shape hint from the local table.

Parameters:

• aspect Unresolved aspect

See: resetSkinHint(), setBoxShapeHint()

Return: true, if an entry in the local hint table was found and removed.

function boxShapeHint

QskBoxShapeMetrics boxShapeHint(
    QskAspect aspect,
    QskSkinHintStatus * status =nullptr
) const

Retrieves a shape hint.

Parameters:

• aspect Unresolved aspect
• status Optional status information

See: effectiveSkinHint(), setBoxShapeHint()

Return: shape, or QskBoxShapeMetrics() if no value was found

function setBoxBorderMetricsHint

bool setBoxBorderMetricsHint(
    QskAspect aspect,
    const QskBoxBorderMetrics & border
)

Sets a border metrics hint.

Parameters:

• aspect Unresolved aspect
• border Border metrics

See: setSkinHint(), QskAspect::Metric, QskAspect::Border

function resetBoxBorderMetricsHint

bool resetBoxBorderMetricsHint(
    QskAspect aspect
)

Removes a border metrics hint from the local table.

Parameters:

• aspect Unresolved aspect

See: resetSkinHint(), setBoxBorderMetricsHint()

Return: true, if an entry in the local hint table was found and removed.

function boxBorderMetricsHint

QskBoxBorderMetrics boxBorderMetricsHint(
    QskAspect aspect,
    QskSkinHintStatus * status =nullptr
) const

Retrieves a border hint.

Parameters:

• aspect Unresolved aspect
• status Optional status information

See: effectiveSkinHint(), setBoxBorderMetricsHint()

Return: border metrics, or QskBoxBorderMetrics() if no value was found

function setBoxBorderColorsHint

bool setBoxBorderColorsHint(
    QskAspect aspect,
    const QskBoxBorderColors & colors
)

Sets a border colors hint.

Parameters:

• aspect Unresolved aspect
• border Border colors

See: setSkinHint(), QskAspect::Color, QskAspect::Border

function resetBoxBorderColorsHint

bool resetBoxBorderColorsHint(
    QskAspect aspect
)

Removes a border colors hint from the local table.

Parameters:

• aspect Unresolved aspect

See: resetSkinHint(), setBoxBorderColorsHint()

Return: true, if an entry in the local hint table was found and removed.

function boxBorderColorsHint

QskBoxBorderColors boxBorderColorsHint(
    QskAspect aspect,
    QskSkinHintStatus * status =nullptr
) const

Retrieves border colors hint.

Parameters:

• aspect Unresolved aspect
• status Optional status information

See: effectiveSkinHint(), setBoxBorderColorsHint()

Return: border colors, or QskBoxBorderColors() if no value was found

function setArcMetricsHint

bool setArcMetricsHint(
    QskAspect aspect,
    const QskArcMetrics & arc
)

function resetArcMetricsHint

bool resetArcMetricsHint(
    QskAspect aspect
)

function arcMetricsHint

QskArcMetrics arcMetricsHint(
    QskAspect aspect,
    QskSkinHintStatus * status =nullptr
) const

function setSpacingHint

bool setSpacingHint(
    QskAspect aspect,
    qreal spacing
)

Sets a spacing hint.

Parameters:

• aspect Unresolved aspect
• spacing Spacing

See: setSkinHint(), QskAspect::Metric, QskAspect::Spacing

function resetSpacingHint

bool resetSpacingHint(
    QskAspect aspect
)

Removes a spacing hint from the local table.

Parameters:

• aspect Unresolved aspect

See: resetSkinHint(), setSpacingHint()

Return: true, if an entry in the local hint table was found and removed.

function spacingHint

qreal spacingHint(
    QskAspect aspect,
    QskSkinHintStatus * status =nullptr
) const

Retrieves a spacing hint.

Parameters:

• aspect Unresolved aspect
• status Optional status information

See: effectiveSkinHint(), setSpacingHint()

Return: spacing, or 0 if no value was found

function setAlignmentHint

bool setAlignmentHint(
    QskAspect aspect,
    Qt::Alignment alignment
)

Sets an alignment hint.

Parameters:

• aspect Unresolved aspect
• alignment Alignment hint

See: setSkinHint(), QskAspect::Flag, QskAspect::Alignment

function resetAlignmentHint

bool resetAlignmentHint(
    QskAspect aspect
)

Removes an alignment hint from the local table.

Parameters:

• aspect Unresolved aspect

See: resetSkinHint(), setAlignmentHint()

Return: true, if an entry in the local hint table was found and removed.

function alignmentHint

inline Qt::Alignment alignmentHint(
    QskAspect aspect,
    Qt::Alignment defaultAlignment =Qt::Alignment()
) const

Retrieves an alignment hint.

Parameters:

• aspect Unresolved aspect
• defaultAlignment Default value

See: effectiveSkinHint(), setAlignmentHint()

Return: alignment, or defaultAlignment if no value was found

function setFontRoleHint

bool setFontRoleHint(
    QskAspect aspect,
    int role
)

Sets a font role hint.

Parameters:

• aspect Unresolved aspect
• role Font role

See: setSkinHint(), QskAspect::Flag, QskAspect::FontRole

function resetFontRoleHint

bool resetFontRoleHint(
    QskAspect aspect
)

Removes a font role hint from the local table.

Parameters:

• aspect Unresolved aspect

See: resetSkinHint(), setFontRoleHint()

Return: true, if an entry in the local hint table was found and removed.

function fontRoleHint

int fontRoleHint(
    QskAspect aspect,
    QskSkinHintStatus * status =nullptr
) const

Retrieves a font role hint.

Parameters:

• aspect Unresolved aspect
• status Optional status information

See: effectiveSkinHint(), setFontRoleHint()

Return: font role, or 0 if no value was found

function setGraphicRoleHint

bool setGraphicRoleHint(
    QskAspect aspect,
    int role
)

Sets a graphic role hint.

Parameters:

• aspect Unresolved aspect
• role Graphic role

See: setSkinHint(), QskAspect::Flag, QskAspect::GraphicRole

function resetGraphicRoleHint

bool resetGraphicRoleHint(
    QskAspect aspect
)

Removes a graphic role hint from the local table.

Parameters:

• aspect Unresolved aspect

See: resetSkinHint(), setGraphicRoleHint()

Return: true, if an entry in the local hint table was found and removed.

function graphicRoleHint

int graphicRoleHint(
    QskAspect aspect,
    QskSkinHintStatus * status =nullptr
) const

A Retrieves a graphic role hint.

Parameters:

• aspect Unresolved aspect
• status Optional status information

See: effectiveSkinHint(), setGraphicRoleHint()

Return: graphic role, or 0 if no value was found

Protected Functions Documentation

function updateNode

virtual void updateNode(
    QSGNode * parentNode
)

Parameters:

• parentNode The parent of the nodes to be added in this method.

See: QskSkinlet::updateSubNode()

Note: Overriding updateNode() might break the themeability and the usual strategy to implement custom painting is to customize or replace the skinlet.

This method replaces the QQuickItem::updatePaintNode method as the preferred paint method to override when subclassing QskControl. This allows QskControl to perform some additional steps before calling updateNode(), and provides a consistent parent node which subclasses can rely on.

The default implementation simply forwards the operation to the skinlet,

function isTransitionAccepted

virtual bool isTransitionAccepted(
    QskAspect aspect
) const

Additional check if an transition should be started.

Parameters:

• aspect Aspect

Return: true, when owningControl()->isInitiallyPainted() is true

In certain situations a transition initiated from state depending hints needs to be avoided.

function substitutedSubcontrol

virtual QskAspect::Subcontrol substitutedSubcontrol(
    QskAspect::Subcontrol subControl
) const

function hintTable

QskSkinHintTable & hintTable()

Accessor for local skin hint table.

See: setSkinHint(), QskSkinHintTableEditor

Return: Reference to the local hint table

Definitions in the local hint table have precedence over those from the table of the skin. Initially the local table is empty.

function hintTable

const QskSkinHintTable & hintTable() const

Accessor for local skin hint table.

See: setSkinHint(), QskSkinHintTableEditor

Return: Reference to the local hint table

Definitions in the local hint table have precedence over those from the table of the skin. Initially the local table is empty.

Updated on 28 July 2023 at 14:02:28 CEST