A data structure for holding actions
Copies @action, creating an identical #PopplerAction.
a new action identical to @action
Frees @action
Action to perform over a list of layers
Layer actions
Movie operations
Action types
Gets the type of @poppler_annot
#PopplerAnnotType of @poppler_annot.
Retrieves the color of @poppler_annot.
@poppler_annot, or %NULL. It must be freed with g_free() when done.
a new allocated #PopplerColor with the color values of
Retrieves the contents of @poppler_annot.
must be freed with g_free() when done.
a new allocated string with the contents of @poppler_annot. It
Retrieves the flag field specifying various characteristics of the
@poppler_annot.
the flag field of @poppler_annot.
Retrieves the last modification data of @poppler_annot. The returned
string will be either a PDF format date or a text string.
See also #poppler_date_parse()
@poppler_annot. It must be freed with g_free() when done.
a new allocated string with the last modification data of
Retrieves the name of @poppler_annot.
be freed with g_free() when done.
a new allocated string with the name of @poppler_annot. It must
Returns the page index to which @poppler_annot is associated, or -1 if unknown
page index or -1
Sets the color of @poppler_annot.
a #PopplerColor, or %NULL
Sets the contents of @poppler_annot to the given value,
replacing the current contents.
a text string containing the new contents
Creates a new empty #PopplerAnnotCalloutLine.
It must be freed when done.
a new allocated #PopplerAnnotCalloutLine, %NULL in other case.
It does copy @callout to a new #PopplerAnnotCalloutLine.
@callout, %NULL in other case. It must be freed when done.
a new allocated #PopplerAnnotCalloutLine as exact copy of
Frees the memory used by #PopplerAnnotCalloutLine.
Creates a #PopplerAttachment for the file of the file attachment annotation @annot.
The #PopplerAttachment must be unrefed with g_object_unref by the caller.
@PopplerAttachment
Retrieves the name of @poppler_annot.
be freed with g_free() when done.
a new allocated string with the name of @poppler_annot. It must
Retrieves a #PopplerAnnotCalloutLine of four or six numbers specifying a callout
line attached to the @poppler_annot.
line, %NULL in other case. It must be freed with g_free() when
done.
a new allocated #PopplerAnnotCalloutLine if the annot has a callout
Retrieves the justification of the text of @poppler_annot.
#PopplerAnnotFreeTextQuadding of @poppler_annot.
A #PopplerAnnotMapping structure represents the location
of @annot on the page
Creates a new #PopplerAnnotMapping
a new #PopplerAnnotMapping, use poppler_annot_mapping_free() to free it
Creates a copy of @mapping
a new allocated copy of @mapping
Frees the given #PopplerAnnotMapping
Returns the date and time when the annotation was created
when the annotation was created, or %NULL
a #GDate representing the date and time
Retrieves the label text of @poppler_annot.
the label text of @poppler_annot.
Retrieves the opacity value of @poppler_annot.
between 0 (transparent) and 1 (opaque)
the opacity value of @poppler_annot,
Retrieves the state of the popup window related to @poppler_annot.
other case.
the state of @poppler_annot. %TRUE if it's open, %FALSE in
Retrieves the rectangle of the popup window related to @poppler_annot.
%TRUE if #PopplerRectangle was correctly filled, %FALSE otherwise
a #PopplerRectangle to store the popup rectangle
Return %TRUE if the markup annotation has a popup window associated
%TRUE, if @poppler_annot has popup, %FALSE otherwise
Sets the label text of @poppler_annot, replacing the current one
a text string containing the new label, or %NULL
Sets the opacity of @poppler_annot. This value applies to
all visible elements of @poppler_annot in its closed state,
but not to the pop-up window that appears when it's openened
a constant opacity value, between 0 (transparent) and 1 (opaque)
Associates a new popup window for editing contents of @poppler_annot.
Popup window shall be displayed by viewers at @popup_rect on the page.
a #PopplerRectangle
Sets the state of the popup window related to @poppler_annot.
whether popup window should initially be displayed open
Retrieves the movie object (PopplerMovie) stored in the @poppler_annot.
object is owned by #PopplerAnnotMovie and should not be freed
the movie object stored in the @poppler_annot. The returned
Retrieves the movie title of @poppler_annot.
the title text of @poppler_annot.
Retrieves the action (#PopplerAction) that shall be performed when @poppler_annot is activated
object is owned by @poppler_annot and should not be freed
the action to perform. The returned
Creates a new Text annotation that will be
located on @rect when added to a page. See
poppler_page_add_annot()
A newly created #PopplerAnnotText annotation
a #PopplerDocument
a #PopplerRectangle
Gets name of the icon of @poppler_annot.
a new allocated string containing the icon name
Retrieves the state of @poppler_annot.
other case.
the state of @poppler_annot. %TRUE if it's open, %FALSE in
Retrieves the state of @poppler_annot.
#PopplerAnnotTextState of @poppler_annot.
Sets the icon of @poppler_annot. The following predefined
icons are currently supported:
<variablelist>
<varlistentry>
<term>#POPPLER_ANNOT_TEXT_ICON_NOTE</term>
</varlistentry>
<varlistentry>
<term>#POPPLER_ANNOT_TEXT_ICON_COMMENT</term>
</varlistentry>
<varlistentry>
<term>#POPPLER_ANNOT_TEXT_ICON_KEY</term>
</varlistentry>
<varlistentry>
<term>#POPPLER_ANNOT_TEXT_ICON_HELP</term>
</varlistentry>
<varlistentry>
<term>#POPPLER_ANNOT_TEXT_ICON_NEW_PARAGRAPH</term>
</varlistentry>
<varlistentry>
<term>#POPPLER_ANNOT_TEXT_ICON_PARAGRAPH</term>
</varlistentry>
<varlistentry>
<term>#POPPLER_ANNOT_TEXT_ICON_INSERT</term>
</varlistentry>
<varlistentry>
<term>#POPPLER_ANNOT_TEXT_ICON_CROSS</term>
</varlistentry>
<varlistentry>
<term>#POPPLER_ANNOT_TEXT_ICON_CIRCLE</term>
</varlistentry>
</variablelist>
the name of an icon
Sets whether @poppler_annot should initially be displayed open
whether annotation should initially be displayed open
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
and whatever the save function generates.
%TRUE, if the file successfully saved
name of file to save
Saves @attachment by feeding the produced data to @save_func. Can be used
when you want to store the attachment to something other than a file, such as
an in-memory buffer or a socket. If @error is set, %FALSE will be
returned. Possible errors include those in the #G_FILE_ERROR domain and
whatever the save function generates.
%TRUE, if the save successfully completed
a function that is called to save each block of data that the save routine generates.
user data to pass to the save function.
Specifies the type of the function passed to
poppler_attachment_save_to_callback(). It is called once for each block of
bytes that is "written" by poppler_attachment_save_to_callback(). If
successful it should return %TRUE. If an error occurs it should set
@error and return %FALSE, in which case poppler_attachment_save_to_callback()
will fail with the same error.
buffer containing bytes to be written.
number of bytes in @buf.
user data passed to poppler_attachment_save_to_callback()
A #PopplerColor describes a RGB color. Color components
are values between 0 and 65535
Creates a new #PopplerColor
a new #PopplerColor, use poppler_color_free() to free it
Creates a copy of @color
a new allocated copy of @color
Frees the given #PopplerColor
Data structure for holding a destination
Copies @dest, creating an identical #PopplerDest.
a new destination identical to @dest
Frees @dest
Destination types
Creates a new #PopplerDocument. If %NULL is returned, then @error will be
set. Possible errors include those in the #POPPLER_ERROR and #G_FILE_ERROR
domains.
A newly created #PopplerDocument, or %NULL
the pdf data contained in a char array
the length of #data
password to unlock the file with, or %NULL
Creates a new #PopplerDocument. If %NULL is returned, then @error will be
set. Possible errors include those in the #POPPLER_ERROR and #G_FILE_ERROR
domains.
A newly created #PopplerDocument, or %NULL
uri of the file to load
password to unlock the file with, or %NULL
Finds named destination @link_name in @document
@link_name is not a destination. Returned value must
be freed with #poppler_dest_free
The #PopplerDest destination or %NULL if
a named destination
Returns a #GList containing #PopplerAttachment<!-- -->s. These attachments
are unowned, and must be unreffed, and the list must be freed with
g_list_free().
a list of available attachments.
Returns the author of the document
of @document, or %NULL
a new allocated string containing the author
Returns the date the document was created as seconds since the Epoch
the date the document was created, or -1
Returns the creator of the document. If the document was converted
from another format, the creator is the name of the product
that created the original document from which it was converted.
of @document, or %NULL
a new allocated string containing the creator
Returns the #PopplerFormField for the given @id. It must be freed with
g_object_unref()
not found
a new #PopplerFormField or %NULL if
an id of a #PopplerFormField
Returns the PDF file identifier represented as two byte string arrays of size 32.
@permanent_id is the permanent identifier that is built based on the file
contents at the time it was originally created, so that this identifer
never changes. @update_id is the update identifier that is built based on
the file contents at the time it was last updated.
Note that returned strings are not null-terminated, they have a fixed
size of 32 bytes.
%TRUE if the @document contains an id, %FALSE otherwise
location to store an allocated string, use g_free() to free the returned string
location to store an allocated string, use g_free() to free the returned string
Returns the keywords associated to the document
to @document, or %NULL
a new allocated string containing keywords associated
Returns the XML metadata string of the document
metadata, or %NULL
a new allocated string containing the XML
Returns the date the document was most recently modified as seconds since the Epoch
the date the document was most recently modified, or -1
Returns the number of attachments in a loaded document.
See also poppler_document_get_attachments()
Number of attachments
Returns the number of pages in a loaded document.
Number of pages
Returns the #PopplerPage indexed at @index. This object is owned by the
caller.
The #PopplerPage at @index
a page index
Returns the #PopplerPage reference by @label. This object is owned by the
caller. @label is a human-readable string representation of the page number,
and can be document specific. Typically, it is a value such as "iii" or "3".
By default, "1" refers to the first page.
The #PopplerPage referenced by @label
a page label
Returns the page layout that should be used when the document is opened
a #PopplerPageLayout that should be used when the document is opened
Returns a #PopplerPageMode representing how the document should
be initially displayed when opened.
a #PopplerPageMode that should be used when document is opened
the major and minor PDF version numbers
return location for the PDF major version number
return location for the PDF minor version number
Returns the PDF version of @document as a string (e.g. PDF-1.6)
of @document, or %NULL
a new allocated string containing the PDF version
Returns the flags specifying which operations are permitted when the document is opened.
a set of falgs from #PopplerPermissions enumeration
Returns the producer of the document. If the document was converted
from another format, the producer is the name of the product
that converted it to PDF
of @document, or %NULL
a new allocated string containing the producer
Returns the subject of the document
of @document, or %NULL
a new allocated string containing the subject
Returns the document's title
of @document, or %NULL
a new allocated string containing the title
Returns %TRUE of @document has any attachments.
%TRUE, if @document has attachments.
Returns whether @document is linearized or not. Linearization of PDF
enables efficient incremental access of the PDF file in a network environment.
%TRUE if @document is linearized, %FALSE otherwhise
Saves @document. Any change made in the document such as
form fields filled, annotations added or modified
will be saved.
If @error is set, %FALSE will be returned. Possible errors
include those in the #G_FILE_ERROR domain.
%TRUE, if the document was successfully saved
uri of file to save
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.
If @error is set, %FALSE will be returned. Possible errors
include those in the #G_FILE_ERROR domain.
%TRUE, if the document was successfully saved
uri of file to save
The author of the document
The date the document was created as seconds since the Epoch, or -1
The creator of the document. See also poppler_document_get_creator()
The PDF version as string. See also poppler_document_get_pdf_version_string()
The PDF major version number. See also poppler_document_get_pdf_version()
The PDF minor version number. See also poppler_document_get_pdf_version()
The keywords associated to the document
Whether document is linearized. See also poppler_document_is_linearized()
Document metadata in XML format, or %NULL
The date the document was most recently modified as seconds since the Epoch, or -1
The page layout that should be used when the document is opened
The mode that should be used when the document is opened
Flags specifying which operations are permitted when the document is opened
The producer of the document. See also poppler_document_get_producer()
The subject of the document
The document's title or %NULL
Error codes returned by #PopplerDocument
Creates a new #PopplerFontInfo object
a new #PopplerFontInfo instance
a #PopplerDocument
Scans the document associated with @font_info for fonts. At most
@n_pages will be scanned starting from the current iterator. @iter will
point to the first font scanned.
Here is a simple example of code to scan fonts in a document
<informalexample><programlisting>
font_info = poppler_font_info_new (document);
while (poppler_font_info_scan (font_info, 20, &fonts_iter)) {
if (!fonts_iter)
continue; /<!-- -->* No fonts found in these 20 pages *<!-- -->/
do {
/<!-- -->* Do something with font iter *<!-- -->/
g_print ("Font Name: %s\n", poppler_fonts_iter_get_name (fonts_iter));
} while (poppler_fonts_iter_next (fonts_iter));
poppler_fonts_iter_free (fonts_iter);
}
</programlisting></informalexample>
%TRUE, if there are more fonts left to scan
number of pages to scan
return location for a #PopplerFontsIter
Font types
Creates a copy of @iter
a new allocated copy of @iter
Frees the given #PopplerFontsIter
Returns the encoding of the font associated with @iter
the font encoding
The filename of the font associated with @iter or %NULL if
the font is embedded
the filename of the font or %NULL if font is embedded
Returns the type of the font associated with @iter
the font type
Returns the full name of the font associated with @iter
the font full name
Returns the name of the font associated with @iter
the font name
The name of the substitute font of the font associated with @iter or %NULL if
the font is embedded
the name of the substitute font or %NULL if font is embedded
Returns whether the font associated with @iter is embedded in the document
%TRUE if font is emebdded, %FALSE otherwise
Returns whether the font associated with @iter is a subset of another font
%TRUE if font is a subset, %FALSE otherwise
Sets @iter to point to the next font
%TRUE, if @iter was set to the next font
Gets the button type of @field
#PopplerFormButtonType of @field
Queries a #PopplerFormField and returns its current state. Returns %TRUE if
@field is pressed in and %FALSE if it is raised.
current state of @field
Sets the status of @field. Set to %TRUE if you want the #PopplerFormField
to be 'pressed in', and %FALSE to raise it.
%TRUE or %FALSE
Checks whether @field allows multiple choices to be selected
%TRUE if @field allows multiple choices to be selected
Checks whether spell checking should be done for the contents of @field
%TRUE if spell checking should be done for @field
Gets the choice type of @field
#PopplerFormChoiceType of @field
Returns the contents of the item on @field at the given index
a new allocated string. It must be freed with g_free() when done.
the index of the item
Returns the number of items on @field
the number of items on @field
Retrieves the contents of @field.
a new allocated string. It must be freed with g_free() when done.
Checks whether @field is editable
%TRUE if @field is editable
Checks whether the item at the given index on @field is currently selected
%TRUE if item at @index is currently selected
the index of the item
Selects the item at the given index on @field
the index of the item
Sets the text in @field to the given value, replacing the current contents
the new text
Changes the state of the item at the given index
the index of the item
Unselects all the items on @field
Retrieves the action (#PopplerAction) that shall be
performed when @field is activated, or %NULL
object is owned by @field and should not be freed
the action to perform. The returned
Gets the type of @field
#PopplerFormFieldType of @field
Gets the font size of @field
the font size of @field
Gets the id of @field
the id of @field
Gets the mapping name of @field that is used when
exporting interactive form field data from the document
a new allocated string. It must be freed with g_free() when done.
Gets the fully qualified name of @field. It's constructed by concatenating
the partial field names of the field and all of its ancestors.
a new allocated string. It must be freed with g_free() when done.
Gets the partial name of @field.
a new allocated string. It must be freed with g_free() when done.
Checks whether @field is read only
%TRUE if @field is read only
Checks whether spell checking should be done for the contents of @field
%TRUE if spell checking should be done for @field
Retrieves the maximum allowed length of the text in @field
the maximum allowed number of characters in @field, or -1 if there is no maximum.
Retrieves the contents of @field.
a new allocated string. It must be freed with g_free() when done.
Gets the text type of @field.
#PopplerFormTextType of @field
Checks whether content of @field is a password and it must be hidden
%TRUE if the content of @field is a password
Checks whether the contents of @field are rich text
%TRUE if the contents of @field are rich text
Sets the text in @field to the given value, replacing the current contents.
the new text
A #PopplerFormFieldMapping structure represents the location
of @field on the page
Creates a new #PopplerFormFieldMapping
a new #PopplerFormFieldMapping, use poppler_form_field_mapping_free() to free it
Creates a copy of @mapping
a new allocated copy of @mapping
Frees the given #PopplerFormFieldMapping
A #PopplerImageMapping structure represents the location
of an image on the page
Creates a new #PopplerImageMapping
a new #PopplerImageMapping, use poppler_image_mapping_free() to free it
Creates a copy of @mapping
a new allocated copy of @mapping
Frees the given #PopplerImageMapping
Returns the root #PopplerIndexIter for @document, or %NULL. This must be
freed with poppler_index_iter_free().
Certain documents have an index associated with them. This index can be used
to help the user navigate the document, and is similar to a table of
contents. Each node in the index will contain a #PopplerAction that can be
displayed to the user — typically a #POPPLER_ACTION_GOTO_DEST or a
#POPPLER_ACTION_URI<!-- -->.
Here is a simple example of some code that walks the full index:
<informalexample><programlisting>
static void
walk_index (PopplerIndexIter *iter)
{
do
{
/<!-- -->* Get the the action and do something with it *<!-- -->/
PopplerIndexIter *child = poppler_index_iter_get_child (iter);
if (child)
walk_index (child);
poppler_index_iter_free (child);
}
while (poppler_index_iter_next (iter));
}
...
{
iter = poppler_index_iter_new (document);
walk_index (iter);
poppler_index_iter_free (iter);
}
</programlisting></informalexample>
a new #PopplerIndexIter
a #PopplerDocument
Creates a new #PopplerIndexIter as a copy of @iter. This must be freed with
poppler_index_iter_free().
a new #PopplerIndexIter
Frees @iter.
Returns the #PopplerAction associated with @iter. It must be freed with
poppler_action_free().
a new #PopplerAction
Returns a newly created child of @parent, or %NULL if the iter has no child.
See poppler_index_iter_new() for more information on this function.
a new #PopplerIndexIter
Returns whether this node should be expanded by default to the user. The
document can provide a hint as to how the document's index should be expanded
initially.
%TRUE, if the document wants @iter to be expanded
Sets @iter to point to the next action at the current level, if valid. See
poppler_index_iter_new() for more information.
%TRUE, if @iter was set to the next action
Returns the numeric ID the radio button group associated with @layer.
or 0 if the layer is not associated to any radio button group
the ID of the radio button group associated with @layer,
Returns the name of the layer suitable for
presentation as a title in a viewer's GUI
a string containing the title of the layer
Hides @layer. If @layer is the parent of other nested layers,
such layers will be also hidden and will be blocked until @layer
is shown again
Returns whether @layer is parent of other nested layers.
%TRUE if @layer is a parent layer
Returns whether @layer is visible
%TRUE if @layer is visible
Shows @layer
a #PopplerDocument
Creates a new #PopplerLayersIter as a copy of @iter. This must be freed with
poppler_layers_iter_free().
Since 0.12
a new #PopplerLayersIter
Frees @iter.
Returns a newly created child of @parent, or %NULL if the iter has no child.
See poppler_layers_iter_new() for more information on this function.
a new #PopplerLayersIter, or %NULL
Returns the #PopplerLayer associated with @iter.
there isn't any layer associated with @iter
a new #PopplerLayer, or %NULL if
Returns the title associated with @iter. It must be freed with
g_free().
The returned string should be freed with g_free() when no longer needed.
a new string containing the @iter's title or %NULL if @iter doesn't have a title.
Sets @iter to point to the next action at the current level, if valid. See
poppler_layers_iter_new() for more information.
%TRUE, if @iter was set to the next action
A #PopplerLinkMapping structure represents the location
of @action on the page
Creates a new #PopplerLinkMapping
a new #PopplerLinkMapping, use poppler_link_mapping_free() to free it
Creates a copy of @mapping
a new allocated copy of @mapping
Frees the given #PopplerLinkMapping
Returns the media clip mime-type
the mime-type, return value is owned by #PopplerMedia and should not be freed
Whether the media clip is embedded in the PDF. If the result is %TRUE, the embedded stream
can be saved with poppler_media_save() or poppler_media_save_to_callback() function.
If the result is %FALSE, the media clip filename can be retrieved with
poppler_media_get_filename() function.
%TRUE if media clip is embedded, %FALSE otherwise
Saves embedded stream of @poppler_media to a file indicated by @filename.
If @error is set, %FALSE will be returned.
Possible errors include those in the #G_FILE_ERROR domain
and whatever the save function generates.
%TRUE, if the file successfully saved
name of file to save
Saves embedded stream of @poppler_media by feeding the produced data to @save_func. Can be used
when you want to store the media clip stream to something other than a file, such as
an in-memory buffer or a socket. If @error is set, %FALSE will be
returned. Possible errors include those in the #G_FILE_ERROR domain and
whatever the save function generates.
%TRUE, if the save successfully completed
a function that is called to save each block of data that the save routine generates.
user data to pass to the save function.
Specifies the type of the function passed to
poppler_media_save_to_callback(). It is called once for each block of
bytes that is "written" by poppler_media_save_to_callback(). If
successful it should return %TRUE. If an error occurs it should set
@error and return %FALSE, in which case poppler_media_save_to_callback()
will fail with the same error.
%TRUE if successful, %FALSE (with @error set) if failed.
buffer containing bytes to be written.
number of bytes in @buf.
user data passed to poppler_media_save_to_callback()
Returns whether a poster image representing the Movie
shall be displayed. The poster image must be retrieved
from the movie file.
%TRUE if move needs a poster image, %FALSE otherwise
Returns whether to display a movie controller bar while playing the movie
%TRUE if controller bar should be displayed, %FALSE otherwise
Create a new postscript file to render to
a PopplerPSFile
a #PopplerDocument
the path of the output filename
the first page to print
the number of pages to print
Frees @ps_file
Enable or disable Duplex printing.
whether to force duplex printing (on printers which support this)
Set the output paper size. These values will end up in the
DocumentMedia, the BoundingBox DSC comments and other places in the
generated PostScript.
the paper width in 1/72 inch
the paper height in 1/72 inch
Frees a list of #PopplerAnnotMapping<!-- -->s allocated by
poppler_page_get_annot_mapping(). It also unreferences the #PopplerAnnot<!-- -->s
that each mapping contains, so if you want to keep them around, you need to
reference them with g_object_ref().
A list of #PopplerAnnotMapping<!-- -->s
Frees a list of #PopplerFormFieldMapping<!-- -->s allocated by
poppler_page_get_form_field_mapping().
A list of #PopplerFormFieldMapping<!-- -->s
Frees a list of #PopplerImageMapping<!-- -->s allocated by
poppler_page_get_image_mapping().
A list of #PopplerImageMapping<!-- -->s
Frees a list of #PopplerLinkMapping<!-- -->s allocated by
poppler_page_get_link_mapping(). It also frees the #PopplerAction<!-- -->s
that each mapping contains, so if you want to keep them around, you need to
copy them with poppler_action_copy().
A list of #PopplerLinkMapping<!-- -->s
Frees a list of #PopplerTextAttributes<!-- -->s allocated by
poppler_page_get_text_attributes().
A list of #PopplerTextAttributes<!-- -->s
Frees @region
a #GList of #PopplerRectangle
Adds annotation @annot to @page.
a #PopplerAnnot to add
A #GList of rectangles for each occurance of the text on the page.
The coordinates are in PDF points.
a #GList of #PopplerRectangle,
the text to search for (UTF-8 encoded)
Returns a list of #PopplerAnnotMapping items that map from a location on
@page to a #PopplerAnnot. This list must be freed with
poppler_page_free_annot_mapping() when done.
A #GList of #PopplerAnnotMapping
Retrurns the crop box of @page
a #PopplerRectangle to fill
Returns the duration of @page
duration in seconds of @page or -1.
Returns a list of #PopplerFormFieldMapping items that map from a
location on @page to a form field. This list must be freed
with poppler_page_free_form_field_mapping() when done.
A #GList of #PopplerFormFieldMapping
Returns a cairo surface for the image of the @page
A cairo surface for the image
The image identifier
Returns a list of #PopplerImageMapping items that map from a
location on @page to an image of the page. This list must be freed
with poppler_page_free_image_mapping() when done.
A #GList of #PopplerImageMapping
Returns the index of @page
index value of @page
Returns the label of @page. Note that page labels
and page indices might not coincide.
or %NULL if @page doesn't have a label
a new allocated string containing the label of @page,
Returns a list of #PopplerLinkMapping items that map from a
location on @page to a #PopplerAction. This list must be freed
with poppler_page_free_link_mapping() when done.
A #GList of #PopplerLinkMapping
Returns a region containing the area that would be rendered by
poppler_page_render_selection().
The returned region must be freed with cairo_region_destroy()
a cairo_region_t
scale specified as pixels per point
a #PopplerSelectionStyle
start and end point of selection as a rectangle
Retrieves the contents of the specified @selection as text.
as a string
a pointer to the contents of the @selection
a #PopplerSelectionStyle
the #PopplerRectangle including the text
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().
a #GList of #PopplerRectangle
scale specified as pixels per point
a #PopplerSelectionStyle
start and end point of selection as a rectangle
Gets the size of @page at the current scale and rotation.
return location for the width of @page
return location for the height of @page
Retrieves the text of @page.
as a string
a pointer to the text of the @page
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.
A #GList of #PopplerTextAttributes
Obtains the layout of the text 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()
%TRUE if the page contains text, %FALSE otherwise
return location for an array of #PopplerRectangle
(out) length of returned array
Get the embedded thumbnail for the specified page. If the document
doesn't have an embedded thumbnail for the page, this function
returns %NULL.
doesn't have a thumbnail for this page.
the tumbnail as a cairo_surface_t or %NULL if the document
Returns %TRUE if @page has a thumbnail associated with it. It also
fills in @width and @height with the width and height of the
thumbnail. The values of width and height are not changed if no
appropriate thumbnail exists.
%TRUE, if @page has a thumbnail associated with it.
(out) return location for width
(out) return location for height
Returns the transition effect of @page
a #PopplerPageTransition or %NULL.
Render the page to the given cairo context. This function
is for rendering a page that will be displayed. If you want
to render a page that will be printed use
poppler_page_render_for_printing() instead
cairo context to render to
Render the page to the given cairo context for printing.
cairo context to render to
Render the page to the given cairo context for printing
with the specified options
cairo context to render to
print options
Render the selection specified by @selection for @page to
the given cairo context. The selection will be rendered, using
@glyph_color for the glyphs and @background_color for the selection
background.
If non-NULL, @old_selection specifies the selection that is already
rendered to @cairo, in which case this function will (some day)
only render the changed part of the selection.
cairo context to render to
start and end point of selection as a rectangle
previous selection
a #PopplerSelectionStyle
color to use for drawing glyphs
color to use for the selection background
Render the page on a postscript file
the PopplerPSFile to render to
The label of the page or %NULL. See also poppler_page_get_label()
Page layout types
Page modes
A #PopplerPageTransition structures describes a visual transition
to use when moving between pages during a presentation
Creates a new #PopplerPageTransition
a new #PopplerPageTransition, use poppler_page_transition_free() to free it
Creates a copy of @transition
a new allocated copy of @transition
Frees the given #PopplerPageTransition
Page transition alignment types for #POPPLER_PAGE_TRANSITION_SPLIT
and #POPPLER_PAGE_TRANSITION_BLINDS transition types
Page transition direction types for #POPPLER_PAGE_TRANSITION_SPLIT,
#POPPLER_PAGE_TRANSITION_BOX and #POPPLER_PAGE_TRANSITION_FLY transition types
Page transition types
Permissions
Printing flags
A #PopplerRectangle is used to describe
locations on a page and bounding boxes
Creates a new #PopplerRectangle
a new #PopplerRectangle, use poppler_rectangle_free() to free it
Creates a copy of @rectangle
a new allocated copy of @rectangle
Frees the given #PopplerRectangle
Selection styles
A #PopplerTextAttributes is used to describe text attributes of a range of text
Creates a new #PopplerTextAttributes
a new #PopplerTextAttributes, use poppler_text_attributes_free() to free it
Creates a copy of @text_attrs
a new allocated copy of @text_attrs
Frees the given #PopplerTextAttributes
Viewer preferences
Parses a PDF format date string and converts it to a #time_t. Returns #FALSE
if the parsing fails or the input string is not a valid PDF format date string
#TRUE, if @timet was set
string to parse
an uninitialized #time_t
Returns the backend compiled into the poppler library.
The backend used by poppler
Returns the version of poppler in use. This result is not to be freed.
the version of poppler.