From 029b2e8a5495c1a582bebe94306182d6ed5208ae Mon Sep 17 00:00:00 2001
From: "Aaron J. Seigo" <aseigo@kde.org>
Date: Wed, 13 Jun 2007 04:56:49 +0000
Subject: [PATCH] API consistency fixes; all methods now use "Source" to mean
 "DataSource"

svn path=/trunk/KDE/kdebase/workspace/lib/plasma/; revision=674784
---
 dataengine.cpp | 32 ++++++++++----------------------
 dataengine.h   | 16 +++++++++-------
 2 files changed, 19 insertions(+), 29 deletions(-)

diff --git a/dataengine.cpp b/dataengine.cpp
index 2042063a2..ba451afbb 100644
--- a/dataengine.cpp
+++ b/dataengine.cpp
@@ -75,7 +75,7 @@ class DataEngine::Private
                 trimQueue();
                 sourceQueue.enqueue(s);
             }
-            emit engine->newDataSource(sourceName);
+            emit engine->newSource(sourceName);
             return s;
         }
 
@@ -95,10 +95,10 @@ class DataEngine::Private
             updateTimer->start(0);
         }
 
-        bool dataSourceRequested(const QString& source)
+        bool sourceRequested(const QString& source)
         {
             //get around const! =P
-            return engine->dataSourceRequested(source);
+            return engine->sourceRequested(source);
         }
 
         QAtomic ref;
@@ -127,7 +127,7 @@ DataEngine::~DataEngine()
     delete d;
 }
 
-QStringList DataEngine::dataSources() const
+QStringList DataEngine::sources() const
 {
     return d->sources.keys();
 }
@@ -138,7 +138,7 @@ void DataEngine::connectSource(const QString& source, QObject* visualization) co
 
     if (!s) {
         // we didn't find a data source, so give the engine an opportunity to make one
-        if (d->dataSourceRequested(source)) {
+        if (d->sourceRequested(source)) {
             s = d->source(source);
             if (s) {
                 // now we have a source; since it was created on demand, assume
@@ -200,7 +200,7 @@ void DataEngine::init()
     // start things in motion external to themselves before they can work
 }
 
-bool DataEngine::dataSourceRequested(const QString &name)
+bool DataEngine::sourceRequested(const QString &name)
 {
     Q_UNUSED(name)
     return false;
@@ -227,7 +227,7 @@ void DataEngine::addSource(DataSource* source)
     }
 
     d->sources.insert(source->objectName(), source);
-    emit newDataSource(source->objectName());
+    emit newSource(source->objectName());
 }
 
 void DataEngine::setSourceLimit(uint limit)
@@ -245,34 +245,22 @@ void DataEngine::setSourceLimit(uint limit)
     }
 }
 
-/*
-Plasma::DataSource* DataEngine::createDataSource(const QString& source, const QString& domain)
-{
-    Q_UNUSED(domain)
-    //TODO: add support for domains of sources
-    
-    if (d->source(source)) {
-        kDebug() << "DataEngine " << objectName() << ": source "  << source << " already exists " << endl;
-        return s
-    }
-}*/
-
 void DataEngine::removeSource(const QString& source)
 {
     //kDebug() << "removing source " << source << endl;
     SourceDict::iterator it = d->sources.find(source);
     if (it != d->sources.end()) {
-        emit dataSourceRemoved(it.key());
+        emit sourceRemoved(it.key());
         d->sources.erase(it);
     }
 }
 
-void DataEngine::clearAllDataSources()
+void DataEngine::clearSources()
 {
     QMutableHashIterator<QString, Plasma::DataSource*> it(d->sources);
     while (it.hasNext()) {
         it.next();
-        emit dataSourceRemoved(it.key());
+        emit sourceRemoved(it.key());
         delete it.value();
         it.remove();
     }
diff --git a/dataengine.h b/dataengine.h
index fe945c774..c3cd12007 100644
--- a/dataengine.h
+++ b/dataengine.h
@@ -66,10 +66,12 @@ class PLASMA_EXPORT DataEngine : public QObject
         virtual ~DataEngine();
 
         /**
-         * @return a list of all the data sources currently available via this
-         *         DataEngine
+         * @return a list of all the data sources available via this DataEngine
+         *         Whether these sources are currently available (which is what
+         *         the default implementation provides) or not is up to the
+         *         DataEngine to decide.
          **/
-        virtual QStringList dataSources() const;
+        virtual QStringList sources() const;
 
         /**
          * Connects a source to an object for data updates. The object must
@@ -158,13 +160,13 @@ class PLASMA_EXPORT DataEngine : public QObject
          * Emitted when a new data source is created
          * @param source the name of the new data source
          **/
-        void newDataSource(const QString& source);
+        void newSource(const QString& source);
 
         /**
          * Emitted when a data source is removed.
          * @param source the name of the data source that was removed
          **/
-        void dataSourceRemoved(const QString& source);
+        void sourceRemoved(const QString& source);
 
     protected:
         /**
@@ -182,7 +184,7 @@ class PLASMA_EXPORT DataEngine : public QObject
          *
          * @return true if a DataSource was set up, false otherwise
          */
-        virtual bool dataSourceRequested(const QString &name);
+        virtual bool sourceRequested(const QString &name);
 
         /**
          * Sets a value for a data source. If the source
@@ -226,7 +228,7 @@ class PLASMA_EXPORT DataEngine : public QObject
         /**
          * Removes all data sources
          **/
-        void clearAllDataSources();
+        void clearSources();
 
         /**
          * Sets whether or not this engine is valid, e.g. can be used.