Plasmoid QML Type

Common attached properties for plasmoids. More...

• List of all members, including inherited members

Attached Properties

• backgroundHints : Plasma.Types.BackgroundHints
• busy : bool
• configuration : KConfigPropertyMap
• configurationRequired : bool
• constraintHints : Plasma.Applet.ConstraintHints
• containment : Containment
• containmentDisplayHints : Plasma.Types.ContainmentDisplayHints
• contextualActions : list<Action>
• effectiveBackgroundHints : Plasma.Types.BackgroundHints
• formFactor : Plasma.Types.FormFactor
• globalShortcut : Shortcut
• hasConfigurationInterface : bool
• icon : string
• id : int
• immutability : Plasma.Types.ImmutabilityType
• immutable : bool
• isContainment : bool
• location : Plasma.Types.Location
• metaData : KPluginMetaData
• pluginName : string
• status : Plasma.Types.ItemStatus
• title : string
• userBackgroundHints : Plasma.Types.BackgroundHints
• userConfiguring : bool

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.

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.

Plasmoid.containment : Containment

The Containment managing this plasmoid.

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?

Plasmoid.contextualActions : list<Action>

Actions to be added in the plasmoid's context menu.

Use PlasmaCore.Action to instantiate QActions declaratively.

Plasmoid.effectiveBackgroundHints : Plasma.Types.BackgroundHints

Returns the effective background hints.

The userBackgroundHints will be preferred if set, otherwise returns the plasmoid's backgroundHints.

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.

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.

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.

Plasmoid.isContainment : bool

Whether this plasmoid is a Containment and is acting as one, such as a desktop or a panel.

Plasmoid.location : Plasma.Types.Location

The location of the scene which is displaying this plasmoid.

Plasmoid.metaData : KPluginMetaData

The metadata of the plasmoid.

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.

Plasmoid.userConfiguring : bool

True when the user is configuring, for instance when the configuration dialog is open.