Libplasma
containment.h
64 Q_PROPERTY(Plasma::Containment::Type containmentType READ containmentType NOTIFY containmentTypeChanged)
76 Q_PROPERTY(Plasma::Types::ContainmentDisplayHints containmentDisplayHints READ containmentDisplayHints WRITE setContainmentDisplayHints NOTIFY
79 Q_PROPERTY(QString wallpaperPlugin READ wallpaperPlugin WRITE setWallpaperPlugin NOTIFY wallpaperPluginChanged)
80 Q_PROPERTY(QObject *wallpaperGraphicsObject READ wallpaperGraphicsObject WRITE setWallpaperGraphicsObject NOTIFY wallpaperGraphicsObjectChanged)
94 Q_PROPERTY(QRectF availableScreenRect READ availableRelativeScreenRect NOTIFY availableRelativeScreenRectChanged)
99 Q_PROPERTY(QList<QRectF> availableScreenRegion READ availableRelativeScreenRegion NOTIFY availableRelativeScreenRegionChanged)
118 explicit Containment(QObject *parentObject, const KPluginMetaData &data, const QVariantList &args);
129 * DesktopContainments represent main containments that will own a screen in a mutually exclusive fashion,
132 * This value is specified in the "X-Plasma-ContainmentType" JSON-metadata value of containments.
168 Applet *createApplet(const QString &name, const QVariantList &args = QVariantList(), const QRectF &geometryHint = QRectF(-1, -1, 0, 0));
258 * @returns true when the ui of this containment is fully loaded, as well the ui of every applet in it
263 * @returns The available screen rect (excluding panels) for the screen this containment is associated to,
391 * @param uiReady true when the ui of the containment is ready, as well the ui of each applet in it
Plasma::Types::Location location
The location of the scene which is displaying applet.
Definition applet.h:95
void appletDeleted(Plasma::Applet *applet)
Emitted when the applet is deleted.
Plasma::Types::FormFactor formFactor
The current form factor the applet is being displayed in.
Definition applet.h:88
void containmentTypeChanged()
emitted when the containment type changed
void uiReadyChanged(bool uiReady)
Emitted when the ui has been fully loaded and is fully working.
void configureRequested(Plasma::Applet *applet)
Emitted when the user wants to configure/change the containment, or an applet inside it.
void containmentDisplayHintsChanged(Plasma::Types::ContainmentDisplayHints hints)
Emitted when the containment disaplay hints change.
void formFactorChanged(Plasma::Types::FormFactor formFactor)
Emitted when the formFactor has changed.
void setContainmentDisplayHints(Plasma::Types::ContainmentDisplayHints hints)
Set Display hints that come from the containment that suggest the applet how to look and behave.
Definition containment.cpp:323
@ Custom
A containment that is neither a desktop nor a panel but something application specific.
Definition containment.h:138
void appletCreated(Plasma::Applet *applet, const QRectF &geometryHint)
This signal is emitted when a new applet is created by the containment.
void activityChanged(const QString &activity)
Emitted when the activity id has changed.
QRectF screenGeometry
Provides access to the geometry of the applet is in.
Definition containment.h:105
void wallpaperPluginChanged()
Emitted when the wallpaper plugin is changed.
QRectF availableScreenRect
screen area free of panels: the coordinates are relative to the containment, it's independent from th...
Definition containment.h:94
void availableRelativeScreenRegionChanged(const QList< QRectF > ®ion)
Emitted when the available screen rectangle has changed.
void activityNameChanged(const QString &name)
Emitted when the activity name has changed.
void setFormFactor(Plasma::Types::FormFactor formFactor)
Sets the form factor for this Containment.
Definition containment.cpp:306
QList< QRectF > availableScreenRegion
The available region of this screen, panels excluded.
Definition containment.h:99
Containment(QObject *parentObject, const KPluginMetaData &data, const QVariantList &args)
This constructor can be used with the KCoreAddons plugin loading system.
Definition containment.cpp:43
QList< QRectF > availableRelativeScreenRegion() const
Definition containment.cpp:513
void appletRemoved(Plasma::Applet *applet)
This signal is emitted when an applet is destroyed.
void appletAboutToBeRemoved(Plasma::Applet *applet)
This signal is emitted right before appletRemoved, it can be used to do a preliminary setup on the ap...
void showAddWidgetsInterface(const QPointF &pos)
Emitted when the containment requests an add widgets dialog is shown.
virtual void saveContents(KConfigGroup &group) const
Called when the contents of the containment should be saved.
Definition containment.cpp:228
void locationChanged(Plasma::Types::Location location)
Emitted when the location has changed.
void screenGeometryChanged(const QRectF &rect)
Emitted when the screen geometry has changed.
virtual void restoreContents(KConfigGroup &group)
Called when the contents of the containment should be loaded.
Definition containment.cpp:237
void wallpaperGraphicsObjectChanged()
Emitted when the root wallpaper item has changed.
void appletAboutToBeAdded(Plasma::Applet *applet, const QRectF &geometryHint)
This signal is emitted right before appletAdded, it can be used to do a preliminary setup on the appl...
void setLocation(Plasma::Types::Location location)
Informs the Corona as to what position it is in.
Definition containment.cpp:333
void appletAlternativesRequested(Plasma::Applet *applet)
Emitted when the user wants to chose an alternative for this applet or containment.
void appletsChanged()
Emitted when the list of applets has changed, either added or removed.
void setWallpaperPlugin(const QString &pluginName)
Sets wallpaper plugin.
Definition containment.cpp:549
int screen
The screen number this containment is serving as the desktop for, or -1 if none.
Definition containment.h:87
void screenChanged(int newScreen)
This signal indicates that a containment has been associated (or dissociated) with a physical screen.
void appletAdded(Plasma::Applet *applet, const QRectF &geometryHint)
This signal is emitted when a new applet is added in the containment It may happen in the following s...
void availableRelativeScreenRectChanged(const QRectF &rect)
Emitted when the available screen rectangle has changed.
QRectF availableRelativeScreenRect() const
Definition containment.cpp:485
QList< Plasma::Applet * > applets
List of applets this containment has: the containments KF6: this should be AppletQuickItem *.
Definition containment.h:54
Location
The Location enumeration describes where on screen an element, such as an Applet or its managing cont...
Definition plasma.h:81
FormFactor
The FormFactor enumeration describes how a Plasma::Applet should arrange itself.
Definition plasma.h:40
The EdgeEventForwarder class This class forwards edge events to be replayed within the given margin T...
Definition action.h:20
QObject(QObject *parent)
Q_OBJECTQ_OBJECT
Q_PROPERTY(...)
Q_SLOTSQ_SLOTS
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 24 2025 11:48:23 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 24 2025 11:48:23 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.