Plasma::Types

Search for usage in LXR

Plasma::Types Class Reference

#include <Plasma/Plasma>

Inheritance diagram for Plasma::Types:

Public Types

enum  ActionType {
  AddAction = 0, ConfigureAction = 100, ControlAction = 200, MiscAction = 300,
  DestructiveAction, UserAction = DestructiveAction + 1000
}
 
typedef QFlags< BackgroundHintsBackgroundFlags
 
enum  BackgroundHints {
  NoBackground = 0, StandardBackground = 1, TranslucentBackground = 2, ShadowBackground = 4,
  ConfigurableBackground = 8, DefaultBackground = StandardBackground
}
 
enum  ComponentType {
  AppletComponent = 1, DataEngineComponent = 2, ContainmentComponent = 4, WallpaperComponent = 8,
  GenericComponent = 16
}
 
typedef QFlags< ComponentTypeComponentTypes
 
enum  Constraint {
  NoConstraint = 0, FormFactorConstraint = 1, LocationConstraint = 2, ScreenConstraint = 4,
  ImmutableConstraint = 8, StartupCompletedConstraint = 16, ContextConstraint = 32, UiReadyConstraint = 64,
  AllConstraints = FormFactorConstraint | LocationConstraint | ScreenConstraint | ImmutableConstraint
}
 
typedef QFlags< ConstraintHintsConstraintFlags
 
enum  ConstraintHints { NoHint = 0, CanFillArea = 1, MarginAreasSeparator = CanFillArea | 2 }
 
typedef QFlags< ConstraintConstraints
 
enum  ContainmentDisplayHint { NoContainmentDisplayHint = 0, ContainmentDrawsPlasmoidHeading, ContainmentForcesSquarePlasmoids, DesktopFullyCovered }
 
typedef QFlags< ContainmentDisplayHintContainmentDisplayHints
 
enum  ContainmentType {
  NoContainmentType = -1, DesktopContainment = 0, PanelContainment, CustomContainment = 127,
  CustomPanelContainment = 128, CustomEmbeddedContainment = 129
}
 
enum  Direction { Down = 0, Up, Left, Right }
 
typedef QFlags< FlipDirectionFlip
 
enum  FlipDirection { NoFlip = 0, HorizontalFlip = 1, VerticalFlip = 2 }
 
enum  FormFactor {
  Planar = 0, MediaCenter, Horizontal, Vertical,
  Application
}
 
enum  ImmutabilityType { Mutable = 1, UserImmutable = 2, SystemImmutable = 4 }
 
enum  IntervalAlignment { NoAlignment = 0, AlignToMinute, AlignToHour }
 
enum  ItemStatus {
  UnknownStatus = 0, PassiveStatus = 1, ActiveStatus = 2, NeedsAttentionStatus = 3,
  RequiresAttentionStatus = 4, AcceptingInputStatus = 5, HiddenStatus = 6
}
 
enum  Location {
  Floating = 0, Desktop, FullScreen, TopEdge,
  BottomEdge, LeftEdge, RightEdge
}
 
enum  MarginEdge { TopMargin = 0, BottomMargin, LeftMargin, RightMargin }
 
enum  PopupPlacement {
  FloatingPopup = 0, TopPosedLeftAlignedPopup, TopPosedRightAlignedPopup, LeftPosedTopAlignedPopup,
  LeftPosedBottomAlignedPopup, BottomPosedLeftAlignedPopup, BottomPosedRightAlignedPopup, RightPosedTopAlignedPopup,
  RightPosedBottomAlignedPopup
}
 
enum  Position {
  LeftPositioned, RightPositioned, TopPositioned, BottomPositioned,
  CenterPositioned
}
 
enum  TrustLevel {
  UnverifiableTrust = 0, CompletelyUntrusted, UnknownTrusted, UserTrusted,
  SelfTrusted, FullyTrusted, UltimatelyTrusted
}
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- 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
 
- 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

Enums and constants used in Plasma.

Definition at line 28 of file plasma.h.

Member Enumeration Documentation

A descriptive type for QActions, to help categorizing them when presented to the user.

Enumerator
AddAction 

The action will cause something new being created.

ConfigureAction 

The Action will make some kind of configuration ui to appear.

ControlAction 

Generic control, similar to ConfigureAction TODO: better doc.

MiscAction 

A type of action that doesn't fit in the other categories.

DestructiveAction 

A dangerous action, such as deletion of objects, plasmoids and files.

They are intended to be shown separated from other actions

UserAction 

If new types are needed in a C++ implementation, define them as ids more than UserAction.

Definition at line 129 of file plasma.h.

Description on how draw a background for the applet.

Enumerator
NoBackground 

Not drawing a background under the applet, the applet has its own implementation.

StandardBackground 

The standard background from the theme is drawn.

TranslucentBackground 

An alternate version of the background is drawn, usually more translucent.

ShadowBackground 

The applet won't have a svg background but a drop shadow of its content done via a shader.

DefaultBackground 

If the hint has this flag, the user is able to configure this background.

Default settings: both standard background

Definition at line 298 of file plasma.h.

The ComonentType enumeration refers to the various types of components, or plugins, supported by plasma.

Enumerator
AppletComponent 

Plasma::Applet based plugins.

DataEngineComponent 

Plasma::DataEngine based plugins.

ContainmentComponent 

Plasma::Containment based plugins.

WallpaperComponent 

Plasma::Wallpaper based plugins.

Definition at line 248 of file plasma.h.

The Constraint enumeration lists the various constraints that Plasma objects have managed for them and which they may wish to react to, for instance in Applet::constraintsUpdated.

Enumerator
NoConstraint 

No constraint; never passed in to Applet::constraintsEvent on its own.

FormFactorConstraint 

The FormFactor for an object.

LocationConstraint 

The Location of an object.

ScreenConstraint 

Which screen an object is on.

ImmutableConstraint 

the immutability (locked) nature of the applet changed

StartupCompletedConstraint 

application startup has completed

ContextConstraint 

the context (e.g.

activity) has changed

UiReadyConstraint 

The ui has been completely loaded.

Definition at line 39 of file plasma.h.

This enumeration lists the various hints that an applet can pass to its constraint regarding the way that it is represented.

Enumerator
CanFillArea 

The CompactRepresentation can fill the area and ignore constraint margins.

MarginAreasSeparator 

The applet acts as a separator between the standard and slim panel margin areas.

Definition at line 58 of file plasma.h.

Display hints that come from the containment that suggest the applet how to look and behave.

Since
5.77
Enumerator
ContainmentDrawsPlasmoidHeading 

The containment will draw an titlebar-looking header for the applets, so the applets shouldn't attempt to paint a similar thing.

ContainmentForcesSquarePlasmoids 

The containment will force every plasmoid to be constrained in a square icon (An example is the System Tray)

DesktopFullyCovered 

The desktop area for the contaiment's screen is not visible at all, for instance a window has been maximized on top of it.

Definition at line 96 of file plasma.h.

This enumeration describes the type of the Containment.

DesktopContainments represent main containments that will own a screen in a mutually exclusive fashion, while PanelContainments are accessories which can be present multiple per screen.

Enumerator
NoContainmentType 
DesktopContainment 

A desktop containment.

PanelContainment 

A desktop panel.

CustomContainment 

A containment that is neither a desktop nor a panel but something application specific.

CustomPanelContainment 

A customized desktop panel.

CustomEmbeddedContainment 

A customized containment embedded in another applet.

Definition at line 114 of file plasma.h.

The Direction enumeration describes in which direction, relative to the Applet (and its managing container), popup menus, expanders, balloons, message boxes, arrows and other such visually associated widgets should appear in.

This is usually the opposite of the Location.

Enumerator
Down 

Display downards.

Up 

Display upwards.

Left 

Display to the left.

Right 

Display to the right.

Definition at line 146 of file plasma.h.

Flip enumeration.

Enumerator
NoFlip 

Do not flip.

HorizontalFlip 

Flip horizontally.

VerticalFlip 

Flip vertically.

Definition at line 212 of file plasma.h.

The FormFactor enumeration describes how a Plasma::Applet should arrange itself.

The value is derived from the container managing the Applet (e.g. in Plasma, a Corona on the desktop or on a panel).

Enumerator
Planar 

The applet lives in a plane and has two degrees of freedom to grow.

Optimize for desktop, laptop or tablet usage: a high resolution screen 1-3 feet distant from the viewer.

MediaCenter 

As with Planar, the applet lives in a plane but the interface should be optimized for medium-to-high resolution screens that are 5-15 feet distant from the viewer.

Sometimes referred to as a "ten foot interface".

Horizontal 

The applet is constrained vertically, but can expand horizontally.

Vertical 

The applet is constrained horizontally, but can expand vertically.

Application 

The Applet lives in a plane and should be optimized to look as a full application, for the desktop or the particular device.

Definition at line 72 of file plasma.h.

Defines the immutability of items like applets, corona and containments they can be free to modify, locked down by the user or locked down by the system (e.g.

kiosk setups).

Enumerator
Mutable 

The item can be modified in any way.

UserImmutable 

The user has requested a lock down, and can undo the lock down at any time.

SystemImmutable 

the item is locked down by the system, the user can't unlock it

Definition at line 235 of file plasma.h.

Possible timing alignments.

Enumerator
NoAlignment 

No alignment.

AlignToMinute 

Align to the minute.

AlignToHour 

Align to the hour.

Definition at line 223 of file plasma.h.

Status of an applet.

Since
4.3
Enumerator
UnknownStatus 

The status is unknown.

PassiveStatus 

The Item is passive.

ActiveStatus 

The Item is active.

NeedsAttentionStatus 

The Item needs attention.

RequiresAttentionStatus 

The Item needs persistent attention.

AcceptingInputStatus 

The Item is accepting input.

HiddenStatus 

The Item will be hidden totally.

Definition at line 270 of file plasma.h.

The Location enumeration describes where on screen an element, such as an Applet or its managing container, is positioned on the screen.

Enumerator
Floating 

Free floating.

Neither geometry or z-ordering is described precisely by this value.

Desktop 

On the planar desktop layer, extending across the full screen from edge to edge.

FullScreen 

Full screen.

TopEdge 

Along the top of the screen.

BottomEdge 

Along the bottom of the screen.

LeftEdge 

Along the left side of the screen.

RightEdge 

Along the right side of the screen.

Definition at line 158 of file plasma.h.

Enumerator
TopMargin 

The top margin.

BottomMargin 

The bottom margin.

LeftMargin 

The left margin.

RightMargin 

The right margin.

Definition at line 258 of file plasma.h.

The popup position enumeration relatively to his attached widget.

Enumerator
FloatingPopup 

Free floating, non attached popup.

TopPosedLeftAlignedPopup 

Popup positioned on the top, aligned to the left of the widget.

TopPosedRightAlignedPopup 

Popup positioned on the top, aligned to the right of the widget.

LeftPosedTopAlignedPopup 

Popup positioned on the left, aligned to the top of the widget.

LeftPosedBottomAlignedPopup 

Popup positioned on the left, aligned to the bottom of the widget.

BottomPosedLeftAlignedPopup 

Popup positioned on the bottom, aligned to the left of the widget.

BottomPosedRightAlignedPopup 

Popup positioned on the bottom, aligned to the right of the widget.

RightPosedTopAlignedPopup 

Popup positioned on the right, aligned to the top of the widget.

RightPosedBottomAlignedPopup 

Popup positioned on the right, aligned to the bottom of the widget.

Definition at line 188 of file plasma.h.

The position enumeration.

Enumerator
LeftPositioned 

Positioned left.

RightPositioned 

Positioned right.

TopPositioned 

Positioned top.

BottomPositioned 

Positioned bottom.

CenterPositioned 

Positioned in the center.

Definition at line 175 of file plasma.h.

Enumerator
UnverifiableTrust 

The trust of the object can not be verified, usually because no trust information (e.g.

a cryptographic signature) was provided

CompletelyUntrusted 

The signature is broken/expired/false.

UnknownTrusted 

The signature is valid, but the key is unknown.

UserTrusted 

The signature is valid and made with a key signed by one of the user's own keys.

SelfTrusted 

The signature is valid and made with one of the user's own keys.

FullyTrusted 

The signature is valid and made with a key signed by the vendor's key.

UltimatelyTrusted 

The signature is valid and made with the vendor's key.

Definition at line 282 of file plasma.h.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Thu Sep 23 2021 22:42:09 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.