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

From KDE Community Wiki
(Created page with "= Related changes in ContainmentPrivate = localActionPlugins and globalActionsPlugins get removed, only plugin instances will stay here. all bookeeping of containmentActions w...")
 
 
(18 intermediate revisions by the same user not shown)
Line 1: Line 1:
= Related changes in ContainmentPrivate =
= Related Class: ContainmentActionsPluginConfig =
Remove this class, that should never be used by library users anyways: merge functionality in Corona
 
= Related Class: ContainmentPrivate =
localActionPlugins and globalActionsPlugins get removed, only plugin instances will stay here.
localActionPlugins and globalActionsPlugins get removed, only plugin instances will stay here.
all bookeeping of containmentActions will be kept in Corona, indicized by containmentType
all bookeeping of containmentActions will be kept in Corona, indicized by containmentType
Line 12: Line 15:
{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- 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;"
|- 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;"
as
 
! Status  
! Status  
! Action  
! Action  
Line 20: Line 23:
{{FeatureDone|Keep| ~ContainmentActions();}}
{{FeatureDone|Keep| ~ContainmentActions();}}
{{FeatureDone|Keep| protected ContainmentActions(QObject *parent, const QVariantList &args);}}
{{FeatureDone|Keep| protected ContainmentActions(QObject *parent, const QVariantList &args);}}
|}
=Actions=
{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- 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;"
! Status
! Action
! Method
{{FeatureDone|Remove|virtual QAction *triggerableContextAction();}}
{{FeatureDone|Rename| void performNext() -> performNextAction()}}
{{FeatureDone|Rename| void performPrevious() -> performPreviousAction()}}
{{FeatureDone|Keep| contextualActions() -> not invokable anymore}}
|}
=Bookeeping=
{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- 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;"
! Status
! Action
! Method
{{FeatureDone|Remove| void setSource(ContainmentActionsSource source);}}
{{FeatureDone|Remove| ContainmentActionsSource source() const;}}
{{FeatureDone|Remove| init()}}
{{FeatureDone|Remove| configurationRequired()}}
{{FeatureDone|Remove| protected setConfigurationRequired(bool)}}
{{FeatureDone|Remove| signal configurationrequiredChanged()}}
{{FeatureDone|Remove| dataEngine()}}
{{FeatureDone|Keep| void setContainment(Containment *newContainment);}}
{{FeatureDone|Keep| Containment *containment();}}
{{FeatureDone|Keep| static QString eventToString(QEvent *event); check if can be removed, probably not}}
|}
=Metadata=
{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- 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;"
! Status
! Action
! Method
{{FeatureDone|Remove| QString name() const;}}
{{FeatureDone|Remove| QString pluginName() const;}}
{{FeatureDone|Remove| QString icon() const;}}
{{FeatureDone|Add| KPluginInfo pluginInfo() const;}}
|}
=Configuration=
{| cellspacing="0" cellpadding="5" border="1" style="border: 1px solid gray; border-collapse: collapse; text-align: left; width: 100%;" class="sortable"
|- 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;"
! Status
! Action
! Method
{{FeatureDone|Keep| config()}}
{{FeatureDone|Virtual| void restore(const KConfigGroup &config);}}
{{FeatureDone|Keep| virtual void save(KConfigGroup &config);}}
{{FeatureTodo|Change Signature| virtual QWidget *createConfigurationInterface(QWidget *parent); -> becomes void createConfigurationInterface(QWindow *parent)}}
{{FeatureDone|Remove|virtual void configurationAccepted();}}


|}
|}

Latest revision as of 10:21, 26 February 2013

Related Class: ContainmentActionsPluginConfig

Remove this class, that should never be used by library users anyways: merge functionality in Corona

Related Class: ContainmentPrivate

localActionPlugins and globalActionsPlugins get removed, only plugin instances will stay here. all bookeeping of containmentActions will be kept in Corona, indicized by containmentType

Properties

All properties and invokables are removed.

Enums

ContainmentActionsSource goes, as the concept of source in general.

Constructors

Status Action Method
DONE Keep explicit ContainmentActions(QObject * parent);
DONE Keep ~ContainmentActions();
DONE Keep protected ContainmentActions(QObject *parent, const QVariantList &args);


Actions

Status Action Method
DONE Remove virtual QAction *triggerableContextAction();
DONE Rename void performNext() -> performNextAction()
DONE Rename void performPrevious() -> performPreviousAction()
DONE Keep contextualActions() -> not invokable anymore


Bookeeping

Status Action Method
DONE Remove void setSource(ContainmentActionsSource source);
DONE Remove ContainmentActionsSource source() const;
DONE Remove init()
DONE Remove configurationRequired()
DONE Remove protected setConfigurationRequired(bool)
DONE Remove signal configurationrequiredChanged()
DONE Remove dataEngine()
DONE Keep void setContainment(Containment *newContainment);
DONE Keep Containment *containment();
DONE Keep static QString eventToString(QEvent *event); check if can be removed, probably not

Metadata

Status Action Method
DONE Remove QString name() const;
DONE Remove QString pluginName() const;
DONE Remove QString icon() const;
DONE Add KPluginInfo pluginInfo() const;


Configuration

Status Action Method
DONE Keep config()
DONE Virtual void restore(const KConfigGroup &config);
DONE Keep virtual void save(KConfigGroup &config);
TO DO Change Signature virtual QWidget *createConfigurationInterface(QWidget *parent); -> becomes void createConfigurationInterface(QWindow *parent) <{{{3}}}>
DONE Remove virtual void configurationAccepted();