[poppler]
poppler/glib: poppler-action.cc, 1.4, 1.5 poppler-action.h,
1.3, 1.4 poppler-document.cc, 1.28, 1.29 poppler-document.h,
1.16, 1.17 poppler-page.cc, 1.40, 1.41 test-poppler-glib.c,
1.14, 1.15 poppler.cc, 1.3, 1.4
Jonathan Blandford
jrb at freedesktop.org
Fri Dec 30 18:10:36 PST 2005
- Previous message: [poppler] poppler: ChangeLog,1.270,1.271
- Next message: [poppler] poppler/glib: poppler-action.cc, 1.4,
1.5 poppler-action.h, 1.3, 1.4 poppler-document.cc, 1.28,
1.29 poppler-document.h, 1.16, 1.17 poppler-page.cc, 1.40,
1.41 test-poppler-glib.c, 1.14, 1.15 poppler.cc, 1.3, 1.4
- Messages sorted by:
[ date ]
[ thread ]
[ subject ]
[ author ]
Update of /cvs/poppler/poppler/glib
In directory gabe:/tmp/cvs-serv19405/glib
Modified Files:
poppler-action.cc poppler-action.h poppler-document.cc
poppler-document.h poppler-page.cc test-poppler-glib.c
poppler.cc
Log Message:
Fri Dec 30 21:08:33 2005 Jonathan Blandford <jrb at redhat.com>
* glib/*{cc,h}: Update inline doc comments. This is in
preparation for gtk-doc support.
Index: poppler-action.cc
===================================================================
RCS file: /cvs/poppler/poppler/glib/poppler-action.cc,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- poppler-action.cc 26 Sep 2005 19:29:45 -0000 1.4
+++ poppler-action.cc 31 Dec 2005 02:10:33 -0000 1.5
@@ -51,6 +51,12 @@
return our_type;
}
+/**
+ * poppler_action_free:
+ * @action: a #PopplerAction
+ *
+ * Frees @action
+ **/
void
poppler_action_free (PopplerAction *action)
{
@@ -71,6 +77,14 @@
g_free (action);
}
+/**
+ * poppler_action_copy:
+ * @action: a #PopplerAction
+ *
+ * Copies @action, creating an identical #PopplerAction.
+ *
+ * Return value: a new action identical to @action
+ **/
PopplerAction *
poppler_action_copy (PopplerAction *action)
{
Index: poppler-action.h
===================================================================
RCS file: /cvs/poppler/poppler/glib/poppler-action.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- poppler-action.h 26 Sep 2005 10:42:38 -0000 1.3
+++ poppler-action.h 31 Dec 2005 02:10:33 -0000 1.4
@@ -128,8 +128,6 @@
{
PopplerActionType type;
gchar *title;
-
- // Annot
};
union _PopplerAction
Index: poppler-document.cc
===================================================================
RCS file: /cvs/poppler/poppler/glib/poppler-document.cc,v
retrieving revision 1.28
retrieving revision 1.29
diff -u -d -r1.28 -r1.29
--- poppler-document.cc 4 Nov 2005 19:03:55 -0000 1.28
+++ poppler-document.cc 31 Dec 2005 02:10:33 -0000 1.29
@@ -59,6 +59,18 @@
G_DEFINE_TYPE (PopplerDocument, poppler_document, G_TYPE_OBJECT);
+/**
+ * poppler_document_new_from_file:
+ * @uri: uri of the file to load
+ * @password: password to unlock the file with, or %NULL
+ * @error: Return location for an error, or %NULL
+ *
+ * Creates a new #PopplerDocument. If %NULL is returned, then @error will be
+ * set. Possible errors include those in the #POPPLER_ERROR and #G_FILE_ERROR
+ * domains.
+ *
+ * Return value: A newly created #PopplerDocument, or %NULL
+ **/
PopplerDocument *
poppler_document_new_from_file (const char *uri,
const char *password,
@@ -126,6 +138,17 @@
return document;
}
+/**
+ * poppler_document_save:
+ * @document: a #PopplerDocument
+ * @uri: uri of file to save
+ * @error: return location for an error, or %NULL
+ *
+ * Saves @document. If @error is set, %FALSE will be returned. Possible errors
+ * include those in the #G_FILE_ERROR domain.
+ *
+ * Return value: %TRUE, if the document was successfully saved
+ **/
gboolean
poppler_document_save (PopplerDocument *document,
const char *uri,
@@ -155,6 +178,14 @@
delete document->doc;
}
+/**
+ * poppler_document_get_n_pages:
+ * @document: A #PopplerDocument
+ *
+ * Returns the number of pages in a loaded document.
+ *
+ * Return value: Number of pages
+ **/
int
poppler_document_get_n_pages (PopplerDocument *document)
{
@@ -163,6 +194,18 @@
return document->doc->getNumPages();
}
+/**
+ * poppler_document_get_page:
+ * @document: A #PopplerDocument
+ * @index: a page index
+ *
+ * Returns the #PopplerPage indexed at @index. This object is owned by the
+ * caller.
+ *
+ * #PopplerPage<!-- -->s are indexed starting at 0.
+ *
+ * Return value: The #PopplerPage at @index
+ **/
PopplerPage *
poppler_document_get_page (PopplerDocument *document,
int index)
@@ -180,6 +223,19 @@
return _poppler_page_new (document, page, index);
}
+/**
+ * poppler_document_get_page_by_label:
+ * @document: A #PopplerDocument
+ * @label: a page label
+ *
+ * Returns the #PopplerPage reference by @label. This object is owned by the
+ * caller. @label is a human-readable string representation of the page number,
+ * and can be document specific. Typically, it is a value such as "iii" or "3".
+ *
+ * By default, "1" refers to the first page.
+ *
+ * Return value: The #PopplerPage referenced by @label
+ **/
PopplerPage *
poppler_document_get_page_by_label (PopplerDocument *document,
const char *label)
@@ -633,6 +689,15 @@
return our_type;
}
+/**
+ * poppler_index_iter_copy:
+ * @iter: a #PopplerIndexIter
+ *
+ * Creates a new #PopplerIndexIter as a copy of @iter. This must be freed with
+ * poppler_index_iter_free().
+ *
+ * Return value: a new #PopplerIndexIter
+ **/
PopplerIndexIter *
poppler_index_iter_copy (PopplerIndexIter *iter)
{
@@ -647,6 +712,45 @@
return new_iter;
}
+/**
+ * poppler_index_iter_new:
+ * @document: a #PopplerDocument
+ *
+ * Returns the root #PopplerIndexIter for @document, or %NULL. This must be
+ * freed with poppler_index_iter_free().
+ *
+ * Certain documents have an index associated with them. This index can be used
+ * to help the user navigate the document, and is similar to a table of
+ * contents. Each node in the index will contain a #PopplerAction that can be
+ * displayed to the user — typically a #POPPLER_ACTION_GOTO_DEST or a
+ * #POPPLER_ACTION_URI<!-- -->.
+ *
+ * Here is a simple example of some code that walks the full index:
+ *
+ * <informalexample><programlisting>
+ * static void
+ * walk_index (PopplerIndexIter *iter)
+ * {
+ * do
+ * {
+ * /<!-- -->* Get the the action and do something with it *<!-- -->/
+ * PopplerIndexIter *child = poppler_index_iter_get_child (iter);
+ * if (child)
+ * walk_index (child);
+ * poppler_index_iter_free (child);
+ * }
+ * while (poppler_index_iter_next (iter));
+ * }
+ * ...
+ * {
+ * iter = poppler_index_iter_new (document);
+ * walk_index (iter);
+ * poppler_index_iter_free (iter);
+ * }
+ *</programlisting></informalexample>
+ *
+ * Return value: a new #PopplerIndexIter
+ **/
PopplerIndexIter *
poppler_index_iter_new (PopplerDocument *document)
{
@@ -670,6 +774,15 @@
return iter;
}
+/**
+ * poppler_index_iter_get_child:
+ * @parent: a #PopplerIndexIter
+ *
+ * Returns a newly created child of @parent, or %NULL if the iter has no child.
+ * See poppler_index_iter_new() for more information on this function.
+ *
+ * Return value: a new #PopplerIndexIter
+ **/
PopplerIndexIter *
poppler_index_iter_get_child (PopplerIndexIter *parent)
{
@@ -716,6 +829,16 @@
return g_strdup (gstr.getCString ());
}
+/**
+ * poppler_index_iter_is_open:
+ * @iter: a #PopplerIndexIter
+ *
+ * Returns whether this node should be expanded by default to the user. The
+ * document can provide a hint as to how the document's index should be expanded
+ * initially.
+ *
+ * Return value: %TRUE, if the document wants @iter to be expanded
+ **/
gboolean
poppler_index_iter_is_open (PopplerIndexIter *iter)
{
@@ -726,6 +849,15 @@
return item->isOpen();
}
+/**
+ * poppler_index_iter_get_action:
+ * @iter: a #PopplerIndexIter
+ *
+ * Returns the #PopplerAction associated with @iter. It must be freed with
+ * poppler_action_free().
+ *
+ * Return value: a new #PopplerAction
+ **/
PopplerAction *
poppler_index_iter_get_action (PopplerIndexIter *iter)
{
@@ -748,6 +880,15 @@
return action;
}
+/**
+ * poppler_index_iter_next:
+ * @iter: a #PopplerIndexIter
+ *
+ * Sets @iter to point to the next action at the current level, if valid. See
+ * poppler_index_iter_new() for more information.
+ *
+ * Return value: %TRUE, if @iter was set to the next action
+ **/
gboolean
poppler_index_iter_next (PopplerIndexIter *iter)
{
@@ -760,6 +901,12 @@
return TRUE;
}
+/**
+ * poppler_index_iter_free:
+ * @iter: a #PopplerIndexIter
+ *
+ * Frees @iter.
+ **/
void
poppler_index_iter_free (PopplerIndexIter *iter)
{
@@ -1013,7 +1160,7 @@
/**
* poppler_ps_file_set_duplex:
- * @ps_file a PopplerPSFile which was not yet printed to
+ * @ps_file: a PopplerPSFile which was not yet printed to
* @duplex: whether to force duplex printing (on printers which support this)
*
* Enable or disable Duplex printing.
@@ -1031,7 +1178,7 @@
* poppler_ps_file_free:
* @ps_file: a PopplerPSFile
*
- * Free a PopplerPSFile
+ * Frees @ps_file
*
**/
void
Index: poppler-document.h
===================================================================
RCS file: /cvs/poppler/poppler/glib/poppler-document.h,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -d -r1.16 -r1.17
--- poppler-document.h 3 Dec 2005 23:23:53 -0000 1.16
+++ poppler-document.h 31 Dec 2005 02:10:33 -0000 1.17
@@ -97,7 +97,7 @@
GError **error);
int poppler_document_get_n_pages (PopplerDocument *document);
PopplerPage *poppler_document_get_page (PopplerDocument *document,
- int page);
+ int index);
PopplerPage *poppler_document_get_page_by_label (PopplerDocument *document,
const char *label);
@@ -133,7 +133,7 @@
/* Export to ps */
PopplerPSFile *poppler_ps_file_new (PopplerDocument *document,
const char *filename,
- int first_pages,
+ int first_page,
int n_pages);
void poppler_ps_file_set_paper_size (PopplerPSFile *ps_file,
double width,
Index: poppler-page.cc
===================================================================
RCS file: /cvs/poppler/poppler/glib/poppler-page.cc,v
retrieving revision 1.40
retrieving revision 1.41
diff -u -d -r1.40 -r1.41
--- poppler-page.cc 4 Dec 2005 02:24:26 -0000 1.40
+++ poppler-page.cc 31 Dec 2005 02:10:33 -0000 1.41
@@ -73,6 +73,14 @@
/* page->page is owned by the document */
}
+/**
+ * poppler_page_get_size:
+ * @page: A #PopplerPage
+ * @width: return location for the width of @page
+ * @height: return location for the height of @page
+ *
+ * Gets the size of @page at the current scale and rotation.
+ **/
void
poppler_page_get_size (PopplerPage *page,
double *width,
@@ -98,6 +106,14 @@
*height = page_height;
}
+/**
+ * poppler_page_get_index:
+ * @page: a #PopplerPage
+ *
+ * Returns the index of @page
+ *
+ * Return value: index value of @page
+ **/
int
poppler_page_get_index (PopplerPage *page)
{
@@ -333,6 +349,18 @@
return page->text_dev;
}
+/**
+ * poppler_page_get_selection_region:
+ * @page: a #PopplerPage
+ * @scale: scale specified as pixels per point
+ * @selection: start and end point of selection as a rectangle
+ *
+ * Returns a region containing the area that would be rendered by
+ * poppler_page_render_selection(). The returned region must be freed with
+ * gdk_region_destroy().
+ *
+ * Return value: a newly allocated #GdkRegion
+ **/
GdkRegion *
poppler_page_get_selection_region (PopplerPage *page,
gdouble scale,
Index: test-poppler-glib.c
===================================================================
RCS file: /cvs/poppler/poppler/glib/test-poppler-glib.c,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -d -r1.14 -r1.15
--- test-poppler-glib.c 22 Aug 2005 18:20:12 -0000 1.14
+++ test-poppler-glib.c 31 Dec 2005 02:10:33 -0000 1.15
@@ -8,6 +8,24 @@
static void
+print_index (PopplerIndexIter *iter)
+{
+ do
+ {
+ PopplerAction *action;
+
+ action = poppler_index_iter_get_action (iter);
+ g_print ("Action: %d\n", action->type);
+ poppler_action_free (action);
+ PopplerIndexIter *child = poppler_index_iter_get_child (iter);
+ if (child)
+ print_index (child);
+ poppler_index_iter_free (child);
+ }
+ while (poppler_index_iter_next (iter));
+}
+
+static void
print_document_info (PopplerDocument *document)
{
gchar *title, *format, *author, *subject, *keywords, *creator, *producer, *linearized;
@@ -67,6 +85,17 @@
}
poppler_font_info_free (font_info);
+ PopplerIndexIter *index_iter;
+ index_iter = poppler_index_iter_new (document);
+ if (index_iter)
+ {
+ g_print ("\tindex:\n");
+ print_index (index_iter);
+ poppler_index_iter_free (index_iter);
+ }
+
+
+
/* FIXME: print out the view prefs when we support it */
g_free (title);
Index: poppler.cc
===================================================================
RCS file: /cvs/poppler/poppler/glib/poppler.cc,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- poppler.cc 11 May 2005 20:01:43 -0000 1.3
+++ poppler.cc 31 Dec 2005 02:10:33 -0000 1.4
@@ -29,6 +29,14 @@
return q;
}
+/**
+ * poppler_get_backend:
+ * @void:
+ *
+ * Returns the backend compiled into the poppler library.
+ *
+ * Return value: The backend used by poppler
+ **/
PopplerBackend
poppler_get_backend (void)
{
@@ -43,6 +51,14 @@
static const char poppler_version[] = PACKAGE_VERSION;
+/**
+ * poppler_get_version:
+ * @void:
+ *
+ * Returns the version of poppler in use. This result is not to be freed.
+ *
+ * Return value: the version of poppler.
+ **/
const char *
poppler_get_version (void)
{
- Previous message: [poppler] poppler: ChangeLog,1.270,1.271
- Next message: [poppler] poppler/glib: poppler-action.cc, 1.4,
1.5 poppler-action.h, 1.3, 1.4 poppler-document.cc, 1.28,
1.29 poppler-document.h, 1.16, 1.17 poppler-page.cc, 1.40,
1.41 test-poppler-glib.c, 1.14, 1.15 poppler.cc, 1.3, 1.4
- Messages sorted by:
[ date ]
[ thread ]
[ subject ]
[ author ]
More information about the poppler
mailing list