Difference between revisions of "Projects/Plasma/Tokamak1"

Jump to: navigation, search
(Plasma::Containments(aseigo))
(Plasma runner terminology)
 
(92 intermediate revisions by 7 users not shown)
Line 14: Line 14:
 
* <s>slots -> Q_PRIVATE_SLOT</s>
 
* <s>slots -> Q_PRIVATE_SLOT</s>
  
=== Plasma::Corona ===
+
=== <s>Plasma::Corona</s> ===
  
 
* <s>Remove constructor with size parameters</s>
 
* <s>Remove constructor with size parameters</s>
Line 21: Line 21:
 
* <s>loadDefaultSetup protected and loadDefaultLayout</s>
 
* <s>loadDefaultSetup protected and loadDefaultLayout</s>
 
* <s>clearApplets -> clearContainments</s>
 
* <s>clearApplets -> clearContainments</s>
* config -> private Note : config protected in containments and applets
+
* <s>config -> private Note : config protected in containments and applets</s>
 
     Note: remaining public for now applet needs it for Applet::globalConfig()
 
     Note: remaining public for now applet needs it for Applet::globalConfig()
 
* <s>load/save applets -> load/save Layouts</s>
 
* <s>load/save applets -> load/save Layouts</s>
* scheduleConfigSync -> private
+
* <s>scheduleConfigSync -> private</s>
* addContainment not a slot ->split
+
* <s>addContainment not a slot ->split</s>
** addContainment(id, delayedFlag) [private]
+
** <s>addContainment(id, delayedFlag) [private]</s>
** addContainment() [public]
+
** <s>addContainment() [public]</s>
* containmentFor screen -> Not slot move to plasmaapp
+
* <s>containmentFor screen -> Not slot</s>
 
* <s>containments() not a slot</s>
 
* <s>containments() not a slot</s>
 
* <s>launchActivated -> to plasmaapp</s>
 
* <s>launchActivated -> to plasmaapp</s>
* screenOwnerChanged -> to plasmaapp
+
* <s>screenOwnerChanged -> to plasmaapp</s>
 +
    Note: it's not really desktop specific, so will stay here
 
* <s>protected slots -> private </s>
 
* <s>protected slots -> private </s>
  
Line 63: Line 64:
  
 
=== Plasma::Applet ===
 
=== Plasma::Applet ===
 
+
* <s>remainSquare()+setAspectRatioMode()->merge using our own aspect ratio mode enun</s>
 +
* category()+name()+pluginName() dies->replaced by pluginInfo()
 +
  <!> pluginInfo() should return a hand-made KPluginInfo if id->appletDescription isValid()
 +
* <s>resetConfigurationObject()->pimpl</s>
 +
* <s>watchForMouseMove()-> ??? (the suggested registerDragHandles is a very bad name)</s>
 +
* <s>protected setBackgroundHints() + public backgroundHings() const</s>; <s>as a result (set)DrawStandardBackground() dies</s>
 +
  <s>Note: being protected AppletScript can't change it anymore: AppletScript friend of Applet?</s>
 +
* <s>(set)configNeeded()->(is|set)ConfigurationRequired()+set  protected</s>
 +
* <s>shape() dies</s>
 +
* <s>*Opacity() dies</s>
 +
* <s>launchActivated()-> releaseVisualFocus()</s>
 +
* <s>configXml() -> configScheme()</s>
 +
* <s>contextActions()->const+contextualActions()</s>
 
* <s>inherits QGraphicsWidget</s>
 
* <s>inherits QGraphicsWidget</s>
 
* <s>init()->protecgted+Corona::loadLayout() is friend</s>
 
* <s>init()->protecgted+Corona::loadLayout() is friend</s>
* (NOTE: config will remain public) <s>config() methods->protected.</s>
+
* <s>config() methods->protected.</s>
* (NOTE: globalConfig will remain public) <s>globalConfig()->protected</s>
+
* <s>globalConfig()->protected</s>
 
     Note: It has been decided the above two functions will remain public because if an applet uses an external QWidget it will have to access the configuration of the applet
 
     Note: It has been decided the above two functions will remain public because if an applet uses an external QWidget it will have to access the configuration of the applet
* configXml()->KConfigSkeletonconfigScheme()
+
* <s>constraintUpdated()->constraintEvent()+protected</s>
* constraintUpdated()->constraintEvent()+protected
+
 
     Note: check again corona for events like methods
 
     Note: check again corona for events like methods
* formFactors()->non virtual + get the containment impl there
+
* <s>formFactors()->non virtual + get the containment impl there
   ==>Plasma::Containment::Private inherits Plasma::Applet::Private
+
   ==>Plasma::Containment::Private inherits Plasma::Applet::Private</s>
* location-> Plasma::Containment::Private
+
* <s>location-> Plasma::Containment::Private</s>
* remainSquare()+setAspectRatioMode()->merge using our own aspect ratio mode enun
+
 
* <s>knownApplets()->listAppletInfo()</s>
 
* <s>knownApplets()->listAppletInfo()</s>
 
* <s>knownAppletsForMimetype()->listAppletInfoForMimeType()</s>
 
* <s>knownAppletsForMimetype()->listAppletInfoForMimeType()</s>
Line 81: Line 92:
 
<s>Note:  known*()->list*()</s>
 
<s>Note:  known*()->list*()</s>
  
* because of load(), ctors->protected
+
* <s>because of load(), ctors->protected</s>
* category()+name()+pluginName() dies->replaced by pluginInfo()
+
   Note: containment wants to construct an Applet directly when
   <!> pluginInfo() should return a hand-made KPluginInfo if id->appletDescription isValid()
+
  creates the one with the failed to launch error message,
* color() die! die! die!
+
  but even if it's friend of applet it does that in the dptr,
 +
  and this somewhere compiles somewhere not, generally not good.
 +
* <s>color() die! die! die!</s>
 
* <s>isKioskmmutable()->pimpl</s> isImmutable() setIsImmutable() and isKioskImmutable() became immutability() and setImmutability()
 
* <s>isKioskmmutable()->pimpl</s> isImmutable() setIsImmutable() and isKioskImmutable() became immutability() and setImmutability()
* (set)DrawStandardBackground()->(is|set)StandardBackgroundEnabled()
 
 
* <s>failedtoLaunch()->hasfailedToLaunch()</s>
 
* <s>failedtoLaunch()->hasfailedToLaunch()</s>
 
* <s>setFailedToLaunch()->protected</s>
 
* <s>setFailedToLaunch()->protected</s>
* (set)configNeeded()->(is|set)ConfigurationRequired()+set  protected
 
 
* <s>hasCofigurationInterface()-> const</s>
 
* <s>hasCofigurationInterface()-> const</s>
 
* <s>setHasConfigurationInterface()->protected</s>
 
* <s>setHasConfigurationInterface()->protected</s>
* contextActions()->const+contextualActions()
+
* <s>kill *StandardBackground()+*ShadowShown()</s>
+
* kill *StandardBackground()+*ShadowShown()
+
 
   ->enum BackgroundHint {NoBackground=0, StandardBackground, ShadowedBackground}
 
   ->enum BackgroundHint {NoBackground=0, StandardBackground, ShadowedBackground}
 
   +QFlag
 
   +QFlag
protected setBackgroundHints() + public backgroundHings() const
+
* <s>set(is)containment()->set(ActsAs)Containment()+setter is protected</s>
* set(is)containment()->set(ActsAs)Containment()+setter is protected
+
* <s>raise()->slot+addlower()</s>
* raise()->slot+addlower()
+
* <s>requestFocus() dies</s>
* shape() dies
+
* <s>showConfigurationInterface()->nonvirtual</s>
* resetConfigurationObject()->pimpl
+
* <s>createconfigurationInterface()->virtual protected, not slot</s>
* *Opacity() dies
+
* <s>Flush UpdatedConstraints()->Flush PendingCostraintEvents()</s>
* requestFocus() dies
+
* <s>ThemeChanged()->Q_PRIVATE_SLOT</s>
* showConfigurationInterface()->nonvirtual
+
* <s>globalName(), instanceName()->pimpl</s>
* createconfigurationInterface()->virtual protected, not slot
+
* <s>watchForFocus()->dies</s>
* Flush UpdatedConstraints()->Flush PendingCostraintEvents()
+
* <s>needFocus()->dies</s>
 
+
* <s>topLeft()->dies</s>
* launchActivated()->protected, releaseVisualFocus()
+
* <s>checkImmutability()->Q_PRIVATE_SLOT</s>
* ThemeChanged()->Q_PRIVATE_SLOT
+
* globalName(), instanceName()->pimpl
+
* watchForFocus()->dies
+
* watchForMouseMove()->registerDragHandles()
+
* needFocus()->dies
+
* topLeft()->dies
+
* checkImmutability()->Q_PRIVATE_SLOT
+
  
 
=== Plasma::Containments(aseigo)  ===
 
=== Plasma::Containments(aseigo)  ===
 +
* addToolBoxTool() -> addToolBoxAction(action)
 +
* add removeToolBoxAction(action)
 +
* <s>formfactor() & location() in Applet</s>
 +
* <s>setFormFactor() & setLocation() in Containment</s>
 
* <s>StyleOption::desktop dies</s>
 
* <s>StyleOption::desktop dies</s>
 
* <s>List, Dict dies</s>
 
* <s>List, Dict dies</s>
Line 123: Line 129:
 
* <s>setContainmentType() -> protected</s>
 
* <s>setContainmentType() -> protected</s>
 
* <s>setIsContainment() -> dies (meat in applet)</s>
 
* <s>setIsContainment() -> dies (meat in applet)</s>
* formfactor() & location() in Applet
 
* setFormFactor() & setLocation() in Containment
 
 
* <s>known...() -> list...()</s>
 
* <s>known...() -> list...()</s>
 
* <s>addApplet() -> split</s>
 
* <s>addApplet() -> split</s>
 
** <s>addApplet(name, args, point, size) [public]</s>
 
** <s>addApplet(name, args, point, size) [public]</s>
 
** <s>addApplet(name, args, point, size, id, delayedinit) [private]</s>
 
** <s>addApplet(name, args, point, size, id, delayedinit) [private]</s>
* indexAt() dies, add QPointF to appletAdded()
+
* <s>indexAt() dies, add QPointF to appletAdded()</s>
* setScreen() & screen() & effectiveScreenPos() -> die
+
* <s>setScreen() & screen() & effectiveScreenPos() -> die</s> will remain due to PUI relevance - aseigo
* (save|load)Constraints() -> pimpl
+
* <s>(save|load)Constraints() -> pimpl</s>
* emitLaunchActivated() -> see Applet, maybe not public
+
* <s>emitLaunchActivated() -> see Applet, maybe not public</s>
* addToolBoxTool() -> addToolBoxAction(action)
+
* <s>containmentConstraingUpdated() -> pimpl</s>
* add removeToolBoxAction(action)
+
* <s>add setToolBoxExpanded(bool) slot</s>
* containmentConstraingUpdated() -> pimpl
+
* <s>(show|hide)ToolBox() -> (expand|unexpand)ToolBox()</s>
* add setToolBoxExpanded(bool) slot
+
* <s>launchActivated() -> see Applet</s>
* (show|hide)ToolBox() -> (expand|unexpand)ToolBox()
+
* <s>zoomIn() & zoomOut() signals -> zoomRequested(containment, direction enum)</s>
* launchActivated() -> see Applet
+
* <s>showAddWidgets() -> showAddWidgetsInterface(QPointF)</s>
* zoomIn() & zoomOut() signals -> zoomRequested(containment, direction enum)
+
* <s>screenChanged() -> dies (move to plasma app ScreenManager)</s>
* showAddWidgets() -> showAddWidgetsInterface(QPointF)
+
* <s>toggleDesktopImmutability() -> Q_PRIVATE_SLOT</s>
* screenChanged() -> dies (move to plasma app ScreenManager)
+
* <s>zoomIn() -> Q_PRIVATE_SLOT</s>
* toggleDesktopImmutability() -> Q_PRIVATE_SLOT
+
* <s>createLayout() -> dies</s>
* zoomIn() -> Q_PRIVATE_SLOT
+
* <s>protected slots (except dropEvent()) & private slots & methods ->pimpl & Q_PRIVATE_SLOT</s>
* createLayout() -> dies
+
* proected slots (except dropEvent()) & private slots & methods ->pimpl & Q_PRIVATE_SLOT
+
  
=== Plasma::DataEngine ===
+
=== <s>Plasma::DataEngine</s> ===
 
* <s>sourceDict() -> containerDict()</s>
 
* <s>sourceDict() -> containerDict()</s>
 
* <s>engineName() -> name() + add protected setName()</s>
 
* <s>engineName() -> name() + add protected setName()</s>
Line 157: Line 159:
 
* <s>sourceRequested -> sourceRequestEvent()</s>
 
* <s>sourceRequested -> sourceRequestEvent()</s>
 
* <s>updateSource() -> updateSourceEvent()</s>
 
* <s>updateSource() -> updateSourceEvent()</s>
* setData() -> SHALL NOT remove source (fix APIDOX)
+
* <s>setData() -> SHALL NOT remove source (fix APIDOX)</s>
 
* <s>clearData() -> removeAllData()</s>
 
* <s>clearData() -> removeAllData()</s>
 
* <s>setSourceLimit() -> DIE! DIE! DIE!</s>
 
* <s>setSourceLimit() -> DIE! DIE! DIE!</s>
 
* <s>clearSources() -> removeAllSources()</s>
 
* <s>clearSources() -> removeAllSources()</s>
 
* <s>checkForUpdates() -> scheduleSourcesUpdated()</s>
 
* <s>checkForUpdates() -> scheduleSourcesUpdated()</s>
* internalUpdateSource() -> Q_PRIVATE_SLOT
+
* <s>internalUpdateSource() -> Q_PRIVATE_SLOT</s>
  
 
=== <s>Plasma::DataEngineManager</s> ===
 
=== <s>Plasma::DataEngineManager</s> ===
Line 170: Line 172:
 
* <s>(un)load()->(un)loadEngine()</s>
 
* <s>(un)load()->(un)loadEngine()</s>
  
=== Plasma::DataContainer ===
+
=== <s>Plasma::DataContainer</s> ===
 
* <s>clearData()->removeAllData()</s>
 
* <s>clearData()->removeAllData()</s>
* checkForUpdate()->protected
+
* <s>checkForUpdate()->protected</s>
* int timeSinceLastUpdate()->protected+return uint
+
* <s>int timeSinceLastUpdate()->protected+return uint</s>
* hasUpdates()->pimpl
+
* <s>hasUpdates()->pimpl</s>
* setNeedsUpdate()->pimpl
+
* <s>setNeedsUpdate()->pimpl</s>
* checkUsage()->pimpl
+
* <s>checkUsage()->pimpl</s>
 
* <s>connectVisualization()->not slot</s>
 
* <s>connectVisualization()->not slot</s>
* unused()->becameUnused() DONE but move to pimpl?
+
* <s>unused()->becameUnused()</s>
* requestUpdate()->updateRequested() DONE but move to pimpl?
+
* <s>requestUpdate()->updateRequested()</s>
  
=== Plasma::View ===
+
=== <s>Plasma::View</s> ===
(Rob Scheepmaker (pinda))
+
  
 
* <s>(set)DrawWallpaper() -> (set|is)WallpaperEnabled()</s>
 
* <s>(set)DrawWallpaper() -> (set|is)WallpaperEnabled()</s>
* (set)Screen() -> plasma app
+
* <s>(set)Screen() -> plasma app</s> going to leave this here, as the screen management is not manditory, but useful for any PUI - aseigo
* (set)Desktop() -> plasma app
+
* <s>(set)Desktop() -> plasma app</s> going to leave this here, as the screen management is not manditory, but useful for any PUI - aseigo
* effectiveDesktop -> plasma app
+
* <s>effectiveDesktop -> plasma app</s> going to leave this here, as the screen management is not manditory, but useful for any PUI - aseigo
 
* <s>config() -> protected</s>
 
* <s>config() -> protected</s>
 
* <s>updateSceneRect() -> Q_PRIVATE_SLOT</s>
 
* <s>updateSceneRect() -> Q_PRIVATE_SLOT</s>
Line 193: Line 194:
  
 
=== Plasma::AbstractRunner ===
 
=== Plasma::AbstractRunner ===
* SlowSpeed before NormalSpeed
+
* <s>SlowSpeed before NormalSpeed</s>
* load() -> loadAll() + load()  no = QString() for whitelist
+
* <s>load() -> loadAll()</s> + load()  no = QString() for whitelist
* ctors -> protected
+
* <s>ctors -> protected</s>
* confg() -> protected
+
* <s>confg() -> protected</s>
 
* match() -> protected
 
* match() -> protected
* (set)hasMatchOptions() -> (set)hasRunOptions()
+
* <s>(set)hasMatchOptions() -> (set)hasRunOptions()</s> -> (set)hasExecOptions()? (proposed by bettio)
* createMatchOptions() -> createRunOptions()
+
* <s>createMatchOptions() -> createRunOptions()</s> -> createExecOptions()? (proposed by bettio)
* runnerName() -> name()
+
* <s>runnerName() -> name()</s>
 
* init() -> Q_PRIVATE_SLOT
 
* init() -> Q_PRIVATE_SLOT
  
Line 212: Line 213:
 
* <s>clearMatches() -> removeAllMatches()</s>
 
* <s>clearMatches() -> removeAllMatches()</s>
  
=== Plasma::Phase -> Plasma::AnimationController ===
+
=== Plasma runner terminology ===
* Animation merges with ElementAnimation -> AppearAnimation,DisappearAnimation,ActivateAnimation
+
* <s>Plasma::SearchContext => Plasma::RunnerContext</s>
 +
* <s>Plasma::SearchMatch => Plasma::QueryMatch</s>
 +
* <s>In the RunnerContext, RunnerResult and AbstractRunner APIs:</s>
 +
  * search term => query
 +
 
 +
=== <s>Plasma::Phase -> Plasma::Animator</s> ===
 +
* <s>Animation merges with ElementAnimation -> AppearAnimation,DisappearAnimation,ActivateAnimation</s>
 
* <s>SlideInMovement,SlideOutMovement,FastSlideInMovement, FastSlideOutMovement</s>
 
* <s>SlideInMovement,SlideOutMovement,FastSlideInMovement, FastSlideOutMovement</s>
 
* <s>AnimId dies -> use int</s>
 
* <s>AnimId dies -> use int</s>
* constructor + destructor private
+
* <s>constructor + destructor private</s>
* animateItem, moveItem return int
+
* <s>animateItem, moveItem return int</s>
* add stopItemAnimation(int)
+
* <s>add stopItemAnimation(int)</s>
 
* <s>animationCompleted() -> animationFinished()</s>
 
* <s>animationCompleted() -> animationFinished()</s>
 
* <s>same for others signal</s>
 
* <s>same for others signal</s>
* protected slots -> Q_PRIVATE_SLOT
+
* <s>protected slots -> Q_PRIVATE_SLOT</s>
* init -> pimpl
+
* <s>init -> pimpl</s>
 
* <s>setAnimationPixmap -> setInitialPixmap</s>
 
* <s>setAnimationPixmap -> setInitialPixmap</s>
 
* <s>animationResult() -> currentPixmap</s>
 
* <s>animationResult() -> currentPixmap</s>
  
=== <s>Plasma::Animator</s> ===
+
=== <s>Plasma::AnimationDriver</s> ===
 
* <s>FramesPerSeconds -> animationFramesPerSeconds, elementAnimationFramesPerSeconds,movementAnimationFramesPerSeconds</s>
 
* <s>FramesPerSeconds -> animationFramesPerSeconds, elementAnimationFramesPerSeconds,movementAnimationFramesPerSeconds</s>
 
* <s>same for duration and curve</s>
 
* <s>same for duration and curve</s>
Line 235: Line 242:
 
* <s>elementX -> should use progress, not frame</s>
 
* <s>elementX -> should use progress, not frame</s>
  
=== Plasma::GlApplet ===
+
=== <s>Plasma::GlApplet</s> ===
* makeCurrent -> pimpl
+
* <s>makeCurrent -> pimpl</s>: actually, this is required to be public - aseigo
* Dialog
+
** themeUpdated()-> Q_PRIVATE_SLOT
+
* Delegate
+
** <nowiki>*</nowiki>columnType* -> device notifier
+
** ctor should have parent param
+
** constants + protected non virtual -> pimpl
+
** setRole()->setRoleMapping(QMap) + add roleMapping() getter
+
** fixme: copy rhs of whiteboard (missing)
+
  
=== Plasma::Dialog ===
+
=== Plasma::Delegate ===
 +
(Marco Martin)
 +
* <nowiki>*</nowiki>columnType* -> device notifier
 +
  Needed for the delegate to know he must draw an icon smaller than the main one
 +
* <s>ctor should have parent param</s>
 +
* <s>constants ->pimpl</s>
 +
* <s>protected non virtual</s> -> pimpl
 +
  The protected methods are needed only by subclasses to know where to paint so they are still needed
 +
* <s>setRole()->setRoleMapping(QMap) + add roleMapping() getter</s>
 +
* fixme: copy rhs of whiteboard (missing)
 +
 
 +
=== <s>Plasma::Dialog</s> ===
 
(Ménard Alexis)
 
(Ménard Alexis)
 
* <s>themeUpdated -> Q_PRIVATE_SLOT</s>
 
* <s>themeUpdated -> Q_PRIVATE_SLOT</s>
  
=== Plasma::Delegate ===
+
=== <s>Plasma::AppletBrowserWidget</s> ===
* *columType* -> go to device Notifier
+
* <s>remove containment from constructor</s>
* constructor should have a parent parameter
+
* <s>protected slots -> Q_PRIVATE_SLOTS</s>
* constants + protected non virtual -> pimpl
+
* <s>private methods -> pimpl</s>
* setRole -> setRoleMapping(QMap)
+
* roleMapping getter
+
 
+
=== Plasma::AppletBrowserWidget ===
+
* remove containment from constructor
+
* protected slots -> Q_PRIVATE_SLOTS
+
* private methods -> pimpl
+
  
=== Plasma::AppletBrowser ===
+
=== <s>Plasma::AppletBrowser</s> ===
* remove containment from constructor
+
* <s>remove containment from constructor</s>
  
 
NOTE : AppletBrowser and AppletBrowserWidget should be in different .h
 
NOTE : AppletBrowser and AppletBrowserWidget should be in different .h
  
=== Plasma::PackageMetadata ===
+
=== <s>Plasma::PackageMetadata</s> ===
* isComplete -> isValid
+
* <s>isComplete -> isValid</s>
* write() -> remove icon parameter
+
* <s>write() -> remove icon parameter</s>
  
=== Plasma::PackageStructure ===
+
=== Plasma::PackageStructure(josebur) ===
 
* must not inherits of QObject
 
* must not inherits of QObject
 
* QList<char *> -> QStringList
 
* QList<char *> -> QStringList
 
* const char * -> QString
 
* const char * -> QString
* required -> isRequired()
+
* <s>required -> isRequired()</s>
 
* (set)(Default)Mimetypes -> (set)(Default)Mimetypes ??
 
* (set)(Default)Mimetypes -> (set)(Default)Mimetypes ??
* uninstallPackage -> packageName instead of param package
+
* <s>uninstallPackage -> packageName instead of param package</s>
* pathChanged -> died
+
* <s>pathChanged -> died</s>
 
* Xtypes() -> XFormat()
 
* Xtypes() -> XFormat()
  
=== Plasma::Package ===
+
=== Plasma::Package(josebur) ===
 
* const char * -> QString
 
* const char * -> QString
* knownPackages -> listInstalled
+
* <s>knownPackages -> listInstalled</s>
* installPackage -> install
+
* <s>installPackage -> install</s> leave it
* registerPackage -> register
+
* <s>registerPackage -> register</s> '''Keyword!''' leave it
* createPackage -> create
+
* <s>createPackage -> create</s> leave it
 
* Missing uninstall
 
* Missing uninstall
  
 
=== Plasma::ScriptEngine ===
 
=== Plasma::ScriptEngine ===
* contructor -> protected
+
* <s>contructor -> protected</s>
* protected slots -> not slots
+
* <s>protected slots -> not slots</s>
 
* knowLanguages -> getScriptApis() ??
 
* knowLanguages -> getScriptApis() ??
 
* loadScriptEngine() -> language param become a scriptAPI
 
* loadScriptEngine() -> language param become a scriptAPI
Line 297: Line 300:
  
 
=== Plasma::AppletScript ===
 
=== Plasma::AppletScript ===
* contentSizeHint -> died
+
* <s>contentSizeHint -> died</s>
* constraintsUpdated -> constraintsEvent
+
* <s>constraintsUpdated -> constraintsEvent</s>
* contextActions -> contextualActions
+
* <s>contextActions -> contextualActions</s>
 
* change the K_EXPORT stuff to support several plugins by lib
 
* change the K_EXPORT stuff to support several plugins by lib
  
 
=== Plasma::RunnerScript ===
 
=== Plasma::RunnerScript ===
 
* change to new runner API
 
* change to new runner API
* protected slots -> not slots
+
* <s>protected slots -> not slots</s>
  
=== Plasma::DataEngineScript ===
+
=== <s>Plasma::DataEngineScript</s> ===
* Change to new API
+
* <s>Change to new API</s>
  
== Introduction Hotpoint List ==
+
== Personal Hotpoints Shared During Introductory Session ==
  
 
* Get QScript script bindings loading
 
* Get QScript script bindings loading

Latest revision as of 19:56, 2 May 2008

Contents

[edit] API Reviews

[edit] Plasma::Theme

  • self() -> default()  :NOTE: default is a C++ keyword, defaultTheme() perhaps?
  • set application dies, use KGlobal instead
  • implementation note: Theme::Private::config() shouldn't open config everytime
  • image() -> imagePath()
  • colors() -> KColorScheme colorScheme()
  • color methods -> color(ColorRole) (enum)
  • font methods -> font(RontRole) (enum)
  • compositingActive -> windowTranslucencyEnabled (out of place?)
  • changed() -> themeChanged()
  • slots -> Q_PRIVATE_SLOT

[edit] Plasma::Corona

  • Remove constructor with size parameters
  • Remove isKioskImmutable() -> protected isImmutable() setIsImmutable() and isKioskImmutable() became immutability() and setImmutability()
  • remove maxSizeHint
  • loadDefaultSetup protected and loadDefaultLayout
  • clearApplets -> clearContainments
  • config -> private Note : config protected in containments and applets
   Note: remaining public for now applet needs it for Applet::globalConfig()
  • load/save applets -> load/save Layouts
  • scheduleConfigSync -> private
  • addContainment not a slot ->split
    • addContainment(id, delayedFlag) [private]
    • addContainment() [public]
  • containmentFor screen -> Not slot
  • containments() not a slot
  • launchActivated -> to plasmaapp
  • screenOwnerChanged -> to plasmaapp
   Note: it's not really desktop specific, so will stay here
  • protected slots -> private

Terminology : layouts = Applets + containments organization

[edit] Plasma::Widget

  • deletion
  • Create a tooltip manager

[edit] Plasma::Svg

  • ContentType -> kill change methods using it to take bool and change their names to containsMultiplesImages (hmm actually not understood what this means :D)
  • elementRect -> return a QRectF
  • elementExists -> hasElement
  • matrixForElement -> private
  • size -> group with resize
  • move private slots to a pimpl

[edit] Plasma::PanelSvg

  • should inherits of Plasma::Svg
  • drawXborder -> Xborder
  • contentAtOrigin -> separate bool property
  • SvgPanel(path,parent) -> SvgPanel(parent)
  • setFile + file() -> setImagePath + imagePath() NOTE : same modification in svg and theme classes
  • setBorderFlags + borderFlags() -> setEnabledBorders + enabledBorders
  • add resize(x,y)
  • setPrefix ->setElementsPrefix
  • updateSizes() -> Q_PRIVATE_SLOT
  • pos + setPos died -> pos added to paint
  • setLocation() -> setElementPrefix(enum)
  • location() -> died

[edit] Plasma::Applet

  • remainSquare()+setAspectRatioMode()->merge using our own aspect ratio mode enun
  • category()+name()+pluginName() dies->replaced by pluginInfo()
  <!> pluginInfo() should return a hand-made KPluginInfo if id->appletDescription isValid()
  • resetConfigurationObject()->pimpl
  • watchForMouseMove()-> ??? (the suggested registerDragHandles is a very bad name)
  • protected setBackgroundHints() + public backgroundHings() const; as a result (set)DrawStandardBackground() dies
  Note: being protected AppletScript can't change it anymore: AppletScript friend of Applet?
  • (set)configNeeded()->(is|set)ConfigurationRequired()+set protected
  • shape() dies
  • *Opacity() dies
  • launchActivated()-> releaseVisualFocus()
  • configXml() -> configScheme()
  • contextActions()->const+contextualActions()
  • inherits QGraphicsWidget
  • init()->protecgted+Corona::loadLayout() is friend
  • config() methods->protected.
  • globalConfig()->protected
    Note: It has been decided the above two functions will remain public because if an applet uses an external QWidget it will have to access the configuration of the applet
  • constraintUpdated()->constraintEvent()+protected
   Note: check again corona for events like methods
  • formFactors()->non virtual + get the containment impl there
  ==>Plasma::Containment::Private inherits Plasma::Applet::Private
  • location-> Plasma::Containment::Private
  • knownApplets()->listAppletInfo()
  • knownAppletsForMimetype()->listAppletInfoForMimeType()
  • knownCategories()->listCategories()

Note: known*()->list*()

  • because of load(), ctors->protected
  Note: containment wants to construct an Applet directly when
  creates the one with the failed to launch error message,
  but even if it's friend of applet it does that in the dptr,
  and this somewhere compiles somewhere not, generally not good.
  • color() die! die! die!
  • isKioskmmutable()->pimpl isImmutable() setIsImmutable() and isKioskImmutable() became immutability() and setImmutability()
  • failedtoLaunch()->hasfailedToLaunch()
  • setFailedToLaunch()->protected
  • hasCofigurationInterface()-> const
  • setHasConfigurationInterface()->protected
  • kill *StandardBackground()+*ShadowShown()
 ->enum BackgroundHint {NoBackground=0, StandardBackground, ShadowedBackground}
  +QFlag
  • set(is)containment()->set(ActsAs)Containment()+setter is protected
  • raise()->slot+addlower()
  • requestFocus() dies
  • showConfigurationInterface()->nonvirtual
  • createconfigurationInterface()->virtual protected, not slot
  • Flush UpdatedConstraints()->Flush PendingCostraintEvents()
  • ThemeChanged()->Q_PRIVATE_SLOT
  • globalName(), instanceName()->pimpl
  • watchForFocus()->dies
  • needFocus()->dies
  • topLeft()->dies
  • checkImmutability()->Q_PRIVATE_SLOT

[edit] Plasma::Containments(aseigo)

  • addToolBoxTool() -> addToolBoxAction(action)
  • add removeToolBoxAction(action)
  • formfactor() & location() in Applet
  • setFormFactor() & setLocation() in Containment
  • StyleOption::desktop dies
  • List, Dict dies
  • CustomContainment = 127
  • setContainmentType() -> protected
  • setIsContainment() -> dies (meat in applet)
  • known...() -> list...()
  • addApplet() -> split
    • addApplet(name, args, point, size) [public]
    • addApplet(name, args, point, size, id, delayedinit) [private]
  • indexAt() dies, add QPointF to appletAdded()
  • setScreen() & screen() & effectiveScreenPos() -> die will remain due to PUI relevance - aseigo
  • (save|load)Constraints() -> pimpl
  • emitLaunchActivated() -> see Applet, maybe not public
  • containmentConstraingUpdated() -> pimpl
  • add setToolBoxExpanded(bool) slot
  • (show|hide)ToolBox() -> (expand|unexpand)ToolBox()
  • launchActivated() -> see Applet
  • zoomIn() & zoomOut() signals -> zoomRequested(containment, direction enum)
  • showAddWidgets() -> showAddWidgetsInterface(QPointF)
  • screenChanged() -> dies (move to plasma app ScreenManager)
  • toggleDesktopImmutability() -> Q_PRIVATE_SLOT
  • zoomIn() -> Q_PRIVATE_SLOT
  • createLayout() -> dies
  • protected slots (except dropEvent()) & private slots & methods ->pimpl & Q_PRIVATE_SLOT

[edit] Plasma::DataEngine

  • sourceDict() -> containerDict()
  • engineName() -> name() + add protected setName()
  • connectSource() -> updateInterval -> pollingInterval
  • connectAllSources() -> updateInterval -> pollingInterval
  • ref() & deref() & isUsed() -> private
  • setIcon() -> protected
  • newSource -> sourceAdded()
  • sourceRequested -> sourceRequestEvent()
  • updateSource() -> updateSourceEvent()
  • setData() -> SHALL NOT remove source (fix APIDOX)
  • clearData() -> removeAllData()
  • setSourceLimit() -> DIE! DIE! DIE!
  • clearSources() -> removeAllSources()
  • checkForUpdates() -> scheduleSourcesUpdated()
  • internalUpdateSource() -> Q_PRIVATE_SLOT

[edit] Plasma::DataEngineManager

  • ctor+dtor private
  • knownEngines()->listAllEngines()
  • get()->engine()
  • (un)load()->(un)loadEngine()

[edit] Plasma::DataContainer

  • clearData()->removeAllData()
  • checkForUpdate()->protected
  • int timeSinceLastUpdate()->protected+return uint
  • hasUpdates()->pimpl
  • setNeedsUpdate()->pimpl
  • checkUsage()->pimpl
  • connectVisualization()->not slot
  • unused()->becameUnused()
  • requestUpdate()->updateRequested()

[edit] Plasma::View

  • (set)DrawWallpaper() -> (set|is)WallpaperEnabled()
  • (set)Screen() -> plasma app going to leave this here, as the screen management is not manditory, but useful for any PUI - aseigo
  • (set)Desktop() -> plasma app going to leave this here, as the screen management is not manditory, but useful for any PUI - aseigo
  • effectiveDesktop -> plasma app going to leave this here, as the screen management is not manditory, but useful for any PUI - aseigo
  • config() -> protected
  • updateSceneRect() -> Q_PRIVATE_SLOT
  • initGraphicsView() -> pimpl

[edit] Plasma::AbstractRunner

  • SlowSpeed before NormalSpeed
  • load() -> loadAll() + load() no = QString() for whitelist
  • ctors -> protected
  • confg() -> protected
  • match() -> protected
  • (set)hasMatchOptions() -> (set)hasRunOptions() -> (set)hasExecOptions()? (proposed by bettio)
  • createMatchOptions() -> createRunOptions() -> createExecOptions()? (proposed by bettio)
  • runnerName() -> name()
  • init() -> Q_PRIVATE_SLOT

[edit] Plasma::SearchContext

  • switch to value based for matches too
  • matchesChanged() emitted from performMatch()
  • resetSearchTerm(QString) -> reset()
  • mimetype() -> mimeType()
  • addMatchesTo() -> copyMatchesTo() (copy -> move)
  • determineType() -> pimpl
  • clearMatches() -> removeAllMatches()

[edit] Plasma runner terminology

  • Plasma::SearchContext => Plasma::RunnerContext
  • Plasma::SearchMatch => Plasma::QueryMatch
  • In the RunnerContext, RunnerResult and AbstractRunner APIs:
 * search term => query

[edit] Plasma::Phase -> Plasma::Animator

  • Animation merges with ElementAnimation -> AppearAnimation,DisappearAnimation,ActivateAnimation
  • SlideInMovement,SlideOutMovement,FastSlideInMovement, FastSlideOutMovement
  • AnimId dies -> use int
  • constructor + destructor private
  • animateItem, moveItem return int
  • add stopItemAnimation(int)
  • animationCompleted() -> animationFinished()
  • same for others signal
  • protected slots -> Q_PRIVATE_SLOT
  • init -> pimpl
  • setAnimationPixmap -> setInitialPixmap
  • animationResult() -> currentPixmap

[edit] Plasma::AnimationDriver

  • FramesPerSeconds -> animationFramesPerSeconds, elementAnimationFramesPerSeconds,movementAnimationFramesPerSeconds
  • same for duration and curve
  • appear -> itemAppear
  • disappear -> itemDisappear
  • activate -> itemActivated
  • slide -> itemSlide
  • elementX -> should use progress, not frame

[edit] Plasma::GlApplet

  • makeCurrent -> pimpl: actually, this is required to be public - aseigo

[edit] Plasma::Delegate

(Marco Martin)

  • *columnType* -> device notifier
  Needed for the delegate to know he must draw an icon smaller than the main one
  • ctor should have parent param
  • constants ->pimpl
  • protected non virtual -> pimpl
  The protected methods are needed only by subclasses to know where to paint so they are still needed
  • setRole()->setRoleMapping(QMap) + add roleMapping() getter
  • fixme: copy rhs of whiteboard (missing)

[edit] Plasma::Dialog

(Ménard Alexis)

  • themeUpdated -> Q_PRIVATE_SLOT

[edit] Plasma::AppletBrowserWidget

  • remove containment from constructor
  • protected slots -> Q_PRIVATE_SLOTS
  • private methods -> pimpl

[edit] Plasma::AppletBrowser

  • remove containment from constructor

NOTE : AppletBrowser and AppletBrowserWidget should be in different .h

[edit] Plasma::PackageMetadata

  • isComplete -> isValid
  • write() -> remove icon parameter

[edit] Plasma::PackageStructure(josebur)

  • must not inherits of QObject
  • QList<char *> -> QStringList
  • const char * -> QString
  • required -> isRequired()
  • (set)(Default)Mimetypes -> (set)(Default)Mimetypes ??
  • uninstallPackage -> packageName instead of param package
  • pathChanged -> died
  • Xtypes() -> XFormat()

[edit] Plasma::Package(josebur)

  • const char * -> QString
  • knownPackages -> listInstalled
  • installPackage -> install leave it
  • registerPackage -> register Keyword! leave it
  • createPackage -> create leave it
  • Missing uninstall

[edit] Plasma::ScriptEngine

  • contructor -> protected
  • protected slots -> not slots
  • knowLanguages -> getScriptApis() ??
  • loadScriptEngine() -> language param become a scriptAPI
  • add version number to loading

[edit] Plasma::AppletScript

  • contentSizeHint -> died
  • constraintsUpdated -> constraintsEvent
  • contextActions -> contextualActions
  • change the K_EXPORT stuff to support several plugins by lib

[edit] Plasma::RunnerScript

  • change to new runner API
  • protected slots -> not slots

[edit] Plasma::DataEngineScript

  • Change to new API

[edit] Personal Hotpoints Shared During Introductory Session

  • Get QScript script bindings loading
  • QScript Runners
  • Cool scripting demo
  • Webkit
  • Default set of components for 4.1
  • Clock applet library (and how to do that for other categories of applets)
  • Improve existing applets
  • Write new applets and engines
  • Panel and panel config saner/pretification
  • Kickoff UI
  • Applet handles
  • WoC
  • Video in plasma
  • Extenders
  • System tray applet
  • Keyboard shortcuts
  • Plasma::Service
  • Usability review
  • Documentation
    • Runtime
    • Dev
    • User
  • Top level window physics
  • Plasmoid grouping
  • Plasma configuration UI
  • Devices
  • API review
  • Generic webservice support
  • Theming
  • KIcon issues
  • tooltip love (flickering, hiding..)
  • krunner looks
  • lock desktop work properly
  • use createConfigurationInterface
  • panel toolbox
  • panel hiding
  • twitter improvements
  • Phase::Animator
  • theme installation from files

This page was last modified on 2 May 2008, at 19:56. This page has been accessed 18,643 times. Content is available under Creative Commons License SA 3.0 as well as the GNU Free Documentation License 1.2.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal