Changeset 49 for trunk/src/IDocument.h

Show
Ignore:
Timestamp:
04/13/06 05:47:01 (3 years ago)
Author:
jordi
Message:

Added the doxygen documentation builder file in the "doc" directory. I've also wirtten the missing documentation for all files in "src", but not in "src/gtk" a it would be redundant.

Also I've been paranoic on spelling (I'm a very bad spelled) and spell checked all source files, changing some string. Updated the translations.

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • trunk/src/IDocument.h

    r22 r49  
    3535        /// Couldn't open the PDF file. 
    3636        DocumentErrorOpenFile = 1, 
    37         /// Coudln't read the page catalog. 
     37        /// Couldn't read the page catalog. 
    3838        DocumentErrorBadCatalog = 2, 
    3939        /// PDF file is damaged and couldn't be repaired. 
    … …  
    6666        PageModeOC, 
    6767        PageModeAttach, 
    68         // Not yet defined. 
     68        /// Not set yet. 
    6969        PageModeUnset 
    7070    } PageMode; 
    … …  
    8181        PageLayoutTwoPageLeft, 
    8282        PageLayoutTwoPageRight, 
    83         // Not yet defined. 
     83        // Not set yet. 
    8484        PageLayoutUnset 
    8585    } PageLayout; 
    8686 
    8787    /// 
    88     /// @class Document 
    89     /// @brief Has information about a single document. 
    90     /// 
    91     /// Every PDF handled by the application is represented as a Document 
    92     /// class. All information about the document, number of pages, current 
    93     /// page, etc. is inside this class. 
     88    /// @class IDocument 
     89    /// @brief Interface for documents. 
     90    /// 
     91    /// Every document type that the application can handle must be  
     92    /// created from this base class. 
     93    /// Besides the abstracts methods for open a document, this class also 
     94    /// handles the rotation and zoom levels for any IDocument's child class. 
    9495    /// 
    9596    class IDocument 
    … …  
    9899            virtual ~IDocument (void); 
    99100 
     101            /// 
     102            /// @brief Checks if the document has been loaded. 
     103            /// 
     104            /// @return TRUE if the document has been loaded or FALSE otherwise. 
     105            /// 
    100106            virtual gboolean isLoaded (void) = 0; 
     107 
     108            /// 
     109            /// @brief Load a document file. 
     110            /// 
     111            /// Tries to open the document file @a filename using @a password 
     112            /// as a password to decrypt the document. 
     113            /// 
     114            /// The rotation degree is reset to 0 and the scale level to 1.0f 
     115            /// 
     116            /// @param filename The path, absolute or relative, to the flame  
     117            ///                 to open. 
     118            /// @param password The password to use to decrypt @a filename. If 
     119            ///                 the file is not encrypted, you can set it to 
     120            ///                 NULL. 
     121            /// @param error Location to store any error that could happen or 
     122            ///              set to NULL to ignore errors. 
     123            /// 
     124            /// @return TRUE if the file could be opened. FALSE otherwise. 
     125            ///  
    101126            virtual gboolean loadFile (const gchar *filename,  
    102127                                       const gchar *password,  
    103128                                       GError **error) = 0; 
     129            /// 
     130            /// @brief Gets the current page's unscaled size. 
     131            /// 
     132            /// Retrieves the width and height of the current page before 
     133            /// scaling, but after rotate it. 
     134            /// 
     135            /// @param width The location to save the page's width. 
     136            /// @param height The location to save the page's height. 
     137            /// 
     138            virtual void getPageSize (gdouble *width, gdouble *height) = 0; 
     139 
     140            /// 
     141            /// @brief Renders the current page. 
     142            /// 
     143            /// Rendering the current page means to get the pixels for the 
     144            /// current page image given the current rotation and scale level. 
     145            /// 
     146            /// @return A DocumentPage with the image. The returned page must 
     147            ///         be freed by calling delete when done with it. 
     148            /// 
     149            virtual DocumentPage *renderPage (void) = 0; 
     150 
     151             
    104152            const gchar *getTitle (void); 
    105153            void setTitle (const gchar *title); 
    … …  
    121169            void setLinearized (gboolean linearized); 
    122170            const gchar *getCreationDate (void); 
    123             void setCreationDate (const char *date); 
     171            void setCreationDate (const gchar *date); 
    124172            const gchar *getModifiedDate (void); 
    125173            void setModifiedDate (const gchar *date); 
    … …  
    133181            DocumentIndex &getDocumentIndex (void); 
    134182 
    135             void goToFirstPage (); 
    136             void goToLastPage (); 
    137             void goToNextPage (); 
     183            void goToFirstPage (void); 
     184            void goToLastPage (void); 
     185            void goToNextPage (void); 
    138186            void goToPage (gint pageNum); 
    139             void goToPreviousPage (); 
     187            void goToPreviousPage (void); 
    140188 
    141189            gint getRotation (void); 
    … …  
    150198            void zoomToFit (gint width, gint height); 
    151199            void zoomToWidth (gint width); 
    152  
    153             virtual void getPageSize (gdouble *width, gdouble *height) = 0; 
    154             virtual DocumentPage *renderPage (void) = 0; 
    155200 
    156201            static GQuark getErrorQuark (void);