Plasma/libplasma2/API Review/Corona: Difference between revisions

Latest revision as of 10:31, 13 March 2013

as

Status	Action	Method
DONE	Keep	explicit Corona(QObject * parent);
DONE	Keep	~Corona();
DONE	Keep	Plasma::Package package() const;
DONE	Remove	void setAppletMimeType(const QString &mimetype);
DONE	Remove	QString appletMimeType();
DONE	Remove	QString defaultContainmentPlugin() const; -> will be in the package
DONE	Keep	QList<Containment*> containments() const;
DONE	Keep	KSharedConfig::Ptr config() const;
IN PROGRESS	Rename	Containment *addContainment(const QString &name, const QVariantList &args ); ->createContainment, remove args
DONE	Keep	Containment *containmentForScreen(int screen) const;
DONE	Remove	Containment *containmentForScreen(int screen, const QString &defaultPluginIfNonExistent, const QVariantList &defaultArgs );
DONE	Keep	virtual int numScreens() const;
DONE	Keep	virtual QRect screenGeometry(int id) const;
DONE	Keep	virtual QRegion availableScreenRegion(int id) const;
DONE	Keep	QList<Plasma::Location> freeEdges(int screen) const;
DONE	Remove	void updateShortcuts();-> Only used internally, don’t expose
DONE	Remove	void addShortcuts(KActionCollection newShortcuts); also remove: CoronaPrivate::actionCollections * "configure shortcuts" actions * CoronaPrivate::showShortcutConfig
DONE	Keep	KActionCollection* actions() const;
DONE	Remove	void setContainmentActionsDefault(Plasma::ContainmentType containmentType, QEventQString *trigger, const QString &name);
DONE	Remove	QString containmentActionsDefault(ContainmentType containmentType, QEvent *triggerQString &trigger) const;
DONE	Rename	QHash<QString, QString>containmentActionsDefaults(ContainmentType containmentType) const; ->defaultContainmentActions() and reads what’s in the package()
DONE	Remove	void setDialogManager(AbstractDialogManager *manager); Remove AbstractDialogManager class
DONE	Remove	AbstractDialogManager *dialogManager();
DONE	Remove	QString preferredToolBoxPlugin(const ContainmentType type) const; -> into the package()
DONE	Keep	QList<Plasma::Containment *> importLayout(const KConfigGroup &config);
DONE	Keep	void exportLayout(KConfigGroup &config, QList<Containment*> containments);
DONE	Remove	SLOT void initializeLayout(const QString &config );
DONE	Keep	SLOT void loadLayout(const QString &config );
DONE	Keep	SLOT void saveLayout(const QString &config ) const;
DONE	Keep	SLOT ImmutabilityType immutability() const;
DONE	Keep	SLOT void setImmutability(const ImmutabilityType immutable);
DONE	Keep	SLOT void requestConfigSync();
DONE	Keep	SLOT void requireConfigSync();
DONE	Keep	SIGNAL void containmentAdded(Plasma::Containment *containment);
DONE	Keep	SIGNAL void screenOwnerChanged(int wasScreen, int isScreen, Plasma::Containment *containment);
DONE	Remove	SIGNAL void releaseVisualFocus();
DONE	Keep	SIGNAL void configSynced(); ->remains, still a workaround though
DONE	Keep	SIGNAL void availableScreenRegionChanged();
DONE	Keep	SIGNAL void immutabilityChanged(Plasma::ImmutabilityType immutability);
DONE	Remove	SIGNAL void shortcutsChanged();
DONE	Keep	protected virtual void loadDefaultLayout();
DONE	Remove	protected void setPreferredToolBoxPlugin(const ContainmentType type, const QString &plugin); -> read from package()
DONE	Remove	protected void setDefaultContainmentPlugin(const QString &name);-> goes in package(), will be done for containment type

@@ Line 1: / Line 1: @@
-= Methods =
-* Containment *containmentForScreen(int screen, int desktop = -1) const; Remove desktop?
-* Containment *containmentForScreen(int screen, int desktop, const QString &defaultPluginIfNonExistent,  const QVariantList &defaultArgs = QVariantList()); Remove desktop?
-Still necassary?
+{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
-* void setAppletMimeType(const QString &mimetype);
+|- style="background: rgb(236, 236, 236) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; white-space: nowrap;"
-* QString appletMimeType();
+as
-* void setDialogManager(AbstractDialogManager *manager); DialogManager was fow main windows of config uis. If all config is going to be qml, this could go (alternative is that we do an AbstractDialogManager that is a declarative view: possible as well).
+! Status
-* AbstractDialogManager *dialogManager();
+! Action
-* QString preferredToolBoxPlugin(const Containment::Type type) const; Toolboxes, instead of plugin may come from the only corona QML package.
+! Method
-void setPreferredToolBoxPlugin(const Containment::Type type, const QString &plugin);
-*  void setDefaultContainmentPlugin(const QString &name);  Default containment plugin also told in the one Corona QML package?
-* void requestConfigSync(); Ugly api: are requestConfigSync and requireConfigSync still required both?
-* void requireConfigSync();
-=Signals =
+{{FeatureDone|Keep| explicit Corona(QObject * parent);}}
-* void releaseVisualFocus();
+{{FeatureDone|Keep| ~Corona();}}
+{{FeatureDone|Keep| Plasma::Package package() const;}}
+{{FeatureDone|Remove| void setAppletMimeType(const QString &mimetype);}}
+{{FeatureDone|Remove| QString appletMimeType();}}
+{{FeatureDone|Remove| QString defaultContainmentPlugin() const; -> will be in the package}}
+{{FeatureDone|Keep| QList<Containment*> containments() const;}}
+{{FeatureDone|Keep|KSharedConfig::Ptr config() const;}}
+{{FeatureInProgress|Rename|Containment *addContainment(const QString &name, const QVariantList &args ); ->createContainment, remove args}}
+{{FeatureDone|Keep|Containment *containmentForScreen(int screen) const;}}
+{{FeatureDone|Remove|Containment *containmentForScreen(int screen, const QString &defaultPluginIfNonExistent, const QVariantList &defaultArgs );}}
+{{FeatureDone|Keep|virtual int numScreens() const;}}
+{{FeatureDone|Keep|virtual QRect screenGeometry(int id) const;}}
+{{FeatureDone|Keep|virtual QRegion availableScreenRegion(int id) const;}}
+{{FeatureDone|Keep|QList<Plasma::Location> freeEdges(int screen) const;}}
+{{FeatureDone|Remove| void updateShortcuts();-> Only used internally, don’t expose}}
+{{FeatureDone|Remove| void addShortcuts(KActionCollection *newShortcuts);  also remove:
+        * CoronaPrivate::actionCollections
+        * "configure shortcuts" actions
+        * CoronaPrivate::showShortcutConfig }}
+{{FeatureDone|Keep|KActionCollection* actions() const;}}
+{{FeatureDone|Remove| void setContainmentActionsDefault(Plasma::ContainmentType containmentType, QEventQString *trigger, const QString &name);}}
+ {{FeatureDone|Remove| QString containmentActionsDefault(ContainmentType containmentType, QEvent *triggerQString &trigger) const;}}
+ {{FeatureDone|Rename| QHash<QString, QString>containmentActionsDefaults(ContainmentType containmentType) const; ->defaultContainmentActions() and reads what’s in the package()}}
+ {{FeatureDone|Remove|  void setDialogManager(AbstractDialogManager *manager); Remove AbstractDialogManager class}}
+ {{FeatureDone|Remove| AbstractDialogManager *dialogManager();}}
+ {{FeatureDone|Remove| QString preferredToolBoxPlugin(const ContainmentType type) const; -> into the package()}}
+{{FeatureDone|Keep|QList<Plasma::Containment *> importLayout(const KConfigGroup &config);}}
+{{FeatureDone|Keep|void exportLayout(KConfigGroup &config, QList<Containment*> containments);}}{{FeatureDone|Remove| SLOT void initializeLayout(const QString &config );}}
+{{FeatureDone|Keep| SLOT void loadLayout(const QString &config );}}
+{{FeatureDone|Keep| SLOT void saveLayout(const QString &config ) const;}}
+{{FeatureDone|Keep| SLOT ImmutabilityType immutability() const;}}
+{{FeatureDone|Keep| SLOT void setImmutability(const ImmutabilityType immutable);}}
+{{FeatureDone|Keep| SLOT void requestConfigSync();}}
+{{FeatureDone|Keep| SLOT  void requireConfigSync();}}
+{{FeatureDone|Keep| SIGNAL void containmentAdded(Plasma::Containment *containment);}}
+{{FeatureDone|Keep| SIGNAL void screenOwnerChanged(int wasScreen, int isScreen, Plasma::Containment *containment);}}
+{{FeatureDone|Remove| SIGNAL void releaseVisualFocus();}}
+{{FeatureDone|Keep| SIGNAL void configSynced(); ->remains, still a workaround though}}
+{{FeatureDone|Keep| SIGNAL void availableScreenRegionChanged();}}
+{{FeatureDone|Keep| SIGNAL void immutabilityChanged(Plasma::ImmutabilityType immutability);}}
+{{FeatureDone|Remove| SIGNAL void shortcutsChanged();}}
+{{FeatureDone|Keep| protected virtual void loadDefaultLayout();}}
+{{FeatureDone|Remove| protected  void setPreferredToolBoxPlugin(const ContainmentType type, const QString &plugin); -> read from package()}}
+{{FeatureDone|Remove| protected void setDefaultContainmentPlugin(const QString &name);-> goes in package(), will be done for containment type}}
+|}