KDecoration3::DecoratedWindow
#include <decoratedwindow.h>
Properties | |
| bool | active |
| Qt::Edges | adjacentScreenEdges |
| bool | applicationMenuActive |
| QString | caption |
| bool | closeable |
| KDecoration3::Decoration * | decoration |
| bool | hasApplicationMenu |
| qreal | height |
| QIcon | icon |
| bool | keepAbove |
| bool | keepBelow |
| bool | maximizeable |
| bool | maximized |
| bool | maximizedHorizontally |
| bool | maximizedVertically |
| bool | minimizeable |
| bool | modal |
| bool | moveable |
| qreal | nextScale |
| bool | onAllDesktops |
| QPalette | palette |
| bool | providesContextHelp |
| bool | resizeable |
| qreal | scale |
| bool | shadeable |
| bool | shaded |
| QSizeF | size |
| qreal | width |
 Properties inherited from QObject | |
| objectName | |
Signals | |
| void | activeChanged (bool) |
| void | adjacentScreenEdgesChanged (Qt::Edges edges) |
| void | applicationMenuActiveChanged (bool) |
| void | captionChanged (QString) |
| void | closeableChanged (bool) |
| void | hasApplicationMenuChanged (bool) |
| void | heightChanged (qreal) |
| void | iconChanged (QIcon) |
| void | keepAboveChanged (bool) |
| void | keepBelowChanged (bool) |
| void | maximizeableChanged (bool) |
| void | maximizedChanged (bool) |
| void | maximizedHorizontallyChanged (bool) |
| void | maximizedVerticallyChanged (bool) |
| void | minimizeableChanged (bool) |
| void | moveableChanged (bool) |
| void | nextScaleChanged () |
| void | onAllDesktopsChanged (bool) |
| void | paletteChanged (const QPalette &palette) |
| void | providesContextHelpChanged (bool) |
| void | resizeableChanged (bool) |
| void | scaleChanged () |
| void | shadeableChanged (bool) |
| void | shadedChanged (bool) |
| void | sizeChanged (const QSizeF &size) |
| void | widthChanged (qreal) |
Public Member Functions | |
| Qt::Edges | adjacentScreenEdges () const |
| QString | caption () const |
| QColor | color (ColorGroup group, ColorRole role) const |
| QColor | color (QPalette::ColorGroup group, QPalette::ColorRole role) const |
| Decoration * | decoration () const |
| bool | hasApplicationMenu () const |
| qreal | height () const |
| QIcon | icon () const |
| bool | isActive () const |
| bool | isApplicationMenuActive () const |
| bool | isCloseable () const |
| bool | isKeepAbove () const |
| bool | isKeepBelow () const |
| bool | isMaximizeable () const |
| bool | isMaximized () const |
| bool | isMaximizedHorizontally () const |
| bool | isMaximizedVertically () const |
| bool | isMinimizeable () const |
| bool | isModal () const |
| bool | isMoveable () const |
| bool | isOnAllDesktops () const |
| bool | isResizeable () const |
| bool | isShadeable () const |
| bool | isShaded () const |
| qreal | nextScale () const |
| QPalette | palette () const |
| qreal | pixelSize () const |
| bool | providesContextHelp () const |
| qreal | scale () const |
| void | showApplicationMenu (int actionId) |
| QSizeF | size () const |
| QPointF | snapToPixelGrid (const QPointF &value) const |
| QRectF | snapToPixelGrid (const QRectF &value) const |
| QSizeF | snapToPixelGrid (const QSizeF &value) const |
| qreal | snapToPixelGrid (qreal value) const |
| qreal | width () const |
| QString | windowClass () const |
| Public Member Functions inherited from QObject | |
| QObject (QObject *parent) | |
| QBindable< QString > | bindableObjectName () |
| bool | blockSignals (bool block) |
| const QObjectList & | children () 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< QByteArray > | dynamicPropertyNames () const const |
| virtual bool | event (QEvent *e) |
| virtual bool | eventFilter (QObject *watched, QEvent *event) |
| T | 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 QMetaObject * | metaObject () const const |
| void | moveToThread (QThread *targetThread) |
| QString | objectName () const const |
| void | objectNameChanged (const QString &objectName) |
| QObject * | parent () 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 | |
| T | qobject_cast (const QObject *object) |
| T | 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) |
| QThread * | thread () const const |
Additional Inherited Members | |
| Public Types inherited from QObject | |
| typedef | QObjectList |
| 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 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 |
| QObject * | sender () const const |
| int | senderSignalIndex () const const |
| virtual void | timerEvent (QTimerEvent *event) |
Detailed Description
The Client which gets decorated.
The DecoratedWindow provides access to all the properties relevant for decorating the Client. Each DecoratedWindow is bound to one Decoration and each Decoration is bound to this one DecoratedWindow.
The DecoratedWindow only exports properties, it does not provide any means to change the state. To change state one needs to call the methods on Decoration. This is as the backend might disallow state changes. Therefore any changes should be bound to the change signals of the DecoratedWindow and not be bound to state changes of input elements (such as a button).
Definition at line 38 of file decoratedwindow.h.
Property Documentation
◆ active
|
read |
Whether the DecoratedWindow is active (has focus) or is inactive.
Definition at line 48 of file decoratedwindow.h.
◆ adjacentScreenEdges
|
read |
The Edges which are adjacent to a screen edge.
E.g. for a maximized DecoratedWindow this will include all Edges. The Decoration can use this information to hide borders.
Definition at line 152 of file decoratedwindow.h.
◆ applicationMenuActive
|
read |
Whether the application menu for this DecoratedWindow is currently shown to the user The Decoration can use this information to highlight the respective button.
- Since
- 5.9
Definition at line 163 of file decoratedwindow.h.
◆ caption
|
read |
The caption of the DecoratedWindow.
Definition at line 52 of file decoratedwindow.h.
◆ closeable
|
read |
Whether the DecoratedWindow can be closed.
If this property is false a DecorationButton for closing the DecoratedWindow should be disabled.
Definition at line 97 of file decoratedwindow.h.
◆ decoration
|
read |
The Decoration of this DecoratedWindow.
Definition at line 44 of file decoratedwindow.h.
◆ hasApplicationMenu
|
read |
Whether the DecoratedWindow has an application menu.
- Since
- 5.9
Definition at line 157 of file decoratedwindow.h.
◆ height
|
read |
The height of the DecoratedWindow.
Definition at line 138 of file decoratedwindow.h.
◆ icon
|
read |
The icon of the DecoratedWindow.
This can be used as the icon for the window menu button.
Definition at line 65 of file decoratedwindow.h.
◆ keepAbove
|
read |
Whether the DecoratedWindow is set to be kept above other DecoratedWindows.
There can be multiple DecoratedWindows which are set to be kept above.
Definition at line 86 of file decoratedwindow.h.
◆ keepBelow
|
read |
Whether the DecoratedWindow is set to be kept below other DecoratedWindows.
There can be multiple DecoratedWindows which are set to be kept below.
Definition at line 91 of file decoratedwindow.h.
◆ maximizeable
|
read |
Whether the DecoratedWindow can be maximized.
If this property is false a DecorationButton for maximizing the DecoratedWindow should be disabled.
Definition at line 102 of file decoratedwindow.h.
◆ maximized
|
read |
Whether the DecoratedWindow is maximized.
A DecoratedWindow is maximized if it is both maximizedHorizontally and maximizedVertically. The Decoration of a maximized DecoratedWindow should only consist of the title bar area.
Definition at line 71 of file decoratedwindow.h.
◆ maximizedHorizontally
|
read |
Whether the DecoratedWindow is maximized horizontally.
A horizontally maximized DecoratedWindow uses the maximal possible width.
Definition at line 76 of file decoratedwindow.h.
◆ maximizedVertically
|
read |
Whether the DecoratedWindow is maximized vertically.
A vertically maximized DecoratedWindow uses the maximal possible height.
Definition at line 81 of file decoratedwindow.h.
◆ minimizeable
|
read |
Whether the DecoratedWindow can be minimized.
If this property is false a DecorationButton for minimizing the DecoratedWindow should be disabled.
Definition at line 107 of file decoratedwindow.h.
◆ modal
|
read |
Whether the DecoratedWindow is a modal dialog.
Definition at line 116 of file decoratedwindow.h.
◆ moveable
|
read |
Whether the DecoratedWindow can be moved.
Definition at line 125 of file decoratedwindow.h.
◆ nextScale
|
read |
The next scale this decorated window is going to target.
- Since
- 6.3
Definition at line 175 of file decoratedwindow.h.
◆ onAllDesktops
|
read |
Whether the DecoratedWindow is on all desktops or on just one.
Definition at line 56 of file decoratedwindow.h.
◆ palette
|
read |
The palette this DecoratedWindow uses.
The palette might be different for each DecoratedWindow and the Decoration should honor the palette.
Definition at line 147 of file decoratedwindow.h.
◆ providesContextHelp
|
read |
Whether the DecoratedWindow provides context help.
The Decoration should only show a context help button if this property is true.
Definition at line 112 of file decoratedwindow.h.
◆ resizeable
|
read |
Whether the DecoratedWindow can be resized.
Definition at line 129 of file decoratedwindow.h.
◆ scale
|
read |
The current scale this decorated window is targeting.
- Since
- 6.3
Definition at line 169 of file decoratedwindow.h.
◆ shadeable
|
read |
Whether the DecoratedWindow can be shaded.
If this property is false a DecorationButton for shading the DecoratedWindow should be disabled.
Definition at line 121 of file decoratedwindow.h.
◆ shaded
|
read |
Whether the DecoratedWindow is shaded.
Shaded means that the actual content is not visible, only the Decoration is visible.
Definition at line 61 of file decoratedwindow.h.
◆ size
|
read |
The size of the DecoratedWindow.
Definition at line 142 of file decoratedwindow.h.
◆ width
|
read |
The width of the DecoratedWindow.
Definition at line 134 of file decoratedwindow.h.
Member Function Documentation
◆ adjacentScreenEdges()
| Qt::Edges KDecoration3::DecoratedWindow::adjacentScreenEdges | ( | ) | const |
Definition at line 133 of file decoratedwindow.cpp.
◆ caption()
| QString KDecoration3::DecoratedWindow::caption | ( | ) | const |
Definition at line 28 of file decoratedwindow.cpp.
◆ color() [1/2]
| QColor KDecoration3::DecoratedWindow::color | ( | ColorGroup | group, |
| ColorRole | role ) const |
Used to get additional colors that are not in QPalette.
- Parameters
-
group The color group role The color role
- Returns
- The color if provided for combination of group and role, otherwise invalid QColor.
- Since
- 5.3
Definition at line 163 of file decoratedwindow.cpp.
◆ color() [2/2]
| QColor KDecoration3::DecoratedWindow::color | ( | QPalette::ColorGroup | group, |
| QPalette::ColorRole | role ) const |
Used to get colors in QPalette.
- Parameters
-
group The color group role The color role
- Returns
- palette().color(group, role)
- Since
- 5.3
Definition at line 158 of file decoratedwindow.cpp.
◆ decoration()
| Decoration * KDecoration3::DecoratedWindow::decoration | ( | ) | const |
Definition at line 153 of file decoratedwindow.cpp.
◆ hasApplicationMenu()
| bool KDecoration3::DecoratedWindow::hasApplicationMenu | ( | ) | const |
Whether the DecoratedWindow has an application menu.
- Since
- 5.9
Definition at line 143 of file decoratedwindow.cpp.
◆ height()
| qreal KDecoration3::DecoratedWindow::height | ( | ) | const |
Definition at line 118 of file decoratedwindow.cpp.
◆ icon()
| QIcon KDecoration3::DecoratedWindow::icon | ( | ) | const |
Definition at line 43 of file decoratedwindow.cpp.
◆ isActive()
| bool KDecoration3::DecoratedWindow::isActive | ( | ) | const |
Definition at line 23 of file decoratedwindow.cpp.
◆ isApplicationMenuActive()
| bool KDecoration3::DecoratedWindow::isApplicationMenuActive | ( | ) | const |
Whether the application menu for this DecoratedWindow is currently shown to the user The Decoration can use this information to highlight the respective button.
- Since
- 5.9
Definition at line 148 of file decoratedwindow.cpp.
◆ isCloseable()
| bool KDecoration3::DecoratedWindow::isCloseable | ( | ) | const |
Definition at line 73 of file decoratedwindow.cpp.
◆ isKeepAbove()
| bool KDecoration3::DecoratedWindow::isKeepAbove | ( | ) | const |
Definition at line 63 of file decoratedwindow.cpp.
◆ isKeepBelow()
| bool KDecoration3::DecoratedWindow::isKeepBelow | ( | ) | const |
Definition at line 68 of file decoratedwindow.cpp.
◆ isMaximizeable()
| bool KDecoration3::DecoratedWindow::isMaximizeable | ( | ) | const |
Definition at line 78 of file decoratedwindow.cpp.
◆ isMaximized()
| bool KDecoration3::DecoratedWindow::isMaximized | ( | ) | const |
Definition at line 48 of file decoratedwindow.cpp.
◆ isMaximizedHorizontally()
| bool KDecoration3::DecoratedWindow::isMaximizedHorizontally | ( | ) | const |
Definition at line 53 of file decoratedwindow.cpp.
◆ isMaximizedVertically()
| bool KDecoration3::DecoratedWindow::isMaximizedVertically | ( | ) | const |
Definition at line 58 of file decoratedwindow.cpp.
◆ isMinimizeable()
| bool KDecoration3::DecoratedWindow::isMinimizeable | ( | ) | const |
Definition at line 83 of file decoratedwindow.cpp.
◆ isModal()
| bool KDecoration3::DecoratedWindow::isModal | ( | ) | const |
Definition at line 93 of file decoratedwindow.cpp.
◆ isMoveable()
| bool KDecoration3::DecoratedWindow::isMoveable | ( | ) | const |
Definition at line 103 of file decoratedwindow.cpp.
◆ isOnAllDesktops()
| bool KDecoration3::DecoratedWindow::isOnAllDesktops | ( | ) | const |
Definition at line 33 of file decoratedwindow.cpp.
◆ isResizeable()
| bool KDecoration3::DecoratedWindow::isResizeable | ( | ) | const |
Definition at line 108 of file decoratedwindow.cpp.
◆ isShadeable()
| bool KDecoration3::DecoratedWindow::isShadeable | ( | ) | const |
Definition at line 98 of file decoratedwindow.cpp.
◆ isShaded()
| bool KDecoration3::DecoratedWindow::isShaded | ( | ) | const |
Definition at line 38 of file decoratedwindow.cpp.
◆ nextScale()
| qreal KDecoration3::DecoratedWindow::nextScale | ( | ) | const |
Returns the next scale this decorated window is going to target.
Definition at line 178 of file decoratedwindow.cpp.
◆ palette()
| QPalette KDecoration3::DecoratedWindow::palette | ( | ) | const |
Definition at line 128 of file decoratedwindow.cpp.
◆ pixelSize()
| qreal KDecoration3::DecoratedWindow::pixelSize | ( | ) | const |
- Returns
- the logical size of a device pixel with the current scale
- Since
- 6.3
Definition at line 183 of file decoratedwindow.cpp.
◆ providesContextHelp()
| bool KDecoration3::DecoratedWindow::providesContextHelp | ( | ) | const |
Definition at line 88 of file decoratedwindow.cpp.
◆ scale()
| qreal KDecoration3::DecoratedWindow::scale | ( | ) | const |
Returns the current scale this decorated window is targeting.
- Since
- 6.3
Definition at line 173 of file decoratedwindow.cpp.
◆ showApplicationMenu()
| void KDecoration3::DecoratedWindow::showApplicationMenu | ( | int | actionId | ) |
Request the application menu to be shown to the user.
- Parameters
-
actionId The DBus menu ID of the action that should be highlighted, 0 for none.
Definition at line 168 of file decoratedwindow.cpp.
◆ size()
| QSizeF KDecoration3::DecoratedWindow::size | ( | ) | const |
Definition at line 123 of file decoratedwindow.cpp.
◆ snapToPixelGrid() [1/4]
snaps the logical geometry value to a fractional logical geometry value that aligns to the pixel grid with the current scale factor
- Since
- 6.3
Definition at line 193 of file decoratedwindow.cpp.
◆ snapToPixelGrid() [2/4]
snaps the logical geometry value to a fractional logical geometry value that aligns to the pixel grid with the current scale factor
- Since
- 6.3
Definition at line 203 of file decoratedwindow.cpp.
◆ snapToPixelGrid() [3/4]
snaps the logical geometry value to a fractional logical geometry value that aligns to the pixel grid with the current scale factor
- Since
- 6.3
Definition at line 198 of file decoratedwindow.cpp.
◆ snapToPixelGrid() [4/4]
| qreal KDecoration3::DecoratedWindow::snapToPixelGrid | ( | qreal | value | ) | const |
snaps the logical geometry value to a fractional logical geometry value that aligns to the pixel grid with the current scale factor
- Since
- 6.3
Definition at line 188 of file decoratedwindow.cpp.
◆ width()
| qreal KDecoration3::DecoratedWindow::width | ( | ) | const |
Definition at line 113 of file decoratedwindow.cpp.
◆ windowClass()
| QString KDecoration3::DecoratedWindow::windowClass | ( | ) | const |
Definition at line 138 of file decoratedwindow.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 16:55:48 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.