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

From KDE Community Wiki
No edit summary
Line 34: Line 34:
! Method  
! Method  


{{FeatureDone|Keep| uint id() const;}}
{{FeatureTodo|Rename, Change signature| Applet *addApplet(const QString &name, const QVariantList args,  const QRectF geometry ; -> becomes createApplet, args and geometry arguments go away}}
{{FeatureTodo | Change signature| void addApplet(Applet *applet, const QPointF pos);  -> pos parameter goes }}
{{FeatureDone | Keep| QList<Applet *> applets() const; }}
{{FeatureTodo | Remove| void clearApplets(); }}
|}
 
= Constructors =
 
{| 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;"
as
! Status
! Action
! Method
 
{{FeatureDone|Keep|explicit Containment(QObject *parent = 0, const QString &serviceId = QString(), uint containmentId = 0);}}
{{FeatureDone|Keep|Containment(QObject *parent, const QVariantList &args);}}
{{FeatureDone|Keep|~Containment();}}


|}
|}

Revision as of 14:25, 18 February 2013

Q_PROPERTIES

All qproperties and invokables must go

Enums

Type probably goes in plasma.h

       enum Type {
           NoContainmentType = -1,  /**< @internal */
           DesktopContainment = 0,  /**< A desktop containment */ New name -> suggestions [ Canvas ]
           PanelContainment,        /**< A desktop panel */
           CustomContainment = 127, /**< A containment that is neither a desktop nor a panel
                                       but something application specific */
          CustomPanelContainment = 128 /**< A customized desktop panel */
       };

ToolType goes in plasma.h it becomes ActionType (not related to toolbox anymore)

       enum ToolType {
           AddTool = 0,
           ConfigureTool = 100,
           ControlTool = 200,
           MiscTool = 300,
           DestructiveTool = 400,
           UserToolType = DestructiveTool + 1000
       };
       Q_ENUMS(ToolType)

Bookkeeping

as
Status Action Method
TO DO Rename, Change signature Applet *addApplet(const QString &name, const QVariantList args, const QRectF geometry ; -> becomes createApplet, args and geometry arguments go away <{{{3}}}>
TO DO Change signature void addApplet(Applet *applet, const QPointF pos); -> pos parameter goes <{{{3}}}>
DONE Keep QList<Applet *> applets() const;
TO DO Remove void clearApplets(); <{{{3}}}>

Constructors

as
Status Action Method
DONE Keep {{{2}}}
DONE Keep Containment(QObject *parent, const QVariantList &args);
DONE Keep ~Containment();