C# Class Plasma.Containment

Inheritance: Applet, IDisposable
ファイルを表示 Open project: 0xd34df00d/Qross

Public Methods

Method Description
Activity ( ) : string
AddApplet ( string name ) : Applet
AddApplet ( string name, List args ) : Applet
AddApplet ( string name, List args, Qyoto.QRectF geometry ) : Applet Adds an applet to this Containment name="name" the plugin name for the applet, as given by KPluginInfo.PluginName() name="args" argument list to pass to the plasmoid name="geometry" where to place the applet, or to auto-place it if an invalid is provided
AddApplet ( Plasma applet ) : void
AddApplet ( Plasma applet, QPointF pos ) : void
AddApplet ( Plasma applet, QPointF pos, bool dontInit ) : void Add an existing applet to this Containment If dontInit is true, the pending constraints are not flushed either. So it is your responsibility to call both init() and flushPendingConstraints() on the applet. name="applet" the applet that should be added name="pos" the containment-relative position name="dontInit" if true, init() will not be called on the applet
AddToolBoxAction ( Qyoto.QAction action ) : void Add an action to the toolbox
Applets ( ) : List
ClearApplets ( ) : void Removes all applets from this Containment
CloseToolBox ( ) : void Closes Containment's toolbox
Containment ( IQGraphicsItem parent ) : System
Containment ( IQGraphicsItem parent, string serviceId ) : System
Containment ( IQGraphicsItem parent, string serviceId, uint containmentId ) : 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="containmentId" a unique id used to differentiate between multiple instances of the same Applet type
Containment ( 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
ContainmentActions ( string trigger ) : string
ContainmentActionsTriggers ( ) : List
ContainmentType ( ) : Plasma.Containment.TypeOf Returns the type of containment
Corona ( ) : Corona Returns the Corona (if any) that this Containment is hosted by
Desktop ( ) : int
Dispose ( ) : void
DrawWallpaper ( ) : bool Return whether wallpaper is painted or not.
EnableAction ( string name, bool enable ) : void convenience function - enables or disables an action by name name="name" the name of the action in our collection name="enable" true to enable, false to disable
ListContainmentTypes ( ) : List
ListContainments ( ) : List
ListContainments ( string category ) : List
ListContainments ( string category, string parentApp ) : List Returns a list of all known containments. name="category" Only containments matching this category will be returned. Useful in conjunction with knownCategories. If "Miscellaneous" 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.
ListContainmentsForMimetype ( string mimetype ) : List Returns a list of all known applets associated with a certain mimetype
ListContainmentsOfType ( string type ) : List
ListContainmentsOfType ( string type, string category ) : List
ListContainmentsOfType ( string type, string category, string parentApp ) : List Returns a list of all known Containments that match the parameters. name="type" Only Containments with this string in X-Plasma-ContainmentCategories in their .desktop files will be returned. Common values are panel and desktop name="category" Only applets matchin this category will be returned. Useful in conjunction with knownCategories. If "Miscellaneous" 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.
OpenToolBox ( ) : void Open the Containment's toolbox
RemoveToolBoxAction ( Qyoto.QAction action ) : void Remove an action from the toolbox
Screen ( ) : int
SetActivity ( string activity ) : void Sets the current activity by name name="activity" the name of the activity; if it doesn't exist in the semantic store, it will be created.
SetContainmentActions ( string trigger, string pluginName ) : void Sets a containmentactions plugin. name="trigger" the mouse button (and optional modifier) to associate the plugin with name="pluginName" the name of the plugin to attempt to load. blank = set no plugin.
SetScreen ( int screen ) : void
SetScreen ( int screen, int desktop ) : void Sets the physical screen this Containment is associated with. name="screen" the screen number this containment is the desktop for, or -1 if it is not serving as the desktop for any screen name="desktop" the desktop to also associate this this screen with
SetToolBoxOpen ( bool open ) : void Sets the open or closed state of the Containment's toolbox @arg open true to open the ToolBox, false to close it
SetWallpaper ( string pluginName ) : void
SetWallpaper ( string pluginName, string mode ) : void Sets wallpaper plugin. name="pluginName" the name of the wallpaper to attempt to load name="mode" optional mode or the wallpaper plugin (e.g. "Slideshow"). These values are pugin specific and enumerated in the plugin's .desktop file.
ShowContextMenu ( QPointF containmentPos, QPoint screenPos ) : void Shows the context menu for the containment directly, bypassing Applets altogether.
Wallpaper ( ) : Plasma.Wallpaper Return wallpaper plugin.

Protected Methods

Method Description
Containment ( Type dummy ) : System
CreateProxy ( ) : void
SetContainmentType ( Plasma type ) : void Sets the type of this containment.
SetDrawWallpaper ( bool drawWallpaper ) : void Sets whether wallpaper is painted or not.
SetToolBox ( Plasma toolBox ) : void Sets a custom ToolBox if there was an old one it will be deleted and the new one won't have any actions in it name="item" the new toolbox item
ToolBox ( ) : AbstractToolBox

Private Methods

Method Description
AddAssociatedWidget ( QWidget widget ) : void
AddSiblingContainment ( ) : void
Containment ( ) : System
ContextMenuEvent ( Qyoto.QGraphicsSceneContextMenuEvent arg1 ) : void
Destroy ( ) : void
Destroy ( bool confirm ) : void
DragEnterEvent ( Qyoto.QGraphicsSceneDragDropEvent arg1 ) : void
DragLeaveEvent ( Qyoto.QGraphicsSceneDragDropEvent arg1 ) : void
DragMoveEvent ( Qyoto.QGraphicsSceneDragDropEvent arg1 ) : void
DropEvent ( Qyoto.QGraphicsSceneDragDropEvent arg1 ) : void
FocusNextApplet ( ) : void
FocusPreviousApplet ( ) : void
Init ( ) : void
ItemChange ( QGraphicsItem change, Qyoto.QVariant value ) : Qyoto.QVariant
KeyPressEvent ( Qyoto.QKeyEvent arg1 ) : void
MouseMoveEvent ( Qyoto.QGraphicsSceneMouseEvent arg1 ) : void
MousePressEvent ( Qyoto.QGraphicsSceneMouseEvent arg1 ) : void
MouseReleaseEvent ( Qyoto.QGraphicsSceneMouseEvent arg1 ) : void
RemoveAssociatedWidget ( QWidget widget ) : void
ResizeEvent ( Qyoto.QGraphicsSceneResizeEvent arg1 ) : void
Restore ( Kimono.KConfigGroup group ) : void
RestoreContents ( Kimono.KConfigGroup group ) : void
Save ( Kimono.KConfigGroup group ) : void
SaveContents ( Kimono.KConfigGroup group ) : void
SceneEventFilter ( IQGraphicsItem watched, Qyoto.QEvent arg2 ) : bool
SetFormFactor ( Plasma formFactor ) : void
SetLocation ( Plasma location ) : void
ShowConfigurationInterface ( ) : void
ShowDropZone ( QPoint pos ) : void
WheelEvent ( QGraphicsSceneWheelEvent arg1 ) : void

Method Details

Activity() public method

public Activity ( ) : string
return string

AddApplet() public method

public AddApplet ( string name ) : Applet
name string
return Applet

AddApplet() public method

public AddApplet ( string name, List args ) : Applet
name string
args List
return Applet

AddApplet() public method

Adds an applet to this Containment name="name" the plugin name for the applet, as given by KPluginInfo.PluginName() name="args" argument list to pass to the plasmoid name="geometry" where to place the applet, or to auto-place it if an invalid is provided
public AddApplet ( string name, List args, Qyoto.QRectF geometry ) : Applet
name string
args List
geometry Qyoto.QRectF
return Applet

AddApplet() public method

public AddApplet ( Plasma applet ) : void
applet Plasma
return void

AddApplet() public method

public AddApplet ( Plasma applet, QPointF pos ) : void
applet Plasma
pos Qyoto.QPointF
return void

AddApplet() public method

Add an existing applet to this Containment If dontInit is true, the pending constraints are not flushed either. So it is your responsibility to call both init() and flushPendingConstraints() on the applet. name="applet" the applet that should be added name="pos" the containment-relative position name="dontInit" if true, init() will not be called on the applet
public AddApplet ( Plasma applet, QPointF pos, bool dontInit ) : void
applet Plasma
pos Qyoto.QPointF
dontInit bool
return void

AddToolBoxAction() public method

Add an action to the toolbox
public AddToolBoxAction ( Qyoto.QAction action ) : void
action Qyoto.QAction
return void

Applets() public method

public Applets ( ) : List
return List

ClearApplets() public method

Removes all applets from this Containment
public ClearApplets ( ) : void
return void

CloseToolBox() public method

Closes Containment's toolbox
public CloseToolBox ( ) : void
return void

Containment() public method

public Containment ( IQGraphicsItem parent ) : System
parent IQGraphicsItem
return System

Containment() public method

public Containment ( IQGraphicsItem parent, string serviceId ) : System
parent IQGraphicsItem
serviceId string
return System

Containment() public method

name="parent" the QGraphicsItem this applet is parented to name="serviceId" the name of the .desktop file containing the information about the widget name="containmentId" a unique id used to differentiate between multiple instances of the same Applet type
public Containment ( IQGraphicsItem parent, string serviceId, uint containmentId ) : System
parent IQGraphicsItem
serviceId string
containmentId uint
return System

Containment() 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 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
public Containment ( QObject parent, List args ) : System
parent Qyoto.QObject
args List
return System

Containment() protected method

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

ContainmentActions() public method

public ContainmentActions ( string trigger ) : string
trigger string
return string

ContainmentActionsTriggers() public method

public ContainmentActionsTriggers ( ) : List
return List

ContainmentType() public method

Returns the type of containment
public ContainmentType ( ) : Plasma.Containment.TypeOf
return Plasma.Containment.TypeOf

Corona() public method

Returns the Corona (if any) that this Containment is hosted by
public Corona ( ) : Corona
return Corona

CreateProxy() protected method

protected CreateProxy ( ) : void
return void

Desktop() public method

public Desktop ( ) : int
return int

Dispose() public method

public Dispose ( ) : void
return void

DrawWallpaper() public method

Return whether wallpaper is painted or not.
public DrawWallpaper ( ) : bool
return bool

EnableAction() public method

convenience function - enables or disables an action by name name="name" the name of the action in our collection name="enable" true to enable, false to disable
public EnableAction ( string name, bool enable ) : void
name string
enable bool
return void

ListContainmentTypes() public static method

public static ListContainmentTypes ( ) : List
return List

ListContainments() public static method

public static ListContainments ( ) : List
return List

ListContainments() public static method

public static ListContainments ( string category ) : List
category string
return List

ListContainments() public static method

Returns a list of all known containments. name="category" Only containments matching this category will be returned. Useful in conjunction with knownCategories. If "Miscellaneous" 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.
public static ListContainments ( string category, string parentApp ) : List
category string
parentApp string
return List

ListContainmentsForMimetype() public static method

Returns a list of all known applets associated with a certain mimetype
public static ListContainmentsForMimetype ( string mimetype ) : List
mimetype string
return List

ListContainmentsOfType() public static method

public static ListContainmentsOfType ( string type ) : List
type string
return List

ListContainmentsOfType() public static method

public static ListContainmentsOfType ( string type, string category ) : List
type string
category string
return List

ListContainmentsOfType() public static method

Returns a list of all known Containments that match the parameters. name="type" Only Containments with this string in X-Plasma-ContainmentCategories in their .desktop files will be returned. Common values are panel and desktop name="category" Only applets matchin this category will be returned. Useful in conjunction with knownCategories. If "Miscellaneous" 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.
public static ListContainmentsOfType ( string type, string category, string parentApp ) : List
type string
category string
parentApp string
return List

OpenToolBox() public method

Open the Containment's toolbox
public OpenToolBox ( ) : void
return void

RemoveToolBoxAction() public method

Remove an action from the toolbox
public RemoveToolBoxAction ( Qyoto.QAction action ) : void
action Qyoto.QAction
return void

Screen() public method

public Screen ( ) : int
return int

SetActivity() public method

Sets the current activity by name name="activity" the name of the activity; if it doesn't exist in the semantic store, it will be created.
public SetActivity ( string activity ) : void
activity string
return void

SetContainmentActions() public method

Sets a containmentactions plugin. name="trigger" the mouse button (and optional modifier) to associate the plugin with name="pluginName" the name of the plugin to attempt to load. blank = set no plugin.
public SetContainmentActions ( string trigger, string pluginName ) : void
trigger string
pluginName string
return void

SetContainmentType() protected method

Sets the type of this containment.
protected SetContainmentType ( Plasma type ) : void
type Plasma
return void

SetDrawWallpaper() protected method

Sets whether wallpaper is painted or not.
protected SetDrawWallpaper ( bool drawWallpaper ) : void
drawWallpaper bool
return void

SetScreen() public method

public SetScreen ( int screen ) : void
screen int
return void

SetScreen() public method

Sets the physical screen this Containment is associated with. name="screen" the screen number this containment is the desktop for, or -1 if it is not serving as the desktop for any screen name="desktop" the desktop to also associate this this screen with
public SetScreen ( int screen, int desktop ) : void
screen int
desktop int
return void

SetToolBox() protected method

Sets a custom ToolBox if there was an old one it will be deleted and the new one won't have any actions in it name="item" the new toolbox item
protected SetToolBox ( Plasma toolBox ) : void
toolBox Plasma
return void

SetToolBoxOpen() public method

Sets the open or closed state of the Containment's toolbox @arg open true to open the ToolBox, false to close it
public SetToolBoxOpen ( bool open ) : void
open bool
return void

SetWallpaper() public method

public SetWallpaper ( string pluginName ) : void
pluginName string
return void

SetWallpaper() public method

Sets wallpaper plugin. name="pluginName" the name of the wallpaper to attempt to load name="mode" optional mode or the wallpaper plugin (e.g. "Slideshow"). These values are pugin specific and enumerated in the plugin's .desktop file.
public SetWallpaper ( string pluginName, string mode ) : void
pluginName string
mode string
return void

ShowContextMenu() public method

Shows the context menu for the containment directly, bypassing Applets altogether.
public ShowContextMenu ( QPointF containmentPos, QPoint screenPos ) : void
containmentPos QPointF
screenPos QPoint
return void

ToolBox() protected method

protected ToolBox ( ) : AbstractToolBox
return AbstractToolBox

Wallpaper() public method

Return wallpaper plugin.
public Wallpaper ( ) : Plasma.Wallpaper
return Plasma.Wallpaper