• Home
• Plasma
• Applet

C# Class Plasma.Applet

ファイルを表示 Open project: 0xd34df00d/Qross Class Usage Examples

Private Properties

Property	Type	Description
AddAssociatedWidget	void
Applet	System
ConfigChanged	void
ConstraintsEvent	void
ContextualActions	List
CreateConfigurationInterface	void
Destroy	void
EventFilter	bool
FlushPendingConstraintsEvents	void
FocusInEvent	void
HoverEnterEvent	void
HoverLeaveEvent	void
Init	void
InitExtenderItem	void
IsPopupShowing	bool
IsPublished	bool
ItemChange	QVariant
Lower	void
MouseMoveEvent	void
PaintInterface	void
PaintWindowFrame	void
Publish	void
Raise	void
RemoveAssociatedWidget	void
ResizeEvent	void
Restore	void
RunAssociatedApplication	void
Save	void
SaveState	void
SceneEventFilter	bool
SetBusy	void
SetImmutability	void
SetStatus	void
Shape	QPainterPath
ShowConfigurationInterface	void
SizeHint	QSizeF
SizeHint	QSizeF
StartupArguments	List
Status	Plasma.ItemStatus
TimerEvent	void
Unpublish	void
formFactor	Plasma.FormFactor
location	Plasma.Location
type	int

Public Methods

Method	Description
Action ( string name ) : Qyoto.QAction	Returns the QAction with the given name from our collection
AddAction ( string name, Qyoto.QAction action ) : void	Adds the action to our collection under the given name
Applet ( IQGraphicsItem parent ) : System
Applet ( IQGraphicsItem parent, string serviceId ) : System
Applet ( IQGraphicsItem parent, string serviceId, uint appletId ) : System	name="parent" the QGraphicsItem this applet is parented to name="serviceId" the name of the .desktop file containing the information about the widget name="appletId" a unique id used to differentiate between multiple instances of the same Applet type
Applet ( IQGraphicsItem parent, string serviceId, uint appletId, List args ) : System	name="parent" the QGraphicsItem this applet is parented to name="serviceId" the name of the .desktop file containing the information about the widget name="appletId" a unique id used to differentiate between multiple instances of the same Applet type name="args" a list of strings containing two entries: the service id and the applet id
Applet ( QObject parent, List args ) : System	This constructor is to be used with the plugin loading systems found in KPluginInfo and KService. The argument list is expected to have two elements: the KService service ID for the desktop entry and an applet ID which must be a base 10 number. name="parent" a QObject parent; you probably want to pass in 0 name="args" a list of strings containing two entries: the service id and the applet id
AssociatedApplication ( ) : string
AssociatedApplicationUrls ( ) : List
BackgroundHints ( ) : uint
Config ( ) : Kimono.KConfigGroup	Returns the KConfigGroup to access the applets configuration. This config object will write to an instance specific config file named \\rc in the Plasma appdata directory.
Config ( string group ) : Kimono.KConfigGroup	Returns a config group with the name provided. This ensures that the group name is properly namespaced to avoid collision with other applets that may be sharing this config file name="group" the name of the group to access
ConfigScheme ( ) : Plasma.ConfigLoader	Returns the config skeleton object from this applet's package, if any.
Containment ( ) : Containment
Context ( ) : Plasma.Context	Returns the workspace context which the applet is operating in
CustomCategories ( ) : List
DataEngine ( string name ) : DataEngine	Loads the given DataEngine Tries to load the data engine given by name. Each engine is only loaded once, and that instance is re-used on all subsequent requests. If the data engine was not found, an invalid data engine is returned (see DataEngine.IsValid()). Note that you should not delete the returned engine. name="name" Name of the data engine to load
Destroyed ( ) : bool
Dispose ( ) : void
Font ( ) : QFont
GlobalConfig ( ) : KConfigGroup	Returns a KConfigGroup object to be shared by all applets of this type. This config object will write to an applet-specific config object named plasma_\rc in the local config directory.
GlobalShortcut ( ) : KShortcut
HasAuthorization ( string constraint ) : bool	Returns true if the applet is allowed to perform functions covered by the given constraint eg. hasAuthorization("FileDialog") returns true if applets are allowed to show filedialogs.
HasValidAssociatedApplication ( ) : bool
Icon ( ) : string	Returns the icon related to this applet
IsContainment ( ) : bool
ListAppletInfo ( ) : List
ListAppletInfo ( string category ) : List
ListAppletInfo ( string category, string parentApp ) : List	Returns a list of all known applets. name="category" Only applets matchin this category will be returned. Useful in conjunction with knownCategories. If "Misc" is passed in, then applets without a Categories= entry are also returned. If an empty string is passed in, all applets are returned. name="parentApp" the application to filter applets on. Uses the X-KDE-ParentApp entry (if any) in the plugin info. The default value of string() will result in a list containing only applets not specifically registered to an application.
ListAppletInfoForMimetype ( string mimetype ) : List	Returns a list of all known applets associated with a certain mimetype.
ListAppletInfoForUrl ( QUrl url ) : List	Returns a list of all known applets associated with a certain URL.
ListCategories ( ) : List
ListCategories ( string parentApp ) : List
ListCategories ( string parentApp, bool visibleOnly ) : List	Returns a list of all the categories used by installed applets. name="parentApp" the application to filter applets on. Uses the X-KDE-ParentApp entry (if any) in the plugin info. The default value of string() will result in a list containing only applets not specifically registered to an application. name="visibleOnly" true if it should only return applets that are marked as visible
Load ( KPluginInfo info ) : Applet
Load ( KPluginInfo info, uint appletId ) : Applet
Load ( KPluginInfo info, uint appletId, List args ) : Applet	Attempts to load an applet Returns a pointer to the applet if successful. The caller takes responsibility for the applet, including deleting it when no longer needed. name="info" KPluginInfo object for the desired applet name="appletId" unique ID to assign the applet, or zero to have one assigned automatically. name="args" to send the applet extra arguments
Load ( string name ) : Applet
Load ( string name, uint appletId ) : Applet
Load ( string name, uint appletId, List args ) : Applet	Attempts to load an applet Returns a pointer to the applet if successful. The caller takes responsibility for the applet, including deleting it when no longer needed. name="name" the plugin name, as returned by KPluginInfo.PluginName() name="appletId" unique ID to assign the applet, or zero to have one assigned automatically. name="args" to send the applet extra arguments
LoadPlasmoid ( string path ) : Applet
LoadPlasmoid ( string path, uint appletId ) : Applet
LoadPlasmoid ( string path, uint appletId, List args ) : Applet	Attempts to load an applet from a package Returns a pointer to the applet if successful. The caller takes responsibility for the applet, including deleting it when no longer needed. name="path" the path to the package name="appletId" unique ID to assign the applet, or zero to have one assigned automatically. name="args" to send the applet extra arguments
MapFromView ( QGraphicsView view, QRect rect ) : QRectF	Maps a QRect from a view's coordinates to local coordinates. name="view" the view from which rect should be mapped name="rect" the rect to be mapped
MapToView ( QGraphicsView view, QRectF rect ) : QRect	Maps a QRectF from local coordinates to a view's coordinates. name="view" the view to which rect should be mapped name="rect" the rect to be mapped
Package ( ) : Package	Accessor for the associated Package object if any. Generally, only Plasmoids come in a Package.
PackageStructure ( ) : Plasma.PackageStructure
PluginName ( ) : string	Returns the plugin name for the applet
PopupPosition ( QSize s ) : QPoint	Reccomended position for a popup window like a menu or a tooltip given its size name="s" size of the popup
PopupPosition ( QSize s, Qt alignment ) : QPoint	name="s" size of the popup name="alignment" alignment of the popup, valid flags are Qt.AlignLeft, Qt.AlignRight and Qt.AlignCenter
ScreenRect ( ) : QRect	This method returns screen coordinates for the widget; this method can be somewhat expensive and should ONLY be called when screen coordinates are required. For example when positioning top level widgets on top of the view to create the appearance of unit. This should NOT be used for popups (@see popupPosition) or for normal widget use (use Plasma. widgets or QGraphicsProxyWidget instead).
SetAspectRatioMode ( Plasma arg1 ) : void	Sets the preferred aspect ratio mode for placement and resizing
SetAssociatedApplication ( string arg1 ) : void	Sets an application associated to this applet, that will be regarded as a full view of what is represented in the applet name="string" the name of the application. it can be a name understood by KService.ServiceByDesktopName (e.g. "konqueror") a command in $PATH or an absolute path to an executable
SetAssociatedApplicationUrls ( List urls ) : void	Sets a list of urls associated to this application, they will be used as parameters for the associated application name="urls"
SetBackgroundHints ( uint hints ) : void	Sets the BackgroundHints for this applet @see BackgroundHint name="hints" the BackgroundHint combination for this applet
SetCustomCategories ( List categories ) : void	Sets the list of custom categories that are used in addition to the default set of categories known to libplasma for Applets. @arg categories a list of categories
SetGlobalShortcut ( KShortcut shortcut ) : void	Sets the global shorcut to associate with this widget.
UpdateConstraints ( ) : void
UpdateConstraints ( uint constraints ) : void	Called when any of the geometry constraints have been updated. This method calls constraintsEvent, which may be reimplemented, once the Applet has been prepared for updating the constraints. name="constraints" the type of constraints that were updated
View ( ) : QGraphicsView	Returns the view this widget is visible on, or 0 if none can be found. @warning do NOT assume this will always return a view! a null view probably means that either plasma isn't finished loading, or your applet is on an activity that's not being shown anywhere.
aspectRatioMode ( ) : Plasma.AspectRatioMode
category ( KPluginInfo applet ) : string	Get the category of the given applet name="applet" a KPluginInfo object for the applet
category ( string appletName ) : string	Get the category of the given applet name="appletName" the name of the applet

Protected Methods

Method	Description
Applet ( Type dummy ) : System
CreateProxy ( ) : void
Extender ( ) : Extender
IsRegisteredAsDragHandle ( IQGraphicsItem item ) : bool	name="item" the item to look for if it is registered or not
RegisterAsDragHandle ( IQGraphicsItem item ) : void	Register the widgets that manage mouse clicks but you still want to be able to drag the applet around when holding the mouse pointer on that widget. Calling this results in an eventFilter being places on the widget. name="item" the item to watch for mouse move
SetConfigurationRequired ( bool needsConfiguring ) : void
SetConfigurationRequired ( bool needsConfiguring, string reason ) : void	When the applet needs to be configured before being usable, this method can be called to show a standard interface prompting the user to configure the applet name="needsConfiguring" true if the applet needs to be configured, or false if it doesn't name="reason" a translated message for the user explaining that the applet needs configuring; this should note what needs to be configured
SetFailedToLaunch ( bool failed ) : void
SetFailedToLaunch ( bool failed, string reason ) : void	Call this method when the applet fails to launch properly. An optional reason can be provided. Not that all children items will be deleted when this method is called. If you have pointers to these items, you will need to reset them after calling this method. name="failed" true when the applet failed, false when it succeeded name="reason" an optional reason to show the user why the applet failed to launch
ShowMessage ( QIcon icon, string message, uint buttons ) : void	Shows a message as an overlay of the applet: the message has an icon, text and (optional) buttons name="icon" the icon that will be shown name="message" the message string that will be shown. If the message is empty nothng will be shown and if there was a message already it will be hidden name="buttons" an OR combination of all the buttons needed
UnregisterAsDragHandle ( IQGraphicsItem item ) : void	Unregister a widget registered with registerAsDragHandle. name="item" the item to unregister

Private Methods

Method	Description
AddAssociatedWidget ( QWidget widget ) : void
Applet ( ) : System
ConfigChanged ( ) : void
ConstraintsEvent ( uint constraints ) : void
ContextualActions ( ) : List
CreateConfigurationInterface ( KConfigDialog parent ) : void
Destroy ( ) : void
EventFilter ( QObject o, QEvent e ) : bool
FlushPendingConstraintsEvents ( ) : void
FocusInEvent ( QFocusEvent arg1 ) : void
HoverEnterEvent ( QGraphicsSceneHoverEvent arg1 ) : void
HoverLeaveEvent ( QGraphicsSceneHoverEvent arg1 ) : void
Init ( ) : void
InitExtenderItem ( Plasma item ) : void
IsPopupShowing ( ) : bool
IsPublished ( ) : bool
ItemChange ( QGraphicsItem change, QVariant value ) : QVariant
Lower ( ) : void
MouseMoveEvent ( QGraphicsSceneMouseEvent arg1 ) : void
PaintInterface ( QPainter painter, QStyleOptionGraphicsItem option, QRect contentsRect ) : void
PaintWindowFrame ( QPainter painter, QStyleOptionGraphicsItem option, QWidget widget ) : void
Publish ( uint methods, string resourceName ) : void
Raise ( ) : void
RemoveAssociatedWidget ( QWidget widget ) : void
ResizeEvent ( QGraphicsSceneResizeEvent arg1 ) : void
Restore ( KConfigGroup group ) : void
RunAssociatedApplication ( ) : void
Save ( KConfigGroup group ) : void
SaveState ( KConfigGroup config ) : void
SceneEventFilter ( IQGraphicsItem watched, QEvent arg2 ) : bool
SetBusy ( bool busy ) : void
SetImmutability ( Plasma immutable ) : void
SetStatus ( Plasma stat ) : void
Shape ( ) : QPainterPath
ShowConfigurationInterface ( ) : void
SizeHint ( Qt which ) : QSizeF
SizeHint ( Qt which, QSizeF constraint ) : QSizeF
StartupArguments ( ) : List
Status ( ) : Plasma.ItemStatus
TimerEvent ( QTimerEvent arg1 ) : void
Unpublish ( ) : void
formFactor ( ) : Plasma.FormFactor
location ( ) : Plasma.Location
type ( ) : int

Method Details