[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    branches/work/kdev-its-gonna-be-great
From:       Matt Rogers <mattr () kde ! org>
Date:       2006-07-29 16:26:32
Message-ID: 1154190392.291969.5571.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 567631 by mattr:

rename LanguageController to KDevLanguageController and add some docs to
KDevCore.

Deprecate KDevCore::initialize() since it will go away soon.



 M  +2 -2      lib/CMakeLists.txt  
 M  +4 -7      lib/kdevcore.cpp  
 M  +102 -10   lib/kdevcore.h  
 A             lib/kdevlanguagecontroller.cpp   lib/languagecontroller.cpp#567432 [License: LGPL (v2+)]
 A             lib/kdevlanguagecontroller.h   lib/languagecontroller.h#567432 [License: LGPL (v2+)]
 M  +1 -1      lib/kdevprojectcontroller.cpp  
 D             lib/languagecontroller.cpp  
 D             lib/languagecontroller.h  
 M  +2 -2      src/main.cpp  


--- branches/work/kdev-its-gonna-be-great/lib/CMakeLists.txt #567630:567631
@@ -46,7 +46,7 @@
     kdevconfig.cpp
     kdevprojectcontroller.cpp
     partcontroller.cpp
-    languagecontroller.cpp
+    kdevlanguagecontroller.cpp
     statusbar.cpp
     mainwindowshare.cpp
     shellextension.cpp
@@ -104,7 +104,7 @@
     kdevsharedptr.h
     kdevprojectcontroller.h
     partcontroller.h
-    languagecontroller.h
+    kdevlanguagecontroller.h
     statusbar.h
     mainwindowshare.h
     shellextension.h
--- branches/work/kdev-its-gonna-be-great/lib/kdevcore.cpp #567630:567631
@@ -29,9 +29,6 @@
 
 #include "kdevcore.h"
 
-#include <QtDBus/QtDBus>
-#include <QMenu>
-
 #include "kdevenv.h"
 
 #include "kdevprojectcontroller.h"
@@ -43,7 +40,7 @@
 #include "kdevmainwindow.h"
 #include "kdevlanguagesupport.h"
 #include "kdevplugincontroller.h"
-#include "languagecontroller.h"
+#include "kdevlanguagecontroller.h"
 #include "partcontroller.h"
 
 class KDevCore::Private
@@ -61,7 +58,7 @@
     KDevMainWindow *mainWindow;
     PartController *partController;
     KDevProjectController *projectController;
-    LanguageController *languageController;
+    KDevLanguageController *languageController;
     KDevPluginController *pluginController;
     KDevDocumentController *documentController;
 
@@ -148,12 +145,12 @@
     d->partController = partController;
 }
 
-LanguageController* KDevCore::languageController()
+KDevLanguageController* KDevCore::languageController()
 {
     return d->languageController;
 }
 
-void KDevCore::setLanguageController( LanguageController * langController )
+void KDevCore::setLanguageController( KDevLanguageController * langController )
 {
     d->languageController = langController;
 }
--- branches/work/kdev-its-gonna-be-great/lib/kdevcore.h #567630:567631
@@ -30,10 +30,6 @@
 #ifndef KDEVCORE_H
 #define KDEVCORE_H
 
-/**
-@file kdevcore.h
-The interface to the application core.
-*/
 
 #include <QObject>
 
@@ -49,7 +45,7 @@
 class KDevProject;
 class KDevProjectController;
 class KDevLanguageSupport;
-class LanguageController;
+class KDevLanguageController;
 class PartController;
 class KDevDocumentController;
 class KDevPluginController;
@@ -62,7 +58,23 @@
 
 /**
  * KDevCore is the container class for all the various objects in use by
- * KDevelop.
+ * KDevelop. If access is needed to a particular controller, then this class
+ * should be used.
+ *
+ * KDevCore can provide the user with instances of the following things:
+ * <li>the project controller
+ * <li>the document controller
+ * <li>the mainwindow
+ * <li>the plugin controller
+ * <li>the part controller
+ * <li>the language controller
+ * <li>the currently active project
+ * <li>the currently active language support
+ * <li>the environment as used by processes started by KDevelop
+ *
+ * When an object is provided to KDevCore so it can be used later, KDevCore
+ * will take ownership of the object and upon application shutdown will take
+ * responsibility for deleting the objects stored by KDevCore.
  */
 class KDEVINTERFACES_EXPORT KDevCore
 {
@@ -73,30 +85,110 @@
     /** Destructor.*/
     virtual ~KDevCore() {};
 
+    /**
+     * @brief Get the current environment for child processes
+     * @return the KDevEnv object that represents the current environment
+     * that will be used by processes started by KDevelop as part of an
+     * operation requested by the user. 
+     */
     static KDevEnv *environment();
+    
+    /**
+     * @brief Set the current environment for child processes
+     * @param environment the KDevEnv object that represents the current
+     * environment that will be used by processes started by KDevelop as
+     * part of an operation requested by the user.
+     */
     static void setEnvironment( KDevEnv *environment );
 
+    /**
+     * 
+     * @return 
+     */
     static KDevProjectController *projectController();
-    static void setProjectController( KDevProjectController *projectController );
+
+    /**
+     * 
+     * @param project 
+     */
+    static void setProjectController( KDevProjectController *project );
+
+    /**
+     * 
+     * @return 
+     */
     static KDevProject* activeProject();
 
+    /**
+     * 
+     * @return 
+     */
     static KDevMainWindow *mainWindow();
+
+    /**
+     * 
+     * @param mainWindow 
+     */
     static void setMainWindow( KDevMainWindow *mainWindow );
 
+    /**
+     * 
+     * @return 
+     */
     static KDevPluginController *pluginController();
+    
+    /**
+     * 
+     * @param pluginController 
+     */
     static void setPluginController( KDevPluginController *pluginController );
 
+    /**
+     * 
+     * @return 
+     */
     static KDevDocumentController *documentController();
+
+    /**
+     * 
+     * @param documentController 
+     */
     static void setDocumentController( KDevDocumentController *documentController );
 
+    /**
+     * 
+     * @return 
+     */
     static PartController *partController();
+
+    /**
+     * 
+     * @param partController 
+     */
     static void setPartController( PartController* partController );
 
-    static LanguageController *languageController();
-    static void setLanguageController( LanguageController *langController );
+    /**
+     * @brief Get the language controller
+     * @return the previously stored KDevLanguageController based object
+     * @sa setLanguageController
+     */
+    static KDevLanguageController *languageController();
+    
+    /**
+     * @brief Set the language controller
+     * @param langController The KDevLanguageController based object to set as
+     * the language controller
+     */
+    static void setLanguageController( KDevLanguageController *langController );
+    
+    /**
+     * @brief Get the active language support
+     * @return a KDevLanguageSupport object representing the currently active
+     * language support
+     */
     static KDevLanguageSupport *activeLanguage();
 
-    static void initialize();
+    static KDE_DEPRECATED void initialize();
 
 private:
     class Private;
--- branches/work/kdev-its-gonna-be-great/lib/kdevprojectcontroller.cpp #567630:567631
@@ -30,7 +30,7 @@
 #include "kdevconfig.h"
 #include "kdevproject.h"
 #include "kdevmainwindow.h"
-#include "languagecontroller.h"
+#include "kdevlanguagecontroller.h"
 #include "kdevplugincontroller.h"
 #include "kdevdocumentcontroller.h"
 
--- branches/work/kdev-its-gonna-be-great/src/main.cpp #567630:567631
@@ -15,7 +15,7 @@
 #include "kdevconfig.h"
 #include "kdevmainwindow.h"
 #include "partcontroller.h"
-#include "languagecontroller.h"
+#include "kdevlanguagecontroller.h"
 #include "splashscreen.h"
 #include "kdevplugincontroller.h"
 #include "kdevprojectcontroller.h"
@@ -103,7 +103,7 @@
     KDevCore::setPluginController( new KDevPluginController );
     KDevCore::setPartController( new PartController );
     KDevCore::setDocumentController( new KDevDocumentController );
-    KDevCore::setLanguageController( new LanguageController );
+    KDevCore::setLanguageController( new KDevLanguageController );
     KDevCore::setProjectController( new KDevProjectController );
 
     QObject::connect( KDevCore::pluginController(),
[prev in list] [next in list] [prev in thread] [next in thread] 

Configure | About | News | Add a list | Sponsored by KoreLogic