Plasma

Plasma Namespace Reference

Classes

class  AbstractRunner
 
class  Applet
 
class  AppletScript
 
class  Containment
 
class  ContainmentActions
 
class  Corona
 
class  DataContainer
 
class  DataEngine
 
class  DataEngineConsumer
 
class  DataEngineScript
 
class  DataModel
 
class  DataSource
 
class  FrameSvg
 
class  FrameSvgItem
 
class  FrameSvgItemMargins
 
class  Package
 
class  PluginLoader
 
class  QueryMatch
 
class  QuickTheme
 
class  RunnerContext
 
class  RunnerManager
 
class  RunnerSyntax
 
class  ScriptEngine
 
class  Service
 
class  ServiceJob
 
class  SortFilterModel
 
class  Svg
 
class  SvgItem
 
class  Theme
 
class  TimeTracker
 
class  Types
 
class  WindowThumbnail
 

Typedefs

typedef QHash< QString, KPluginMetaDataEngineCache
 

Functions

bool appletConfigLessThan (const KConfigGroup &c1, const KConfigGroup &c2)
 
static KPluginMetaData appletMetadataForDirectory (const QString &path)
 
static void closeConnection ()
 
bool isContainmentMetaData (const KPluginMetaData &md)
 
static bool isExactMatch (const QRegularExpression &re, const QString &s)
 
bool isPluginVersionCompatible (unsigned int version)
 
QStringList knownLanguages (Types::ComponentTypes types)
 
QList< KPluginMetaDatalistAppletMetaDataInternal (const QString &category, const QString &parentApp)
 
static QVector< KPluginMetaDatalistEngines (Types::ComponentTypes types, std::function< bool(const KPluginMetaData &)> filter)
 
ScriptEngineloadEngine (const QString &language, Types::ComponentType type, QObject *parent, const QVariantList &args=QVariantList())
 
AppletScriptloadScriptEngine (const QString &language, Applet *applet, const QVariantList &args)
 
DataEngineScriptloadScriptEngine (const QString &language, DataEngine *dataEngine, const QVariantList &args)
 
Types::Direction locationToDirection (Types::Location location)
 
Types::Direction locationToInverseDirection (Types::Location location)
 
static KPluginInfo::List standardInternalInfo (const QString &type, const QString &category=QString())
 
unsigned int version ()
 
unsigned int versionMajor ()
 
unsigned int versionMinor ()
 
unsigned int versionRelease ()
 
const char * versionString ()
 
Types::PopupPlacement visualPopupPlacement (Types::PopupPlacement placement, Qt::LayoutDirection layoutDirection=Qt::LayoutDirectionAuto)
 

Variables

static const int MAX_FRAME_SIZE = 100000
 
static PluginLoaders_pluginLoader = nullptr
 

Detailed Description

Namespace for everything in libplasma.

Function Documentation

◆ isPluginVersionCompatible()

PLASMA_EXPORT bool Plasma::isPluginVersionCompatible ( unsigned int  version)

Verifies that a plugin is compatible with plasma.

Deprecated:
Since 5.85, method is obsolete with the deprecation of KPluginLoader::pluginVersion.

Consider using a versioned namespace or KPluginMetaData::version instead.

Definition at line 40 of file version.cpp.

◆ knownLanguages()

PLASMA_EXPORT QStringList Plasma::knownLanguages ( Types::ComponentTypes  types)
Parameters
typesa set of ComponentTypes flags for which to look up the language support for
Returns
a list of all supported languages for the given type(s).

Definition at line 67 of file scriptengine.cpp.

◆ loadScriptEngine() [1/2]

PLASMA_EXPORT AppletScript * Plasma::loadScriptEngine ( const QString language,
Applet applet,
const QVariantList &  args 
)

Loads an Applet script engine for the given language.

Parameters
languagethe language to load for
appletthe Plasma::Applet for this script
Returns
pointer to the AppletScript or 0 on failure; the caller is responsible for the return object which will be parented to the Applet

Definition at line 111 of file scriptengine.cpp.

◆ loadScriptEngine() [2/2]

PLASMA_EXPORT DataEngineScript * Plasma::loadScriptEngine ( const QString language,
DataEngine dataEngine,
const QVariantList &  args 
)

Loads an DataEngine script engine for the given language.

Parameters
languagethe language to load for
dataEnginethe Plasma::DataEngine for this script;
Returns
pointer to the DataEngineScript or 0 on failure; the caller is responsible for the return object which will be parented to the DataEngine

Definition at line 122 of file scriptengine.cpp.

◆ locationToDirection()

PLASMA_EXPORT Types::Direction Plasma::locationToDirection ( Types::Location  location)

Converts a location to a direction.

Handy for figuring out which way to send a popup based on location or to point arrows and other directional items.

Parameters
locationthe location of the container the element will appear in
Returns
the visual direction the element should be oriented in

Definition at line 26 of file plasma.cpp.

◆ locationToInverseDirection()

PLASMA_EXPORT Types::Direction Plasma::locationToInverseDirection ( Types::Location  location)

Converts a location to the direction facing it.

Handy for figuring out which way to collapse a popup or to point arrows at the item itself.

Parameters
locationthe location of the container the element will appear in
Returns
the visual direction the element should be oriented in

Definition at line 47 of file plasma.cpp.

◆ version()

PLASMA_EXPORT unsigned int Plasma::version ( )

The runtime version of libplasma.

Deprecated:
Since 5.85, use plasma_version.h header instead

Definition at line 15 of file version.cpp.

◆ versionMajor()

PLASMA_EXPORT unsigned int Plasma::versionMajor ( )

The runtime major version of libplasma.

Deprecated:
Since 5.85, use plasma_version.h header instead

Definition at line 20 of file version.cpp.

◆ versionMinor()

PLASMA_EXPORT unsigned int Plasma::versionMinor ( )

The runtime major version of libplasma.

Deprecated:
Since 5.85, use plasma_version.h header instead

Definition at line 25 of file version.cpp.

◆ versionRelease()

PLASMA_EXPORT unsigned int Plasma::versionRelease ( )

The runtime major version of libplasma.

Deprecated:
Since 5.85, use plasma_version.h header instead

Definition at line 30 of file version.cpp.

◆ versionString()

const PLASMA_EXPORT char * Plasma::versionString ( )

The runtime version string of libplasma.

Deprecated:
Since 5.85, use plasma_version.h header instead

Definition at line 35 of file version.cpp.

◆ visualPopupPlacement()

PLASMA_EXPORT Types::PopupPlacement Plasma::visualPopupPlacement ( Types::PopupPlacement  placement,
Qt::LayoutDirection  layoutDirection = Qt::LayoutDirectionAuto 
)

Mirrors popup placement horizontally in Right-To-Left environments.

Mirroring behavior can be explicitly overridden by passing a specific direction with layoutDirection parameter, or left at default value of Qt::LayoutDirectionAuto, in which case it will be deduced from shared QGuiApplication instance.

Definition at line 68 of file plasma.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Oct 3 2023 04:08:34 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.