Changeset 117

Timestamp:

04/25/06 09:27:46 (2 years ago)

Author:

jordi

Message:

The main view now shows on the status bar the file loading as well as changing the current cursor to a watch.

Added the missing comments to the JobLoad? class.

Location:

trunk

Files:

• src/IMainView.h (modified) (4 diffs)
• src/JobLoad.cxx (modified) (26 diffs)
• src/JobLoad.h (modified) (1 diff)
• src/MainPter.cxx (modified) (8 diffs)
• src/gtk/MainView.cxx (modified) (4 diffs)
• src/gtk/MainView.h (modified) (2 diffs)
• src/main.cxx (modified) (2 diffs)
• tests/DumbMainView.cxx (modified) (3 diffs)
• tests/DumbMainView.h (modified) (2 diffs)

trunk/src/IMainView.h

@@ -27 +27 @@
     class DocumentOutline;
 
+    ///
+    /// @brief How to show the new page.
+    ///
     enum PageScroll
     {
@@ -38 +41 @@
 
     ///
+    /// @brief Main view's cursor.
+    ///
+    enum ViewCursor
+    {
+        /// Normal cursor.
+        MAIN_VIEW_CURSOR_NORMAL,
+        /// Hour glass wait cursor.
+        MAIN_VIEW_CURSOR_WAIT,
+        /// Drag cursor.
+        MAIN_VIEW_CURSOR_DRAG
+    };
+
+    ///
     /// @class IMainView
     /// @brief Interface class for the main view.
@@ -168 +184 @@
             ///
             virtual void sensitiveGoToPreviousPage (gboolean sensitive) = 0;
+            
+            ///
+            /// @brief Changes the sensitivity of the "Open" action.
+            ///
+            /// The view must change the sensitivity (it's called enabled or
+            /// disabled on some toolkits) of the "Open" action
+            /// (both on the menu and the toolbar or any other place).
+            ///
+            /// @param sensitive Set to TRUE if need to make sensitive (enable)
+            ///                  the action (enable) or FALSE to 
+            ///                  insensitive (disable) it.
+            ///
+            virtual void sensitiveOpen (gboolean sensitive) = 0;
 
             ///
@@ -259 +288 @@
             ///
             virtual void sensitiveZoomWidth (gboolean sensitive) = 0;
+
+            ///
+            /// @brief Sets the page view's cursor.
+            ///
+            /// The main view must show the cursor as given by @a cursorType
+            /// for the page's view.
+            ///
+            /// @param cursorType The type of cursor to show.
+            ///
+            virtual void setCursor (ViewCursor cursorType) = 0;
+
+            ///
+            /// @brief Sets the text of the status bar.
+            ///
+            /// The view must show the text at @a text unless it's NULL,
+            /// which means show nothing.
+            ///
+            /// @param text The text to shown on the status bar or NULL if
+            ///             no text should be shown on the status bar.
+            ///
+            virtual void setStatusBarText (const gchar *text) = 0;
 
             ///

trunk/src/JobLoad.cxx

@@ -22 +22 @@
 
 // Forward declarations.
-gboolean job_load_done (gpointer data);
-gboolean job_load_error (gpointer data);
-gboolean job_load_password (gpointer data);
-gpointer job_load_run (gpointer data);
-
+static gboolean job_load_done (gpointer data);
+static gboolean job_load_error (gpointer data);
+static gboolean job_load_password (gpointer data);
+static gpointer job_load_run (gpointer data);
+
+///
+/// @brief Constructs a new JobLoad object.
+///
 JobLoad::JobLoad ()
 {
@@ -40 +43 @@
 }
 
+///
+/// @brief Deletes all dynamically allocated memory by JobLoad.
+///
 JobLoad::~JobLoad ()
 {
@@ -50 +56 @@
 }
 
+///
+/// @brief Checks if a new password can be tried.
+///
+/// This function checks if we passed the number of time we can try a
+/// password.
+///
+/// Be warned that this function alters the number of tries left.
+///
+/// @return TRUE if we can try another password, FALSE otherwise.
+///
 gboolean
 JobLoad::canTryPassword ()
@@ -62 +78 @@
 }
 
+///
+/// @brief Gets the file name to load or reload.
+///
+/// @return The file name to load or reload.
+///
 const gchar *
 JobLoad::getFileName ()
@@ -68 +89 @@
 }
 
+///
+/// @brief Gets the last error.
+///
+/// @return The last load error.
+///
 GError *
 JobLoad::getError ()
@@ -74 +100 @@
 }
 
+///
+/// @brief Gets the previously used page num.
+///
+/// This is for reloading, gives the page where we were before reloading
+/// the document.
+///
+/// @return The numbe of the page where we were.
+///
 gint
 JobLoad::getPageNum ()
@@ -80 +114 @@
 }
 
+///
+/// @brief Gets the password.
+///
+/// @return The password to use to open the document.
+///
 const gchar *
 JobLoad::getPassword ()
@@ -86 +125 @@
 }
 
+///
+/// @brief The presenter that's opening the file.
+///
+/// @return The presenter that is loading or reloading the document.
+///
 MainPter &
 JobLoad::getPresenter ()
@@ -94 +138 @@
 }
 
+///
+/// @brief Gets the previously used rotation.
+///
+/// This is for reloading. Gets the rotation of the document before reloading.
+///
+/// @return The degrees the document was rotated before.
+///
 gint
 JobLoad::getRotation ()
@@ -100 +151 @@
 }
 
+///
+/// @brief Gets the previously used zoom.
+///
+/// This is for reloading. Gets the zoom of the document before reloading.
+///
+/// @return The degrees the document was zoomed before.
+///
 gdouble
 JobLoad::getZoom ()
@@ -106 +164 @@
 }
 
+///
+/// @brief Checks if we are reloading.
+///
+/// @return TRUE if we are reloading, FALSE otherwise.
+///
 gboolean
 JobLoad::isReload ()
@@ -112 +175 @@
 }
 
+///
+/// @brief Open the document.
+///
+/// This function will insensitive the Open and Reload actions, set
+/// the view's status bar text, sets the wait cursor, and creates a new thread
+/// that opens the document.
+///
 void
 JobLoad::run ()
@@ -119 +189 @@
         g_thread_init (NULL);
     }
+    
+    // Unsensitive the open and reload actions.
+    IMainView &view = getPresenter ().getView ();
+    view.sensitiveOpen (FALSE);
+    view.sensitiveReload (FALSE);
+    // Show the statusbar text.
+    gchar *statusText = NULL;
+    if ( isReload () )
+    {
+        statusText = g_strdup_printf (_("Reloading file %s..."), 
+                                        getFileName ());
+    }
+    else
+    {
+        statusText = g_strdup_printf (_("Loading file %s..."), getFileName ());
+    }
+    view.setStatusBarText (statusText);
+    g_free (statusText);
+    // Set the cursor.
+    view.setCursor (MAIN_VIEW_CURSOR_WAIT);
 
     GError *error = NULL;
@@ -128 +218 @@
 }
 
+///
+/// @brief Sets the file name to open.
+///
+/// @param fileName The file name to load or reload.
+///
 void
 JobLoad::setFileName (const gchar *fileName)
@@ -135 +230 @@
 }
 
+///
+/// @brief Sets the last error.
+///
+/// @param error The last error opening a file.
+///
 void
 JobLoad::setError (GError *error)
@@ -145 +245 @@
 }
 
+///
+/// @brief Sets the page number.
+///
+/// This is used for reloading, see getPageNum().
+///
+/// @param pageNum The page to go when the document is reloaded.
+///
 void
 JobLoad::setPage (gint pageNum)
@@ -151 +258 @@
 }
 
+///
+/// @brief Sets the password to open the document.
+///
+/// @param password The password to use.
+///
 void
 JobLoad::setPassword (const gchar *password)
@@ -158 +270 @@
 }
 
+///
+/// @brief Sets the presenter that loads the document.
+///
+/// @param pter The MainPter that will load the document.
+///
 void
 JobLoad::setPresenter (MainPter *pter)
@@ -164 +281 @@
 }
 
+///
+/// @brief Sets if we are reloading.
+///
+/// @param reload TRUE if we are reloading, false otherwise.
+///
 void
 JobLoad::setReload (gboolean reload)
@@ -170 +292 @@
 }
 
+///
+/// @brief Sets the rotation to use after reloading.
+///
+/// @param rotation The degrees of rotation.
+///
 void
 JobLoad::setRotation (gint rotation)
@@ -176 +303 @@
 }
 
+///
+/// @brief Sets the zoom to use after reloading.
+///
+/// @param zoom The level of zoom.
+///
 void
 JobLoad::setZoom (gdouble zoom)
@@ -182 +314 @@
 }
 
-///
-
+////////////////////////////////////////////////////////////////
+// Static threaded functions.
+////////////////////////////////////////////////////////////////
+
+///
+/// @brief The load is finished.
+///
+/// This can be called either when the document was loaded correctly or 
+/// after an error. What it does is set the presenter in a known state
+/// ready to be used again.
+///
+/// @param data This parameter hold the JobLoad to open.
+/// 
 gboolean
 job_load_done (gpointer data)
@@ -201 +344 @@
 }
 
+///
+/// @brief The load had errors.
+///
+/// This is called when the load of the document had any error except
+/// when it's encrypted.
+///
+/// @param data This parameter hold the JobLoad to open.
+/// 
 gboolean
 job_load_error (gpointer data)
@@ -209 +360 @@
     job->getPresenter ().getView ().showErrorMessage (_("Error Loading File"),
                                                     job->getError ()->message);
-    delete job;
-
-    return FALSE;
-}
-
+    job->setReload (FALSE);
+    return job_load_done (data);
+}
+
+///
+/// @brief The document is encrypted.
+///
+/// This function is called when the document is encrypted. It asks to the
+/// user the password and tries until the user doesn't supply a password
+/// anymore (returned NULL) or canTryPassword() returns FALSE.
+///
+/// When trying a new password, it creates a new thread.
+///
+/// @param data This parameter hold the JobLoad to open.
+/// 
 gboolean
 job_load_password (gpointer data)
@@ -234 +395 @@
                 g_error_free (error);
             }
-        }
-        else
-        {
-            delete job;
+            return FALSE;
         }
     }
@@ -246 +404 @@
                 _("The password you have supplier is not a valid password "
                   "for this file."));
-        delete job;
-    }
-
-    return FALSE;
-}
-
+    }
+
+    return job_load_done (data);
+}
+
+///
+/// @brief Opens the files.
+///
+/// This is the threaded function that will try to call the presenter's
+/// loading function with the given file name and password. This function
+/// just tests if the load was successful or not and then tells glib to 
+/// call the actual end function, that will show the result to the user.
+///
+/// When this function is compiled with DEBUG defined, the calls to the
+/// "end" functions aren't scheduled by glib, since the test framework doesn't
+/// use it.
+///
+/// @param data This parameter hold the JobLoad to open.
+///
 gpointer
 job_load_run (gpointer data)

trunk/src/JobLoad.h

@@ -23 +23 @@
     // Forward declarations.
     class MainPter;
-    
+   
+    ///
+    /// @class JobLoad
+    /// @brief A background job that loads a file.
+    ///
+    /// This class is used to load and reload the PDF files. It creates
+    /// a thread that loads a file name.
+    ///
     class JobLoad
     {

trunk/src/MainPter.cxx

@@ -136 +136 @@
     }
 
+    // Sensitive the open file action.
+    view.sensitiveOpen (TRUE);
     // Show the toolbar and statusbar depending on the configuration.
     view.showToolbar (config.showToolbar ());
@@ -141 +143 @@
     view.setOutline (m_Document->getOutline ());
     view.showSidebar (showSidebar);
+    // Remove the status bar text.
+    view.setStatusBarText (NULL);
     // Show the first page *AFTER* showing the sidebar because 
     // the view change the row to the first outline that doesn't need
@@ -146 +150 @@
     // by the first outline is selected and we don't want this.
     m_Document->goToFirstPage ();
+    // Show the normal cursor.
+    view.setCursor (MAIN_VIEW_CURSOR_NORMAL);
     view.show (); 
 }
@@ -278 +284 @@
     Config &config = Config::getConfig ();
     gchar *lastFolder = config.getOpenFileFolder ();
-    gchar *fileName = getView ().openFileDialog (lastFolder);
+    IMainView &view = getView ();
+    gchar *fileName = view.openFileDialog (lastFolder);
     g_free (lastFolder);    
     if ( NULL != fileName )
@@ -287 +294 @@
     }
 
+    // Open the file.
     JobLoad *job = new JobLoad ();
     job->setPresenter (this);
@@ -356 +364 @@
 void
 MainPter::reloadActivated ()
-{    
+{   
+    // Reopen the document.
     JobLoad *job = new JobLoad ();
     job->setPresenter (this);
@@ -366 +375 @@
     job->setRotation (m_Document->getRotation ());
     job->setZoom ( m_Document->getZoom ());
-    // Reopen the document.
     job->run ();
 }
@@ -617 +625 @@
     return TRUE;
 }
-/*
-        {
-            // Now that the document has been loaded, just reset the initial
-            // state.
-            setInitialState (canShowPage);
-        }
-        else
-        {
-            // We got an error, but also can be that the file is encrypted.
-            if ( DocumentErrorEncrypted == error->code )
-            {
-                // Now we got an encrypted file.
-                // Prompt for the password up to three time, until the password
-                // is correct or the user cancels the password dialog.
-                int passwordTries = 0;
-                gchar *password = NULL;
-                gboolean loaded = FALSE;
-                do 
-                {
-                    g_free (password);
-                    password = getView ().promptPasswordDialog ();
-                    loaded = m_Document->loadFile (fileName, password, NULL);
-                } while ( 3 > ++passwordTries && 
-                          NULL != password && 
-                          !loaded);
-
-                // We are go, just check if we could load it or show the
-                // error.
-                if ( loaded )
-                {
-                    // Phew, finally loaded. Set the initial state.
-                    setInitialState (canShowPage);
-                }
-                else if ( NULL != password )
-                {
-                    // We didn't get the correct password, but the user
-                    // tried, because the password is not NULL.
-                    getView ().showErrorMessage (_("Error Loading File"),
-                            _("The password you have supplier is not a"
-                              " valid password for this file."));
-                    g_free (password);
-                }
-            }
-            else
-            {
-                // It was an error. Show the error message.
-                getView ().showErrorMessage (_("Error Loading File"), 
-                                             error->message);                
-
-            }
-            g_free (error);
-        }
-    }
-    
-}
-*/
 
 ///

trunk/src/gtk/MainView.cxx

@@ -357 +357 @@
 
 void 
+MainView::sensitiveOpen (gboolean sensitive)
+{
+    GtkAction *open = 
+        gtk_ui_manager_get_action (m_UIManager, "/MenuBar/FileMenu/OpenFile");
+    gtk_action_set_sensitive (open, sensitive);
+}
+
+void 
 MainView::sensitiveReload (gboolean sensitive)
 {
@@ -479 +487 @@
 }
 
+void
+MainView::setCursor (ViewCursor cursorType)
+{
+    GdkCursor *cursor = NULL;
+    switch (cursorType)
+    {
+        case MAIN_VIEW_CURSOR_WAIT:
+            cursor = gdk_cursor_new (GDK_WATCH);
+            break;
+        case MAIN_VIEW_CURSOR_DRAG:
+            cursor = gdk_cursor_new (GDK_FLEUR);
+            break;
+        default:
+            cursor = NULL;
+    }
+
+    if ( NULL != m_MainWindow && GDK_IS_WINDOW (m_MainWindow->window) )
+    {
+        gdk_window_set_cursor (m_MainWindow->window, cursor);
+    }
+    if ( NULL != cursor )
+    {
+        gdk_cursor_unref (cursor);
+    }
+    gdk_flush ();
+}
+
 void 
 MainView::setTotalPages (gint pages)
@@ -497 +532 @@
 {
     return gtk_entry_get_text (GTK_ENTRY (m_CurrentPage));
+}
+
+void
+MainView::setStatusBarText (const gchar *text)
+{
+    gint contextId = gtk_statusbar_get_context_id (GTK_STATUSBAR (m_StatusBar),
+            "general_message");
+    gtk_statusbar_pop (GTK_STATUSBAR (m_StatusBar), contextId);
+    if ( NULL != text )
+    {
+        gtk_statusbar_push (GTK_STATUSBAR (m_StatusBar), contextId, text);
+    }
 }
 
@@ -1074 +1121 @@
         DragInfo *info = (DragInfo *)data;
         delete info;
-        
         return TRUE;
     }

trunk/src/gtk/MainView.h

@@ -42 +42 @@
             void sensitiveGoToPreviousPage (gboolean sensitive);
             void sensitiveReload (gboolean sensitive);
+            void sensitiveOpen (gboolean sensitive);
             void sensitiveRotateLeft (gboolean sensitive);
             void sensitiveRotateRight (gboolean sensitive);
@@ -52 +53 @@
             void showPage (DocumentPage *page, PageScroll scroll);
             void showSidebar (gboolean show);
+            void setCursor (ViewCursor cursorType);
             void setTotalPages (gint pages);
             void setGoToPageText (const gchar *text);
+            void setStatusBarText (const gchar *text);
             const gchar *getGoToPageText (void);
             void getPageViewSize (gint *width, gint *height);

trunk/src/main.cxx

@@ -54 +54 @@
     // Create the main presenter.
     MainPter *mainPter = new MainPter ();
+    // Create the main view.
+    MainView *mainView = new MainView (mainPter);
+    // Let know to the presenter which is its view.
+    mainPter->setView (mainView);
+    // Enter the main loop and wait for user interaction. */
     // Now check if we have additional parameters. Any additional parameter
     // will be a file name to open.
@@ -63 +68 @@
         job->run ();
     }
-    // Create the main view.
-    MainView *mainView = new MainView (mainPter);
-    // Let know to the presenter which is its view.
-    mainPter->setView (mainView);
-    // Enter the main loop and wait for user interaction. */
     gtk_main();
     

trunk/tests/DumbMainView.cxx

@@ -126 +126 @@
 
 void
+DumbMainView::sensitiveOpen (gboolean sensitive)
+{
+}
+
+void
 DumbMainView::sensitiveReload (gboolean sensitive)
 {