Changeset 58 for trunk/src/DocumentOutline.h

Timestamp:

04/14/06 10:13:02 (3 years ago)

Author:

jordi

Message:

I've changed the old DocumentIndex? class name to DocumentOutline?, following a little closer the PDF specifications.

Created a new test fixture for the DocumentOutline?, removing this part from the PDFDocument test fixture.

I also removed the Poppler headers from the epdfview.h header, so I don't need to specify the POPPLER_CFLAGS on the test directory.

Files:

• trunk/src/DocumentOutline.h (moved) (moved from trunk/src/DocumentIndex.h) (2 diffs)

trunk/src/DocumentOutline.h

@@ -16 +16 @@
 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
-#if !defined (__DOCUMENT_INDEX_H__)
-#define __DOCUMENT_INDEX_H__
+#if !defined (__DOCUMENT_OUTLINE_H__)
+#define __DOCUMENT_OUTLINE_H__
 
 namespace ePDFView
 {
     ///
-    /// @class DocumentIndex
-    /// @brief Stores the document's index name, action and its children.
+    /// @class DocumentOutline
+    /// @brief Stores the document's outline title, page num. and its children.
     ///
     /// Some documents have an index with them. This index can be used to
@@ -29 +29 @@
     /// contents.
     ///
-    /// Each node contains a name, an action an possibly children nodes. The
-    /// only node that have an empty name and no action is the top level 
-    /// DocumentIndex, that is only used as a container for all other
-    /// DocumentIndex objects.
+    /// Each node contains a title, a destination page an possibly children
+    /// nodes. The only node that have an empty name and a 0 page number is the
+    /// top level DocumentOutline, that is only used as a container for all 
+    /// other DocumentOutline objects.
     ///
-    class DocumentIndex
+    class DocumentOutline
     {
         public:
-            DocumentIndex (void);
-            ~DocumentIndex (void);
+            DocumentOutline (void);
+            ~DocumentOutline (void);
 
+            gint getDestinationPage (void);
+            DocumentOutline *getFirstChild (void);
             gint getNumChildren (void);
+            const gchar *getTitle (void);
     };
 }
 
-#endif // !__DOCUMENT_INDEX_H__
+#endif // !__DOCUMENT_OUTLINE_H__