Changeset 58 for trunk/src/DocumentOutline.cxx

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.cxx (moved) (moved from trunk/src/DocumentIndex.cxx) (1 diff)

trunk/src/DocumentOutline.cxx

@@ -22 +22 @@
 
 ///
-/// @brief Constructs a new DocumentIndex.
+/// @brief Constructs a new DocumentOutline.
 ///
-DocumentIndex::DocumentIndex ()
+DocumentOutline::DocumentOutline ()
 {
 }
 
 ///
-/// @brief Destroys any dynamically created object of DocumentIndex;
+/// @brief Destroys any dynamically allocated memory for DocumentOutline.
 ///
-DocumentIndex::~DocumentIndex ()
+DocumentOutline::~DocumentOutline ()
 {
 }
 
 ///
-/// @brief Get the number of children for this index.
+/// @brief Get the outline's destination page.
 ///
-/// @return The number of children this index has.
+/// I'm only using the outlines as a way to go to an specific page, although
+/// the PDF Specification says that an outline could open a page from another
+/// file, execute an application, etc... I won't use all those features and
+/// concentrate only on the pages.
+///
+/// @return The destination page number for the outline number or 1 if the
+///         outline item has no page number (like the root outline item or
+///         other kinds of destinations).
 ///
 gint
-DocumentIndex::getNumChildren ()
+DocumentOutline::getDestinationPage ()
+{
+    return 1;
+}
+
+///
+/// @brief The first children of the outline item.
+///
+/// @return The pointer to the first children of the outline item, or
+///         NULL if the outline has no children.
+///
+DocumentOutline *
+DocumentOutline::getFirstChild ()
+{
+    return NULL;
+}
+
+///
+/// @brief Gets the number of children for this outline.
+///
+/// @return The number of children this utline has.
+///
+gint
+DocumentOutline::getNumChildren ()
 {
     return 0;
 }
+
+///
+/// @brief Gets the outline's title.
+///
+/// @return The title of the outline item or an empty string if the
+///         outline item has no title (like the root outline item).
+///
+const gchar *
+DocumentOutline::getTitle ()
+{
+    return "";
+}