qskinny/doc/classes/QskControl.dox

928 lines
22 KiB
Plaintext
Raw Normal View History

2020-12-08 11:02:57 +01:00
/*!
2020-12-12 14:05:09 +01:00
\class QskControl QskControl.h
2021-04-23 15:15:18 +02:00
\ingroup Framework Controls
2020-12-08 11:02:57 +01:00
2021-03-04 09:15:19 +01:00
\brief Base class of all controls
2020-12-08 11:02:57 +01:00
2021-05-03 14:13:33 +02:00
QskControl combines the themeability implemented in QskSkinnable with
what is needed to support a layout system, that is on par with what
is known from Qt/Widgets.
\todo Explain: QskQuickItem::geometry(), QskQuickItem::rect(),
QQuickItem::boundingRect(), layoutRect(), contentsRect(),
subControlRect(), focusIndicatorRect(), QQuickItem::clipRect(),
QQuickItem::contains()
2021-04-23 17:31:28 +02:00
\states QskControl::Disabled, QskControl::Hovered, QskControl::Focused
*/
/*!
\var QskControl::Disabled
A state bit that is set, when QQuickItem::isEnabled() == false.
\extends QskAspect::State
\sa QskQuickItem::setDisabled()
\saqt QQuickItem::enabled
\var QskControl::Hovered
A state bit that is set, when the item is hovered
It allows to define a specific representation in the skin,
when being hovered.
\saqt QQuickItem::acceptHoverEvents(), QQuickItem::hoverEnterEvent(),
QQuickItem::hoverLeaveEvent()
\var QskControl::Focused
A state bit that is set, when the item is the active focus item
\sa focusPolicy
\saqt QQuickItem::acceptHoverEvents(), QQuickItem::focusInEvent()
QQuickItem::focusOutEvent()
2021-03-04 09:15:19 +01:00
*/
/*!
\enum QskControl::LayoutHint
2021-04-23 17:31:28 +02:00
Hints, that can be used by the layout code
2021-03-04 09:15:19 +01:00
\sa setLayoutHint(), testLayoutHint(), setLayoutHints(), layoutHints()
2021-04-23 17:31:28 +02:00
setAutoLayoutChildren(), QskLinearBox, QskGridBox, QskStackBox
2021-03-04 09:15:19 +01:00
\var QskControl::RetainSizeWhenHidden
2021-04-23 17:31:28 +02:00
When being enabled the layout code should retain the necessary space
for the control even when it is hidden.
\saqt QSizePolicy::retainSizeWhenHidden()
2021-03-04 09:15:19 +01:00
2021-04-23 17:31:28 +02:00
\var QskControl::LayoutWhenHidden
2021-03-04 09:15:19 +01:00
2021-04-23 17:31:28 +02:00
When being enabled the layout code should set the geometry
to the control - even if it is not visible.
2021-03-04 09:15:19 +01:00
*/
/*!
\property QLocale QskControl::locale
2021-06-02 16:41:19 +02:00
The locale of the control
As long as no special locale has been set, this is the locale
of the parentItem(). If none of the ancestors has a special locale
it is the locale of the window ( in case it is a QskWindow ).
Otherwise it is is the default locale.
2021-03-04 09:15:19 +01:00
\accessors locale(), setLocale(), resetLocale(), localeChanged()
*/
/*!
\property bool QskControl::autoFillBackground
2021-04-23 17:31:28 +02:00
This property holds whether the background is filled automatically
with the background gradient.
2021-03-04 09:15:19 +01:00
\accessors autoFillBackground(), setAutoFillBackground()
2021-04-23 17:31:28 +02:00
\sa background()
\saqt QWidget::autoFillBackground
2021-03-04 09:15:19 +01:00
*/
/*!
\property bool QskControl::autoLayoutChildren
2021-06-02 16:41:19 +02:00
QskControl offers basic layout functionalities that can be enabled be
setting the autoLayoutChildren flag. The default setting is \c false.
Auto layouting calculates and assignes the geometries of childItems()
- when polishing - inside of the rectangle specified by layoutRect().
Size and alignment of the child depends on the specific layout constraints of the child.
Child items, where the transparentForPositioners flag is set, are excluded.
2021-03-04 09:15:19 +01:00
\accessors autoLayoutChildren(), setAutoLayoutChildren()
2021-06-02 16:41:19 +02:00
\sa layoutRect(), layoutHints(), layoutAlignmentHint(),
QskQuickItem::transparentForPositioners
\saqt QQuickItem::updatePolish()
\note Auto layouting is similar to what happens when putting several items
into the same cell of a \ref QskGridBox.
2021-03-04 09:15:19 +01:00
*/
/*!
\property Qt::FocusPolicy QskControl::focusPolicy
2021-06-02 16:41:19 +02:00
This property holds the way the control accepts keyboard focus
The default setting is \c Qt::NoFocus, accepting no keyboard inputs.
2021-03-04 09:15:19 +01:00
\accessors focusPolicy(), setFocusPolicy(), focusPolicyChanged()
2021-06-02 16:41:19 +02:00
\saqt QQuickItem::activeFocusOnTab()
\note For some reason Qt/Quick only offers a crippled version of the focus
policy as QQuickItem::activeFocusOnTab(). The implementation in QskControl
is using this flag for the Qt::TabFocus bit, but also supports all
other bits that are known from Qt/Widgets.
2021-03-04 09:15:19 +01:00
*/
/*!
\property bool QskControl::wheelEnabled
2021-06-02 16:41:19 +02:00
This property indicates if a control is interested in receiving wheel events.
2021-03-04 09:15:19 +01:00
\accessors isWheelEnabled(), setWheelEnabled(), wheelEnabledChanged()
2021-06-02 16:41:19 +02:00
\saqt QQuickItem::wheelEvent()
\note For some reason is QQuickItem only allows to indicate if it is
interested in receiving mouse/touch/hover events. The corresponding
functionality for wheel events might have been simply forgotten.
\note Even when wheelEnabled is set to false, QQuickWindow creates a QWheelEvent.
However QskSetup::eventFilter blocks delivering of this event to the control.
2021-03-04 09:15:19 +01:00
*/
/*!
\property bool QskControl::visibleToLayout
2021-06-02 16:41:19 +02:00
Allows calling isVisibleToLayout() as a property.
2021-03-04 09:15:19 +01:00
\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()
*/
2021-06-02 16:41:19 +02:00
/*!
\var QskControl::Control
This is a special subcontrol, that is used as fallback when no hints
have been defined for a specific subcontrol. F.e. when looking for
the gradient of QskBox::Panel and none has been defined
it will be resolved from this fallback subcontrol.
\sa QskSkinnable::effectiveSkinHint()
*/
2021-03-04 09:15:19 +01:00
/*!
\fn QskControl::QskControl
2021-06-02 16:41:19 +02:00
Initializes \ref focusPolicy to Qt::NoFocus and disables
2021-05-03 14:13:33 +02:00
processing of wheel events. The default sizePolicy is
QskSizePolicy::Preferred in vertical and horizontal direction.
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::~QskControl
2021-05-03 14:13:33 +02:00
Destructor
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::setMargins( qreal )
2021-04-23 17:31:28 +02:00
Sets the margins around the contents of the control
The value is stored in the local hint table for the aspect:
QskControl::Control | QskAspect::Metric | QskAspect::Margin
\param margin Margin for all sides
\aspect QskControl::Control | QskAspect::Metric | QskAspect::Margin
\sa contentsRect(), margins(), QskSkinnable::setMarginHint()
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::setMargins( const QMarginsF& )
2021-04-23 17:31:28 +02:00
Sets the margins around the contents of the control
\param margins Margins
\aspect QskControl::Control | QskAspect::Metric | QskAspect::Margin
\sa contentsRect(), margins()
\saqt QEvent::ContentsRectChange
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::resetMargins
2021-04-23 17:31:28 +02:00
Reset the margins to the default value provided from the skin
\aspect QskControl::Control | QskAspect::Metric | QskAspect::Margin
\sa contentsRect(), setMargins(), margins()
\saqt QEvent::ContentsRectChange
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::margins() const
2021-04-23 17:31:28 +02:00
\return margins around the contents of the control
\aspect QskControl::Control | QskAspect::Metric | QskAspect::Margin
\sa contentsRect(), setMargins()
\saqt QEvent::ContentsRectChange
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::setBackgroundColor
2021-06-02 16:41:19 +02:00
A conveninece method that enables the \ref autoFillBackground property
2021-04-23 17:31:28 +02:00
and sets a solid color as background. Usually used for debugging
layout problems.
\sa setBackground(), setAutoFillBackground()
\sa QskQuickItem::DebugForceBackground
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::setBackground
2021-04-23 17:31:28 +02:00
Set the gradient that is used to fill the background,
2021-06-02 16:41:19 +02:00
when \ref autoFillBackground is enabled.
2021-04-23 17:31:28 +02:00
\aspect QskControl::Control | QskAspect::Color
\sa resetBackground(), background(), autoFillBackground()
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::resetBackground
2021-04-23 17:31:28 +02:00
Reset the background gradient to the default colors from the skin
\aspect QskControl::Control | QskAspect::Color
\sa setBackground(), background(), autoFillBackground()
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::background() const
2021-04-23 17:31:28 +02:00
\return Gradient that is used to fill the background,
when autoFillBackground is enabled.
\aspect QskControl::Control | QskAspect::Color
\sa setBackground(), resetBackground(), autoFillBackground()
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::contentsRect
2021-05-03 14:13:33 +02:00
Returns the area inside the controls's margins.
contentsRect() is a rectangle being used for laying out scene graph nodes,
while layoutRect() is used for child items.
\sa margins(), setMargins(), layoutRect()
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::layoutRect
2021-05-03 14:13:33 +02:00
Returns the area for laying out child items
layoutRect() is a rectangle being used for laying out child items,
while contentsRect() is used for scene graph nodes.
F.e QskBox::layoutRect() returns an area that fits inside the ( maybe rounded )
borders, while the borders itself are rendered into the contentsRect().
The implementation relies on layoutRectForSize()
\sa layoutRectForSize(), contentsRect()
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::layoutRectForSize
2021-05-03 14:13:33 +02:00
Returns the geometry where to lay out child items for a given size.
layoutRectForSize() is intended to be overloaded, when layoutRect()
is supposed differ from contentsRect()
\param size Size Bounding size for the control
\return Area, where to lay out the child items
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::gestureRect
2021-05-03 14:13:33 +02:00
Returns the area where to accept gestures.
The default implementation returns QskQuickItem::rect().
\sa gestureFilter(), gestureEvent()
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::focusIndicatorRect
2021-05-03 14:13:33 +02:00
Returns the rectangle where to draw the focus indicator
For controls, that implement some sort of internal focus chain
( list boxes, sliders with more handles ... ) the rectangle might
change according to the state of the control.
The default implementation return contentsRect()
\sa QskFocusIndicator, focusIndicatorClipRect(), focusIndicatorRectChanged()
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::focusIndicatorClipRect
2021-05-03 14:13:33 +02:00
This is a specific rectangle, that can be returned to clip the focus
indicator being displayed for a child item.
The default implementation return QQuickItem::contentsRect()
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::subControlRect( QskAspect::Subcontrol ) const
2021-05-03 14:13:33 +02:00
Calculates the rectangle for a subcontrol from contentsRect().
\param subControl Subcontrol
\return Bounding rectangle for the subControl
\sa QskSkinnable::subControlRect
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::subControlRect( const QSizeF&, QskAspect::Subcontrol ) const
2021-05-03 14:13:33 +02:00
Calculates the rectangle for a subcontrol inside a rectangle at the position
0, 0 for the given size
\param subControl Subcontrol
\param size Size for the control
\return Bounding rectangle for the subControl
\sa QskSkinnable::subControlRect
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::subControlContentsRect( QskAspect::Subcontrol ) const
2021-05-03 14:13:33 +02:00
Calculate the inner rectangle for subControl calculated from contentsRect.
\param subControl Subcontrol
\return Inner rectangle of the subControl
\sa QskSkinnable::subControlContentsRect
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::subControlContentsRect( const QSizeF&, QskAspect::Subcontrol ) const
2021-05-03 14:13:33 +02:00
Calculate the inner rectangle for subControl for a rectangle at the position
0, 0 for the given size
\param subControl Subcontrol
\param size Size for the control
\return Inner rectangle of the subControl
\sa QskSkinnable::subControlContentsRect
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::setAutoFillBackground
2021-06-02 16:41:19 +02:00
Set or clear the \ref autoFillBackground property
2021-04-23 17:31:28 +02:00
\sa autoFillBackground()
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::autoFillBackground() const
2021-06-02 16:41:19 +02:00
\return Value of the \ref autoFillBackground property
2021-04-23 17:31:28 +02:00
\sa setAutoFillBackground()
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::setAutoLayoutChildren
2021-04-23 17:31:28 +02:00
Set or clear the autoLayoutChildren property
\sa autoFillBackground()
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::autoLayoutChildren() const
2021-06-02 16:41:19 +02:00
\return Value of the \ref autoLayoutChildren property
\sa setAutoLayoutChildren()
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::setWheelEnabled
2021-06-02 16:41:19 +02:00
Set or clear the \ref wheelEnabled property
2021-05-03 14:13:33 +02:00
\sa wheelEnabled isWheelEnabled
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::isWheelEnabled
2021-06-02 16:41:19 +02:00
\return Value of the \ref wheelEnabled property
2021-05-03 14:13:33 +02:00
\sa wheelEnabled
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::setFocusPolicy
2021-06-02 16:41:19 +02:00
Set the value for the \ref focusPolicy property
2021-05-03 14:13:33 +02:00
\sa focusPolicy()
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::focusPolicy() const
2021-06-02 16:41:19 +02:00
\return Value of the \ref focusPolicy property
2021-05-03 14:13:33 +02:00
\sa focusPolicy(), setFocusPolicy()
2021-03-04 09:15:19 +01:00
*/
/*!
2021-05-03 14:13:33 +02:00
\fn QskControl::setSizePolicy( QskSizePolicy )
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::setSizePolicy( QskSizePolicy::Policy, QskSizePolicy::Policy )
*/
/*!
\fn QskControl::setSizePolicy( Qt::Orientation, QskSizePolicy::Policy )
*/
2021-06-02 16:41:19 +02:00
/*!
\fn QskControl::initSizePolicy
A simpler version of setSizePolicy(), that does not send a QEvent::LayouRequest
to the parentItem(). It is used in constructors of derived controls.
*/
2021-03-04 09:15:19 +01:00
/*!
\fn QskControl::sizePolicy() const
2021-06-02 16:41:19 +02:00
\return Value of the \ref sizePolicy property
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::sizePolicy( Qt::Orientation ) const
*/
/*!
\fn QskControl::setLayoutAlignmentHint
*/
/*!
\fn QskControl::layoutAlignmentHint
*/
/*!
\fn QskControl::setLayoutHint
*/
/*!
\fn QskControl::testLayoutHint
*/
/*!
\fn QskControl::setLayoutHints
*/
/*!
\fn QskControl::layoutHints
*/
/*!
\fn QskControl::isVisibleToLayout
2021-05-03 14:13:33 +02:00
Return true, when the control is relevant for layout calculations
A control has an impact on the layout calutaions, when:
- isTransparentForPositioner() is false
- QskQuickItem::isVisibleToParent() is true, or RetainSizeWhenHidden is set
\sa isVisibleToParent(), RetainSizeWhenHidden
2021-03-04 09:15:19 +01:00
*/
2021-06-02 16:41:19 +02:00
/*!
\fn QskControl::minimumSize() const;
\return The explicit size hint for Qt::MinimumSize
*/
2021-03-04 09:15:19 +01:00
/*!
\fn QskControl::setMinimumSize( const QSizeF& )
2021-06-02 16:41:19 +02:00
Sets the minimum size.
The minimum size is a synonym for the explicit size hint for Qt::MinimumSize.
\sa setExplicitSizeHint(), setMinimumWidth(), setMinimumHeight(), minimumSize()
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::setMinimumSize( qreal, qreal )
2021-06-02 16:41:19 +02:00
Sets the minimum size.
The minimum size is a synonym for the explicit size hint for Qt::MinimumSize.
\sa setExplicitSizeHint(), setMinimumWidth(), setMinimumHeight(), minimumSize()
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::setMinimumWidth
2021-06-02 16:41:19 +02:00
Sets the minimum width.
The minimum width is a synonym for the width of the explicit
size hint for Qt::MinimumSize.
\sa setExplicitSizeHint(), setMinimumSize(), setMinimumHeight(), minimumSize()
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::setMinimumHeight
2021-06-02 16:41:19 +02:00
Sets the minimum height.
The minimum height is a synonym for the height of the explicit
size hint for Qt::MinimumSize.
\sa setExplicitSizeHint(), setMinimumSize(), setMinimumWidth(), minimumSize()
*/
/*!
\fn QskControl::maximumSize() const;
\return The explicit size hint for Qt::MaximumSize
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::setMaximumSize( const QSizeF& )
2021-06-02 16:41:19 +02:00
Sets the maximum size.
The maximum size is a synonym for the explicit size hint for Qt::MaximumSize.
\sa setExplicitSizeHint(), setMaximumWidth(), setMaximumHeight(), maximumSize()
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::setMaximumSize( qreal, qreal )
2021-06-02 16:41:19 +02:00
Sets the maximum size.
The maximum size is a synonym for the explicit size hint for Qt::MaximumSize.
\sa setExplicitSizeHint(), setMaximumWidth(), setMaximumHeight(), maximumSize()
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::setMaximumWidth
2021-06-02 16:41:19 +02:00
Sets the maximum width.
The minimum width is a synonym for the width of the explicit
size hint for Qt::MaximumSize.
\sa setExplicitSizeHint(), setMaximumSize(), setMaximumHeight(), maximumSize()
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::setMaximumHeight
2021-06-02 16:41:19 +02:00
Sets the maximum height.
2021-03-04 09:15:19 +01:00
2021-06-02 16:41:19 +02:00
The maximum height is a synonym for the height of the explicit
size hint for Qt::MaximumSize.
2021-03-04 09:15:19 +01:00
2021-06-02 16:41:19 +02:00
\sa setExplicitSizeHint(), setMaximumSize(), setMaximumWidth(), maximumSize()
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::sizeHint() const;
\return The explicit size hint for Qt::PreferredSize
2021-03-04 09:15:19 +01:00
2021-06-02 16:41:19 +02:00
\note sizeHint() does exactly the same as preferredSize() and only
exists because of being a name, that is well known from Qt/Widgets
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::preferredSize() const;
\return The explicit size hint for Qt::PreferredSize
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::setPreferredSize( const QSizeF& )
Sets the preferred size.
2021-03-04 09:15:19 +01:00
2021-06-02 16:41:19 +02:00
The preferred size is a synonym for the explicit size hint for Qt::PreferredSize.
\sa setExplicitSizeHint(), setPreferredWidth(), setPreferredHeight(), preferredSize()
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::setPreferredSize( qreal, qreal )
2021-03-04 09:15:19 +01:00
2021-06-02 16:41:19 +02:00
Sets the preferred size.
2021-03-04 09:15:19 +01:00
2021-06-02 16:41:19 +02:00
The preferred size is a synonym for the explicit size hint for Qt::PreferredSize.
2021-03-04 09:15:19 +01:00
2021-06-02 16:41:19 +02:00
\sa setExplicitSizeHint(), setPreferredWidth(), setPreferredHeight(), preferredSize()
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::setPreferredWidth
2021-03-04 09:15:19 +01:00
2021-06-02 16:41:19 +02:00
Sets the preferred width.
The preferred width is a synonym for the width of the explicit
size hint for Qt::PreferredSize.
\sa setExplicitSizeHint(), setPreferredSize(), setPreferredHeight(), preferredSize()
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::setPreferredHeight
Sets the preferred height.
The preferred height is a synonym for the height of the explicit
size hint for Qt::PreferredSize.
2021-03-04 09:15:19 +01:00
2021-06-02 16:41:19 +02:00
\sa setExplicitSizeHint(), setPreferredSize(), setPreferredWidth(), preferredSize()
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::setFixedSize( const QSizeF& )
2021-03-04 09:15:19 +01:00
2021-06-02 16:41:19 +02:00
Sets the explicit size hint for Qt::PreferredSize and changes the size policy to
QskSizePolicy::Fixed for both orientations.
\warning
The name of this method is misleading as it only sets a size hint, but does not
change the size as it implies. Without a layout code, that respects this value
it does not have any effect. However the name was chosen as with Qt/Widgets
there is a corresponding call with the same semantics developers might be
familiar with.
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::setFixedSize( qreal width, qreal height )
2021-03-04 09:15:19 +01:00
2021-06-02 16:41:19 +02:00
Sets the explicit size hint for Qt::PreferredSize and changes the size policy to
QskSizePolicy::Fixed for both orientations.
2021-03-04 09:15:19 +01:00
*/
2020-12-08 11:02:57 +01:00
2021-03-04 09:15:19 +01:00
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::setFixedWidth
2021-03-04 09:15:19 +01:00
2021-06-02 16:41:19 +02:00
Sets the width of the explicit size hint for Qt::PreferredSize and changes
the horizontal size policy to QskSizePolicy::Fixed.
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::setFixedHeight
2021-03-04 09:15:19 +01:00
2021-06-02 16:41:19 +02:00
Sets the height of the explicit size hint for Qt::PreferredSize and changes
the vertical size policy to QskSizePolicy::Fixed.
2021-03-04 09:15:19 +01:00
*/
2020-12-08 11:02:57 +01:00
2021-03-04 09:15:19 +01:00
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::setExplicitSizeHint( Qt::SizeHint, const QSizeF& )
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::setExplicitSizeHint( Qt::SizeHint, qreal width, qreal height )
2021-03-04 09:15:19 +01:00
*/
2020-12-08 11:02:57 +01:00
2021-03-04 09:15:19 +01:00
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::resetExplicitSizeHint
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::explicitSizeHint
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::implicitSizeHint
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::heightForWidth
2020-12-08 11:02:57 +01:00
2021-06-02 16:41:19 +02:00
\return Preferred height for given a width.
\sa effectiveSizeHint(), widthForHeight()
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::widthForHeight
2021-06-02 16:41:19 +02:00
\return Preferred width for given a height.
\sa effectiveSizeHint(), heightForWidth()
2021-03-04 09:15:19 +01:00
*/
/*!
\fn QskControl::effectiveSizeHint
*/
/*!
\fn QskControl::sizeConstraint( Qt::SizeHint, const QSizeF& ) const
*/
/*!
\fn QskControl::sizeConstraint() const
*/
/*!
\fn QskControl::locale() const
*/
/*!
\fn QskControl::resetLocale
*/
/*!
\fn QskControl::subControls
2021-06-02 16:41:19 +02:00
Calculates and returns a list of all effective subcontrols, that have been defined
for the corresponding metaObject(). This list can be used to decide if
a skin hint for specific subControl might have an impact on a control.
\sa QskAspect::subControls(), QskControl::effectiveSubcontrol()
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::backgroundChanged
2021-03-04 09:15:19 +01:00
2021-06-02 16:41:19 +02:00
Signal indicating, that the value of the \ref background property has changed
\sa background
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::marginsChanged
2021-03-04 09:15:19 +01:00
2021-06-02 16:41:19 +02:00
Signal indicating, that the value of the \ref margins property has changed
\sa margins
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::focusIndicatorRectChanged
2021-03-04 09:15:19 +01:00
2021-06-02 16:41:19 +02:00
Signal indicating that the value of the focusIndicatorRect() has changed.
\sa focusIndicatorRect()
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::localeChanged
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::focusPolicyChanged
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::wheelEnabledChanged
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::setLocale
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::event
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn void QskControl::gestureEvent
2021-03-04 09:15:19 +01:00
*/
/*!
\fn void QskControl::hoverEnterEvent
2021-06-02 16:41:19 +02:00
Sets the Hovered state
2021-03-04 09:15:19 +01:00
*/
/*!
\fn void QskControl::hoverLeaveEvent
2021-06-02 16:41:19 +02:00
Clears the Hovered state
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::childMouseEventFilter
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::gestureFilter
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::itemChange
2021-03-04 09:15:19 +01:00
2021-06-02 16:41:19 +02:00
Overload, that updates certain QSkinny specific attributes
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::geometryChange
2021-03-04 09:15:19 +01:00
2021-06-02 16:41:19 +02:00
Overload, that schedules a re-layouting of the child items when
autoLayoutChildren() is enabled.
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::updateResources
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::updateLayout
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::contentsSizeHint
2021-03-04 09:15:19 +01:00
*/
/*!
2021-06-02 16:41:19 +02:00
\fn QskControl::layoutSizeHint
2020-12-08 11:02:57 +01:00
*/