[poppler] glib/poppler-action.h glib/poppler-annot.cc glib/poppler-date.cc glib/poppler-document.cc glib/poppler-layer.cc glib/poppler-media.cc glib/poppler-media.h glib/poppler-movie.cc glib/poppler-page.cc glib/reference
Carlos Garcia Campos
carlosgc at kemper.freedesktop.org
Thu Jul 1 09:02:22 PDT 2010
glib/poppler-action.h | 10 +++++++---
glib/poppler-annot.cc | 17 +++++++++++++++++
glib/poppler-date.cc | 2 ++
glib/poppler-document.cc | 16 +++++++++++++++-
glib/poppler-layer.cc | 12 ++++++++++++
glib/poppler-media.cc | 14 ++++++++++++--
glib/poppler-media.h | 3 +++
glib/poppler-movie.cc | 6 ++++++
glib/poppler-page.cc | 2 ++
glib/reference/poppler-docs.sgml | 12 ++++++++++++
10 files changed, 88 insertions(+), 6 deletions(-)
New commits:
commit 6facefb3fa8f97a9d330545308fb2d89c7f57fa0
Author: Carlos Garcia Campos <carlosgc at gnome.org>
Date: Thu Jul 1 18:01:45 2010 +0200
[glib] docs: Add index of new symbols for versions 0.12, 0.14 and 0.16
diff --git a/glib/poppler-action.h b/glib/poppler-action.h
index de59e44..6bb87ba 100644
--- a/glib/poppler-action.h
+++ b/glib/poppler-action.h
@@ -33,9 +33,9 @@ G_BEGIN_DECLS
* @POPPLER_ACTION_LAUNCH: launch app (or open document
* @POPPLER_ACTION_URI: URI
* @POPPLER_ACTION_NAMED: predefined action
- * @POPPLER_ACTION_MOVIE: play movies
- * @POPPLER_ACTION_RENDITION: play multimedia content
- * @POPPLER_ACTION_OCG_STATE: state of layer
+ * @POPPLER_ACTION_MOVIE: play movies. Since 0.14
+ * @POPPLER_ACTION_RENDITION: play multimedia content. Since 0.14
+ * @POPPLER_ACTION_OCG_STATE: state of layer. Since 0.14
*
* Action types
*/
@@ -107,6 +107,8 @@ typedef enum
* @POPPLER_ACTION_MOVIE_STOP: stop playing movie
*
* Movie operations
+ *
+ * Since: 0.14
*/
typedef enum
{
@@ -123,6 +125,8 @@ typedef enum
* @POPPLER_ACTION_LAYER_TOGGLE: reverse the layer visibility state
*
* Layer actions
+ *
+ * Since: 0.14
*/
typedef enum
{
diff --git a/glib/poppler-annot.cc b/glib/poppler-annot.cc
index 0c40f10..03dfaec 100644
--- a/glib/poppler-annot.cc
+++ b/glib/poppler-annot.cc
@@ -414,6 +414,8 @@ poppler_annot_get_contents (PopplerAnnot *poppler_annot)
*
* Sets the contents of @poppler_annot to the given value,
* replacing the current contents.
+ *
+ * Since: 0.12
**/
void
poppler_annot_set_contents (PopplerAnnot *poppler_annot,
@@ -550,6 +552,8 @@ poppler_annot_get_color (PopplerAnnot *poppler_annot)
* Returns the page index to which @poppler_annot is associated, or -1 if unknown
*
* Return value: page index or -1
+ *
+ * Since: 0.14
**/
gint
poppler_annot_get_page_index (PopplerAnnot *poppler_annot)
@@ -593,6 +597,8 @@ poppler_annot_markup_get_label (PopplerAnnotMarkup *poppler_annot)
* Return %TRUE if the markup annotation has a popup window associated
*
* Return value: %TRUE, if @poppler_annot has popup, %FALSE otherwise
+ *
+ * Since: 0.12
**/
gboolean
poppler_annot_markup_has_popup (PopplerAnnotMarkup *poppler_annot)
@@ -640,6 +646,8 @@ poppler_annot_markup_get_popup_is_open (PopplerAnnotMarkup *poppler_annot)
*
* Return value: %TRUE if #PopplerRectangle was correctly filled,
* %FALSE otherwise
+ *
+ * Since: 0.12
**/
gboolean
poppler_annot_markup_get_popup_rectangle (PopplerAnnotMarkup *poppler_annot,
@@ -968,6 +976,8 @@ poppler_annot_free_text_get_callout_line (PopplerAnnotFreeText *poppler_annot)
* The #PopplerAttachment must be unrefed with g_object_unref by the caller.
*
* Return value: @PopplerAttachment
+ *
+ * Since: 0.14
**/
PopplerAttachment *
poppler_annot_file_attachment_get_attachment (PopplerAnnotFileAttachment *poppler_annot)
@@ -994,6 +1004,7 @@ poppler_annot_file_attachment_get_attachment (PopplerAnnotFileAttachment *popple
*
* Return value: a new allocated string with the name of @poppler_annot. It must
* be freed with g_free() when done.
+ * Since: 0.14
**/
gchar *
poppler_annot_file_attachment_get_name (PopplerAnnotFileAttachment *poppler_annot)
@@ -1071,6 +1082,8 @@ poppler_annot_callout_line_free (PopplerAnnotCalloutLine *callout)
* Retrieves the movie title of @poppler_annot.
*
* Return value: the title text of @poppler_annot.
+*
+* Since: 0.14
*/
gchar *
poppler_annot_movie_get_title (PopplerAnnotMovie *poppler_annot)
@@ -1095,6 +1108,8 @@ poppler_annot_movie_get_title (PopplerAnnotMovie *poppler_annot)
*
* Return value: the movie object stored in the @poppler_annot. The returned
* object is owned by #PopplerAnnotMovie and should not be freed
+*
+* Since: 0.14
*/
PopplerMovie *
poppler_annot_movie_get_movie (PopplerAnnotMovie *poppler_annot)
@@ -1111,6 +1126,8 @@ poppler_annot_movie_get_movie (PopplerAnnotMovie *poppler_annot)
*
* Return value: the action to perform. The returned
* object is owned by @poppler_annot and should not be freed
+ *
+ * Since: 0.14
*/
PopplerAction *
poppler_annot_screen_get_action (PopplerAnnotScreen *poppler_annot)
diff --git a/glib/poppler-date.cc b/glib/poppler-date.cc
index 2444f93..e3141c1 100644
--- a/glib/poppler-date.cc
+++ b/glib/poppler-date.cc
@@ -30,6 +30,8 @@
* if the parsing fails or the input string is not a valid PDF format date string
*
* Return value: #TRUE, if @timet was set
+ *
+ * Since: 0.12
**/
gboolean
poppler_date_parse (const gchar *date,
diff --git a/glib/poppler-document.cc b/glib/poppler-document.cc
index b2c1910..68451d5 100644
--- a/glib/poppler-document.cc
+++ b/glib/poppler-document.cc
@@ -1735,6 +1735,8 @@ POPPLER_DEFINE_BOXED_TYPE (PopplerLayersIter, poppler_layers_iter,
* poppler_layers_iter_free().
*
* Return value: a new #PopplerLayersIter
+ *
+ * Since 0.12
**/
PopplerLayersIter *
poppler_layers_iter_copy (PopplerLayersIter *iter)
@@ -1754,6 +1756,8 @@ poppler_layers_iter_copy (PopplerLayersIter *iter)
* @iter: a #PopplerLayersIter
*
* Frees @iter.
+ *
+ * Since: 0.12
**/
void
poppler_layers_iter_free (PopplerLayersIter *iter)
@@ -1768,6 +1772,8 @@ poppler_layers_iter_free (PopplerLayersIter *iter)
/**
* poppler_layers_iter_new:
* @document: a #PopplerDocument
+ *
+ * Since: 0.12
**/
PopplerLayersIter *
poppler_layers_iter_new (PopplerDocument *document)
@@ -1795,6 +1801,8 @@ poppler_layers_iter_new (PopplerDocument *document)
* See poppler_layers_iter_new() for more information on this function.
*
* Return value: a new #PopplerLayersIter, or %NULL
+ *
+ * Since: 0.12
**/
PopplerLayersIter *
poppler_layers_iter_get_child (PopplerLayersIter *parent)
@@ -1825,7 +1833,9 @@ poppler_layers_iter_get_child (PopplerLayersIter *parent)
* g_free().
*
* Return value: a new string containing the @iter's title or %NULL if @iter doesn't have a title.
- * The returned string should be freed with g_free() when no longer needed.
+ * The returned string should be freed with g_free() when no longer needed.
+ *
+ * Since: 0.12
**/
gchar *
poppler_layers_iter_get_title (PopplerLayersIter *iter)
@@ -1847,6 +1857,8 @@ poppler_layers_iter_get_title (PopplerLayersIter *iter)
* poppler_layer_free().
*
* Return value: a new #PopplerLayer, or %NULL if there isn't any layer associated with @iter
+ *
+ * Since: 0.12
**/
PopplerLayer *
poppler_layers_iter_get_layer (PopplerLayersIter *iter)
@@ -1875,6 +1887,8 @@ poppler_layers_iter_get_layer (PopplerLayersIter *iter)
* poppler_layers_iter_new() for more information.
*
* Return value: %TRUE, if @iter was set to the next action
+ *
+ * Since: 0.12
**/
gboolean
poppler_layers_iter_next (PopplerLayersIter *iter)
diff --git a/glib/poppler-layer.cc b/glib/poppler-layer.cc
index 021ca0b..12f06b7 100644
--- a/glib/poppler-layer.cc
+++ b/glib/poppler-layer.cc
@@ -97,6 +97,8 @@ _poppler_layer_new (PopplerDocument *document,
* presentation as a title in a viewer's GUI
*
* Return value: a string containing the title of the layer
+ *
+ * Since: 0.12
**/
const gchar *
poppler_layer_get_title (PopplerLayer *poppler_layer)
@@ -113,6 +115,8 @@ poppler_layer_get_title (PopplerLayer *poppler_layer)
* Returns whether @layer is visible
*
* Return value: %TRUE if @layer is visible
+ *
+ * Since: 0.12
**/
gboolean
poppler_layer_is_visible (PopplerLayer *poppler_layer)
@@ -127,6 +131,8 @@ poppler_layer_is_visible (PopplerLayer *poppler_layer)
* @layer: a #PopplerLayer
*
* Shows @layer
+ *
+ * Since: 0.12
**/
void
poppler_layer_show (PopplerLayer *poppler_layer)
@@ -158,6 +164,8 @@ poppler_layer_show (PopplerLayer *poppler_layer)
* Hides @layer. If @layer is the parent of other nested layers,
* such layers will be also hidden and will be blocked until @layer
* is shown again
+ *
+ * Since: 0.12
**/
void
poppler_layer_hide (PopplerLayer *poppler_layer)
@@ -182,6 +190,8 @@ poppler_layer_hide (PopplerLayer *poppler_layer)
* Returns whether @layer is parent of other nested layers.
*
* Return value: %TRUE if @layer is a parent layer
+ *
+ * Since: 0.12
**/
gboolean
poppler_layer_is_parent (PopplerLayer *poppler_layer)
@@ -199,6 +209,8 @@ poppler_layer_is_parent (PopplerLayer *poppler_layer)
*
* Return value: the ID of the radio button group associated with @layer,
* or 0 if the layer is not associated to any radio button group
+ *
+ * Since: 0.12
**/
gint
poppler_layer_get_radio_button_group_id (PopplerLayer *poppler_layer)
diff --git a/glib/poppler-media.cc b/glib/poppler-media.cc
index 1380fef..ab2270a 100644
--- a/glib/poppler-media.cc
+++ b/glib/poppler-media.cc
@@ -117,6 +117,8 @@ _poppler_media_new (MediaRendition *poppler_media)
* a local relative or absolute path or a URI
*
* Return value: a filename, return value is owned by #PopplerMedia and should not be freed
+*
+* Since: 0.14
*/
const gchar *
poppler_media_get_filename (PopplerMedia *poppler_media)
@@ -137,6 +139,8 @@ poppler_media_get_filename (PopplerMedia *poppler_media)
* poppler_media_get_file_name() function.
*
* Return value: %TRUE if media clip is embedded, %FALSE otherwise
+ *
+ * Since: 0.14
*/
gboolean
poppler_media_is_embedded (PopplerMedia *poppler_media)
@@ -153,6 +157,8 @@ poppler_media_is_embedded (PopplerMedia *poppler_media)
* Returns the media clip mime-type
*
* Return value: the mime-type, return value is owned by #PopplerMedia and should not be freed
+ *
+ * Since: 0.14
*/
const gchar *
poppler_media_get_mime_type (PopplerMedia *poppler_media)
@@ -197,7 +203,9 @@ save_helper (const gchar *buf,
* and whatever the save function generates.
*
* Return value: %TRUE, if the file successfully saved
- **/
+ *
+ * Since: 0.14
+ */
gboolean
poppler_media_save (PopplerMedia *poppler_media,
const char *filename,
@@ -258,7 +266,9 @@ poppler_media_save (PopplerMedia *poppler_media,
* whatever the save function generates.
*
* Return value: %TRUE, if the save successfully completed
- **/
+ *
+ * Since: 0.14
+ */
gboolean
poppler_media_save_to_callback (PopplerMedia *poppler_media,
PopplerMediaSaveFunc save_func,
diff --git a/glib/poppler-media.h b/glib/poppler-media.h
index 755695a..c8ad222 100644
--- a/glib/poppler-media.h
+++ b/glib/poppler-media.h
@@ -30,6 +30,7 @@ G_BEGIN_DECLS
#define POPPLER_IS_MEDIA(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), POPPLER_TYPE_MEDIA))
// FIXME: this should be generic (PopplerSaveToCallbackFunc)
+
/**
* PopplerMediaSaveFunc:
* @buf: buffer containing bytes to be written.
@@ -45,6 +46,8 @@ G_BEGIN_DECLS
* will fail with the same error.
*
* Returns: %TRUE if successful, %FALSE (with @error set) if failed.
+ *
+ * Since: 0.14
*/
typedef gboolean (*PopplerMediaSaveFunc) (const gchar *buf,
gsize count,
diff --git a/glib/poppler-movie.cc b/glib/poppler-movie.cc
index b162653..cb5a2ad 100644
--- a/glib/poppler-movie.cc
+++ b/glib/poppler-movie.cc
@@ -102,6 +102,8 @@ _poppler_movie_new (Movie *poppler_movie)
*
* Return value: a local filename, return value is owned by #PopplerMovie and
* should not be freed
+*
+* Since: 0.14
*/
const gchar *
poppler_movie_get_filename (PopplerMovie *poppler_movie)
@@ -120,6 +122,8 @@ poppler_movie_get_filename (PopplerMovie *poppler_movie)
* from the movie file.
*
* Return value: %TRUE if move needs a poster image, %FALSE otherwise
+ *
+ * Since: 0.14
*/
gboolean
poppler_movie_need_poster (PopplerMovie *poppler_movie)
@@ -136,6 +140,8 @@ poppler_movie_need_poster (PopplerMovie *poppler_movie)
* Returns whether to display a movie controller bar while playing the movie
*
* Return value: %TRUE if controller bar should be displayed, %FALSE otherwise
+ *
+ * Since: 0.14
*/
gboolean
poppler_movie_show_controls (PopplerMovie *poppler_movie)
diff --git a/glib/poppler-page.cc b/glib/poppler-page.cc
index b7c7df7..c5d696c 100644
--- a/glib/poppler-page.cc
+++ b/glib/poppler-page.cc
@@ -1896,6 +1896,8 @@ poppler_page_get_crop_box (PopplerPage *page, PopplerRectangle *rect)
* poppler_page_get_text
*
* Return value: %TRUE if the page contains text, %FALSE otherwise
+ *
+ * Since: 0.16
**/
gboolean
poppler_page_get_text_layout (PopplerPage *page,
diff --git a/glib/reference/poppler-docs.sgml b/glib/reference/poppler-docs.sgml
index 8486da5..dc8bf40 100644
--- a/glib/reference/poppler-docs.sgml
+++ b/glib/reference/poppler-docs.sgml
@@ -30,4 +30,16 @@
<title>Index of all symbols</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
+ <index id="api-index-0-12">
+ <title>Index of new symbols in 0.12</title>
+ <xi:include href="xml/api-index-0.12.xml"><xi:fallback /></xi:include>
+ </index>
+ <index id="api-index-0-14">
+ <title>Index of new symbols in 0.14</title>
+ <xi:include href="xml/api-index-0.14.xml"><xi:fallback /></xi:include>
+ </index>
+ <index id="api-index-0-16">
+ <title>Index of new symbols in 0.16</title>
+ <xi:include href="xml/api-index-0.16.xml"><xi:fallback /></xi:include>
+ </index>
</book>
More information about the poppler
mailing list