Plasmoid QML Type
Common attached properties for plasmoids. More...
- Import Statement: import org.kde.plasma.plasmoid
- In C++: Applet
Detailed Description
Attached Property Documentation
Plasmoid.backgroundHints : Plasma.Types.BackgroundHints
How the plasmoid wants its background to be drawn.
The containment may ignore this hint with userBackgroundHints.
Plasmoid.busy : bool
True if the plasmoid should show a busy status, for instance while doing some network operation.
[read-only] Plasmoid.configuration : KConfigPropertyMap
Configuration for the plasmoid.
Can be used to read and write settings like any JavaScript Object.
Plasmoid.configurationRequired : bool
If true, the plasmoid requires manual configuration from the user.
Plasmoid.constraintHints : Plasma.Applet.ConstraintHints
Hints how the plasmoid should be constrained, such as asking to fill all the available space ignoring margins.
[read-only] Plasmoid.containment : Containment
The Containment managing this plasmoid.
[read-only] Plasmoid.containmentDisplayHints : Plasma.Types.ContainmentDisplayHints
Display hints that come from the containment that suggest how the plasmoid should look and behave. TODO: only in containment?
[read-only] Plasmoid.contextualActions : list<Action>
Actions to be added in the plasmoid's context menu.
Use PlasmaCore.Action to instantiate QActions declaratively.
[read-only] Plasmoid.effectiveBackgroundHints : Plasma.Types.BackgroundHints
Returns the effective background hints.
The userBackgroundHints will be preferred if set, otherwise returns the plasmoid's backgroundHints.
[read-only] Plasmoid.formFactor : Plasma.Types.FormFactor
The current form factor the plasmoid is being displayed in.
Plasmoid.globalShortcut : Shortcut
The global shortcut to activate the plasmoid.
This is typically only used by the default configuration module.
Plasmoid.hasConfigurationInterface : bool
True if this plasmoid will provide a UI for its configuration.
Plasmoid.icon : string
Icon to represent the Plasmoid.
[read-only] Plasmoid.id : int
The plasmoid's id is unique in the whole Plasma session and will never change across restarts.
Plasmoid.immutability : Plasma.Types.ImmutabilityType
Sets the immutability of the Corona. Tells the plasmoid whether it should allow for any modification by the user.
[read-only] Plasmoid.immutable : bool
Whether the Corona is immutable.
The plasmoid implementation should avoid allowing "dangerous" modifications from the user when in an immutable mode.
This is true when immutability is not Mutable.
[read-only] Plasmoid.isContainment : bool
Whether this plasmoid is a Containment and is acting as one, such as a desktop or a panel.
[read-only] Plasmoid.location : Plasma.Types.Location
The location of the scene which is displaying this plasmoid.
[read-only] Plasmoid.metaData : KPluginMetaData
The metadata of the plasmoid.
[read-only] Plasmoid.pluginName : string
Plugin name for the plasmoid.
Plasmoid.status : Plasma.Types.ItemStatus
Allows to instruct the shell if this plasmoid is requesting attention, accepting input, or if it is in an idle, inactive state.
Plasmoid.title : string
User friendly title for the plasmoid, the localized plasmoid name by default.
Plasmoid.userBackgroundHints : Plasma.Types.BackgroundHints
Allows the containment or user to override the set backgroundHints if they exist.
[read-only] Plasmoid.userConfiguring : bool
True when the user is configuring, for instance when the configuration dialog is open.