Plasma - Units Class Reference

View on LXR

#include <units.h>

Inheritance diagram for Units:

Properties
QtObject	__styleItem

qreal	devicePixelRatio

real	devicePixelRatio

variant	fontMetrics

int	gridUnit

QQmlPropertyMap	iconSizeHints

QQmlPropertyMap	iconSizes

QtObject	iconSizes

int	largeSpacing

int	longDuration

int	shortDuration

int	smallSpacing

int	toolTipDelay

int	wheelScrollLines

Properties inherited from QObject
	objectName

Signals
void	devicePixelRatioChanged ()

void	durationChanged ()

void	gridUnitChanged ()

void	iconSizeHintsChanged ()

void	iconSizesChanged ()

void	spacingChanged ()

Static Public Member Functions
static Q_INVOKABLE int	roundToIconSize (int size)

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 receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

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, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Additional Inherited Members
Public Member Functions inherited from QObject
	QObject (QObject *parent)

bool	blockSignals (bool block)

const QObjectList &	children () const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const

bool	disconnect (const QObject receiver, const char method) const

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const

bool	inherits (const char *className) const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const

bool	isWindowType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

QString	objectName () const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const

QVariant	property (const char *name) const

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval, Qt::TimerType timerType)

QThread *	thread () const

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

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Expose sizes to QML.

Remarks: This component is a singleton

Definition at line 51 of file units.h.

Property Documentation

QtObject Units::__styleItem

Remarks: This property is read-only

Definition at line 85 of file kirigamiplasmadesktopstyle/Units.qml.

qreal Units::devicePixelRatio

read

The ratio between physical and device-independent pixels.

This value does not depend on the \ size of the configured font. If you want to take font sizes into account when scaling elements, use theme.mSize(theme.defaultFont), units.smallSpacing and units.largeSpacing. The devicePixelRatio follows the definition of "device independent pixel" by Microsoft.

Definition at line 121 of file units.h.

real Units::devicePixelRatio

The ratio between physical and device-independent pixels.

This value does not depend on the size of the configured font. If you want to take font sizes into account when scaling elements, use theme.mSize(theme.defaultFont), units.smallSpacing and units.largeSpacing. The devicePixelRatio follows the definition of "device independent pixel" by Microsoft.

Definition at line 72 of file kirigamiplasmadesktopstyle/Units.qml.

variant Units::fontMetrics

metrics used by the default font

Definition at line 95 of file kirigamiplasmadesktopstyle/Units.qml.

int 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 a width of the capital letter M

Definition at line 60 of file units.h.

QQmlPropertyMap * Units::iconSizeHints

read

units.iconSizeHints provides access to user-configurable icon size hints, to be used where appropriate in the user interface.

Conceptually, an icon size hint is a key that has one of the sizes from property as value.

Currently available hints:

panel
desktop

Definition at line 95 of file units.h.

QQmlPropertyMap * 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.

Icon sizes from KIconLoader, adjusted to devicePixelRatio:

small
smallMedium
medium
large
huge
enormous
desktop (DEPRECATED: use iconSizeHints instead)

Definition at line 80 of file units.h.

QtObject Units::iconSizes

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.

Icon sizes from KIconLoader, adjusted to devicePixelRatio:

small
smallMedium
medium
large
huge
enormous

Not devicePixelRation-adjusted::

desktop

Definition at line 51 of file kirigamiplasmadesktopstyle/Units.qml.

int Units::largeSpacing

read

units.largeSpacing is the amount of spacing that should be used inside bigger UI elements, for example between an icon and the corresponding text.

Internally, this size depends on the size of the default font as rendered on the screen, so it takes user-configured font size and DPI into account.

Definition at line 113 of file units.h.

int 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 127 of file units.h.

int Units::shortDuration

read

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

Definition at line 133 of file units.h.

int Units::smallSpacing

read

units.smallSpacing is the amount of spacing that should be used around smaller UI elements, for example as spacing in Columns.

Internally, this size depends on the size of the default font as rendered on the screen, so it takes user-configured font size and DPI into account.

Definition at line 105 of file units.h.

int Units::wheelScrollLines

How much the mouse scroll wheel scrolls, expressed in lines of text.

Note: this is strictly for classical mouse wheels, touchpads 2 figer scrolling won't be affected

Remarks: This property is read-only

Note: this is strictly for classical mouse wheels, touchpads 2 figer scrolling won't be affected

Definition at line 91 of file kirigamiplasmadesktopstyle/Units.qml.

Member Function Documentation

int Units::roundToIconSize ( int size )

static

Returns: a size rounded tothe nearest inferior standard icon size. sizes larger than iconSizes.huge, it will be returned unmodified

Parameters

int	size the size we want to be rounded down

See also: iconSizes

Definition at line 152 of file units.cpp.

The documentation for this class was generated from the following files:

KDE's Doxygen guidelines are available online.

Quick Links

Class Picker

About

Units

Properties

Signals

Static Public Member Functions

Additional Inherited Members

Detailed Description

Property Documentation

Member Function Documentation