• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

Plasma

AppletInterface Class Reference

#include <appletinterface.h>

Inheritance diagram for AppletInterface:

Inheritance graph
[legend]

List of all members.


Public Types

enum  AspectRatioMode {
  InvalidAspectRatioMode = -1, IgnoreAspectRatio = 0, KeepAspectRatio = 1, Square = 2,
  ConstrainedSquare = 3, FixedSize = 4
}
enum  FormFactor { Planar = 0, MediaCenter, Horizontal, Vertical }
enum  Location {
  Floating = 0, Desktop, FullScreen, TopEdge,
  BottomEdge, LeftEdge, RightEdge
}
enum  QtOrientation { QtHorizontal = Qt::Horizontal, QtVertical = Qt::Vertical }

Public Slots

void dataUpdated (QString source, Plasma::DataEngine::Data data)

Signals

void configNeedsSaving ()
void releaseVisualFocus ()

Public Member Functions

Q_INVOKABLE QString activeConfig () const
Plasma::Applet * applet () const
 AppletInterface (SimpleJavaScriptApplet *parent)
Q_INVOKABLE AspectRatioMode aspectRatioMode ()
QList< QAction * > contextualActions () const
Q_INVOKABLE QString currentActivity ()
Plasma::DataEngine * dataEngine (const QString &name)
Q_INVOKABLE FormFactor formFactor ()
Q_INVOKABLE bool isBusy ()
Q_INVOKABLE Location location ()
const Plasma::Package * package () const
Q_INVOKABLE QVariant readConfig (const QString &entry) const
Q_INVOKABLE void removeAction (const QString &name)
Q_INVOKABLE void resize (qreal w, qreal h)
Q_INVOKABLE void setAction (const QString &name, const QString &text, const QString &icon=QString(), const QString &shortcut=QString())
Q_INVOKABLE void setActiveConfig (const QString &name)
Q_INVOKABLE void setAspectRatioMode (AspectRatioMode mode)
Q_INVOKABLE void setBusy (bool busy)
Q_INVOKABLE void setConfigurationRequired (bool needsConfiguring, const QString &reason=QString())
Q_INVOKABLE void setFailedToLaunch (bool failed, const QString &reason=QString())
Q_INVOKABLE void setMinimumSize (qreal w, qreal h)
Q_INVOKABLE void setPreferredSize (qreal w, qreal h)
Q_INVOKABLE bool shouldConserveResources ()
Q_INVOKABLE QSizeF size () const
Q_INVOKABLE void update ()
Q_INVOKABLE void writeConfig (const QString &entry, const QVariant &value)
 ~AppletInterface ()

Properties

QString activeConfig

Detailed Description

Definition at line 40 of file appletinterface.h.


Member Enumeration Documentation

enum AppletInterface::AspectRatioMode

Enumerator:
InvalidAspectRatioMode  Unsetted mode used for dev convenience when there is a need to store the aspectRatioMode somewhere.
IgnoreAspectRatio  The applet can be freely resized.
KeepAspectRatio  The applet keeps a fixed aspect ratio.
Square  The applet is always a square.
ConstrainedSquare  The applet is no wider (in horizontal formfactors) or no higher (in vertical ones) than a square.
FixedSize 

Definition at line 83 of file appletinterface.h.

enum AppletInterface::FormFactor

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.

Definition at line 56 of file appletinterface.h.

enum AppletInterface::Location

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 72 of file appletinterface.h.

enum AppletInterface::QtOrientation

Enumerator:
QtHorizontal 
QtVertical 

Definition at line 97 of file appletinterface.h.


Constructor & Destructor Documentation

AppletInterface::AppletInterface ( SimpleJavaScriptApplet *  parent  ) 

Definition at line 36 of file appletinterface.cpp.

AppletInterface::~AppletInterface (  ) 

Definition at line 45 of file appletinterface.cpp.


Member Function Documentation

Q_INVOKABLE QString AppletInterface::activeConfig (  )  const

Plasma::Applet * AppletInterface::applet (  )  const

Definition at line 264 of file appletinterface.cpp.

AppletInterface::AspectRatioMode AppletInterface::aspectRatioMode (  ) 

Definition at line 69 of file appletinterface.cpp.

void AppletInterface::configNeedsSaving (  )  [signal]

QList< QAction * > AppletInterface::contextualActions (  )  const

Definition at line 178 of file appletinterface.cpp.

QString AppletInterface::currentActivity (  ) 

Definition at line 64 of file appletinterface.cpp.

Plasma::DataEngine * AppletInterface::dataEngine ( const QString &  name  ) 

Definition at line 49 of file appletinterface.cpp.

void AppletInterface::dataUpdated ( QString  source,
Plasma::DataEngine::Data  data 
) [slot]

Definition at line 259 of file appletinterface.cpp.

AppletInterface::FormFactor AppletInterface::formFactor (  ) 

Definition at line 54 of file appletinterface.cpp.

bool AppletInterface::isBusy (  ) 

Definition at line 89 of file appletinterface.cpp.

AppletInterface::Location AppletInterface::location (  ) 

Definition at line 59 of file appletinterface.cpp.

const Plasma::Package * AppletInterface::package (  )  const

Definition at line 173 of file appletinterface.cpp.

QVariant AppletInterface::readConfig ( const QString &  entry  )  const

Definition at line 157 of file appletinterface.cpp.

void AppletInterface::releaseVisualFocus (  )  [signal]

void AppletInterface::removeAction ( const QString &  name  ) 

Definition at line 228 of file appletinterface.cpp.

void AppletInterface::resize ( qreal  w,
qreal  h 
)

Definition at line 244 of file appletinterface.cpp.

void AppletInterface::setAction ( const QString &  name,
const QString &  text,
const QString &  icon = QString(),
const QString &  shortcut = QString() 
)

Definition at line 199 of file appletinterface.cpp.

void AppletInterface::setActiveConfig ( const QString &  name  ) 

Definition at line 114 of file appletinterface.cpp.

void AppletInterface::setAspectRatioMode ( AppletInterface::AspectRatioMode  mode  ) 

Definition at line 74 of file appletinterface.cpp.

void AppletInterface::setBusy ( bool  busy  ) 

Definition at line 94 of file appletinterface.cpp.

void AppletInterface::setConfigurationRequired ( bool  needsConfiguring,
const QString &  reason = QString() 
)

Definition at line 99 of file appletinterface.cpp.

void AppletInterface::setFailedToLaunch ( bool  failed,
const QString &  reason = QString() 
)

Definition at line 84 of file appletinterface.cpp.

void AppletInterface::setMinimumSize ( qreal  w,
qreal  h 
)

Definition at line 249 of file appletinterface.cpp.

void AppletInterface::setPreferredSize ( qreal  w,
qreal  h 
)

Definition at line 254 of file appletinterface.cpp.

bool AppletInterface::shouldConserveResources (  ) 

Definition at line 79 of file appletinterface.cpp.

QSizeF AppletInterface::size (  )  const

Definition at line 194 of file appletinterface.cpp.

void AppletInterface::update (  ) 

Definition at line 104 of file appletinterface.cpp.

void AppletInterface::writeConfig ( const QString &  entry,
const QVariant &  value 
)

Definition at line 138 of file appletinterface.cpp.


Property Documentation

QString AppletInterface::activeConfig [read, write]

Definition at line 47 of file appletinterface.h.


The documentation for this class was generated from the following files:
  • appletinterface.h
  • appletinterface.cpp

Plasma

Skip menu "Plasma"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

API Reference

Skip menu "API Reference"
  • KWin
  •   KWin Libraries
  • Libraries
  •   libkworkspace
  •   libsolidcontrol
  •   libtaskmanager
  • Plasma
  •   Animators
  •   Applets
  •   Engines
  • Solid Modules
Generated for API Reference by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal