C# Class Plasma.ContainmentActions

Inheritance: Qyoto.QObject, IDisposable
Mostra file Open project: 0xd34df00d/Qross

Private Properties

Property Type Description
ConfigurationAccepted void
ContainmentActions System
ContextEvent void
ContextualActions List
CreateConfigurationInterface Qyoto.QWidget
Event bool
Init void
Save void

Public Methods

Method Description
ConfigurationRequired ( ) : bool
ContainmentActions ( QObject parent ) : System Default constructor for an empty or null containmentactions
ContainmentActions ( 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 one element: the KService service ID for the desktop entry. name="parent" a QObject parent; you probably want to pass in 0 name="args" a list of strings containing one entry: the service id
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
Dispose ( ) : void
EventToString ( Qyoto.QEvent arg1 ) : string Turns a mouse or wheel event into a string suitable for a ContainmentActions
IsInitialized ( ) : bool
ListContainmentActionsInfo ( ) : List Returns a list of all known containmentactions plugins.
Load ( Plasma parent, Kimono.KPluginInfo info ) : ContainmentActions
Load ( Plasma parent, Kimono.KPluginInfo info, List args ) : ContainmentActions Attempts to load a containmentactions Returns a pointer to the containmentactions if successful. The caller takes responsibility for the containmentactions, including deleting it when no longer needed. name="parent" the parent containment. Required; if you send null you'll get back null. name="info" KPluginInfo object for the desired containmentactions name="args" to send the containmentactions extra arguments
Load ( Plasma parent, string name ) : ContainmentActions
Load ( Plasma parent, string name, List args ) : ContainmentActions Attempts to load a containmentactions Returns a pointer to the containmentactions if successful. The caller takes responsibility for the containmentactions, including deleting it when no longer needed. name="parent" the parent containment. Required; if you send null you'll get back null. name="name" the plugin name, as returned by KPluginInfo.PluginName() name="args" to send the containmentactions extra arguments
PackageStructure ( ) : Plasma.PackageStructure Returns the Package specialization for containmentactions.
Restore ( Kimono.KConfigGroup config ) : void This method should be called once the plugin is loaded or settings are changed. name="config" Config group to load settings

Protected Methods

Method Description
Containment ( ) : Containment
ContainmentActions ( Type dummy ) : System
CreateProxy ( ) : void
Paste ( QPointF scenePos, Qyoto.QPoint screenPos ) : void pastes the clipboard at a given location
SetConfigurationRequired ( ) : void
SetConfigurationRequired ( bool needsConfiguring ) : void When the containmentactions needs to be configured before being usable, this method can be called to denote that action is required name="needsConfiguring" true if the applet needs to be configured, or false if it doesn't

Private Methods

Method Description
ConfigurationAccepted ( ) : void
ContainmentActions ( ) : System
ContextEvent ( Qyoto.QEvent arg1 ) : void
ContextualActions ( ) : List
CreateConfigurationInterface ( QWidget parent ) : QWidget
Event ( Qyoto.QEvent e ) : bool
Init ( Kimono.KConfigGroup config ) : void
Save ( Kimono.KConfigGroup config ) : void

Method Details

ConfigurationRequired() public method

public ConfigurationRequired ( ) : bool
return bool

Containment() protected method

protected Containment ( ) : Containment
return Containment

ContainmentActions() public method

Default constructor for an empty or null containmentactions
public ContainmentActions ( QObject parent ) : System
parent Qyoto.QObject
return System

ContainmentActions() public method

This constructor is to be used with the plugin loading systems found in KPluginInfo and KService. The argument list is expected to have one element: the KService service ID for the desktop entry. name="parent" a QObject parent; you probably want to pass in 0 name="args" a list of strings containing one entry: the service id
public ContainmentActions ( QObject parent, List args ) : System
parent Qyoto.QObject
args List
return System

ContainmentActions() protected method

protected ContainmentActions ( Type dummy ) : System
dummy System.Type
return System

CreateProxy() protected method

protected CreateProxy ( ) : void
return void

DataEngine() public method

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
public DataEngine ( string name ) : DataEngine
name string
return DataEngine

Dispose() public method

public Dispose ( ) : void
return void

EventToString() public static method

Turns a mouse or wheel event into a string suitable for a ContainmentActions
public static EventToString ( Qyoto.QEvent arg1 ) : string
arg1 Qyoto.QEvent
return string

IsInitialized() public method

public IsInitialized ( ) : bool
return bool

ListContainmentActionsInfo() public static method

Returns a list of all known containmentactions plugins.
public static ListContainmentActionsInfo ( ) : List
return List

Load() public static method

public static Load ( Plasma parent, Kimono.KPluginInfo info ) : ContainmentActions
parent Plasma
info Kimono.KPluginInfo
return ContainmentActions

Load() public static method

Attempts to load a containmentactions Returns a pointer to the containmentactions if successful. The caller takes responsibility for the containmentactions, including deleting it when no longer needed. name="parent" the parent containment. Required; if you send null you'll get back null. name="info" KPluginInfo object for the desired containmentactions name="args" to send the containmentactions extra arguments
public static Load ( Plasma parent, Kimono.KPluginInfo info, List args ) : ContainmentActions
parent Plasma
info Kimono.KPluginInfo
args List
return ContainmentActions

Load() public static method

public static Load ( Plasma parent, string name ) : ContainmentActions
parent Plasma
name string
return ContainmentActions

Load() public static method

Attempts to load a containmentactions Returns a pointer to the containmentactions if successful. The caller takes responsibility for the containmentactions, including deleting it when no longer needed. name="parent" the parent containment. Required; if you send null you'll get back null. name="name" the plugin name, as returned by KPluginInfo.PluginName() name="args" to send the containmentactions extra arguments
public static Load ( Plasma parent, string name, List args ) : ContainmentActions
parent Plasma
name string
args List
return ContainmentActions

PackageStructure() public static method

Returns the Package specialization for containmentactions.
public static PackageStructure ( ) : Plasma.PackageStructure
return Plasma.PackageStructure

Paste() protected method

pastes the clipboard at a given location
protected Paste ( QPointF scenePos, Qyoto.QPoint screenPos ) : void
scenePos Qyoto.QPointF
screenPos Qyoto.QPoint
return void

Restore() public method

This method should be called once the plugin is loaded or settings are changed. name="config" Config group to load settings
public Restore ( Kimono.KConfigGroup config ) : void
config Kimono.KConfigGroup
return void

SetConfigurationRequired() protected method

protected SetConfigurationRequired ( ) : void
return void

SetConfigurationRequired() protected method

When the containmentactions needs to be configured before being usable, this method can be called to denote that action is required name="needsConfiguring" true if the applet needs to be configured, or false if it doesn't
protected SetConfigurationRequired ( bool needsConfiguring ) : void
needsConfiguring bool
return void