Documented API bookmarks && download classes.

Fixed load on startup

5 files changed, 114 insertions, 21 deletions

diff --git a/TODO b/TODO
index ce205bcd..93ae6959 100644
--- a/TODO
+++ b/TODO
@@ -10,6 +10,16 @@ To 0.0.4
 - contextMenu in searchbar to set different search engines
 - KDE proxy support
 - QWebPluginFactory subclass to load KParts into QtWebKit.
+
 + ------------------------
 
+1. check the lines above...
+2. Improve docs
+3. Let rekonq be a Singleton app. (And work well..)
+4. fix bookmarks toolbar POSITION
+5. fix bookmarks action menu (in toolbar)
+6. fix load at startup
+7. fix FONTS problems between webkit && KDE settings (at least, here..)
+8. enable flash support !!
 
++ ------------------------
\ No newline at end of file
diff --git a/src/application.cpp b/src/application.cpp
index c4b4b38f..315c5cf1 100644
--- a/src/application.cpp
+++ b/src/application.cpp
@@ -65,6 +65,9 @@ Application::Application()
     m_mainWindow = new MainWindow();
     m_mainWindow->setObjectName("MainWindow");
     setWindowIcon( KIcon("rekonq") );
+    newTab();
+    mainWindow()->slotHome();
+
     m_mainWindow->show();
 
     QTimer::singleShot(0, this, SLOT( postLaunch() ) );
@@ -75,7 +78,6 @@ Application::~Application()
 {
     delete s_networkAccessManager;
     delete s_historyManager;
-    delete m_mainWindow;
 }
 
 
@@ -83,7 +85,7 @@ int Application::newInstance()
 {
     KCmdLineArgs::setCwd(QDir::currentPath().toUtf8());
     KCmdLineArgs* args = KCmdLineArgs::parsedArgs();
-    static bool first = true;
+
     if (args->count() > 0) 
     {
         for (int i = 0; i < args->count(); ++i) 
@@ -92,17 +94,9 @@ int Application::newInstance()
             newTab();
             mainWindow()->loadUrl( url );
         }
+        args->clear();
     } 
-    else 
-    {
-        if( !first || !isSessionRestored()) 
-        {
-            newTab();
-            mainWindow()->slotHome();
-        }
-    }
-    first = false;
-    args->clear();
+
     return 0;
 }
 
diff --git a/src/bookmarks.cpp b/src/bookmarks.cpp
index 584b2689..a2ebf08a 100644
--- a/src/bookmarks.cpp
+++ b/src/bookmarks.cpp
@@ -37,8 +37,10 @@ OwnBookMarks::OwnBookMarks(KMainWindow *parent)
 }
 
 
-void OwnBookMarks::openBookmark (const KBookmark & b, Qt::MouseButtons , Qt::KeyboardModifiers )
+void OwnBookMarks::openBookmark (const KBookmark & b, Qt::MouseButtons mb, Qt::KeyboardModifiers km)
 {
+    Q_UNUSED(mb);
+    Q_UNUSED(km);
     emit openUrl( b.url() );
 }
 
diff --git a/src/bookmarks.h b/src/bookmarks.h
index aa18834c..825c0d3a 100644
--- a/src/bookmarks.h
+++ b/src/bookmarks.h
@@ -31,40 +31,112 @@
 
 class MainWindow;
 
-/*
+/** 
+ * Inherited from KBookmarkOwner, this class allows to manage 
+ * bookmarks as actions
  *
+ * @author Andrea Diamantini <adjam7@gmail.com>
+ * @since 4.x
  */
 class OwnBookMarks : public QObject , public KBookmarkOwner
 {
 Q_OBJECT
+
 public:
-    OwnBookMarks(KMainWindow *);
 
-    virtual void openBookmark (const KBookmark & , Qt::MouseButtons , Qt::KeyboardModifiers );
+    /**  
+     * The class ctor.
+     *
+     * @param parent the pointer to the browser mainwindow. We need it
+     *               to link bookmarks actions with the right window 
+     *               where load url in
+     */
+    OwnBookMarks(KMainWindow *parent);
+
+    /**
+     * This function is called when a bookmark is selected and belongs to 
+     * the ancestor class.
+     * This method actually emits signal to load bookmark's url without
+     * considering mousebuttons or keyboard modifiers.
+     *
+     * @param b  the bookmark to open
+     * @param mb the mouse buttons clicked to select the bookmark
+     * @param km the keyboard modifiers pushed when the bookmark was selected
+     */
+    virtual void openBookmark (const KBookmark &b , Qt::MouseButtons mb, Qt::KeyboardModifiers km);
 
-    // KBookmarkOwner interface:
+    
+    /** 
+     * this method, from KBookmarkOwner interface, allows to add the current page
+     * to the bookmark list, returning the URL page as QString.
+     *
+     * @return the current page's URL
+     */
     virtual QString currentUrl() const;
+
+    /** 
+     * this method, from KBookmarkOwner interface, allows to add the current page
+     * to the bookmark list, returning the title's page as QString.
+     *
+     * @return the current page's title
+     */
     virtual QString currentTitle() const;
 
 signals:
+    /**
+     * This signal is emitted when an url has to be loaded 
+     *
+     * @param url the URL to load
+     *
+     */
     void openUrl(const KUrl &);
 
 private:
+    // the MainWindow pointer
     MainWindow *m_parent;
 };
 
+
 // ------------------------------------------------------------------------------
 
-/*
+
+/** 
+ * This class represent the interface to rekonq bookmarks system.
+ * All rekonq needs (Bookmarks Menu, Bookmarks Toolbar) is provided
+ * from this class.
+ * So it implements code to have each one
+ *
+ * @author Andrea Diamantini <adjam7@gmail.com>
+ * @since 4.x
  *
  */
 class BookmarksProvider : public QObject
 {
 Q_OBJECT
+
 public:
-    BookmarksProvider(KMainWindow*);
+    /** 
+     * Class constructor. Connect BookmarksProvider with bookmarks source
+     * (actually konqueror's bookmarks)
+     *
+     * @param parent The MainWindow to provide bookmarks objects
+     *
+     */
+    BookmarksProvider(KMainWindow* parent);
+
+    /** 
+     * Customize bookmarks toolbar
+     *
+     * @param toolbar the toolbar to customize
+     */
+    void provideBmToolbar(KToolBar* toolbar);
 
-    void provideBmToolbar(KToolBar*);
+    /** 
+     * Generate the Bookmarks Menu
+     *
+     * @return the Bookmarks Menu
+     *
+     */
     KMenu *bookmarksMenu();
 
 private:
diff --git a/src/download.h b/src/download.h
index cd363d00..a3ce9d23 100644
--- a/src/download.h
+++ b/src/download.h
@@ -29,16 +29,31 @@
 #include <QObject>
 #include <QByteArray>
 
-/*
+/**
  * This class lets rekonq to download an object from the network.
  * Creating a new object, you can continue downloading a file also 
  * when rekonq is closed.
+ *
  */ 
 class Download : public QObject
 {
     Q_OBJECT
     public:
+        /**
+         * Class constructor. This is the unique method we need to
+         * use this class. In fact Download class needs to know just
+         * "where" catch the file to download and where it has to put it
+         *
+         * @param srcUrl the source url
+         *
+         * @param destUrl the destination url
+         *
+         */
         Download(const KUrl &srcUrl, const KUrl &destUrl);
+
+        /**
+         * class destructor
+         */
         ~Download();
 
     private slots: