View source for Plasma/DBusInterface

= D-Bus interface planning  =

== Preamble ==

'''ivan: Please don't edit this document until this notice is removed'''

== Summary  ==

This document serves for planning and revising the future plasma-desktop D-Bus interface. 

== Namespace  ==

The namespace to be used is org.kde.plasma-desktop with the path&nbsp;??? 

== Interface  ==

*Global functions (Corona)<br> 
**int numScreens()<br> 
**ImmutabilityType immutability() 
**void setImmutability(IT value) 
**''signal:'' immutabilityChanged(IT value) 
**void requestConfigSync()

*Activity functions 
**'''QStringList activities()'''<br>returns a list of activity IDs 
**'''QMap &lt;&nbsp;QString, QVariant &gt; activityInfo(QString id)'''<br>returns additional info about an activity - name, type, ... 
**'''QString currentActivity()'''<br>returns the ID of the current activity (in case of multi-monitor setups, returns the activity for the monitor that has the mouse cursor???) 
**'''QStringList currentActivities()'''<br>returns the list of open activities (in case of non-multi-monitor setups, returns just one item) 
**'''void setCurrentActivity(QString id)'''<br>switches to the specified activity 
**'''QString newActivity(QString name = "", QString type = "")'''<br>creates a new activity with the specified name and type, and returns the ID. If an argument is empty, the default values are used 
**'''void deleteActivity(QString id)'''<br>removes the specified activity 
**'''QMap &lt; QString, QVariant &gt; wallpaper()'''<br>returns the info about the active wallpaper plugin - name and serialized data 
*Containment functions 
**'''QStringList containments() '''<br>returns a list of unique containment IDs. 
**'''QString containmentForScreen(int screen, int desktop = -1)'''<br>returns the containment for the psecified screen 
**'''QMap &lt; QString, QVariant &gt;&nbsp;containmentInfo(QString id)'''<br>returns a map containing containment type, position...<br> 
**'''QString addContainment(QString type, QVariantList args)'''<br>creates a containment with the specified type (panel, ...) and returns its ID 
**'''void deleteContainment(QString id)'''<br>deletes the specified containment<br> 
*Applet functions 
**'''QStringList applets() '''<br>returns a list of unique applet IDs.<br> 
**'''QStringList appletsForContainment(QString containmentID)'''<br>returns a list of applet IDs that belong to the specified containment 
**'''QStringList appletsForType(QString type)'''<br>returns a list of applets of the specified type 
**'''QMap &lt;...&gt; appletInfo(QString id)'''<br>returns additional info about the specified applet 
** 
*Other functions