C# Class Plasma.Corona

Inheritance: Qyoto.QGraphicsScene, IDisposable

Public Methods

Method	Description
Action ( string name ) : Qyoto.QAction	Returns the QAction with the given name from our collection
Actions ( ) : List	Returns all the actions in our collection
AddAction ( string name ) : Kimono.KAction
AddAction ( string name, Qyoto.QAction action ) : void	Adds the action to our collection under the given name
AddContainment ( string name ) : Containment
AddContainment ( string name, List args ) : Containment	Adds a Containment to the Corona name="name" the plugin name for the containment, as given by KPluginInfo.PluginName(). If an empty string is passed in, the defalt containment plugin will be used (usually DesktopContainment). If the string literal "null" is passed in, then no plugin will be loaded and a simple Containment object will be created instead. name="args" argument list to pass to the containment
AddOffscreenWidget ( QGraphicsWidget widget ) : void	Adds a widget in the topleft quadrant in the scene. Widgets in the topleft quadrant are normally never shown unless you specifically aim a view at it, which makes it ideal for toplevel views etc. name="widget" the widget to add.
AddShortcuts ( Kimono.KActionCollection newShortcuts ) : void
AppletMimeType ( ) : string	The current mime type of Drag/Drop items.
ClearContainments ( ) : void	Clear the Corona from all applets.
Config ( ) : Kimono.KSharedConfig	Returns the config file used to store the configuration for this Corona
ContainmentActionsDefaults ( Plasma containmentType ) : ContainmentActionsPluginsConfig
ContainmentForScreen ( int screen ) : Containment
ContainmentForScreen ( int screen, int desktop ) : Containment	Returns the Containment, if any, for a given physical screen name="screen" number of the physical screen to locate name="desktop" the desktop) to locate; if < 0 then it will simply return the first Containment associated with screen
Containments ( ) : List
Corona ( ) : System
Corona ( QObject parent ) : System
Dispose ( ) : void
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
FreeEdges ( int screen ) : List	This method is useful in order to retrieve the list of available screen edges for panel type containments. name="screen" the id of the screen to look for free edges.
OffscreenWidgets ( ) : List
PopupPosition ( IQGraphicsItem item, Qyoto.QSize size ) : Qyoto.QPoint	Recommended position for a popup window like a menu or a tooltip given its size name="item" the item that the popup should appear adjacent to (an applet, say) name="size" size of the popup
PopupPosition ( IQGraphicsItem item, Qyoto.QSize size, Qt alignment ) : Qyoto.QPoint	name="item" the item that the popup should appear adjacent to (an applet, say) name="size" size of the popup name="alignment" alignment of the popup, valid flags are Qt.AlignLeft, Qt.AlignRight and Qt.AlignCenter
RemoveOffscreenWidget ( QGraphicsWidget widget ) : void	Removes a widget from the topleft quadrant in the scene. name="widget" the widget to remove.
SetAppletMimeType ( string mimetype ) : void	Sets the mimetype of Drag/Drop items. Default is text/x-plasmoidservicename
SetContainmentActionsDefaults ( Plasma containmentType, Plasma config ) : void
UpdateShortcuts ( ) : void

Protected Methods

Method	Description
AddContainmentDelayed ( string name ) : Containment
AddContainmentDelayed ( string name, List args ) : Containment	Loads a containment with delayed initialization, primarily useful for implementations of loadDefaultLayout. The caller is responsible for all initializating, saving and notification of a new containment. name="name" the plugin name for the containment, as given by KPluginInfo.PluginName(). If an empty string is passed in, the defalt containment plugin will be used (usually DesktopContainment). If the string literal "null" is passed in, then no plugin will be loaded and a simple Containment object will be created instead. name="args" argument list to pass to the containment
Corona ( Type dummy ) : System
CreateProxy ( ) : void

Private Methods

Method	Description
AvailableScreenRegion ( int id ) : QRegion
DragEnterEvent ( Qyoto.QGraphicsSceneDragDropEvent arg1 ) : void
DragLeaveEvent ( Qyoto.QGraphicsSceneDragDropEvent arg1 ) : void
DragMoveEvent ( Qyoto.QGraphicsSceneDragDropEvent arg1 ) : void
Immutability ( ) : Plasma.ImmutabilityType
InitializeLayout ( ) : void
InitializeLayout ( string config ) : void
LoadDefaultLayout ( ) : void
LoadLayout ( ) : void
LoadLayout ( string config ) : void
NumScreens ( ) : int
RequestConfigSync ( ) : void
RequireConfigSync ( ) : void
SaveLayout ( ) : void
SaveLayout ( string config ) : void
ScreenGeometry ( int id ) : Qyoto.QRect
SetImmutability ( Plasma immutable ) : void

Method Details

Action() public method

Returns the QAction with the given name from our collection

public Action ( string name ) : Qyoto.QAction
name	string
return	Qyoto.QAction

Actions() public method

Returns all the actions in our collection

public Actions ( ) : List
return	List

AddAction() public method

public AddAction ( string name ) : Kimono.KAction
name	string
return	Kimono.KAction

AddAction() public method

Adds the action to our collection under the given name

public AddAction ( string name, Qyoto.QAction action ) : void
name	string
action	Qyoto.QAction
return	void

AddContainment() public method

public AddContainment ( string name ) : Containment
name	string
return	Containment

AddContainment() public method

Adds a Containment to the Corona name="name" the plugin name for the containment, as given by KPluginInfo.PluginName(). If an empty string is passed in, the defalt containment plugin will be used (usually DesktopContainment). If the string literal "null" is passed in, then no plugin will be loaded and a simple Containment object will be created instead. name="args" argument list to pass to the containment

public AddContainment ( string name, List args ) : Containment
name	string
args	List
return	Containment

AddContainmentDelayed() protected method

protected AddContainmentDelayed ( string name ) : Containment
name	string
return	Containment

AddContainmentDelayed() protected method

Loads a containment with delayed initialization, primarily useful for implementations of loadDefaultLayout. The caller is responsible for all initializating, saving and notification of a new containment. name="name" the plugin name for the containment, as given by KPluginInfo.PluginName(). If an empty string is passed in, the defalt containment plugin will be used (usually DesktopContainment). If the string literal "null" is passed in, then no plugin will be loaded and a simple Containment object will be created instead. name="args" argument list to pass to the containment

protected AddContainmentDelayed ( string name, List args ) : Containment
name	string
args	List
return	Containment

AddOffscreenWidget() public method

Adds a widget in the topleft quadrant in the scene. Widgets in the topleft quadrant are normally never shown unless you specifically aim a view at it, which makes it ideal for toplevel views etc. name="widget" the widget to add.

public AddOffscreenWidget ( QGraphicsWidget widget ) : void
widget	Qyoto.QGraphicsWidget
return	void

AddShortcuts() public method

public AddShortcuts ( Kimono.KActionCollection newShortcuts ) : void
newShortcuts	Kimono.KActionCollection
return	void

AppletMimeType() public method

The current mime type of Drag/Drop items.

public AppletMimeType ( ) : string
return	string

ClearContainments() public method

Clear the Corona from all applets.

public ClearContainments ( ) : void
return	void

Config() public method

Returns the config file used to store the configuration for this Corona

public Config ( ) : Kimono.KSharedConfig
return	Kimono.KSharedConfig

ContainmentActionsDefaults() public method

public ContainmentActionsDefaults ( Plasma containmentType ) : ContainmentActionsPluginsConfig
containmentType	Plasma
return	ContainmentActionsPluginsConfig

ContainmentForScreen() public method

public ContainmentForScreen ( int screen ) : Containment
screen	int
return	Containment

ContainmentForScreen() public method

Returns the Containment, if any, for a given physical screen name="screen" number of the physical screen to locate name="desktop" the desktop) to locate; if < 0 then it will simply return the first Containment associated with screen

public ContainmentForScreen ( int screen, int desktop ) : Containment
screen	int
desktop	int
return	Containment

Containments() public method

public Containments ( ) : List
return	List

Corona() public method

public Corona ( ) : System
return	System

Corona() public method

public Corona ( QObject parent ) : System
parent	Qyoto.QObject
return	System

Corona() protected method

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

CreateProxy() protected method

protected CreateProxy ( ) : void
return	void

Dispose() public method

public Dispose ( ) : void
return	void

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

FreeEdges() public method

This method is useful in order to retrieve the list of available screen edges for panel type containments. name="screen" the id of the screen to look for free edges.

public FreeEdges ( int screen ) : List
screen	int
return	List

OffscreenWidgets() public method

public OffscreenWidgets ( ) : List
return	List

PopupPosition() public method

Recommended position for a popup window like a menu or a tooltip given its size name="item" the item that the popup should appear adjacent to (an applet, say) name="size" size of the popup

public PopupPosition ( IQGraphicsItem item, Qyoto.QSize size ) : Qyoto.QPoint
item	IQGraphicsItem
size	Qyoto.QSize
return	Qyoto.QPoint

PopupPosition() public method

name="item" the item that the popup should appear adjacent to (an applet, say) name="size" size of the popup name="alignment" alignment of the popup, valid flags are Qt.AlignLeft, Qt.AlignRight and Qt.AlignCenter

public PopupPosition ( IQGraphicsItem item, Qyoto.QSize size, Qt alignment ) : Qyoto.QPoint
item	IQGraphicsItem
size	Qyoto.QSize
alignment	Qyoto.Qt
return	Qyoto.QPoint

RemoveOffscreenWidget() public method

Removes a widget from the topleft quadrant in the scene. name="widget" the widget to remove.

public RemoveOffscreenWidget ( QGraphicsWidget widget ) : void
widget	Qyoto.QGraphicsWidget
return	void

SetAppletMimeType() public method

Sets the mimetype of Drag/Drop items. Default is text/x-plasmoidservicename

public SetAppletMimeType ( string mimetype ) : void
mimetype	string
return	void

SetContainmentActionsDefaults() public method

public SetContainmentActionsDefaults ( Plasma containmentType, Plasma config ) : void
containmentType	Plasma
config	Plasma
return	void

UpdateShortcuts() public method

public UpdateShortcuts ( ) : void
return	void