KDecoration2::DecorationSettings

KDecoration2::DecorationSettings Class Reference

#include <decorationsettings.h>

Inheritance diagram for KDecoration2::DecorationSettings:

Properties

bool alphaChannelSupported
 
KDecoration2::BorderSize borderSize
 
bool closeOnDoubleClickOnMenu
 
QVector< KDecoration2::DecorationButtonTypedecorationButtonsLeft
 
QVector< KDecoration2::DecorationButtonTypedecorationButtonsRight
 
QFont font
 
int gridUnit
 
int largeSpacing
 
bool onAllDesktopsAvailable
 
int smallSpacing
 
- Properties inherited from QObject
 objectName
 

Signals

void alphaChannelSupportedChanged (bool)
 
void borderSizeChanged (KDecoration2::BorderSize size)
 
void closeOnDoubleClickOnMenuChanged (bool)
 
void decorationButtonsLeftChanged (const QVector< KDecoration2::DecorationButtonType > &)
 
void decorationButtonsRightChanged (const QVector< KDecoration2::DecorationButtonType > &)
 
void fontChanged (const QFont &font)
 
void gridUnitChanged (int)
 
void onAllDesktopsAvailableChanged (bool)
 
void reconfigured ()
 
void spacingChanged ()
 

Public Member Functions

 DecorationSettings (DecorationBridge *bridge, QObject *parent=nullptr)
 
BorderSize borderSize () const
 
QVector< DecorationButtonTypedecorationButtonsLeft () const
 
QVector< DecorationButtonTypedecorationButtonsRight () const
 
QFont font () const
 
QFontMetricsF fontMetrics () const
 
int gridUnit () const
 
bool isAlphaChannelSupported () const
 
bool isCloseOnDoubleClickOnMenu () const
 
bool isOnAllDesktopsAvailable () const
 
int largeSpacing () const
 
int smallSpacing () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
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_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- 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)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- 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)
 

Detailed Description

Common settings for the Decoration.

This class gets injected into the Decoration and provides recommendations for the Decoration. The Decoration is suggested to honor the settings, but may decide that some settings don't fit the design and ignore them.

See also
Decoration

Definition at line 45 of file decorationsettings.h.

Property Documentation

bool KDecoration2::DecorationSettings::alphaChannelSupported
read

Whether the Decoration will be rendered with an alpha channel.

If no alpha channel is available a Decoration should not use round borders.

Definition at line 60 of file decorationsettings.h.

KDecoration2::BorderSize KDecoration2::DecorationSettings::borderSize
read

The suggested border size.

Definition at line 77 of file decorationsettings.h.

bool KDecoration2::DecorationSettings::closeOnDoubleClickOnMenu
read

Whether the Decoration should close the DecoratedClient when double clicking on the DecorationButtonType::Menu.

Definition at line 65 of file decorationsettings.h.

QVector<KDecoration2::DecorationButtonType> KDecoration2::DecorationSettings::decorationButtonsLeft
read

The suggested ordering of the decoration buttons on the left.

Definition at line 69 of file decorationsettings.h.

QVector<KDecoration2::DecorationButtonType> KDecoration2::DecorationSettings::decorationButtonsRight
read

The suggested ordering of the decoration buttons on the right.

Definition at line 73 of file decorationsettings.h.

QFont KDecoration2::DecorationSettings::font
read

The recommended font for the Decoration's caption.

Definition at line 86 of file decorationsettings.h.

int KDecoration2::DecorationSettings::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 millimeter

Definition at line 82 of file decorationsettings.h.

int KDecoration2::DecorationSettings::largeSpacing
read

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 101 of file decorationsettings.h.

bool KDecoration2::DecorationSettings::onAllDesktopsAvailable
read

Whether the feature to put a DecoratedClient on all desktops is available.

If this feature is not available a Decoration might decide to not show the DecorationButtonType::OnAllDesktops.

Definition at line 54 of file decorationsettings.h.

int KDecoration2::DecorationSettings::smallSpacing
read

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 93 of file decorationsettings.h.

Member Function Documentation

QFontMetricsF KDecoration2::DecorationSettings::fontMetrics ( ) const

The fontMetrics for the recommended font.

See also
font
void KDecoration2::DecorationSettings::reconfigured ( )
signal

This signal is emitted when the backend got reconfigured.

If the plugin uses custom settings, it is recommended to re-read them after this signal got emitted.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Tue Aug 11 2020 23:09:37 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.