Kirigami::Platform::Units

Search for usage in LXR

#include <Kirigami/Units>

Inheritance diagram for Kirigami::Platform::Units:

Properties

qreal cornerRadius
 
int gridUnit
 
int humanMoment
 
Kirigami::Platform::IconSizesiconSizes
 
int largeSpacing
 
int longDuration
 
int mediumSpacing
 
int shortDuration
 
int smallSpacing
 
int toolTipDelay
 
int veryLongDuration
 
int veryShortDuration
 
- Properties inherited from QObject
 objectName
 

Signals

void cornerRadiusChanged ()
 
void gridUnitChanged ()
 
void humanMomentChanged ()
 
void largeSpacingChanged ()
 
void longDurationChanged ()
 
void mediumSpacingChanged ()
 
void shortDurationChanged ()
 
void smallSpacingChanged ()
 
void toolTipDelayChanged ()
 
void veryLongDurationChanged ()
 
void veryShortDurationChanged ()
 
void wheelScrollLinesChanged ()
 

Public Member Functions

qreal cornerRadius () const
 
int gridUnit () const
 
int humanMoment () const
 
IconSizesiconSizes () const
 
int largeSpacing () const
 
int longDuration () const
 
int mediumSpacing () const
 
void setcornerRadius (qreal cornerRadius)
 
void setGridUnit (int size)
 
void setHumanMoment (int duration)
 
void setLargeSpacing (int size)
 
void setLongDuration (int duration)
 
void setMediumSpacing (int size)
 
void setShortDuration (int duration)
 
void setSmallSpacing (int size)
 
void setToolTipDelay (int delay)
 
void setVeryLongDuration (int duration)
 
void setVeryShortDuration (int duration)
 
int shortDuration () const
 
int smallSpacing () const
 
int toolTipDelay () const
 
int veryLongDuration () const
 
int veryShortDuration () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QStringbindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo () const const
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool setProperty (const char *name, QVariant &&value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
 
QThreadthread () const const
 

Static Public Member Functions

static Unitscreate (QQmlEngine *qmlEngine, QJSEngine *jsEngine)
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 

Protected Member Functions

 Units (QObject *parent=nullptr)
 
bool eventFilter (QObject *watched, QEvent *event) override
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Additional Inherited Members

- Public Attributes inherited from QObject
typedef QObjectList
 

Detailed Description

A set of values to define semantically sizes and durations.

Definition at line 79 of file units.h.

Property Documentation

◆ cornerRadius

qreal Kirigami::Platform::Units::cornerRadius
read

Corner radius value shared by buttons and other rectangle elements.

Since
6.2

Definition at line 200 of file units.h.

◆ gridUnit

int Kirigami::Platform::Units::gridUnit
read

The fundamental unit of space that should be used for sizes, expressed in pixels.

Given the screen has an accurate DPI settings, it corresponds to the height of the font's boundingRect.

Definition at line 92 of file units.h.

◆ humanMoment

int Kirigami::Platform::Units::humanMoment
read

Time in milliseconds equivalent to the theoretical human moment, which can be used to determine whether how long to wait until the user should be informed of something, or can be used as the limit for how long something should wait before being automatically initiated.

Some examples:

  • When the user types text in a search field, wait no longer than this duration after the user completes typing before starting the search
  • When loading data which would commonly arrive rapidly enough to not require interaction, wait this long before showing a spinner

This might seem an arbitrary number, but given the psychological effect that three seconds seems to be what humans consider a moment (and in the case of waiting for something to happen, a moment is that time when you think "this is taking a bit long, isn't it?"), the idea is to postpone for just before such a conceptual moment. The reason for the two seconds, rather than three, is to function as a middle ground: Not long enough that the user would think that something has taken too long, for also not so fast as to happen too soon.

See also https://www.psychologytoday.com/blog/all-about-addiction/201101/tick-tock-tick-hugs-and-life-in-3-second-intervals (the actual paper is hidden behind an academic paywall and consequently not readily available to us, so the source will have to be the blog entry above)

Note
This should not be used as an animation duration, as it is deliberately not scaled according to the animation settings. This is specifically for determining when something has taken too long and the user should expect some kind of feedback. See veryShortDuration, shortDuration, longDuration, and veryLongDuration for animation duration choices.
Since
5.81
org.kde.kirigami 2.16

Definition at line 186 of file units.h.

◆ iconSizes

Kirigami::Platform::IconSizes * Kirigami::Platform::Units::iconSizes
read

units.iconSizes provides access to platform-dependent icon sizing

The icon sizes provided are normalized for different DPI, so icons will scale depending on the DPI.

  • sizeForLabels (the largest icon size that fits within fontMetrics.height)
    Since
    5.80
    org.kde.kirigami 2.16
  • small
  • smallMedium
  • medium
  • large
  • huge
  • enormous

Definition at line 108 of file units.h.

◆ largeSpacing

int Kirigami::Platform::Units::largeSpacing
read

This property holds the amount of spacing that should be used between bigger UI elements, such as a large icon and a heading in a card.

Definition at line 126 of file units.h.

◆ longDuration

int Kirigami::Platform::Units::longDuration
read

units.longDuration should be used for longer, screen-covering animations, for opening and closing of dialogs and other "not too small" animations

Definition at line 138 of file units.h.

◆ mediumSpacing

int Kirigami::Platform::Units::mediumSpacing
read

This property holds the amount of spacing that should be used between medium UI elements, such as buttons and text fields in a toolbar.

Definition at line 120 of file units.h.

◆ shortDuration

int Kirigami::Platform::Units::shortDuration
read

units.shortDuration should be used for short animations, such as accentuating a UI event, hover events, etc.

Definition at line 144 of file units.h.

◆ smallSpacing

int Kirigami::Platform::Units::smallSpacing
read

This property holds the amount of spacing that should be used between smaller UI elements, such as a small icon and a label in a button.

Definition at line 114 of file units.h.

◆ toolTipDelay

int Kirigami::Platform::Units::toolTipDelay
read

time in ms by which the display of tooltips will be delayed.

See also
ToolTip.delay property

Definition at line 193 of file units.h.

◆ veryLongDuration

int Kirigami::Platform::Units::veryLongDuration
read

units.veryLongDuration should be used for specialty animations that benefit from being even longer than longDuration.

Definition at line 132 of file units.h.

◆ veryShortDuration

int Kirigami::Platform::Units::veryShortDuration
read

units.veryShortDuration should be used for elements that should have a hint of smoothness, but otherwise animate near instantly.

Definition at line 150 of file units.h.

Constructor & Destructor Documentation

◆ Units()

Units::Units ( QObject * parent = nullptr)
explicitprotected

Definition at line 79 of file units.cpp.

Member Function Documentation

◆ cornerRadius()

qreal Units::cornerRadius ( ) const

Definition at line 240 of file units.cpp.

◆ create()

Units * Units::create ( QQmlEngine * qmlEngine,
QJSEngine * jsEngine )
static

Definition at line 255 of file units.cpp.

◆ eventFilter()

bool Units::eventFilter ( QObject * watched,
QEvent * event )
overrideprotectedvirtual

Reimplemented from QObject.

Definition at line 273 of file units.cpp.

◆ gridUnit()

int Units::gridUnit ( ) const

Definition at line 86 of file units.cpp.

◆ humanMoment()

int Units::humanMoment ( ) const

Definition at line 210 of file units.cpp.

◆ iconSizes()

IconSizes * Units::iconSizes ( ) const

Definition at line 289 of file units.cpp.

◆ largeSpacing()

int Units::largeSpacing ( ) const

Definition at line 134 of file units.cpp.

◆ longDuration()

int Units::longDuration ( ) const

Definition at line 165 of file units.cpp.

◆ mediumSpacing()

int Units::mediumSpacing ( ) const

Definition at line 118 of file units.cpp.

◆ setcornerRadius()

void Units::setcornerRadius ( qreal cornerRadius)

Definition at line 245 of file units.cpp.

◆ setGridUnit()

void Units::setGridUnit ( int size)

Definition at line 91 of file units.cpp.

◆ setHumanMoment()

void Units::setHumanMoment ( int duration)

Definition at line 215 of file units.cpp.

◆ setLargeSpacing()

void Units::setLargeSpacing ( int size)

Definition at line 139 of file units.cpp.

◆ setLongDuration()

void Units::setLongDuration ( int duration)

Definition at line 170 of file units.cpp.

◆ setMediumSpacing()

void Units::setMediumSpacing ( int size)

Definition at line 123 of file units.cpp.

◆ setShortDuration()

void Units::setShortDuration ( int duration)

Definition at line 185 of file units.cpp.

◆ setSmallSpacing()

void Units::setSmallSpacing ( int size)

Definition at line 107 of file units.cpp.

◆ setToolTipDelay()

void Units::setToolTipDelay ( int delay)

Definition at line 230 of file units.cpp.

◆ setVeryLongDuration()

void Units::setVeryLongDuration ( int duration)

Definition at line 155 of file units.cpp.

◆ setVeryShortDuration()

void Units::setVeryShortDuration ( int duration)

Definition at line 200 of file units.cpp.

◆ shortDuration()

int Units::shortDuration ( ) const

Definition at line 180 of file units.cpp.

◆ smallSpacing()

int Units::smallSpacing ( ) const

Definition at line 102 of file units.cpp.

◆ toolTipDelay()

int Units::toolTipDelay ( ) const

Definition at line 225 of file units.cpp.

◆ veryLongDuration()

int Units::veryLongDuration ( ) const

Definition at line 150 of file units.cpp.

◆ veryShortDuration()

int Units::veryShortDuration ( ) const

Definition at line 195 of file units.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 24 2024 11:50:33 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.