diff options
Diffstat (limited to 'glib/Poppler-0.18.gir')
| -rw-r--r-- | glib/Poppler-0.18.gir | 2978 |
1 files changed, 2901 insertions, 77 deletions
diff --git a/glib/Poppler-0.18.gir b/glib/Poppler-0.18.gir index d1040b73..e3143b79 100644 --- a/glib/Poppler-0.18.gir +++ b/glib/Poppler-0.18.gir @@ -187,9 +187,11 @@ and/or use gtk-doc annotations. --> <record name="ActionLayer" c:type="PopplerActionLayer"> <doc xml:space="preserve">Action to perform over a list of layers</doc> <field name="action" writable="1"> + <doc xml:space="preserve">a #PopplerActionLayerAction</doc> <type name="ActionLayerAction" c:type="PopplerActionLayerAction"/> </field> <field name="layers" writable="1"> + <doc xml:space="preserve">list of #PopplerLayer<!-- -->s</doc> <type name="GLib.List" c:type="GList*"> <type name="gpointer" c:type="gpointer"/> </type> @@ -410,7 +412,8 @@ and/or use gtk-doc annotations. --> <method name="get_color" c:identifier="poppler_annot_get_color"> <doc xml:space="preserve">Retrieves the color of @poppler_annot.</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a new allocated #PopplerColor with the color values of @poppler_annot, or %NULL. It must be freed with g_free() when done.</doc> + <doc xml:space="preserve">a new allocated #PopplerColor with the color values of + @poppler_annot, or %NULL. It must be freed with g_free() when done.</doc> <type name="Color" c:type="PopplerColor*"/> </return-value> <parameters> @@ -423,7 +426,8 @@ and/or use gtk-doc annotations. --> <method name="get_contents" c:identifier="poppler_annot_get_contents"> <doc xml:space="preserve">Retrieves the contents of @poppler_annot.</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a new allocated string with the contents of @poppler_annot. It must be freed with g_free() when done.</doc> + <doc xml:space="preserve">a new allocated string with the contents of @poppler_annot. It + must be freed with g_free() when done.</doc> <type name="utf8" c:type="gchar*"/> </return-value> <parameters> @@ -452,7 +456,8 @@ and/or use gtk-doc annotations. --> string will be either a PDF format date or a text string. See also #poppler_date_parse()</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a new allocated string with the last modification data of @poppler_annot. It must be freed with g_free() when done.</doc> + <doc xml:space="preserve">a new allocated string with the last modification data of + @poppler_annot. It must be freed with g_free() when done.</doc> <type name="utf8" c:type="gchar*"/> </return-value> <parameters> @@ -465,7 +470,8 @@ See also #poppler_date_parse()</doc> <method name="get_name" c:identifier="poppler_annot_get_name"> <doc xml:space="preserve">Retrieves the name of @poppler_annot.</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a new allocated string with the name of @poppler_annot. It must be freed with g_free() when done.</doc> + <doc xml:space="preserve">a new allocated string with the name of @poppler_annot. It must + be freed with g_free() when done.</doc> <type name="utf8" c:type="gchar*"/> </return-value> <parameters> @@ -490,6 +496,28 @@ See also #poppler_date_parse()</doc> </instance-parameter> </parameters> </method> + <method name="get_rectangle" + c:identifier="poppler_annot_get_rectangle" + version="0.26"> + <doc xml:space="preserve">Retrieves the rectangle representing the page coordinates where the +annotation @poppler_annot is placed.</doc> + <return-value transfer-ownership="none"> + <type name="none" c:type="void"/> + </return-value> + <parameters> + <instance-parameter name="poppler_annot" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerAnnot</doc> + <type name="Annot" c:type="PopplerAnnot*"/> + </instance-parameter> + <parameter name="poppler_rect" + direction="out" + caller-allocates="1" + transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerRectangle to store the annotation's coordinates</doc> + <type name="Rectangle" c:type="PopplerRectangle*"/> + </parameter> + </parameters> + </method> <method name="set_color" c:identifier="poppler_annot_set_color" version="0.16"> @@ -504,6 +532,7 @@ See also #poppler_date_parse()</doc> </instance-parameter> <parameter name="poppler_color" transfer-ownership="none" + nullable="1" allow-none="1"> <doc xml:space="preserve">a #PopplerColor, or %NULL</doc> <type name="Color" c:type="PopplerColor*"/> @@ -548,6 +577,25 @@ replacing the current contents.</doc> </parameter> </parameters> </method> + <method name="set_rectangle" + c:identifier="poppler_annot_set_rectangle" + version="0.26"> + <doc xml:space="preserve">Move the annotation to the rectangle representing the page coordinates +where the annotation @poppler_annot should be placed.</doc> + <return-value transfer-ownership="none"> + <type name="none" c:type="void"/> + </return-value> + <parameters> + <instance-parameter name="poppler_annot" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerAnnot</doc> + <type name="Annot" c:type="PopplerAnnot*"/> + </instance-parameter> + <parameter name="poppler_rect" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerRectangle with the new annotation's coordinates</doc> + <type name="Rectangle" c:type="PopplerRectangle*"/> + </parameter> + </parameters> + </method> </class> <record name="AnnotCalloutLine" c:type="PopplerAnnotCalloutLine" @@ -578,14 +626,16 @@ replacing the current contents.</doc> <constructor name="new" c:identifier="poppler_annot_callout_line_new"> <doc xml:space="preserve">Creates a new empty #PopplerAnnotCalloutLine.</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a new allocated #PopplerAnnotCalloutLine, %NULL in other case. It must be freed when done.</doc> + <doc xml:space="preserve">a new allocated #PopplerAnnotCalloutLine, %NULL in other case. + It must be freed when done.</doc> <type name="AnnotCalloutLine" c:type="PopplerAnnotCalloutLine*"/> </return-value> </constructor> <method name="copy" c:identifier="poppler_annot_callout_line_copy"> <doc xml:space="preserve">It does copy @callout to a new #PopplerAnnotCalloutLine.</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a new allocated #PopplerAnnotCalloutLine as exact copy of @callout, %NULL in other case. It must be freed when done.</doc> + <doc xml:space="preserve">a new allocated #PopplerAnnotCalloutLine as exact copy of + @callout, %NULL in other case. It must be freed when done.</doc> <type name="AnnotCalloutLine" c:type="PopplerAnnotCalloutLine*"/> </return-value> <parameters> @@ -608,6 +658,71 @@ replacing the current contents.</doc> </parameters> </method> </record> + <class name="AnnotCircle" + c:symbol-prefix="annot_circle" + c:type="PopplerAnnotCircle" + parent="AnnotMarkup" + glib:type-name="PopplerAnnotCircle" + glib:get-type="poppler_annot_circle_get_type"> + <constructor name="new" + c:identifier="poppler_annot_circle_new" + version="0.26"> + <doc xml:space="preserve">Creates a new Circle annotation that will be +located on @rect when added to a page. See +poppler_page_add_annot()</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">a newly created #PopplerAnnotCircle annotation</doc> + <type name="Annot" c:type="PopplerAnnot*"/> + </return-value> + <parameters> + <parameter name="doc" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerDocument</doc> + <type name="Document" c:type="PopplerDocument*"/> + </parameter> + <parameter name="rect" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerRectangle</doc> + <type name="Rectangle" c:type="PopplerRectangle*"/> + </parameter> + </parameters> + </constructor> + <method name="get_interior_color" + c:identifier="poppler_annot_circle_get_interior_color" + version="0.26"> + <doc xml:space="preserve">Retrieves the interior color of @poppler_annot.</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">a new allocated #PopplerColor with the color values of + @poppler_annot, or %NULL. It must be freed with g_free() when done.</doc> + <type name="Color" c:type="PopplerColor*"/> + </return-value> + <parameters> + <instance-parameter name="poppler_annot" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerAnnotCircle</doc> + <type name="AnnotCircle" c:type="PopplerAnnotCircle*"/> + </instance-parameter> + </parameters> + </method> + <method name="set_interior_color" + c:identifier="poppler_annot_circle_set_interior_color" + version="0.26"> + <doc xml:space="preserve">Sets the interior color of @poppler_annot.</doc> + <return-value transfer-ownership="none"> + <type name="none" c:type="void"/> + </return-value> + <parameters> + <instance-parameter name="poppler_annot" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerAnnotCircle</doc> + <type name="AnnotCircle" c:type="PopplerAnnotCircle*"/> + </instance-parameter> + <parameter name="poppler_color" + transfer-ownership="none" + nullable="1" + allow-none="1"> + <doc xml:space="preserve">a #PopplerColor, or %NULL</doc> + <type name="Color" c:type="PopplerColor*"/> + </parameter> + </parameters> + </method> + </class> <enumeration name="AnnotExternalDataType" glib:type-name="PopplerAnnotExternalDataType" glib:get-type="poppler_annot_external_data_type_get_type" @@ -651,7 +766,8 @@ The #PopplerAttachment must be unrefed with g_object_unref by the caller.</doc> version="0.14"> <doc xml:space="preserve">Retrieves the name of @poppler_annot.</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a new allocated string with the name of @poppler_annot. It must be freed with g_free() when done.</doc> + <doc xml:space="preserve">a new allocated string with the name of @poppler_annot. It must + be freed with g_free() when done.</doc> <type name="utf8" c:type="gchar*"/> </return-value> <parameters> @@ -734,7 +850,9 @@ The #PopplerAttachment must be unrefed with g_object_unref by the caller.</doc> <doc xml:space="preserve">Retrieves a #PopplerAnnotCalloutLine of four or six numbers specifying a callout line attached to the @poppler_annot.</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a new allocated #PopplerAnnotCalloutLine if the annot has a callout line, %NULL in other case. It must be freed with g_free() when done.</doc> + <doc xml:space="preserve">a new allocated #PopplerAnnotCalloutLine if the annot has a callout + line, %NULL in other case. It must be freed with g_free() when + done.</doc> <type name="AnnotCalloutLine" c:type="PopplerAnnotCalloutLine*"/> </return-value> <parameters> @@ -780,6 +898,64 @@ line attached to the @poppler_annot.</doc> glib:nick="right-justified"> </member> </enumeration> + <class name="AnnotLine" + c:symbol-prefix="annot_line" + c:type="PopplerAnnotLine" + parent="AnnotMarkup" + glib:type-name="PopplerAnnotLine" + glib:get-type="poppler_annot_line_get_type"> + <constructor name="new" + c:identifier="poppler_annot_line_new" + version="0.26"> + <doc xml:space="preserve">Creates a new Line annotation that will be +located on @rect when added to a page. See +poppler_page_add_annot()</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">A newly created #PopplerAnnotLine annotation</doc> + <type name="Annot" c:type="PopplerAnnot*"/> + </return-value> + <parameters> + <parameter name="doc" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerDocument</doc> + <type name="Document" c:type="PopplerDocument*"/> + </parameter> + <parameter name="rect" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerRectangle</doc> + <type name="Rectangle" c:type="PopplerRectangle*"/> + </parameter> + <parameter name="start" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerPoint of the starting vertice</doc> + <type name="Point" c:type="PopplerPoint*"/> + </parameter> + <parameter name="end" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerPoint of the ending vertice</doc> + <type name="Point" c:type="PopplerPoint*"/> + </parameter> + </parameters> + </constructor> + <method name="set_vertices" + c:identifier="poppler_annot_line_set_vertices" + version="0.26"> + <doc xml:space="preserve">Set the coordinate points where the @poppler_annot starts and ends.</doc> + <return-value transfer-ownership="none"> + <type name="none" c:type="void"/> + </return-value> + <parameters> + <instance-parameter name="poppler_annot" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerAnnotLine</doc> + <type name="AnnotLine" c:type="PopplerAnnotLine*"/> + </instance-parameter> + <parameter name="start" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerPoint of the starting vertice</doc> + <type name="Point" c:type="PopplerPoint*"/> + </parameter> + <parameter name="end" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerPoint of the ending vertice</doc> + <type name="Point" c:type="PopplerPoint*"/> + </parameter> + </parameters> + </method> + </class> <record name="AnnotMapping" c:type="PopplerAnnotMapping" glib:type-name="PopplerAnnotMapping" @@ -788,9 +964,11 @@ line attached to the @poppler_annot.</doc> <doc xml:space="preserve">A #PopplerAnnotMapping structure represents the location of @annot on the page</doc> <field name="area" writable="1"> + <doc xml:space="preserve">a #PopplerRectangle representing an area of the page</doc> <type name="Rectangle" c:type="PopplerRectangle"/> </field> <field name="annot" writable="1"> + <doc xml:space="preserve">a #PopplerAnnot</doc> <type name="Annot" c:type="PopplerAnnot*"/> </field> <constructor name="new" c:identifier="poppler_annot_mapping_new"> @@ -835,7 +1013,8 @@ of @annot on the page</doc> <method name="get_date" c:identifier="poppler_annot_markup_get_date"> <doc xml:space="preserve">Returns the date and time when the annotation was created</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a #GDate representing the date and time when the annotation was created, or %NULL</doc> + <doc xml:space="preserve">a #GDate representing the date and time + when the annotation was created, or %NULL</doc> <type name="GLib.Date" c:type="GDate*"/> </return-value> <parameters> @@ -877,7 +1056,8 @@ of @annot on the page</doc> c:identifier="poppler_annot_markup_get_opacity"> <doc xml:space="preserve">Retrieves the opacity value of @poppler_annot.</doc> <return-value transfer-ownership="none"> - <doc xml:space="preserve">the opacity value of @poppler_annot, between 0 (transparent) and 1 (opaque)</doc> + <doc xml:space="preserve">the opacity value of @poppler_annot, + between 0 (transparent) and 1 (opaque)</doc> <type name="gdouble" c:type="gdouble"/> </return-value> <parameters> @@ -891,7 +1071,8 @@ of @annot on the page</doc> c:identifier="poppler_annot_markup_get_popup_is_open"> <doc xml:space="preserve">Retrieves the state of the popup window related to @poppler_annot.</doc> <return-value transfer-ownership="none"> - <doc xml:space="preserve">the state of @poppler_annot. %TRUE if it's open, %FALSE in other case.</doc> + <doc xml:space="preserve">the state of @poppler_annot. %TRUE if it's open, %FALSE in + other case.</doc> <type name="gboolean" c:type="gboolean"/> </return-value> <parameters> @@ -979,7 +1160,10 @@ of @annot on the page</doc> <doc xml:space="preserve">a #PopplerAnnotMarkup</doc> <type name="AnnotMarkup" c:type="PopplerAnnotMarkup*"/> </instance-parameter> - <parameter name="label" transfer-ownership="none" allow-none="1"> + <parameter name="label" + transfer-ownership="none" + nullable="1" + allow-none="1"> <doc xml:space="preserve">a text string containing the new label, or %NULL</doc> <type name="utf8" c:type="const gchar*"/> </parameter> @@ -1069,7 +1253,8 @@ Popup window shall be displayed by viewers at @popup_rect on the page.</doc> version="0.14"> <doc xml:space="preserve">Retrieves the movie object (PopplerMovie) stored in the @poppler_annot.</doc> <return-value transfer-ownership="none"> - <doc xml:space="preserve">the movie object stored in the @poppler_annot. The returned object is owned by #PopplerAnnotMovie and should not be freed</doc> + <doc xml:space="preserve">the movie object stored in the @poppler_annot. The returned + object is owned by #PopplerAnnotMovie and should not be freed</doc> <type name="Movie" c:type="PopplerMovie*"/> </return-value> <parameters> @@ -1106,7 +1291,8 @@ Popup window shall be displayed by viewers at @popup_rect on the page.</doc> version="0.14"> <doc xml:space="preserve">Retrieves the action (#PopplerAction) that shall be performed when @poppler_annot is activated</doc> <return-value transfer-ownership="none"> - <doc xml:space="preserve">the action to perform. The returned object is owned by @poppler_annot and should not be freed</doc> + <doc xml:space="preserve">the action to perform. The returned + object is owned by @poppler_annot and should not be freed</doc> <type name="Action" c:type="PopplerAction*"/> </return-value> <parameters> @@ -1117,6 +1303,71 @@ Popup window shall be displayed by viewers at @popup_rect on the page.</doc> </parameters> </method> </class> + <class name="AnnotSquare" + c:symbol-prefix="annot_square" + c:type="PopplerAnnotSquare" + parent="AnnotMarkup" + glib:type-name="PopplerAnnotSquare" + glib:get-type="poppler_annot_square_get_type"> + <constructor name="new" + c:identifier="poppler_annot_square_new" + version="0.26"> + <doc xml:space="preserve">Creates a new Square annotation that will be +located on @rect when added to a page. See +poppler_page_add_annot()</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">a newly created #PopplerAnnotSquare annotation</doc> + <type name="Annot" c:type="PopplerAnnot*"/> + </return-value> + <parameters> + <parameter name="doc" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerDocument</doc> + <type name="Document" c:type="PopplerDocument*"/> + </parameter> + <parameter name="rect" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerRectangle</doc> + <type name="Rectangle" c:type="PopplerRectangle*"/> + </parameter> + </parameters> + </constructor> + <method name="get_interior_color" + c:identifier="poppler_annot_square_get_interior_color" + version="0.26"> + <doc xml:space="preserve">Retrieves the interior color of @poppler_annot.</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">a new allocated #PopplerColor with the color values of + @poppler_annot, or %NULL. It must be freed with g_free() when done.</doc> + <type name="Color" c:type="PopplerColor*"/> + </return-value> + <parameters> + <instance-parameter name="poppler_annot" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerAnnotSquare</doc> + <type name="AnnotSquare" c:type="PopplerAnnotSquare*"/> + </instance-parameter> + </parameters> + </method> + <method name="set_interior_color" + c:identifier="poppler_annot_square_set_interior_color" + version="0.26"> + <doc xml:space="preserve">Sets the interior color of @poppler_annot.</doc> + <return-value transfer-ownership="none"> + <type name="none" c:type="void"/> + </return-value> + <parameters> + <instance-parameter name="poppler_annot" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerAnnotSquare</doc> + <type name="AnnotSquare" c:type="PopplerAnnotSquare*"/> + </instance-parameter> + <parameter name="poppler_color" + transfer-ownership="none" + nullable="1" + allow-none="1"> + <doc xml:space="preserve">a #PopplerColor, or %NULL</doc> + <type name="Color" c:type="PopplerColor*"/> + </parameter> + </parameters> + </method> + </class> <class name="AnnotText" c:symbol-prefix="annot_text" c:type="PopplerAnnotText" @@ -1160,7 +1411,8 @@ poppler_page_add_annot()</doc> <method name="get_is_open" c:identifier="poppler_annot_text_get_is_open"> <doc xml:space="preserve">Retrieves the state of @poppler_annot.</doc> <return-value transfer-ownership="none"> - <doc xml:space="preserve">the state of @poppler_annot. %TRUE if it's open, %FALSE in other case.</doc> + <doc xml:space="preserve">the state of @poppler_annot. %TRUE if it's open, %FALSE in + other case.</doc> <type name="gboolean" c:type="gboolean"/> </return-value> <parameters> @@ -1250,6 +1502,161 @@ icons are currently supported: </parameters> </method> </class> + <class name="AnnotTextMarkup" + c:symbol-prefix="annot_text_markup" + c:type="PopplerAnnotTextMarkup" + parent="AnnotMarkup" + glib:type-name="PopplerAnnotTextMarkup" + glib:get-type="poppler_annot_text_markup_get_type"> + <constructor name="new_highlight" + c:identifier="poppler_annot_text_markup_new_highlight" + version="0.26"> + <doc xml:space="preserve">Creates a new Highlight Text annotation that will be +located on @rect when added to a page. See poppler_page_add_annot()</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">A newly created #PopplerAnnotTextMarkup annotation</doc> + <type name="Annot" c:type="PopplerAnnot*"/> + </return-value> + <parameters> + <parameter name="doc" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerDocument</doc> + <type name="Document" c:type="PopplerDocument*"/> + </parameter> + <parameter name="rect" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerRectangle</doc> + <type name="Rectangle" c:type="PopplerRectangle*"/> + </parameter> + <parameter name="quadrilaterals" transfer-ownership="none"> + <doc xml:space="preserve">A #GArray of + #PopplerQuadrilateral<!-- -->s</doc> + <array name="GLib.Array" c:type="GArray*"> + <type name="Quadrilateral"/> + </array> + </parameter> + </parameters> + </constructor> + <constructor name="new_squiggly" + c:identifier="poppler_annot_text_markup_new_squiggly" + version="0.26"> + <doc xml:space="preserve">Creates a new Squiggly Text annotation that will be +located on @rect when added to a page. See poppler_page_add_annot()</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">A newly created #PopplerAnnotTextMarkup annotation</doc> + <type name="Annot" c:type="PopplerAnnot*"/> + </return-value> + <parameters> + <parameter name="doc" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerDocument</doc> + <type name="Document" c:type="PopplerDocument*"/> + </parameter> + <parameter name="rect" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerRectangle</doc> + <type name="Rectangle" c:type="PopplerRectangle*"/> + </parameter> + <parameter name="quadrilaterals" transfer-ownership="none"> + <doc xml:space="preserve">A #GArray of + #PopplerQuadrilateral<!-- -->s</doc> + <array name="GLib.Array" c:type="GArray*"> + <type name="Quadrilateral"/> + </array> + </parameter> + </parameters> + </constructor> + <constructor name="new_strikeout" + c:identifier="poppler_annot_text_markup_new_strikeout" + version="0.26"> + <doc xml:space="preserve">Creates a new Strike Out Text annotation that will be +located on @rect when added to a page. See poppler_page_add_annot()</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">A newly created #PopplerAnnotTextMarkup annotation</doc> + <type name="Annot" c:type="PopplerAnnot*"/> + </return-value> + <parameters> + <parameter name="doc" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerDocument</doc> + <type name="Document" c:type="PopplerDocument*"/> + </parameter> + <parameter name="rect" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerRectangle</doc> + <type name="Rectangle" c:type="PopplerRectangle*"/> + </parameter> + <parameter name="quadrilaterals" transfer-ownership="none"> + <doc xml:space="preserve">A #GArray of + #PopplerQuadrilateral<!-- -->s</doc> + <array name="GLib.Array" c:type="GArray*"> + <type name="Quadrilateral"/> + </array> + </parameter> + </parameters> + </constructor> + <constructor name="new_underline" + c:identifier="poppler_annot_text_markup_new_underline" + version="0.26"> + <doc xml:space="preserve">Creates a new Underline Text annotation that will be +located on @rect when added to a page. See poppler_page_add_annot()</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">A newly created #PopplerAnnotTextMarkup annotation</doc> + <type name="Annot" c:type="PopplerAnnot*"/> + </return-value> + <parameters> + <parameter name="doc" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerDocument</doc> + <type name="Document" c:type="PopplerDocument*"/> + </parameter> + <parameter name="rect" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerRectangle</doc> + <type name="Rectangle" c:type="PopplerRectangle*"/> + </parameter> + <parameter name="quadrilaterals" transfer-ownership="none"> + <doc xml:space="preserve">A #GArray of + #PopplerQuadrilateral<!-- -->s</doc> + <array name="GLib.Array" c:type="GArray*"> + <type name="Quadrilateral"/> + </array> + </parameter> + </parameters> + </constructor> + <method name="get_quadrilaterals" + c:identifier="poppler_annot_text_markup_get_quadrilaterals" + version="0.26"> + <doc xml:space="preserve">Returns a #GArray of #PopplerQuadrilateral items that map from a +location on @page to a #PopplerAnnotTextMarkup. This array must be freed +when done.</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">A #GArray of #PopplerQuadrilateral</doc> + <array name="GLib.Array" c:type="GArray*"> + <type name="Quadrilateral"/> + </array> + </return-value> + <parameters> + <instance-parameter name="poppler_annot" transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerAnnotTextMarkup</doc> + <type name="AnnotTextMarkup" c:type="PopplerAnnotTextMarkup*"/> + </instance-parameter> + </parameters> + </method> + <method name="set_quadrilaterals" + c:identifier="poppler_annot_text_markup_set_quadrilaterals" + version="0.26"> + <doc xml:space="preserve">Set the regions (Quadrilaterals) to apply the text markup in @poppler_annot.</doc> + <return-value transfer-ownership="none"> + <type name="none" c:type="void"/> + </return-value> + <parameters> + <instance-parameter name="poppler_annot" transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerAnnotTextMarkup</doc> + <type name="AnnotTextMarkup" c:type="PopplerAnnotTextMarkup*"/> + </instance-parameter> + <parameter name="quadrilaterals" transfer-ownership="none"> + <doc xml:space="preserve">A #GArray of + #PopplerQuadrilateral<!-- -->s</doc> + <array name="GLib.Array" c:type="GArray*"> + <type name="Quadrilateral"/> + </array> + </parameter> + </parameters> + </method> + </class> <enumeration name="AnnotTextState" glib:type-name="PopplerAnnotTextState" glib:get-type="poppler_annot_text_state_get_type" @@ -1435,7 +1842,8 @@ icons are currently supported: c:type="PopplerAttachment" parent="GObject.Object" glib:type-name="PopplerAttachment" - glib:get-type="poppler_attachment_get_type"> + glib:get-type="poppler_attachment_get_type" + glib:type-struct="AttachmentClass"> <method name="save" c:identifier="poppler_attachment_save" throws="1"> <doc xml:space="preserve">Saves @attachment to a file indicated by @filename. If @error is set, %FALSE will be returned. Possible errors include those in the #G_FILE_ERROR domain @@ -1508,6 +1916,13 @@ whatever the save function generates.</doc> <type name="GLib.String" c:type="GString*"/> </field> </class> + <record name="AttachmentClass" + c:type="PopplerAttachmentClass" + glib:is-gtype-struct-for="Attachment"> + <field name="parent_class"> + <type name="GObject.ObjectClass" c:type="GObjectClass"/> + </field> + </record> <callback name="AttachmentSaveFunc" c:type="PopplerAttachmentSaveFunc" throws="1"> @@ -1523,7 +1938,8 @@ will fail with the same error.</doc> </return-value> <parameters> <parameter name="buf" transfer-ownership="none"> - <doc xml:space="preserve">buffer containing bytes to be written.</doc> + <doc xml:space="preserve">buffer containing + bytes to be written.</doc> <array length="1" zero-terminated="0" c:type="gchar*"> <type name="guint8"/> </array> @@ -1566,12 +1982,15 @@ will fail with the same error.</doc> <doc xml:space="preserve">A #PopplerColor describes a RGB color. Color components are values between 0 and 65535</doc> <field name="red" writable="1"> + <doc xml:space="preserve">the red componment of color</doc> <type name="guint16" c:type="guint16"/> </field> <field name="green" writable="1"> + <doc xml:space="preserve">the green component of color</doc> <type name="guint16" c:type="guint16"/> </field> <field name="blue" writable="1"> + <doc xml:space="preserve">the blue component of color</doc> <type name="guint16" c:type="guint16"/> </field> <constructor name="new" c:identifier="poppler_color_new"> @@ -1614,36 +2033,47 @@ are values between 0 and 65535</doc> c:symbol-prefix="dest"> <doc xml:space="preserve">Data structure for holding a destination</doc> <field name="type" writable="1"> + <doc xml:space="preserve">type of destination</doc> <type name="DestType" c:type="PopplerDestType"/> </field> <field name="page_num" writable="1"> + <doc xml:space="preserve">page number</doc> <type name="gint" c:type="int"/> </field> <field name="left" writable="1"> + <doc xml:space="preserve">left coordinate</doc> <type name="gdouble" c:type="double"/> </field> <field name="bottom" writable="1"> + <doc xml:space="preserve">bottom coordinate</doc> <type name="gdouble" c:type="double"/> </field> <field name="right" writable="1"> + <doc xml:space="preserve">right coordinate</doc> <type name="gdouble" c:type="double"/> </field> <field name="top" writable="1"> + <doc xml:space="preserve">top coordinate</doc> <type name="gdouble" c:type="double"/> </field> <field name="zoom" writable="1"> + <doc xml:space="preserve">scale factor</doc> <type name="gdouble" c:type="double"/> </field> <field name="named_dest" writable="1"> + <doc xml:space="preserve">name of the destination (#POPPLER_DEST_NAMED only)</doc> <type name="utf8" c:type="gchar*"/> </field> <field name="change_left" writable="1" bits="1"> + <doc xml:space="preserve">whether left coordinate should be changed</doc> <type name="guint" c:type="guint"/> </field> <field name="change_top" writable="1" bits="1"> + <doc xml:space="preserve">whether top coordinate should be changed</doc> <type name="guint" c:type="guint"/> </field> <field name="change_zoom" writable="1" bits="1"> + <doc xml:space="preserve">whether scale factor should be changed</doc> <type name="guint" c:type="guint"/> </field> <method name="copy" c:identifier="poppler_dest_copy"> @@ -1687,49 +2117,66 @@ are values between 0 and 65535</doc> value="1" c:identifier="POPPLER_DEST_XYZ" glib:nick="xyz"> - <doc xml:space="preserve">go to page with coordinates (left, top) positioned at the upper-left corner of the window and the contents of the page magnified by the factor zoom</doc> + <doc xml:space="preserve">go to page with coordinates (left, top) +positioned at the upper-left corner of the window and the contents of +the page magnified by the factor zoom</doc> </member> <member name="fit" value="2" c:identifier="POPPLER_DEST_FIT" glib:nick="fit"> - <doc xml:space="preserve">go to page with its contents magnified just enough to fit the entire page within the window both horizontally and vertically</doc> + <doc xml:space="preserve">go to page with its contents magnified just +enough to fit the entire page within the window both horizontally and +vertically</doc> </member> <member name="fith" value="3" c:identifier="POPPLER_DEST_FITH" glib:nick="fith"> - <doc xml:space="preserve">go to page with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of the page within the window</doc> + <doc xml:space="preserve">go to page with the vertical coordinate top +positioned at the top edge of the window and the contents of the page +magnified just enough to fit the entire width of the page within the window</doc> </member> <member name="fitv" value="4" c:identifier="POPPLER_DEST_FITV" glib:nick="fitv"> - <doc xml:space="preserve">go to page with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of the page within the window</doc> + <doc xml:space="preserve">go to page with the horizontal coordinate +left positioned at the left edge of the window and the contents of the +page magnified just enough to fit the entire height of the page within the window</doc> </member> <member name="fitr" value="5" c:identifier="POPPLER_DEST_FITR" glib:nick="fitr"> - <doc xml:space="preserve">go to page with its contents magnified just enough to fit the rectangle specified by the coordinates left, bottom, right, and top entirely within the window both horizontally and vertically</doc> + <doc xml:space="preserve">go to page with its contents magnified just +enough to fit the rectangle specified by the coordinates left, bottom, +right, and top entirely within the window both horizontally and vertically</doc> </member> <member name="fitb" value="6" c:identifier="POPPLER_DEST_FITB" glib:nick="fitb"> - <doc xml:space="preserve">go to page with its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically</doc> + <doc xml:space="preserve">go to page with its contents magnified just enough to fit +its bounding box entirely within the window both horizontally and vertically</doc> </member> <member name="fitbh" value="7" c:identifier="POPPLER_DEST_FITBH" glib:nick="fitbh"> - <doc xml:space="preserve">go to page with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of its bounding box within the window</doc> + <doc xml:space="preserve">go to page with the vertical +coordinate top positioned at the top edge of the window and the +contents of the page magnified just enough to fit the entire width of its +bounding box within the window</doc> </member> <member name="fitbv" value="8" c:identifier="POPPLER_DEST_FITBV" glib:nick="fitbv"> - <doc xml:space="preserve">go to page with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of its bounding box within the window</doc> + <doc xml:space="preserve">go to page with the horizontal +coordinate left positioned at the left edge of the window and the +contents of the page magnified just enough to fit the entire height of its +bounding box within the window</doc> </member> <member name="named" value="9" @@ -1763,7 +2210,10 @@ domains.</doc> <doc xml:space="preserve">the length of #data</doc> <type name="gint" c:type="int"/> </parameter> - <parameter name="password" transfer-ownership="none" allow-none="1"> + <parameter name="password" + transfer-ownership="none" + nullable="1" + allow-none="1"> <doc xml:space="preserve">password to unlock the file with, or %NULL</doc> <type name="utf8" c:type="const char*"/> </parameter> @@ -1784,7 +2234,10 @@ domains.</doc> <doc xml:space="preserve">uri of the file to load</doc> <type name="utf8" c:type="const char*"/> </parameter> - <parameter name="password" transfer-ownership="none" allow-none="1"> + <parameter name="password" + transfer-ownership="none" + nullable="1" + allow-none="1"> <doc xml:space="preserve">password to unlock the file with, or %NULL</doc> <type name="utf8" c:type="const char*"/> </parameter> @@ -1806,12 +2259,16 @@ domains.</doc> <doc xml:space="preserve">a #GFile to load</doc> <type name="Gio.File" c:type="GFile*"/> </parameter> - <parameter name="password" transfer-ownership="none" allow-none="1"> + <parameter name="password" + transfer-ownership="none" + nullable="1" + allow-none="1"> <doc xml:space="preserve">password to unlock the file with, or %NULL</doc> <type name="utf8" c:type="const char*"/> </parameter> <parameter name="cancellable" transfer-ownership="none" + nullable="1" allow-none="1"> <doc xml:space="preserve">a #GCancellable, or %NULL</doc> <type name="Gio.Cancellable" c:type="GCancellable*"/> @@ -1840,12 +2297,16 @@ domains.</doc> <doc xml:space="preserve">the stream length, or -1 if not known</doc> <type name="gint64" c:type="goffset"/> </parameter> - <parameter name="password" transfer-ownership="none" allow-none="1"> + <parameter name="password" + transfer-ownership="none" + nullable="1" + allow-none="1"> <doc xml:space="preserve">password to unlock the file with, or %NULL</doc> <type name="utf8" c:type="const char*"/> </parameter> <parameter name="cancellable" transfer-ownership="none" + nullable="1" allow-none="1"> <doc xml:space="preserve">a #GCancellable, or %NULL</doc> <type name="Gio.Cancellable" c:type="GCancellable*"/> @@ -1855,7 +2316,9 @@ domains.</doc> <method name="find_dest" c:identifier="poppler_document_find_dest"> <doc xml:space="preserve">Finds named destination @link_name in @document</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">The #PopplerDest destination or %NULL if @link_name is not a destination. Returned value must be freed with #poppler_dest_free</doc> + <doc xml:space="preserve">The #PopplerDest destination or %NULL if +@link_name is not a destination. Returned value must +be freed with #poppler_dest_free</doc> <type name="Dest" c:type="PopplerDest*"/> </return-value> <parameters> @@ -1892,7 +2355,8 @@ g_list_free().</doc> version="0.16"> <doc xml:space="preserve">Returns the author of the document</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a new allocated string containing the author of @document, or %NULL</doc> + <doc xml:space="preserve">a new allocated string containing the author + of @document, or %NULL</doc> <type name="utf8" c:type="gchar*"/> </return-value> <parameters> @@ -1924,7 +2388,8 @@ g_list_free().</doc> from another format, the creator is the name of the product that created the original document from which it was converted.</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a new allocated string containing the creator of @document, or %NULL</doc> + <doc xml:space="preserve">a new allocated string containing the creator + of @document, or %NULL</doc> <type name="utf8" c:type="gchar*"/> </return-value> <parameters> @@ -1939,7 +2404,8 @@ that created the original document from which it was converted.</doc> <doc xml:space="preserve">Returns the #PopplerFormField for the given @id. It must be freed with g_object_unref()</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a new #PopplerFormField or %NULL if not found</doc> + <doc xml:space="preserve">a new #PopplerFormField or %NULL if +not found</doc> <type name="FormField" c:type="PopplerFormField*"/> </return-value> <parameters> @@ -1977,6 +2443,7 @@ size of 32 bytes.</doc> direction="out" caller-allocates="0" transfer-ownership="full" + optional="1" allow-none="1"> <doc xml:space="preserve">location to store an allocated string, use g_free() to free the returned string</doc> <type name="utf8" c:type="gchar**"/> @@ -1985,6 +2452,7 @@ size of 32 bytes.</doc> direction="out" caller-allocates="0" transfer-ownership="full" + optional="1" allow-none="1"> <doc xml:space="preserve">location to store an allocated string, use g_free() to free the returned string</doc> <type name="utf8" c:type="gchar**"/> @@ -1996,7 +2464,8 @@ size of 32 bytes.</doc> version="0.16"> <doc xml:space="preserve">Returns the keywords associated to the document</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a new allocated string containing keywords associated to @document, or %NULL</doc> + <doc xml:space="preserve">a new allocated string containing keywords associated + to @document, or %NULL</doc> <type name="utf8" c:type="gchar*"/> </return-value> <parameters> @@ -2011,7 +2480,8 @@ size of 32 bytes.</doc> version="0.16"> <doc xml:space="preserve">Returns the XML metadata string of the document</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a new allocated string containing the XML metadata, or %NULL</doc> + <doc xml:space="preserve">a new allocated string containing the XML + metadata, or %NULL</doc> <type name="utf8" c:type="gchar*"/> </return-value> <parameters> @@ -2152,6 +2622,7 @@ be initially displayed when opened.</doc> direction="out" caller-allocates="0" transfer-ownership="full" + optional="1" allow-none="1"> <doc xml:space="preserve">return location for the PDF major version number</doc> <type name="guint" c:type="guint*"/> @@ -2160,6 +2631,7 @@ be initially displayed when opened.</doc> direction="out" caller-allocates="0" transfer-ownership="full" + optional="1" allow-none="1"> <doc xml:space="preserve">return location for the PDF minor version number</doc> <type name="guint" c:type="guint*"/> @@ -2171,7 +2643,8 @@ be initially displayed when opened.</doc> version="0.16"> <doc xml:space="preserve">Returns the PDF version of @document as a string (e.g. PDF-1.6)</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a new allocated string containing the PDF version of @document, or %NULL</doc> + <doc xml:space="preserve">a new allocated string containing the PDF version + of @document, or %NULL</doc> <type name="utf8" c:type="gchar*"/> </return-value> <parameters> @@ -2203,7 +2676,8 @@ be initially displayed when opened.</doc> from another format, the producer is the name of the product that converted it to PDF</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a new allocated string containing the producer of @document, or %NULL</doc> + <doc xml:space="preserve">a new allocated string containing the producer + of @document, or %NULL</doc> <type name="utf8" c:type="gchar*"/> </return-value> <parameters> @@ -2218,7 +2692,8 @@ that converted it to PDF</doc> version="0.16"> <doc xml:space="preserve">Returns the subject of the document</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a new allocated string containing the subject of @document, or %NULL</doc> + <doc xml:space="preserve">a new allocated string containing the subject + of @document, or %NULL</doc> <type name="utf8" c:type="gchar*"/> </return-value> <parameters> @@ -2233,7 +2708,8 @@ that converted it to PDF</doc> version="0.16"> <doc xml:space="preserve">Returns the document's title</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a new allocated string containing the title of @document, or %NULL</doc> + <doc xml:space="preserve">a new allocated string containing the title + of @document, or %NULL</doc> <type name="utf8" c:type="gchar*"/> </return-value> <parameters> @@ -2298,8 +2774,8 @@ include those in the #G_FILE_ERROR domain.</doc> c:identifier="poppler_document_save_a_copy" throws="1"> <doc xml:space="preserve">Saves a copy of the original @document. -Any change made in the document such as -form fields filled by the user will not be saved. +Any change made in the document such as +form fields filled by the user will not be saved. If @error is set, %FALSE will be returned. Possible errors include those in the #G_FILE_ERROR domain.</doc> <return-value transfer-ownership="none"> @@ -2395,7 +2871,7 @@ include those in the #G_FILE_ERROR domain.</doc> value="0" c:identifier="POPPLER_ERROR_INVALID" glib:nick="invalid"> - <doc xml:space="preserve">Generic error when a document opration fails</doc> + <doc xml:space="preserve">Generic error when a document operation fails</doc> </member> <member name="encrypted" value="1" @@ -3052,7 +3528,8 @@ to be 'pressed in', and %FALSE to raise it.</doc> <doc xml:space="preserve">Retrieves the action (#PopplerAction) that shall be performed when @field is activated, or %NULL</doc> <return-value transfer-ownership="none"> - <doc xml:space="preserve">the action to perform. The returned object is owned by @field and should not be freed</doc> + <doc xml:space="preserve">the action to perform. The returned + object is owned by @field and should not be freed</doc> <type name="Action" c:type="PopplerAction*"/> </return-value> <parameters> @@ -3285,9 +3762,11 @@ the partial field names of the field and all of its ancestors.</doc> <doc xml:space="preserve">A #PopplerFormFieldMapping structure represents the location of @field on the page</doc> <field name="area" writable="1"> + <doc xml:space="preserve">a #PopplerRectangle representing an area of the page</doc> <type name="Rectangle" c:type="PopplerRectangle"/> </field> <field name="field" writable="1"> + <doc xml:space="preserve">a #PopplerFormField</doc> <type name="FormField" c:type="PopplerFormField*"/> </field> <constructor name="new" c:identifier="poppler_form_field_mapping_new"> @@ -3385,9 +3864,11 @@ of @field on the page</doc> <doc xml:space="preserve">A #PopplerImageMapping structure represents the location of an image on the page</doc> <field name="area" writable="1"> + <doc xml:space="preserve">a #PopplerRectangle representing an area of the page</doc> <type name="Rectangle" c:type="PopplerRectangle"/> </field> <field name="image_id" writable="1"> + <doc xml:space="preserve">an image identifier</doc> <type name="gint" c:type="gint"/> </field> <constructor name="new" c:identifier="poppler_image_mapping_new"> @@ -3567,7 +4048,8 @@ poppler_index_iter_new() for more information.</doc> version="0.12"> <doc xml:space="preserve">Returns the numeric ID the radio button group associated with @layer.</doc> <return-value transfer-ownership="none"> - <doc xml:space="preserve">the ID of the radio button group associated with @layer, or 0 if the layer is not associated to any radio button group</doc> + <doc xml:space="preserve">the ID of the radio button group associated with @layer, +or 0 if the layer is not associated to any radio button group</doc> <type name="gint" c:type="gint"/> </return-value> <parameters> @@ -3672,7 +4154,9 @@ is shown again</doc> <doc xml:space="preserve">Creates a new #PopplerLayersIter as a copy of @iter. This must be freed with poppler_layers_iter_free().</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a new #PopplerLayersIter Since 0.12</doc> + <doc xml:space="preserve">a new #PopplerLayersIter + +Since 0.12</doc> <type name="LayersIter" c:type="PopplerLayersIter*"/> </return-value> <parameters> @@ -3717,7 +4201,8 @@ See poppler_layers_iter_new() for more information on this function.</doc> version="0.12"> <doc xml:space="preserve">Returns the #PopplerLayer associated with @iter.</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a new #PopplerLayer, or %NULL if there isn't any layer associated with @iter</doc> + <doc xml:space="preserve">a new #PopplerLayer, or %NULL if +there isn't any layer associated with @iter</doc> <type name="Layer" c:type="PopplerLayer*"/> </return-value> <parameters> @@ -3733,7 +4218,8 @@ See poppler_layers_iter_new() for more information on this function.</doc> <doc xml:space="preserve">Returns the title associated with @iter. It must be freed with g_free().</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">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.</doc> + <doc xml:space="preserve">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.</doc> <type name="utf8" c:type="gchar*"/> </return-value> <parameters> @@ -3768,9 +4254,11 @@ poppler_layers_iter_new() for more information.</doc> <doc xml:space="preserve">A #PopplerLinkMapping structure represents the location of @action on the page</doc> <field name="area" writable="1"> + <doc xml:space="preserve">a #PopplerRectangle representing an area of the page</doc> <type name="Rectangle" c:type="PopplerRectangle"/> </field> <field name="action" writable="1"> + <doc xml:space="preserve">a #PopplerAction</doc> <type name="Action" c:type="PopplerAction*"/> </field> <constructor name="new" c:identifier="poppler_link_mapping_new"> @@ -3815,7 +4303,7 @@ of @action on the page</doc> <type name="gint" c:type="gint"/> </constant> <constant name="MICRO_VERSION" - value="1" + value="5" c:type="POPPLER_MICRO_VERSION" version="0.12"> <doc xml:space="preserve">The micro version number of the poppler header files (e.g. in poppler version @@ -3823,7 +4311,7 @@ of @action on the page</doc> <type name="gint" c:type="gint"/> </constant> <constant name="MINOR_VERSION" - value="24" + value="26" c:type="POPPLER_MINOR_VERSION" version="0.12"> <doc xml:space="preserve">The major version number of the poppler header files (e.g. in poppler version @@ -3956,7 +4444,8 @@ will fail with the same error.</doc> </return-value> <parameters> <parameter name="buf" transfer-ownership="none"> - <doc xml:space="preserve">buffer containing bytes to be written.</doc> + <doc xml:space="preserve">buffer containing + bytes to be written.</doc> <array length="1" zero-terminated="0" c:type="gchar*"> <type name="guint8"/> </array> @@ -3982,7 +4471,8 @@ will fail with the same error.</doc> version="0.14"> <doc xml:space="preserve">Returns the local filename identifying a self-describing movie file</doc> <return-value transfer-ownership="none"> - <doc xml:space="preserve">a local filename, return value is owned by #PopplerMovie and should not be freed</doc> + <doc xml:space="preserve">a local filename, return value is owned by #PopplerMovie and + should not be freed</doc> <type name="utf8" c:type="const gchar*"/> </return-value> <parameters> @@ -4150,7 +4640,8 @@ reference them with g_object_ref().</doc> </return-value> <parameters> <parameter name="list" transfer-ownership="none"> - <doc xml:space="preserve">A list of #PopplerAnnotMapping<!-- -->s</doc> + <doc xml:space="preserve">A list of + #PopplerAnnotMapping<!-- -->s</doc> <type name="GLib.List" c:type="GList*"> <type name="AnnotMapping"/> </type> @@ -4166,7 +4657,8 @@ poppler_page_get_form_field_mapping().</doc> </return-value> <parameters> <parameter name="list" transfer-ownership="none"> - <doc xml:space="preserve">A list of #PopplerFormFieldMapping<!-- -->s</doc> + <doc xml:space="preserve">A list of + #PopplerFormFieldMapping<!-- -->s</doc> <type name="GLib.List" c:type="GList*"> <type name="FormFieldMapping"/> </type> @@ -4182,7 +4674,8 @@ poppler_page_get_image_mapping().</doc> </return-value> <parameters> <parameter name="list" transfer-ownership="none"> - <doc xml:space="preserve">A list of #PopplerImageMapping<!-- -->s</doc> + <doc xml:space="preserve">A list of + #PopplerImageMapping<!-- -->s</doc> <type name="GLib.List" c:type="GList*"> <type name="ImageMapping"/> </type> @@ -4200,7 +4693,8 @@ copy them with poppler_action_copy().</doc> </return-value> <parameters> <parameter name="list" transfer-ownership="none"> - <doc xml:space="preserve">A list of #PopplerLinkMapping<!-- -->s</doc> + <doc xml:space="preserve">A list of + #PopplerLinkMapping<!-- -->s</doc> <type name="GLib.List" c:type="GList*"> <type name="LinkMapping"/> </type> @@ -4217,7 +4711,8 @@ poppler_page_get_text_attributes().</doc> </return-value> <parameters> <parameter name="list" transfer-ownership="none"> - <doc xml:space="preserve">A list of #PopplerTextAttributes<!-- -->s</doc> + <doc xml:space="preserve">A list of + #PopplerTextAttributes<!-- -->s</doc> <type name="GLib.List" c:type="GList*"> <type name="TextAttributes"/> </type> @@ -4226,14 +4721,16 @@ poppler_page_get_text_attributes().</doc> </function> <function name="selection_region_free" c:identifier="poppler_page_selection_region_free" - deprecated="0.16"> + deprecated="1" + deprecated-version="0.16"> <doc xml:space="preserve">Frees @region</doc> <return-value transfer-ownership="none"> <type name="none" c:type="void"/> </return-value> <parameters> <parameter name="region" transfer-ownership="none"> - <doc xml:space="preserve">a #GList of #PopplerRectangle</doc> + <doc xml:space="preserve">a #GList of + #PopplerRectangle</doc> <type name="GLib.List" c:type="GList*"> <type name="Rectangle"/> </type> @@ -4428,7 +4925,8 @@ with poppler_page_free_image_mapping() when done.</doc> <doc xml:space="preserve">Returns the label of @page. Note that page labels and page indices might not coincide.</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a new allocated string containing the label of @page, or %NULL if @page doesn't have a label</doc> + <doc xml:space="preserve">a new allocated string containing the label of @page, + or %NULL if @page doesn't have a label</doc> <type name="utf8" c:type="gchar*"/> </return-value> <parameters> @@ -4490,7 +4988,8 @@ The returned region must be freed with cairo_region_destroy()</doc> version="0.16"> <doc xml:space="preserve">Retrieves the contents of the specified @selection as text.</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a pointer to the contents of the @selection as a string</doc> + <doc xml:space="preserve">a pointer to the contents of the @selection + as a string</doc> <type name="utf8" c:type="char*"/> </return-value> <parameters> @@ -4510,12 +5009,13 @@ The returned region must be freed with cairo_region_destroy()</doc> </method> <method name="get_selection_region" c:identifier="poppler_page_get_selection_region" - deprecated="Use poppler_page_get_selected_region() instead." + deprecated="1" deprecated-version="0.16"> <doc xml:space="preserve">Returns a region containing the area that would be rendered by poppler_page_render_selection() as a #GList of #PopplerRectangle. The returned list must be freed with poppler_page_selection_region_free().</doc> + <doc-deprecated xml:space="preserve">Use poppler_page_get_selected_region() instead.</doc-deprecated> <return-value transfer-ownership="full"> <doc xml:space="preserve">a #GList of #PopplerRectangle</doc> <type name="GLib.List" c:type="GList*"> @@ -4555,6 +5055,7 @@ poppler_page_selection_region_free().</doc> direction="out" caller-allocates="0" transfer-ownership="full" + optional="1" allow-none="1"> <doc xml:space="preserve">return location for the width of @page</doc> <type name="gdouble" c:type="double*"/> @@ -4563,6 +5064,7 @@ poppler_page_selection_region_free().</doc> direction="out" caller-allocates="0" transfer-ownership="full" + optional="1" allow-none="1"> <doc xml:space="preserve">return location for the height of @page</doc> <type name="gdouble" c:type="double*"/> @@ -4574,7 +5076,8 @@ poppler_page_selection_region_free().</doc> version="0.16"> <doc xml:space="preserve">Retrieves the text of @page.</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">a pointer to the text of the @page as a string</doc> + <doc xml:space="preserve">a pointer to the text of the @page + as a string</doc> <type name="utf8" c:type="char*"/> </return-value> <parameters> @@ -4587,11 +5090,35 @@ poppler_page_selection_region_free().</doc> <method name="get_text_attributes" c:identifier="poppler_page_get_text_attributes" version="0.18"> - <doc xml:space="preserve">Obtains the attributes of the text as a GList of #PopplerTextAttributes. + <doc xml:space="preserve">Obtains the attributes of the text as a #GList of #PopplerTextAttributes. This list must be freed with poppler_page_free_text_attributes() when done. Each list element is a #PopplerTextAttributes struct where start_index and end_index indicates the range of text (as returned by poppler_page_get_text()) +to which text attributes apply. + +See also poppler_page_get_text_attributes_for_area()</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">A #GList of #PopplerTextAttributes</doc> + <type name="GLib.List" c:type="GList*"> + <type name="TextAttributes"/> + </type> + </return-value> + <parameters> + <instance-parameter name="page" transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerPage</doc> + <type name="Page" c:type="PopplerPage*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_text_attributes_for_area" + c:identifier="poppler_page_get_text_attributes_for_area" + version="0.26"> + <doc xml:space="preserve">Obtains the attributes of the text in @area as a #GList of #PopplerTextAttributes. +This list must be freed with poppler_page_free_text_attributes() when done. + +Each list element is a #PopplerTextAttributes struct where start_index and +end_index indicates the range of text (as returned by poppler_page_get_text_for_area()) to which text attributes apply.</doc> <return-value transfer-ownership="full"> <doc xml:space="preserve">A #GList of #PopplerTextAttributes</doc> @@ -4604,16 +5131,41 @@ to which text attributes apply.</doc> <doc xml:space="preserve">A #PopplerPage</doc> <type name="Page" c:type="PopplerPage*"/> </instance-parameter> + <parameter name="area" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerRectangle</doc> + <type name="Rectangle" c:type="PopplerRectangle*"/> + </parameter> + </parameters> + </method> + <method name="get_text_for_area" + c:identifier="poppler_page_get_text_for_area" + version="0.26"> + <doc xml:space="preserve">Retrieves the text of @page contained in @area.</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">a pointer to the text as a string</doc> + <type name="utf8" c:type="char*"/> + </return-value> + <parameters> + <instance-parameter name="page" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerPage</doc> + <type name="Page" c:type="PopplerPage*"/> + </instance-parameter> + <parameter name="area" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerRectangle</doc> + <type name="Rectangle" c:type="PopplerRectangle*"/> + </parameter> </parameters> </method> <method name="get_text_layout" c:identifier="poppler_page_get_text_layout" version="0.16"> <doc xml:space="preserve">Obtains the layout of the text as a list of #PopplerRectangle -This array must be freed with g_free () when done. +This array must be freed with g_free() when done. The position in the array represents an offset in the text returned by -poppler_page_get_text()</doc> +poppler_page_get_text() + +See also poppler_page_get_text_layout_for_area().</doc> <return-value transfer-ownership="none"> <doc xml:space="preserve">%TRUE if the page contains text, %FALSE otherwise</doc> <type name="gboolean" c:type="gboolean"/> @@ -4641,12 +5193,52 @@ poppler_page_get_text()</doc> </parameter> </parameters> </method> + <method name="get_text_layout_for_area" + c:identifier="poppler_page_get_text_layout_for_area" + version="0.26"> + <doc xml:space="preserve">Obtains the layout of the text contained in @area as a list of #PopplerRectangle +This array must be freed with g_free() when done. + +The position in the array represents an offset in the text returned by +poppler_page_get_text_for_area()</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">%TRUE if the page contains text, %FALSE otherwise</doc> + <type name="gboolean" c:type="gboolean"/> + </return-value> + <parameters> + <instance-parameter name="page" transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerPage</doc> + <type name="Page" c:type="PopplerPage*"/> + </instance-parameter> + <parameter name="area" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerRectangle</doc> + <type name="Rectangle" c:type="PopplerRectangle*"/> + </parameter> + <parameter name="rectangles" + direction="out" + caller-allocates="0" + transfer-ownership="container"> + <doc xml:space="preserve">return location for an array of #PopplerRectangle</doc> + <array length="2" zero-terminated="0" c:type="PopplerRectangle**"> + <type name="Rectangle" c:type="PopplerRectangle*"/> + </array> + </parameter> + <parameter name="n_rectangles" + direction="out" + caller-allocates="0" + transfer-ownership="full"> + <doc xml:space="preserve">length of returned array</doc> + <type name="guint" c:type="guint*"/> + </parameter> + </parameters> + </method> <method name="get_thumbnail" c:identifier="poppler_page_get_thumbnail"> <doc xml:space="preserve">Get the embedded thumbnail for the specified page. If the document doesn't have an embedded thumbnail for the page, this function returns %NULL.</doc> <return-value transfer-ownership="full"> - <doc xml:space="preserve">the tumbnail as a cairo_surface_t or %NULL if the document doesn't have a thumbnail for this page.</doc> + <doc xml:space="preserve">the tumbnail as a cairo_surface_t or %NULL if the document +doesn't have a thumbnail for this page.</doc> <type name="cairo.Surface" c:type="cairo_surface_t*"/> </return-value> <parameters> @@ -4946,26 +5538,42 @@ only render the changed part of the selection.</doc> <doc xml:space="preserve">A #PopplerPageTransition structures describes a visual transition to use when moving between pages during a presentation</doc> <field name="type" writable="1"> + <doc xml:space="preserve">the type of transtition</doc> <type name="PageTransitionType" c:type="PopplerPageTransitionType"/> </field> <field name="alignment" writable="1"> + <doc xml:space="preserve">the dimension in which the transition effect shall occur. +Only for #POPPLER_PAGE_TRANSITION_SPLIT and #POPPLER_PAGE_TRANSITION_BLINDS transition types</doc> <type name="PageTransitionAlignment" c:type="PopplerPageTransitionAlignment"/> </field> <field name="direction" writable="1"> + <doc xml:space="preserve">the direccion of motion for the transition effect. +Only for #POPPLER_PAGE_TRANSITION_SPLIT, #POPPLER_PAGE_TRANSITION_BOX and #POPPLER_PAGE_TRANSITION_FLY +transition types</doc> <type name="PageTransitionDirection" c:type="PopplerPageTransitionDirection"/> </field> <field name="duration" writable="1"> + <doc xml:space="preserve">the duration of the transition effect</doc> <type name="gint" c:type="gint"/> </field> <field name="angle" writable="1"> + <doc xml:space="preserve">the direction in which the specified transition effect shall moves, +expressed in degrees counterclockwise starting from a left-to-right direction. +Only for #POPPLER_PAGE_TRANSITION_WIPE, #POPPLER_PAGE_TRANSITION_GLITTER, #POPPLER_PAGE_TRANSITION_FLY, +#POPPLER_PAGE_TRANSITION_COVER, #POPPLER_PAGE_TRANSITION_UNCOVER and #POPPLER_PAGE_TRANSITION_PUSH +transition types</doc> <type name="gint" c:type="gint"/> </field> <field name="scale" writable="1"> + <doc xml:space="preserve">the starting or ending scale at which the changes shall be drawn. +Only for #POPPLER_PAGE_TRANSITION_FLY transition type</doc> <type name="gdouble" c:type="gdouble"/> </field> <field name="rectangular" writable="1"> + <doc xml:space="preserve">whether the area that will be flown is rectangular and opaque. +Only for #POPPLER_PAGE_TRANSITION_FLY transition type</doc> <type name="gboolean" c:type="gboolean"/> </field> <constructor name="new" c:identifier="poppler_page_transition_new"> @@ -5060,19 +5668,22 @@ and #POPPLER_PAGE_TRANSITION_BLINDS transition types</doc> value="2" c:identifier="POPPLER_PAGE_TRANSITION_BLINDS" glib:nick="blinds"> - <doc xml:space="preserve">multiple lines, evenly spaced across the screen, synchronously sweep in the same direction to reveal the new page</doc> + <doc xml:space="preserve">multiple lines, evenly spaced across the screen, synchronously +sweep in the same direction to reveal the new page</doc> </member> <member name="box" value="3" c:identifier="POPPLER_PAGE_TRANSITION_BOX" glib:nick="box"> - <doc xml:space="preserve">a rectangular box sweeps inward from the edges of the page or outward from the center revealing the new page</doc> + <doc xml:space="preserve">a rectangular box sweeps inward from the edges of the page or +outward from the center revealing the new page</doc> </member> <member name="wipe" value="4" c:identifier="POPPLER_PAGE_TRANSITION_WIPE" glib:nick="wipe"> - <doc xml:space="preserve">a single line sweeps across the screen from one edge to the other revealing the new page</doc> + <doc xml:space="preserve">a single line sweeps across the screen from one edge to the other +revealing the new page</doc> </member> <member name="dissolve" value="5" @@ -5084,7 +5695,8 @@ and #POPPLER_PAGE_TRANSITION_BLINDS transition types</doc> value="6" c:identifier="POPPLER_PAGE_TRANSITION_GLITTER" glib:nick="glitter"> - <doc xml:space="preserve">similar to #POPPLER_PAGE_TRANSITION_DISSOLVE, except that the effect sweeps across the page in a wide band moving from one side of the screen to the other</doc> + <doc xml:space="preserve">similar to #POPPLER_PAGE_TRANSITION_DISSOLVE, except that the effect +sweeps across the page in a wide band moving from one side of the screen to the other</doc> </member> <member name="fly" value="7" @@ -5156,13 +5768,15 @@ and #POPPLER_PAGE_TRANSITION_BLINDS transition types</doc> value="32" c:identifier="POPPLER_PERMISSIONS_OK_TO_EXTRACT_CONTENTS" glib:nick="ok-to-extract-contents"> - <doc xml:space="preserve">extract text and graphics (in support of accessibility to users with disabilities or for other purposes). Since 0.18</doc> + <doc xml:space="preserve">extract text and graphics +(in support of accessibility to users with disabilities or for other purposes). Since 0.18</doc> </member> <member name="ok_to_assemble" value="64" c:identifier="POPPLER_PERMISSIONS_OK_TO_ASSEMBLE" glib:nick="ok-to-assemble"> - <doc xml:space="preserve">assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images). Since 0.18</doc> + <doc xml:space="preserve">assemble the document (insert, rotate, or delete pages and create +bookmarks or thumbnail images). Since 0.18</doc> </member> <member name="ok_to_print_high_resolution" value="128" @@ -5177,6 +5791,54 @@ and #POPPLER_PAGE_TRANSITION_BLINDS transition types</doc> <doc xml:space="preserve">document permits all operations</doc> </member> </bitfield> + <record name="Point" + c:type="PopplerPoint" + glib:type-name="PopplerPoint" + glib:get-type="poppler_point_get_type" + c:symbol-prefix="point"> + <doc xml:space="preserve">A #PopplerPoint is used to describe a location point on a page</doc> + <field name="x" writable="1"> + <doc xml:space="preserve">x coordinate</doc> + <type name="gdouble" c:type="gdouble"/> + </field> + <field name="y" writable="1"> + <doc xml:space="preserve">y coordinate</doc> + <type name="gdouble" c:type="gdouble"/> + </field> + <constructor name="new" c:identifier="poppler_point_new" version="0.26"> + <doc xml:space="preserve">Creates a new #PopplerPoint. It must be freed with poppler_point_free() after use.</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">a new #PopplerPoint</doc> + <type name="Point" c:type="PopplerPoint*"/> + </return-value> + </constructor> + <method name="copy" c:identifier="poppler_point_copy" version="0.26"> + <doc xml:space="preserve">Creates a copy of @point. The copy must be freed with poppler_point_free() +after use.</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">a new allocated copy of @point</doc> + <type name="Point" c:type="PopplerPoint*"/> + </return-value> + <parameters> + <instance-parameter name="point" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerPoint to copy</doc> + <type name="Point" c:type="PopplerPoint*"/> + </instance-parameter> + </parameters> + </method> + <method name="free" c:identifier="poppler_point_free" version="0.26"> + <doc xml:space="preserve">Frees the memory used by @point</doc> + <return-value transfer-ownership="none"> + <type name="none" c:type="void"/> + </return-value> + <parameters> + <instance-parameter name="point" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerPoint</doc> + <type name="Point" c:type="PopplerPoint*"/> + </instance-parameter> + </parameters> + </method> + </record> <bitfield name="PrintFlags" version="0.16" glib:type-name="PopplerPrintFlags" @@ -5208,6 +5870,70 @@ and #POPPLER_PAGE_TRANSITION_BLINDS transition types</doc> <doc xml:space="preserve">print main document contents and all markup annotations</doc> </member> </bitfield> + <record name="Quadrilateral" + c:type="PopplerQuadrilateral" + glib:type-name="PopplerQuadrilateral" + glib:get-type="poppler_quadrilateral_get_type" + c:symbol-prefix="quadrilateral"> + <doc xml:space="preserve">A #PopplerQuadrilateral is used to describe rectangle-like polygon + with arbitrary inclination on a page. + + Since: 0.26</doc> + <field name="p1" writable="1"> + <doc xml:space="preserve">a #PopplerPoint with the first vertex coordinates</doc> + <type name="Point" c:type="PopplerPoint"/> + </field> + <field name="p2" writable="1"> + <doc xml:space="preserve">a #PopplerPoint with the second vertex coordinates</doc> + <type name="Point" c:type="PopplerPoint"/> + </field> + <field name="p3" writable="1"> + <doc xml:space="preserve">a #PopplerPoint with the third vertex coordinates</doc> + <type name="Point" c:type="PopplerPoint"/> + </field> + <field name="p4" writable="1"> + <doc xml:space="preserve">a #PopplerPoint with the fourth vertex coordinates</doc> + <type name="Point" c:type="PopplerPoint"/> + </field> + <constructor name="new" + c:identifier="poppler_quadrilateral_new" + version="0.26"> + <doc xml:space="preserve">Creates a new #PopplerQuadrilateral. It must be freed with poppler_quadrilateral_free() after use.</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">a new #PopplerQuadrilateral.</doc> + <type name="Quadrilateral" c:type="PopplerQuadrilateral*"/> + </return-value> + </constructor> + <method name="copy" + c:identifier="poppler_quadrilateral_copy" + version="0.26"> + <doc xml:space="preserve">Creates a copy of @quad. The copy must be freed with poppler_quadrilateral_free() after use.</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">a new allocated copy of @quad</doc> + <type name="Quadrilateral" c:type="PopplerQuadrilateral*"/> + </return-value> + <parameters> + <instance-parameter name="quad" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerQuadrilateral to copy</doc> + <type name="Quadrilateral" c:type="PopplerQuadrilateral*"/> + </instance-parameter> + </parameters> + </method> + <method name="free" + c:identifier="poppler_quadrilateral_free" + version="0.26"> + <doc xml:space="preserve">Frees the memory used by @quad</doc> + <return-value transfer-ownership="none"> + <type name="none" c:type="void"/> + </return-value> + <parameters> + <instance-parameter name="quad" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerQuadrilateral</doc> + <type name="Quadrilateral" c:type="PopplerQuadrilateral*"/> + </instance-parameter> + </parameters> + </method> + </record> <record name="Rectangle" c:type="PopplerRectangle" glib:type-name="PopplerRectangle" @@ -5216,15 +5942,19 @@ and #POPPLER_PAGE_TRANSITION_BLINDS transition types</doc> <doc xml:space="preserve">A #PopplerRectangle is used to describe locations on a page and bounding boxes</doc> <field name="x1" writable="1"> + <doc xml:space="preserve">x coordinate of lower left corner</doc> <type name="gdouble" c:type="gdouble"/> </field> <field name="y1" writable="1"> + <doc xml:space="preserve">y coordinate of lower left corner</doc> <type name="gdouble" c:type="gdouble"/> </field> <field name="x2" writable="1"> + <doc xml:space="preserve">x coordinate of upper right corner</doc> <type name="gdouble" c:type="gdouble"/> </field> <field name="y2" writable="1"> + <doc xml:space="preserve">y coordinate of upper right corner</doc> <type name="gdouble" c:type="gdouble"/> </field> <constructor name="new" c:identifier="poppler_rectangle_new"> @@ -5284,6 +6014,1963 @@ locations on a page and bounding boxes</doc> <doc xml:space="preserve">line is the minimum unit for selection</doc> </member> </enumeration> + <enumeration name="StructureBlockAlign" + glib:type-name="PopplerStructureBlockAlign" + glib:get-type="poppler_structure_block_align_get_type" + c:type="PopplerStructureBlockAlign"> + <member name="before" + value="0" + c:identifier="POPPLER_STRUCTURE_BLOCK_ALIGN_BEFORE" + glib:nick="before"> + </member> + <member name="middle" + value="1" + c:identifier="POPPLER_STRUCTURE_BLOCK_ALIGN_MIDDLE" + glib:nick="middle"> + </member> + <member name="after" + value="2" + c:identifier="POPPLER_STRUCTURE_BLOCK_ALIGN_AFTER" + glib:nick="after"> + </member> + <member name="justify" + value="3" + c:identifier="POPPLER_STRUCTURE_BLOCK_ALIGN_JUSTIFY" + glib:nick="justify"> + </member> + </enumeration> + <enumeration name="StructureBorderStyle" + glib:type-name="PopplerStructureBorderStyle" + glib:get-type="poppler_structure_border_style_get_type" + c:type="PopplerStructureBorderStyle"> + <member name="none" + value="0" + c:identifier="POPPLER_STRUCTURE_BORDER_STYLE_NONE" + glib:nick="none"> + </member> + <member name="hidden" + value="1" + c:identifier="POPPLER_STRUCTURE_BORDER_STYLE_HIDDEN" + glib:nick="hidden"> + </member> + <member name="dotted" + value="2" + c:identifier="POPPLER_STRUCTURE_BORDER_STYLE_DOTTED" + glib:nick="dotted"> + </member> + <member name="dashed" + value="3" + c:identifier="POPPLER_STRUCTURE_BORDER_STYLE_DASHED" + glib:nick="dashed"> + </member> + <member name="solid" + value="4" + c:identifier="POPPLER_STRUCTURE_BORDER_STYLE_SOLID" + glib:nick="solid"> + </member> + <member name="double" + value="5" + c:identifier="POPPLER_STRUCTURE_BORDER_STYLE_DOUBLE" + glib:nick="double"> + </member> + <member name="groove" + value="6" + c:identifier="POPPLER_STRUCTURE_BORDER_STYLE_GROOVE" + glib:nick="groove"> + </member> + <member name="inset" + value="7" + c:identifier="POPPLER_STRUCTURE_BORDER_STYLE_INSET" + glib:nick="inset"> + </member> + <member name="outset" + value="8" + c:identifier="POPPLER_STRUCTURE_BORDER_STYLE_OUTSET" + glib:nick="outset"> + </member> + </enumeration> + <class name="StructureElement" + c:symbol-prefix="structure_element" + c:type="PopplerStructureElement" + parent="GObject.Object" + glib:type-name="PopplerStructureElement" + glib:get-type="poppler_structure_element_get_type"> + <method name="get_abbreviation" + c:identifier="poppler_structure_element_get_abbreviation"> + <return-value transfer-ownership="full"> + <type name="utf8" c:type="gchar*"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_actual_text" + c:identifier="poppler_structure_element_get_actual_text" + version="0.26"> + <doc xml:space="preserve">Obtains the actual text enclosed by the element (and its child elements). +The actual text is mostly used for non-text elements like images and +figures which <em>do</em> have the graphical appearance of text, like +a logo. For those the actual text is the equivalent text to those +graphical elements which look like text when rendered. + +Note that for elements containing proper text, the function +poppler_structure_element_get_text() must be used instead.</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">The actual text for the element, or %NULL + if not defined.</doc> + <type name="utf8" c:type="gchar*"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_alt_text" + c:identifier="poppler_structure_element_get_alt_text" + version="0.26"> + <doc xml:space="preserve">Obtains the “alternate” text representation of the element (and its child +elements). This is mostly used for non-text elements like images and +figures, to specify a textual description of the element. + +Note that for elements containing proper text, the function +poppler_structure_element_get_text() must be used instead.</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">The alternate text representation for the + element, or %NULL if not defined.</doc> + <type name="utf8" c:type="gchar*"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_background_color" + c:identifier="poppler_structure_element_get_background_color" + version="0.26"> + <doc xml:space="preserve">Obtains the background color of the element. If this attribute is +not specified, the element shall be treated as if it were transparent.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">%TRUE if a color is defined for the element, + %FALSE otherwise.</doc> + <type name="gboolean" c:type="gboolean"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + <parameter name="color" + direction="out" + caller-allocates="1" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerColor.</doc> + <type name="Color" c:type="PopplerColor*"/> + </parameter> + </parameters> + </method> + <method name="get_baseline_shift" + c:identifier="poppler_structure_element_get_baseline_shift" + version="0.26"> + <doc xml:space="preserve">Obtains how much the text contained in the inline-level structure element should be shifted, +measuring from the baseline of the glyphs.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A numeric value.</doc> + <type name="gdouble" c:type="gdouble"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_block_align" + c:identifier="poppler_structure_element_get_block_align" + version="0.26"> + <doc xml:space="preserve">Obtains the block-alignment mode of the block-level structure element.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureBlockAlign value.</doc> + <type name="StructureBlockAlign" + c:type="PopplerStructureBlockAlign"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_border_color" + c:identifier="poppler_structure_element_get_border_color" + version="0.26"> + <doc xml:space="preserve">Obtains the color of border around the element. The result values +are in before-after-start-end ordering (for the typical Western +left-to-right writing, that is top-bottom-left-right). +If this attribute is not specified, the border color for this element shall +be the current text fill color in effect at the start of its associated +content.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">%TRUE if a color is defined for the element, + %FALSE otherwise.</doc> + <type name="gboolean" c:type="gboolean"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + <parameter name="colors" + direction="out" + caller-allocates="1" + transfer-ownership="none"> + <doc xml:space="preserve">An array + of four #PopplerColor.</doc> + <array zero-terminated="0" c:type="PopplerColor*" fixed-size="4"> + <type name="Color"/> + </array> + </parameter> + </parameters> + </method> + <method name="get_border_style" + c:identifier="poppler_structure_element_get_border_style" + version="0.26"> + <doc xml:space="preserve">Obtains the border style of a structure element. The result values +are in before-after-start-end ordering. For example, using Western +left-to-right writing, that is top-bottom-left-right.</doc> + <return-value transfer-ownership="none"> + <type name="none" c:type="void"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + <parameter name="border_styles" + direction="out" + caller-allocates="0" + transfer-ownership="full"> + <doc xml:space="preserve"> + An array of four #PopplerStructureBorderStyle elements.</doc> + <array zero-terminated="0" + c:type="PopplerStructureBorderStyle*" + fixed-size="4"> + <type name="StructureBorderStyle"/> + </array> + </parameter> + </parameters> + </method> + <method name="get_border_thickness" + c:identifier="poppler_structure_element_get_border_thickness" + version="0.26"> + <doc xml:space="preserve">Obtains the thickness of the border of an element. The result values +are in before-after-start-end ordering (for the typical Western +left-to-right writing, that is top-bottom-left-right). +A value of 0 indicates that the border shall not be drawn.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">%TRUE if the border thickness attribute is defined for + the element, %FALSE otherwise.</doc> + <type name="gboolean" c:type="gboolean"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + <parameter name="border_thicknesses" + direction="out" + caller-allocates="0" + transfer-ownership="full"> + <doc xml:space="preserve"> + Array with the four values of border thicknesses.</doc> + <array zero-terminated="0" c:type="gdouble*" fixed-size="4"> + <type name="gdouble"/> + </array> + </parameter> + </parameters> + </method> + <method name="get_bounding_box" + c:identifier="poppler_structure_element_get_bounding_box" + version="0.26"> + <doc xml:space="preserve">Obtains the size of the bounding box of a block-level structure element.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">%TRUE if a bounding box is defined for the element, + %FALSE otherwise.</doc> + <type name="gboolean" c:type="gboolean"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + <parameter name="bounding_box" + direction="out" + caller-allocates="1" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerRectangle.</doc> + <type name="Rectangle" c:type="PopplerRectangle*"/> + </parameter> + </parameters> + </method> + <method name="get_color" + c:identifier="poppler_structure_element_get_color" + version="0.26"> + <doc xml:space="preserve">Obtains the color of the content contained in the element. +If this attribute is not specified, the color for this element shall +be the current text fill color in effect at the start of its associated content.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">%TRUE if a color is defined for the element, + %FALSE otherwise.</doc> + <type name="gboolean" c:type="gboolean"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + <parameter name="color" + direction="out" + caller-allocates="1" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerColor.</doc> + <type name="Color" c:type="PopplerColor*"/> + </parameter> + </parameters> + </method> + <method name="get_column_count" + c:identifier="poppler_structure_element_get_column_count" + version="0.26"> + <doc xml:space="preserve">Obtains the number of columns used to lay out the content contained +in the grouping element.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">Number of columns.</doc> + <type name="guint" c:type="guint"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_column_gaps" + c:identifier="poppler_structure_element_get_column_gaps" + version="0.26"> + <doc xml:space="preserve">Obtains the size of the gaps in between adjacent columns. Returns an +array of elements: the first one is the size of the gap in between +columns 1 and 2, second is the size between columns 2 and 3, and so on. + +For elements which use a single column, %NULL is returned and %n_values +is set to zero. + +If the attribute is undefined, %NULL is returned and %n_values is set +to a non-zero value. + +The array with the results is allocated by the function. When it is +not needed anymore, be sure to call g_free() on it.</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve"> + Array containing the values for the column gaps, or %NULL if the + array is empty or the attribute is not defined.</doc> + <array length="0" zero-terminated="0" c:type="gdouble*"> + <type name="gdouble"/> + </array> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + <parameter name="n_values" + direction="out" + caller-allocates="0" + transfer-ownership="full"> + <doc xml:space="preserve">Size of the returned array.</doc> + <type name="guint" c:type="guint*"/> + </parameter> + </parameters> + </method> + <method name="get_column_widths" + c:identifier="poppler_structure_element_get_column_widths" + version="0.26"> + <doc xml:space="preserve">Obtains an array with the widths of the columns. + +The array with the results is allocated by the function. When it is +not needed anymore, be sure to call g_free() on it.</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve"> + Array containing widths of the columns, or %NULL if the attribute + is not defined.</doc> + <array length="0" zero-terminated="0" c:type="gdouble*"> + <type name="gdouble"/> + </array> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + <parameter name="n_values" + direction="out" + caller-allocates="0" + transfer-ownership="full"> + <doc xml:space="preserve">Size of the returned array.</doc> + <type name="guint" c:type="guint*"/> + </parameter> + </parameters> + </method> + <method name="get_end_indent" + c:identifier="poppler_structure_element_get_end_indent" + version="0.26"> + <doc xml:space="preserve">Obtains the amount of indentation at the end of the block-level structure element.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A numeric value.</doc> + <type name="gdouble" c:type="gdouble"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_form_description" + c:identifier="poppler_structure_element_get_form_description" + version="0.26"> + <doc xml:space="preserve">Obtains the textual description of the form element. Note that the +description is for informative purposes, and it is not intended +to be rendered. For example, assistive technologies may use the +description field to provide an alternate way of presenting an +element to the user. + +The returned string is allocated by the function. When it is +not needed anymore, be sure to call g_free() on it.</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">A string, or %NULL if the attribute + is not defined.</doc> + <type name="utf8" c:type="gchar*"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_form_role" + c:identifier="poppler_structure_element_get_form_role" + version="0.26"> + <doc xml:space="preserve">Obtains the role of a form structure element that is part of a form, or is +a form field. This hints how the control for the element is intended +to be rendered.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureFormRole value.</doc> + <type name="StructureFormRole" c:type="PopplerStructureFormRole"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_form_state" + c:identifier="poppler_structure_element_get_form_state" + version="0.26"> + <doc xml:space="preserve">For a structure element that is a form field, obtains in which state +the associated control is expected to be rendered.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureFormState value.</doc> + <type name="StructureFormState" c:type="PopplerStructureFormState"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_glyph_orientation" + c:identifier="poppler_structure_element_get_glyph_orientation" + version="0.26"> + <doc xml:space="preserve">Obtains the glyph orientation for the text contained in a +inline-level structure element.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureGlyphOrientation value.</doc> + <type name="StructureGlyphOrientation" + c:type="PopplerStructureGlyphOrientation"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_height" + c:identifier="poppler_structure_element_get_height" + version="0.26"> + <doc xml:space="preserve">Obtains the height of the block-level structure element. Note that for elements which do +not specify a height, it has to be calculated, and in this case -1 is returned.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A positive value if a width is defined, or -1 + if the height is to be calculated automatically.</doc> + <type name="gdouble" c:type="gdouble"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_id" + c:identifier="poppler_structure_element_get_id" + version="0.26"> + <doc xml:space="preserve">Obtains the identifier of an element.</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">The identifier of the element (if + defined), or %NULL.</doc> + <type name="utf8" c:type="gchar*"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_inline_align" + c:identifier="poppler_structure_element_get_inline_align" + version="0.26"> + <doc xml:space="preserve">Obtains the inline-alignment mode of the block-level structure element.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureInlineAlign value.</doc> + <type name="StructureInlineAlign" + c:type="PopplerStructureInlineAlign"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_kind" + c:identifier="poppler_structure_element_get_kind" + version="0.26"> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElementKind value.</doc> + <type name="StructureElementKind" + c:type="PopplerStructureElementKind"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_language" + c:identifier="poppler_structure_element_get_language" + version="0.26"> + <doc xml:space="preserve">Obtains the language and country code for the content in an element, +in two-letter ISO format, e.g. <code>en_ES</code>, or %NULL if not +defined.</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">language and country code, or %NULL.</doc> + <type name="utf8" c:type="gchar*"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_line_height" + c:identifier="poppler_structure_element_get_line_height" + version="0.26"> + <doc xml:space="preserve">Obtains the line height for the text contained in the inline-level structure element. +Note that for elements which do not specify a line height, it has to be calculated, +and in this case -1 is returned.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A positive value if a line height is defined, or -1 + if the height is to be calculated automatically.</doc> + <type name="gdouble" c:type="gdouble"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_list_numbering" + c:identifier="poppler_structure_element_get_list_numbering" + version="0.26"> + <doc xml:space="preserve">Obtains the list numbering style for list items.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureListNumbering value.</doc> + <type name="StructureListNumbering" + c:type="PopplerStructureListNumbering"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_padding" + c:identifier="poppler_structure_element_get_padding" + version="0.26"> + <doc xml:space="preserve">Obtains the padding of an element (space around it). The result +values are in before-after-start-end ordering. For example using +Western left-to-right writing, that is top-bottom-left-right.</doc> + <return-value transfer-ownership="none"> + <type name="none" c:type="void"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + <parameter name="paddings" + direction="out" + caller-allocates="0" + transfer-ownership="full"> + <doc xml:space="preserve"> + Padding for the four sides of the element.</doc> + <array zero-terminated="0" c:type="gdouble*" fixed-size="4"> + <type name="gdouble"/> + </array> + </parameter> + </parameters> + </method> + <method name="get_page" + c:identifier="poppler_structure_element_get_page" + version="0.26"> + <doc xml:space="preserve">Obtains the page number in which the element is contained.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">Number of the page that contains the element, of + <code>-1</code> if not defined.</doc> + <type name="gint" c:type="gint"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_placement" + c:identifier="poppler_structure_element_get_placement" + version="0.26"> + <doc xml:space="preserve">Obtains the placement type of the structure element.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructurePlacement value.</doc> + <type name="StructurePlacement" c:type="PopplerStructurePlacement"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_ruby_align" + c:identifier="poppler_structure_element_get_ruby_align" + version="0.26"> + <doc xml:space="preserve">Obtains the alignment for the ruby text contained in a +inline-level structure element.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureRubyAlign value.</doc> + <type name="StructureRubyAlign" c:type="PopplerStructureRubyAlign"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_ruby_position" + c:identifier="poppler_structure_element_get_ruby_position" + version="0.26"> + <doc xml:space="preserve">Obtains the position for the ruby text contained in a +inline-level structure element.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureRubyPosition value.</doc> + <type name="StructureRubyPosition" + c:type="PopplerStructureRubyPosition"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_space_after" + c:identifier="poppler_structure_element_get_space_after" + version="0.26"> + <doc xml:space="preserve">Obtains the amount of empty space after the block-level structure element.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A positive value.</doc> + <type name="gdouble" c:type="gdouble"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_space_before" + c:identifier="poppler_structure_element_get_space_before" + version="0.26"> + <doc xml:space="preserve">Obtains the amount of empty space before the block-level structure element.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A positive value.</doc> + <type name="gdouble" c:type="gdouble"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_start_indent" + c:identifier="poppler_structure_element_get_start_indent" + version="0.26"> + <doc xml:space="preserve">Obtains the amount of indentation at the beginning of the block-level structure element.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A numeric value.</doc> + <type name="gdouble" c:type="gdouble"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_table_border_style" + c:identifier="poppler_structure_element_get_table_border_style" + version="0.26"> + <doc xml:space="preserve">Obtains the table cell border style of a block-level structure element. The result values +are in before-after-start-end ordering. For example, using Western +left-to-right writing, that is top-bottom-left-right.</doc> + <return-value transfer-ownership="none"> + <type name="none" c:type="void"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + <parameter name="border_styles" + direction="out" + caller-allocates="0" + transfer-ownership="full"> + <doc xml:space="preserve"> + An array of four #PopplerStructureBorderStyle elements.</doc> + <array zero-terminated="0" + c:type="PopplerStructureBorderStyle*" + fixed-size="4"> + <type name="StructureBorderStyle"/> + </array> + </parameter> + </parameters> + </method> + <method name="get_table_column_span" + c:identifier="poppler_structure_element_get_table_column_span" + version="0.26"> + <doc xml:space="preserve">Obtains the number of columns the table element spans to.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A positive, non-zero value.</doc> + <type name="guint" c:type="guint"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_table_headers" + c:identifier="poppler_structure_element_get_table_headers" + version="0.26"> + <doc xml:space="preserve">Obtains an array with the names of the table column headers. This is only +useful for table header row elements. + +The array with the results is allocated by the function. The number +of items in the returned array can be obtained with g_strv_length(). +The returned value must be freed using g_strfreev().</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve"> + Zero-terminated array of strings with the table header names, + or %NULL if the attribute is not defined.</doc> + <array c:type="gchar**"> + <type name="utf8"/> + </array> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_table_padding" + c:identifier="poppler_structure_element_get_table_padding" + version="0.26"> + <doc xml:space="preserve">Obtains the padding between the table cell’s content rectangle and the +surrounding border of a block-level structure element. The result +values are in before-after-start-end ordering (for the typical +Western left-to-right writing, that is top-bottom-left-right).</doc> + <return-value transfer-ownership="none"> + <type name="none" c:type="void"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + <parameter name="paddings" + direction="out" + caller-allocates="0" + transfer-ownership="full"> + <doc xml:space="preserve"> + Padding for the four sides of the element.</doc> + <array zero-terminated="0" c:type="gdouble*" fixed-size="4"> + <type name="gdouble"/> + </array> + </parameter> + </parameters> + </method> + <method name="get_table_row_span" + c:identifier="poppler_structure_element_get_table_row_span" + version="0.26"> + <doc xml:space="preserve">Obtains the number of rows the table element spans to.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A positive, non-zero value.</doc> + <type name="guint" c:type="guint"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_table_scope" + c:identifier="poppler_structure_element_get_table_scope" + version="0.26"> + <doc xml:space="preserve">Obtains the scope of a table structure element.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureScope value.</doc> + <type name="StructureTableScope" + c:type="PopplerStructureTableScope"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_table_summary" + c:identifier="poppler_structure_element_get_table_summary" + version="0.26"> + <doc xml:space="preserve">Obtains the textual summary of the contents of the table element. Note that +the summary is meant for informative purposes, and it is not intended +to be rendered. For example, assistive technologies may use the +description field to provide an alternate way of presenting an element +to the user, or a document indexer may want to scan it for additional +keywords. + +The returned string is allocated by the function. When it is +not needed anymore, be sure to call g_free() on it.</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">A string, or %NULL if the attribute + is not defined.</doc> + <type name="utf8" c:type="gchar*"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_text" + c:identifier="poppler_structure_element_get_text" + version="0.26"> + <doc xml:space="preserve">Obtains the text enclosed by an element, or the text enclosed by the +elements in the subtree (including the element itself).</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">A string.</doc> + <type name="utf8" c:type="gchar*"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + <parameter name="flags" transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureGetTextFlags value, or + %POPPLER_STRUCTURE_GET_TEXT_NONE to disable all the flags.</doc> + <type name="StructureGetTextFlags" + c:type="PopplerStructureGetTextFlags"/> + </parameter> + </parameters> + </method> + <method name="get_text_align" + c:identifier="poppler_structure_element_get_text_align" + version="0.26"> + <doc xml:space="preserve">Obtains the text alignment mode of the text contained into a +block-level structure element.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureTextAlign value.</doc> + <type name="StructureTextAlign" c:type="PopplerStructureTextAlign"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_text_decoration_color" + c:identifier="poppler_structure_element_get_text_decoration_color" + version="0.26"> + <doc xml:space="preserve">Obtains the color of the text decoration for the text contained +in the inline-level structure element. +If this attribute is not specified, the color for this element shall be the current fill +color in effect at the start of its associated content.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">%TRUE if a color is defined for the element, + %FALSE otherwise.</doc> + <type name="gboolean" c:type="gboolean"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + <parameter name="color" + direction="out" + caller-allocates="1" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerColor.</doc> + <type name="Color" c:type="PopplerColor*"/> + </parameter> + </parameters> + </method> + <method name="get_text_decoration_thickness" + c:identifier="poppler_structure_element_get_text_decoration_thickness" + version="0.26"> + <doc xml:space="preserve">Obtains the thickness of the text decoration for the text contained +in the inline-level structure element. +If this attribute is not specified, it shall be derived from the current +stroke thickness in effect at the start of the element’s associated content.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">Thickness of the text decoration, or %NaN if not defined.</doc> + <type name="gdouble" c:type="gdouble"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_text_decoration_type" + c:identifier="poppler_structure_element_get_text_decoration_type" + version="0.26"> + <doc xml:space="preserve">Obtains the text decoration type of the text contained in the +inline-level structure element.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureTextDecoration value.</doc> + <type name="StructureTextDecoration" + c:type="PopplerStructureTextDecoration"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_text_indent" + c:identifier="poppler_structure_element_get_text_indent" + version="0.26"> + <doc xml:space="preserve">Obtains the amount of indentation of the text contained in the block-level structure element.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A numeric value.</doc> + <type name="gdouble" c:type="gdouble"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_text_spans" + c:identifier="poppler_structure_element_get_text_spans" + version="0.26"> + <doc xml:space="preserve">Obtains the text enclosed by an element, as an array of #PopplerTextSpan +structures. Each item in the list is a piece of text which share the same +attributes, plus its attributes. The following example shows how to +obtain and free the text spans of an element: + +<informalexample><programlisting> +guint i, n_spans; +PopplerTextSpan **text_spans = + poppler_structure_element_get_text_spans (element, &n_spans); +/<!-- -->* Use the text spans *<!-- -->/ +for (i = 0; i < n_spans; i++) + poppler_text_span_free (text_spans[i]); +g_free (text_spans); +</programlisting></informalexample></doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve"> + An array of #PopplerTextSpan elments.</doc> + <array length="0" zero-terminated="0" c:type="PopplerTextSpan**"> + <type name="TextSpan"/> + </array> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + <parameter name="n_text_spans" + direction="out" + caller-allocates="0" + transfer-ownership="full"> + <doc xml:space="preserve">A pointer to the location where the number of elements in + the returned array will be stored.</doc> + <type name="guint" c:type="guint*"/> + </parameter> + </parameters> + </method> + <method name="get_title" + c:identifier="poppler_structure_element_get_title" + version="0.26"> + <doc xml:space="preserve">Obtains the title of an element.</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">The title of the element, or %NULL.</doc> + <type name="utf8" c:type="gchar*"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_width" + c:identifier="poppler_structure_element_get_width" + version="0.26"> + <doc xml:space="preserve">Obtains the width of the block-level structure element. Note that for elements which do +not specify a width, it has to be calculated, and in this case -1 is returned.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A positive value if a width is defined, or -1 + if the width is to be calculated automatically.</doc> + <type name="gdouble" c:type="gdouble"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_writing_mode" + c:identifier="poppler_structure_element_get_writing_mode" + version="0.26"> + <doc xml:space="preserve">Obtains the writing mode (writing direction) of the content associated +with a structure element.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureWritingMode value.</doc> + <type name="StructureWritingMode" + c:type="PopplerStructureWritingMode"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="is_block" + c:identifier="poppler_structure_element_is_block" + version="0.26"> + <doc xml:space="preserve">Checks whether an element is a block element.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">%TRUE if the element is a block element, or %FALSE otherwise.</doc> + <type name="gboolean" c:type="gboolean"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="is_content" + c:identifier="poppler_structure_element_is_content" + version="0.26"> + <doc xml:space="preserve">Checks whether an element is actual document content.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">%TRUE if the element is content, or %FALSE otherwise.</doc> + <type name="gboolean" c:type="gboolean"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="is_grouping" + c:identifier="poppler_structure_element_is_grouping" + version="0.26"> + <doc xml:space="preserve">Checks whether an element is a grouping element.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">%TRUE if the element is a grouping element, %FALSE + otherwise.</doc> + <type name="gboolean" c:type="gboolean"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + <method name="is_inline" + c:identifier="poppler_structure_element_is_inline" + version="0.26"> + <doc xml:space="preserve">Checks whether an element is an inline element.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">%TRUE if the element is an inline element, or %FALSE otherwise.</doc> + <type name="gboolean" c:type="gboolean"/> + </return-value> + <parameters> + <instance-parameter name="poppler_structure_element" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerStructureElement</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </instance-parameter> + </parameters> + </method> + </class> + <record name="StructureElementIter" + c:type="PopplerStructureElementIter" + glib:type-name="PopplerStructureElementIter" + glib:get-type="poppler_structure_element_iter_get_type" + c:symbol-prefix="structure_element_iter"> + <constructor name="new" + c:identifier="poppler_structure_element_iter_new" + version="0.26"> + <doc xml:space="preserve">Returns the root #PopplerStructureElementIter for @document, or %NULL. The +returned value must be freed with poppler_structure_element_iter_free(). + +Documents may have an associated structure tree &mdashmostly, Tagged-PDF +compliant documents&mdash; which can be used to obtain information about +the document structure and its contents. Each node in the tree contains +a #PopplerStructureElement. + +Here is a simple example that walks the whole tree: + +<informalexample><programlisting> +static void +walk_structure (PopplerStructureElementIter *iter) +{ + do { + /<!-- -->* Get the element and do something with it *<!-- -->/ + PopplerStructureElementIter *child = poppler_structure_element_iter_get_child (iter); + if (child) + walk_structure (child); + poppler_structure_element_iter_free (child); + } while (poppler_structure_element_iter_next (iter)); +} +... +{ + iter = poppler_structure_element_iter_new (document); + walk_structure (iter); + poppler_structure_element_iter_free (iter); +} +</programlisting></informalexample></doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">a new #PopplerStructureElementIter, or %NULL if document + doesn't have structure tree.</doc> + <type name="StructureElementIter" + c:type="PopplerStructureElementIter*"/> + </return-value> + <parameters> + <parameter name="poppler_document" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerDocument.</doc> + <type name="Document" c:type="PopplerDocument*"/> + </parameter> + </parameters> + </constructor> + <method name="copy" + c:identifier="poppler_structure_element_iter_copy" + version="0.26"> + <doc xml:space="preserve">Creates a new #PopplerStructureElementIter as a copy of @iter. The +returned value must be freed with poppler_structure_element_iter_free().</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">a new #PopplerStructureElementIter</doc> + <type name="StructureElementIter" + c:type="PopplerStructureElementIter*"/> + </return-value> + <parameters> + <instance-parameter name="iter" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerStructureElementIter</doc> + <type name="StructureElementIter" + c:type="PopplerStructureElementIter*"/> + </instance-parameter> + </parameters> + </method> + <method name="free" + c:identifier="poppler_structure_element_iter_free" + version="0.26"> + <doc xml:space="preserve">Frees @iter.</doc> + <return-value transfer-ownership="none"> + <type name="none" c:type="void"/> + </return-value> + <parameters> + <instance-parameter name="iter" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerStructureElementIter</doc> + <type name="StructureElementIter" + c:type="PopplerStructureElementIter*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_child" + c:identifier="poppler_structure_element_iter_get_child" + version="0.26"> + <doc xml:space="preserve">Returns a new iterator to the children elements of the +#PopplerStructureElement associated with @iter. The returned value must +be freed with poppler_structure_element_iter_free().</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">a new #PopplerStructureElementIter</doc> + <type name="StructureElementIter" + c:type="PopplerStructureElementIter*"/> + </return-value> + <parameters> + <instance-parameter name="parent" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerStructureElementIter</doc> + <type name="StructureElementIter" + c:type="PopplerStructureElementIter*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_element" + c:identifier="poppler_structure_element_iter_get_element" + version="0.26"> + <doc xml:space="preserve">Returns the #PopplerStructureElementIter associated with @iter.</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">a new #PopplerStructureElementIter</doc> + <type name="StructureElement" c:type="PopplerStructureElement*"/> + </return-value> + <parameters> + <instance-parameter name="iter" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerStructureElementIter</doc> + <type name="StructureElementIter" + c:type="PopplerStructureElementIter*"/> + </instance-parameter> + </parameters> + </method> + <method name="next" + c:identifier="poppler_structure_element_iter_next" + version="0.26"> + <doc xml:space="preserve">Sets @iter to point to the next structure element at the current level +of the tree, if valid. See poppler_structure_element_iter_new() for more +information.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">%TRUE, if @iter was set to the next structure element</doc> + <type name="gboolean" c:type="gboolean"/> + </return-value> + <parameters> + <instance-parameter name="iter" transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerStructureElementIter</doc> + <type name="StructureElementIter" + c:type="PopplerStructureElementIter*"/> + </instance-parameter> + </parameters> + </method> + </record> + <enumeration name="StructureElementKind" + glib:type-name="PopplerStructureElementKind" + glib:get-type="poppler_structure_element_kind_get_type" + c:type="PopplerStructureElementKind"> + <member name="content" + value="0" + c:identifier="POPPLER_STRUCTURE_ELEMENT_CONTENT" + glib:nick="content"> + </member> + <member name="object_reference" + value="1" + c:identifier="POPPLER_STRUCTURE_ELEMENT_OBJECT_REFERENCE" + glib:nick="object-reference"> + </member> + <member name="document" + value="2" + c:identifier="POPPLER_STRUCTURE_ELEMENT_DOCUMENT" + glib:nick="document"> + </member> + <member name="part" + value="3" + c:identifier="POPPLER_STRUCTURE_ELEMENT_PART" + glib:nick="part"> + </member> + <member name="article" + value="4" + c:identifier="POPPLER_STRUCTURE_ELEMENT_ARTICLE" + glib:nick="article"> + </member> + <member name="section" + value="5" + c:identifier="POPPLER_STRUCTURE_ELEMENT_SECTION" + glib:nick="section"> + </member> + <member name="div" + value="6" + c:identifier="POPPLER_STRUCTURE_ELEMENT_DIV" + glib:nick="div"> + </member> + <member name="span" + value="7" + c:identifier="POPPLER_STRUCTURE_ELEMENT_SPAN" + glib:nick="span"> + </member> + <member name="quote" + value="8" + c:identifier="POPPLER_STRUCTURE_ELEMENT_QUOTE" + glib:nick="quote"> + </member> + <member name="note" + value="9" + c:identifier="POPPLER_STRUCTURE_ELEMENT_NOTE" + glib:nick="note"> + </member> + <member name="reference" + value="10" + c:identifier="POPPLER_STRUCTURE_ELEMENT_REFERENCE" + glib:nick="reference"> + </member> + <member name="bibentry" + value="11" + c:identifier="POPPLER_STRUCTURE_ELEMENT_BIBENTRY" + glib:nick="bibentry"> + </member> + <member name="code" + value="12" + c:identifier="POPPLER_STRUCTURE_ELEMENT_CODE" + glib:nick="code"> + </member> + <member name="link" + value="13" + c:identifier="POPPLER_STRUCTURE_ELEMENT_LINK" + glib:nick="link"> + </member> + <member name="annot" + value="14" + c:identifier="POPPLER_STRUCTURE_ELEMENT_ANNOT" + glib:nick="annot"> + </member> + <member name="blockquote" + value="15" + c:identifier="POPPLER_STRUCTURE_ELEMENT_BLOCKQUOTE" + glib:nick="blockquote"> + </member> + <member name="caption" + value="16" + c:identifier="POPPLER_STRUCTURE_ELEMENT_CAPTION" + glib:nick="caption"> + </member> + <member name="nonstruct" + value="17" + c:identifier="POPPLER_STRUCTURE_ELEMENT_NONSTRUCT" + glib:nick="nonstruct"> + </member> + <member name="toc" + value="18" + c:identifier="POPPLER_STRUCTURE_ELEMENT_TOC" + glib:nick="toc"> + </member> + <member name="toc_item" + value="19" + c:identifier="POPPLER_STRUCTURE_ELEMENT_TOC_ITEM" + glib:nick="toc-item"> + </member> + <member name="index" + value="20" + c:identifier="POPPLER_STRUCTURE_ELEMENT_INDEX" + glib:nick="index"> + </member> + <member name="private" + value="21" + c:identifier="POPPLER_STRUCTURE_ELEMENT_PRIVATE" + glib:nick="private"> + </member> + <member name="paragraph" + value="22" + c:identifier="POPPLER_STRUCTURE_ELEMENT_PARAGRAPH" + glib:nick="paragraph"> + </member> + <member name="heading" + value="23" + c:identifier="POPPLER_STRUCTURE_ELEMENT_HEADING" + glib:nick="heading"> + </member> + <member name="heading_1" + value="24" + c:identifier="POPPLER_STRUCTURE_ELEMENT_HEADING_1" + glib:nick="heading-1"> + </member> + <member name="heading_2" + value="25" + c:identifier="POPPLER_STRUCTURE_ELEMENT_HEADING_2" + glib:nick="heading-2"> + </member> + <member name="heading_3" + value="26" + c:identifier="POPPLER_STRUCTURE_ELEMENT_HEADING_3" + glib:nick="heading-3"> + </member> + <member name="heading_4" + value="27" + c:identifier="POPPLER_STRUCTURE_ELEMENT_HEADING_4" + glib:nick="heading-4"> + </member> + <member name="heading_5" + value="28" + c:identifier="POPPLER_STRUCTURE_ELEMENT_HEADING_5" + glib:nick="heading-5"> + </member> + <member name="heading_6" + value="29" + c:identifier="POPPLER_STRUCTURE_ELEMENT_HEADING_6" + glib:nick="heading-6"> + </member> + <member name="list" + value="30" + c:identifier="POPPLER_STRUCTURE_ELEMENT_LIST" + glib:nick="list"> + </member> + <member name="list_item" + value="31" + c:identifier="POPPLER_STRUCTURE_ELEMENT_LIST_ITEM" + glib:nick="list-item"> + </member> + <member name="list_label" + value="32" + c:identifier="POPPLER_STRUCTURE_ELEMENT_LIST_LABEL" + glib:nick="list-label"> + </member> + <member name="list_body" + value="33" + c:identifier="POPPLER_STRUCTURE_ELEMENT_LIST_BODY" + glib:nick="list-body"> + </member> + <member name="table" + value="34" + c:identifier="POPPLER_STRUCTURE_ELEMENT_TABLE" + glib:nick="table"> + </member> + <member name="table_row" + value="35" + c:identifier="POPPLER_STRUCTURE_ELEMENT_TABLE_ROW" + glib:nick="table-row"> + </member> + <member name="table_heading" + value="36" + c:identifier="POPPLER_STRUCTURE_ELEMENT_TABLE_HEADING" + glib:nick="table-heading"> + </member> + <member name="table_data" + value="37" + c:identifier="POPPLER_STRUCTURE_ELEMENT_TABLE_DATA" + glib:nick="table-data"> + </member> + <member name="table_header" + value="38" + c:identifier="POPPLER_STRUCTURE_ELEMENT_TABLE_HEADER" + glib:nick="table-header"> + </member> + <member name="table_footer" + value="39" + c:identifier="POPPLER_STRUCTURE_ELEMENT_TABLE_FOOTER" + glib:nick="table-footer"> + </member> + <member name="table_body" + value="40" + c:identifier="POPPLER_STRUCTURE_ELEMENT_TABLE_BODY" + glib:nick="table-body"> + </member> + <member name="ruby" + value="41" + c:identifier="POPPLER_STRUCTURE_ELEMENT_RUBY" + glib:nick="ruby"> + </member> + <member name="ruby_base_text" + value="42" + c:identifier="POPPLER_STRUCTURE_ELEMENT_RUBY_BASE_TEXT" + glib:nick="ruby-base-text"> + </member> + <member name="ruby_annot_text" + value="43" + c:identifier="POPPLER_STRUCTURE_ELEMENT_RUBY_ANNOT_TEXT" + glib:nick="ruby-annot-text"> + </member> + <member name="ruby_punctuation" + value="44" + c:identifier="POPPLER_STRUCTURE_ELEMENT_RUBY_PUNCTUATION" + glib:nick="ruby-punctuation"> + </member> + <member name="warichu" + value="45" + c:identifier="POPPLER_STRUCTURE_ELEMENT_WARICHU" + glib:nick="warichu"> + </member> + <member name="warichu_text" + value="46" + c:identifier="POPPLER_STRUCTURE_ELEMENT_WARICHU_TEXT" + glib:nick="warichu-text"> + </member> + <member name="warichu_punctuation" + value="47" + c:identifier="POPPLER_STRUCTURE_ELEMENT_WARICHU_PUNCTUATION" + glib:nick="warichu-punctuation"> + </member> + <member name="figure" + value="48" + c:identifier="POPPLER_STRUCTURE_ELEMENT_FIGURE" + glib:nick="figure"> + </member> + <member name="formula" + value="49" + c:identifier="POPPLER_STRUCTURE_ELEMENT_FORMULA" + glib:nick="formula"> + </member> + <member name="form" + value="50" + c:identifier="POPPLER_STRUCTURE_ELEMENT_FORM" + glib:nick="form"> + </member> + </enumeration> + <enumeration name="StructureFormRole" + glib:type-name="PopplerStructureFormRole" + glib:get-type="poppler_structure_form_role_get_type" + c:type="PopplerStructureFormRole"> + <member name="undefined" + value="0" + c:identifier="POPPLER_STRUCTURE_FORM_ROLE_UNDEFINED" + glib:nick="undefined"> + </member> + <member name="radio_button" + value="1" + c:identifier="POPPLER_STRUCTURE_FORM_ROLE_RADIO_BUTTON" + glib:nick="radio-button"> + </member> + <member name="push_button" + value="2" + c:identifier="POPPLER_STRUCTURE_FORM_ROLE_PUSH_BUTTON" + glib:nick="push-button"> + </member> + <member name="text_value" + value="3" + c:identifier="POPPLER_STRUCTURE_FORM_ROLE_TEXT_VALUE" + glib:nick="text-value"> + </member> + <member name="checkbox" + value="4" + c:identifier="POPPLER_STRUCTURE_FORM_ROLE_CHECKBOX" + glib:nick="checkbox"> + </member> + </enumeration> + <enumeration name="StructureFormState" + glib:type-name="PopplerStructureFormState" + glib:get-type="poppler_structure_form_state_get_type" + c:type="PopplerStructureFormState"> + <member name="on" + value="0" + c:identifier="POPPLER_STRUCTURE_FORM_STATE_ON" + glib:nick="on"> + </member> + <member name="off" + value="1" + c:identifier="POPPLER_STRUCTURE_FORM_STATE_OFF" + glib:nick="off"> + </member> + <member name="neutral" + value="2" + c:identifier="POPPLER_STRUCTURE_FORM_STATE_NEUTRAL" + glib:nick="neutral"> + </member> + </enumeration> + <bitfield name="StructureGetTextFlags" + glib:type-name="PopplerStructureGetTextFlags" + glib:get-type="poppler_structure_get_text_flags_get_type" + c:type="PopplerStructureGetTextFlags"> + <member name="none" + value="0" + c:identifier="POPPLER_STRUCTURE_GET_TEXT_NONE" + glib:nick="none"> + <doc xml:space="preserve">No flags.</doc> + </member> + <member name="recursive" + value="1" + c:identifier="POPPLER_STRUCTURE_GET_TEXT_RECURSIVE" + glib:nick="recursive"> + <doc xml:space="preserve">For non-leaf, non-content + elements, recursively obtain the text from all the elements + enclosed in the subtree.</doc> + </member> + </bitfield> + <enumeration name="StructureGlyphOrientation" + glib:type-name="PopplerStructureGlyphOrientation" + glib:get-type="poppler_structure_glyph_orientation_get_type" + c:type="PopplerStructureGlyphOrientation"> + <member name="auto" + value="0" + c:identifier="POPPLER_STRUCTURE_GLYPH_ORIENTATION_AUTO" + glib:nick="auto"> + </member> + <member name="0" + value="0" + c:identifier="POPPLER_STRUCTURE_GLYPH_ORIENTATION_0" + glib:nick="0"> + </member> + <member name="90" + value="1" + c:identifier="POPPLER_STRUCTURE_GLYPH_ORIENTATION_90" + glib:nick="90"> + </member> + <member name="180" + value="2" + c:identifier="POPPLER_STRUCTURE_GLYPH_ORIENTATION_180" + glib:nick="180"> + </member> + <member name="270" + value="3" + c:identifier="POPPLER_STRUCTURE_GLYPH_ORIENTATION_270" + glib:nick="270"> + </member> + </enumeration> + <enumeration name="StructureInlineAlign" + glib:type-name="PopplerStructureInlineAlign" + glib:get-type="poppler_structure_inline_align_get_type" + c:type="PopplerStructureInlineAlign"> + <member name="start" + value="0" + c:identifier="POPPLER_STRUCTURE_INLINE_ALIGN_START" + glib:nick="start"> + </member> + <member name="center" + value="1" + c:identifier="POPPLER_STRUCTURE_INLINE_ALIGN_CENTER" + glib:nick="center"> + </member> + <member name="end" + value="2" + c:identifier="POPPLER_STRUCTURE_INLINE_ALIGN_END" + glib:nick="end"> + </member> + </enumeration> + <enumeration name="StructureListNumbering" + glib:type-name="PopplerStructureListNumbering" + glib:get-type="poppler_structure_list_numbering_get_type" + c:type="PopplerStructureListNumbering"> + <member name="none" + value="0" + c:identifier="POPPLER_STRUCTURE_LIST_NUMBERING_NONE" + glib:nick="none"> + </member> + <member name="disc" + value="1" + c:identifier="POPPLER_STRUCTURE_LIST_NUMBERING_DISC" + glib:nick="disc"> + </member> + <member name="circle" + value="2" + c:identifier="POPPLER_STRUCTURE_LIST_NUMBERING_CIRCLE" + glib:nick="circle"> + </member> + <member name="square" + value="3" + c:identifier="POPPLER_STRUCTURE_LIST_NUMBERING_SQUARE" + glib:nick="square"> + </member> + <member name="decimal" + value="4" + c:identifier="POPPLER_STRUCTURE_LIST_NUMBERING_DECIMAL" + glib:nick="decimal"> + </member> + <member name="upper_roman" + value="5" + c:identifier="POPPLER_STRUCTURE_LIST_NUMBERING_UPPER_ROMAN" + glib:nick="upper-roman"> + </member> + <member name="lower_roman" + value="6" + c:identifier="POPPLER_STRUCTURE_LIST_NUMBERING_LOWER_ROMAN" + glib:nick="lower-roman"> + </member> + <member name="upper_alpha" + value="7" + c:identifier="POPPLER_STRUCTURE_LIST_NUMBERING_UPPER_ALPHA" + glib:nick="upper-alpha"> + </member> + <member name="lower_alpha" + value="8" + c:identifier="POPPLER_STRUCTURE_LIST_NUMBERING_LOWER_ALPHA" + glib:nick="lower-alpha"> + </member> + </enumeration> + <enumeration name="StructurePlacement" + glib:type-name="PopplerStructurePlacement" + glib:get-type="poppler_structure_placement_get_type" + c:type="PopplerStructurePlacement"> + <member name="block" + value="0" + c:identifier="POPPLER_STRUCTURE_PLACEMENT_BLOCK" + glib:nick="block"> + </member> + <member name="inline" + value="1" + c:identifier="POPPLER_STRUCTURE_PLACEMENT_INLINE" + glib:nick="inline"> + </member> + <member name="before" + value="2" + c:identifier="POPPLER_STRUCTURE_PLACEMENT_BEFORE" + glib:nick="before"> + </member> + <member name="start" + value="3" + c:identifier="POPPLER_STRUCTURE_PLACEMENT_START" + glib:nick="start"> + </member> + <member name="end" + value="4" + c:identifier="POPPLER_STRUCTURE_PLACEMENT_END" + glib:nick="end"> + </member> + </enumeration> + <enumeration name="StructureRubyAlign" + glib:type-name="PopplerStructureRubyAlign" + glib:get-type="poppler_structure_ruby_align_get_type" + c:type="PopplerStructureRubyAlign"> + <member name="start" + value="0" + c:identifier="POPPLER_STRUCTURE_RUBY_ALIGN_START" + glib:nick="start"> + </member> + <member name="center" + value="1" + c:identifier="POPPLER_STRUCTURE_RUBY_ALIGN_CENTER" + glib:nick="center"> + </member> + <member name="end" + value="2" + c:identifier="POPPLER_STRUCTURE_RUBY_ALIGN_END" + glib:nick="end"> + </member> + <member name="justify" + value="3" + c:identifier="POPPLER_STRUCTURE_RUBY_ALIGN_JUSTIFY" + glib:nick="justify"> + </member> + <member name="distribute" + value="4" + c:identifier="POPPLER_STRUCTURE_RUBY_ALIGN_DISTRIBUTE" + glib:nick="distribute"> + </member> + </enumeration> + <enumeration name="StructureRubyPosition" + glib:type-name="PopplerStructureRubyPosition" + glib:get-type="poppler_structure_ruby_position_get_type" + c:type="PopplerStructureRubyPosition"> + <member name="before" + value="0" + c:identifier="POPPLER_STRUCTURE_RUBY_POSITION_BEFORE" + glib:nick="before"> + </member> + <member name="after" + value="1" + c:identifier="POPPLER_STRUCTURE_RUBY_POSITION_AFTER" + glib:nick="after"> + </member> + <member name="warichu" + value="2" + c:identifier="POPPLER_STRUCTURE_RUBY_POSITION_WARICHU" + glib:nick="warichu"> + </member> + <member name="inline" + value="3" + c:identifier="POPPLER_STRUCTURE_RUBY_POSITION_INLINE" + glib:nick="inline"> + </member> + </enumeration> + <enumeration name="StructureTableScope" + glib:type-name="PopplerStructureTableScope" + glib:get-type="poppler_structure_table_scope_get_type" + c:type="PopplerStructureTableScope"> + <member name="row" + value="0" + c:identifier="POPPLER_STRUCTURE_TABLE_SCOPE_ROW" + glib:nick="row"> + </member> + <member name="column" + value="1" + c:identifier="POPPLER_STRUCTURE_TABLE_SCOPE_COLUMN" + glib:nick="column"> + </member> + <member name="both" + value="2" + c:identifier="POPPLER_STRUCTURE_TABLE_SCOPE_BOTH" + glib:nick="both"> + </member> + </enumeration> + <enumeration name="StructureTextAlign" + glib:type-name="PopplerStructureTextAlign" + glib:get-type="poppler_structure_text_align_get_type" + c:type="PopplerStructureTextAlign"> + <member name="start" + value="0" + c:identifier="POPPLER_STRUCTURE_TEXT_ALIGN_START" + glib:nick="start"> + </member> + <member name="center" + value="1" + c:identifier="POPPLER_STRUCTURE_TEXT_ALIGN_CENTER" + glib:nick="center"> + </member> + <member name="end" + value="2" + c:identifier="POPPLER_STRUCTURE_TEXT_ALIGN_END" + glib:nick="end"> + </member> + <member name="justify" + value="3" + c:identifier="POPPLER_STRUCTURE_TEXT_ALIGN_JUSTIFY" + glib:nick="justify"> + </member> + </enumeration> + <enumeration name="StructureTextDecoration" + glib:type-name="PopplerStructureTextDecoration" + glib:get-type="poppler_structure_text_decoration_get_type" + c:type="PopplerStructureTextDecoration"> + <member name="none" + value="0" + c:identifier="POPPLER_STRUCTURE_TEXT_DECORATION_NONE" + glib:nick="none"> + </member> + <member name="underline" + value="1" + c:identifier="POPPLER_STRUCTURE_TEXT_DECORATION_UNDERLINE" + glib:nick="underline"> + </member> + <member name="overline" + value="2" + c:identifier="POPPLER_STRUCTURE_TEXT_DECORATION_OVERLINE" + glib:nick="overline"> + </member> + <member name="linethrough" + value="3" + c:identifier="POPPLER_STRUCTURE_TEXT_DECORATION_LINETHROUGH" + glib:nick="linethrough"> + </member> + </enumeration> + <enumeration name="StructureWritingMode" + glib:type-name="PopplerStructureWritingMode" + glib:get-type="poppler_structure_writing_mode_get_type" + c:type="PopplerStructureWritingMode"> + <member name="lr_tb" + value="0" + c:identifier="POPPLER_STRUCTURE_WRITING_MODE_LR_TB" + glib:nick="lr-tb"> + </member> + <member name="rl_tb" + value="1" + c:identifier="POPPLER_STRUCTURE_WRITING_MODE_RL_TB" + glib:nick="rl-tb"> + </member> + <member name="tb_rl" + value="2" + c:identifier="POPPLER_STRUCTURE_WRITING_MODE_TB_RL" + glib:nick="tb-rl"> + </member> + </enumeration> <record name="TextAttributes" c:type="PopplerTextAttributes" version="0.18" @@ -5292,21 +7979,27 @@ locations on a page and bounding boxes</doc> c:symbol-prefix="text_attributes"> <doc xml:space="preserve">A #PopplerTextAttributes is used to describe text attributes of a range of text</doc> <field name="font_name" writable="1"> + <doc xml:space="preserve">font name</doc> <type name="utf8" c:type="gchar*"/> </field> <field name="font_size" writable="1"> + <doc xml:space="preserve">font size</doc> <type name="gdouble" c:type="gdouble"/> </field> <field name="is_underlined" writable="1"> + <doc xml:space="preserve">if text is underlined</doc> <type name="gboolean" c:type="gboolean"/> </field> <field name="color" writable="1"> + <doc xml:space="preserve">a #PopplerColor, the foreground color</doc> <type name="Color" c:type="PopplerColor"/> </field> <field name="start_index" writable="1"> + <doc xml:space="preserve">start position this text attributes apply</doc> <type name="gint" c:type="gint"/> </field> <field name="end_index" writable="1"> + <doc xml:space="preserve">end position this text text attributes apply</doc> <type name="gint" c:type="gint"/> </field> <constructor name="new" @@ -5348,6 +8041,142 @@ locations on a page and bounding boxes</doc> </parameters> </method> </record> + <record name="TextSpan" + c:type="PopplerTextSpan" + glib:type-name="PopplerTextSpan" + glib:get-type="poppler_text_span_get_type" + c:symbol-prefix="text_span"> + <method name="copy" c:identifier="poppler_text_span_copy" version="0.26"> + <doc xml:space="preserve">Makes a copy of a text span.</doc> + <return-value transfer-ownership="full"> + <doc xml:space="preserve">A new #PopplerTextSpan</doc> + <type name="TextSpan" c:type="PopplerTextSpan*"/> + </return-value> + <parameters> + <instance-parameter name="poppler_text_span" + transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerTextSpan</doc> + <type name="TextSpan" c:type="PopplerTextSpan*"/> + </instance-parameter> + </parameters> + </method> + <method name="free" c:identifier="poppler_text_span_free" version="0.26"> + <doc xml:space="preserve">Frees a text span.</doc> + <return-value transfer-ownership="none"> + <type name="none" c:type="void"/> + </return-value> + <parameters> + <instance-parameter name="poppler_text_span" + transfer-ownership="none"> + <doc xml:space="preserve">A #PopplerTextSpan</doc> + <type name="TextSpan" c:type="PopplerTextSpan*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_color" + c:identifier="poppler_text_span_get_color" + version="0.26"> + <doc xml:space="preserve">Obtains the color in which the text is to be rendered.</doc> + <return-value transfer-ownership="none"> + <type name="none" c:type="void"/> + </return-value> + <parameters> + <instance-parameter name="poppler_text_span" + transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerTextSpan</doc> + <type name="TextSpan" c:type="PopplerTextSpan*"/> + </instance-parameter> + <parameter name="color" + direction="out" + caller-allocates="1" + transfer-ownership="none"> + <doc xml:space="preserve">a return location for a #PopplerColor</doc> + <type name="Color" c:type="PopplerColor*"/> + </parameter> + </parameters> + </method> + <method name="get_font_name" + c:identifier="poppler_text_span_get_font_name" + version="0.26"> + <doc xml:space="preserve">Obtains the name of the font in which the span is to be rendered.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A string containing the font name, or + %NULL if a font is not defined.</doc> + <type name="utf8" c:type="const gchar*"/> + </return-value> + <parameters> + <instance-parameter name="poppler_text_span" + transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerTextSpan</doc> + <type name="TextSpan" c:type="PopplerTextSpan*"/> + </instance-parameter> + </parameters> + </method> + <method name="get_text" + c:identifier="poppler_text_span_get_text" + version="0.26"> + <doc xml:space="preserve">Obtains the text contained in the span.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">A string.</doc> + <type name="utf8" c:type="const gchar*"/> + </return-value> + <parameters> + <instance-parameter name="poppler_text_span" + transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerTextSpan</doc> + <type name="TextSpan" c:type="PopplerTextSpan*"/> + </instance-parameter> + </parameters> + </method> + <method name="is_bold_font" + c:identifier="poppler_text_span_is_bold_font" + version="0.26"> + <doc xml:space="preserve">Check whether a text span is meant to be rendered using a bold font.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">Whether the span uses bold font.</doc> + <type name="gboolean" c:type="gboolean"/> + </return-value> + <parameters> + <instance-parameter name="poppler_text_span" + transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerTextSpan</doc> + <type name="TextSpan" c:type="PopplerTextSpan*"/> + </instance-parameter> + </parameters> + </method> + <method name="is_fixed_width_font" + c:identifier="poppler_text_span_is_fixed_width_font" + version="0.26"> + <doc xml:space="preserve">Check wether a text span is meant to be rendered using a fixed-width font.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">Whether the span uses a fixed-width font.</doc> + <type name="gboolean" c:type="gboolean"/> + </return-value> + <parameters> + <instance-parameter name="poppler_text_span" + transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerTextSpan</doc> + <type name="TextSpan" c:type="PopplerTextSpan*"/> + </instance-parameter> + </parameters> + </method> + <method name="is_serif_font" + c:identifier="poppler_text_span_is_serif_font" + version="0.26"> + <doc xml:space="preserve">Check whether a text span is meant to be rendered using a serif font.</doc> + <return-value transfer-ownership="none"> + <doc xml:space="preserve">Whether the span uses a serif font.</doc> + <type name="gboolean" c:type="gboolean"/> + </return-value> + <parameters> + <instance-parameter name="poppler_text_span" + transfer-ownership="none"> + <doc xml:space="preserve">a #PopplerTextSpan</doc> + <type name="TextSpan" c:type="PopplerTextSpan*"/> + </instance-parameter> + </parameters> + </method> + </record> <bitfield name="ViewerPreferences" glib:type-name="PopplerViewerPreferences" glib:get-type="poppler_viewer_preferences_get_type" @@ -5402,11 +8231,6 @@ locations on a page and bounding boxes</doc> <doc xml:space="preserve">the predominant reading order for text is right to left</doc> </member> </bitfield> - <record name="_AttachmentClass" c:type="_PopplerAttachmentClass"> - <field name="parent_class" writable="1"> - <type name="GObject.ObjectClass" c:type="GObjectClass"/> - </field> - </record> <function name="date_parse" c:identifier="poppler_date_parse" version="0.12"> |