A data structure for holding actions Copies @action, creating an identical #PopplerAction. a new action identical to @action a #PopplerAction Frees @action a #PopplerAction Action to perform over a list of layers a #PopplerActionLayerAction list of #PopplerLayer<!-- -->s Layer actions set layer visibility on set layer visibility off reverse the layer visibility state Movie operations play movie pause playing movie resume paused movie stop playing movie Action types unknown action no action specified go to destination go to destination in another document launch app (or open document URI predefined action play movies. Since 0.14 play multimedia content. Since 0.14 state of layer. Since 0.14 Javascript. Since 0.18 Form field additional action types to be passed to @poppler_form_field_get_additional_action The action to be performed when the user modifies the field. The action to be performed before the field is formatted to display its value. The action to be performed when the field value changes. The action to be performed when the field needs to be recalculated. Gets the type of @poppler_annot #PopplerAnnotType of @poppler_annot. a #PopplerAnnot Retrieves the color of @poppler_annot. a new allocated #PopplerColor with the color values of @poppler_annot, or %NULL. It must be freed with g_free() when done. a #PopplerAnnot Retrieves the contents of @poppler_annot. a new allocated string with the contents of @poppler_annot. It must be freed with g_free() when done. a #PopplerAnnot Retrieves the flag field specifying various characteristics of the @poppler_annot. the flag field of @poppler_annot. a #PopplerAnnot 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() a new allocated string with the last modification data of @poppler_annot. It must be freed with g_free() when done. a #PopplerAnnot Retrieves the name of @poppler_annot. a new allocated string with the name of @poppler_annot. It must be freed with g_free() when done. a #PopplerAnnot Returns the page index to which @poppler_annot is associated, or -1 if unknown page index or -1 a #PopplerAnnot Retrieves the rectangle representing the page coordinates where the annotation @poppler_annot is placed. a #PopplerAnnot a #PopplerRectangle to store the annotation's coordinates Sets the color of @poppler_annot. a #PopplerAnnot a #PopplerColor, or %NULL Sets the contents of @poppler_annot to the given value, replacing the current contents. a #PopplerAnnot a text string containing the new contents Sets the flag field specifying various characteristics of the @poppler_annot. a #PopplerAnnot a #PopplerAnnotFlag Move the annotation to the rectangle representing the page coordinates where the annotation @poppler_annot should be placed. a #PopplerAnnot a #PopplerRectangle with the new annotation's coordinates Creates a new empty #PopplerAnnotCalloutLine. a new allocated #PopplerAnnotCalloutLine, %NULL in other case. It must be freed when done. It does copy @callout to a new #PopplerAnnotCalloutLine. a new allocated #PopplerAnnotCalloutLine as exact copy of @callout, %NULL in other case. It must be freed when done. the #PopplerAnnotCalloutLine to be copied. Frees the memory used by #PopplerAnnotCalloutLine. a #PopplerAnnotCalloutLine Creates a new Circle annotation that will be located on @rect when added to a page. See poppler_page_add_annot() a newly created #PopplerAnnotCircle annotation a #PopplerDocument a #PopplerRectangle Retrieves the interior color of @poppler_annot. a new allocated #PopplerColor with the color values of @poppler_annot, or %NULL. It must be freed with g_free() when done. a #PopplerAnnotCircle Sets the interior color of @poppler_annot. a #PopplerAnnotCircle a #PopplerColor, or %NULL 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 a #PopplerAnnotFileAttachment Retrieves the name of @poppler_annot. a new allocated string with the name of @poppler_annot. It must be freed with g_free() when done. a #PopplerAnnotFileAttachment Retrieves a #PopplerAnnotCalloutLine of four or six numbers specifying a callout line attached to the @poppler_annot. a new allocated #PopplerAnnotCalloutLine if the annot has a callout line, %NULL in other case. It must be freed with g_free() when done. a #PopplerAnnotFreeText Retrieves the justification of the text of @poppler_annot. #PopplerAnnotFreeTextQuadding of @poppler_annot. a #PopplerAnnotFreeText Creates a new Line annotation that will be located on @rect when added to a page. See poppler_page_add_annot() A newly created #PopplerAnnotLine annotation a #PopplerDocument a #PopplerRectangle a #PopplerPoint of the starting vertice a #PopplerPoint of the ending vertice Set the coordinate points where the @poppler_annot starts and ends. a #PopplerAnnotLine a #PopplerPoint of the starting vertice a #PopplerPoint of the ending vertice A #PopplerAnnotMapping structure represents the location of @annot on the page a #PopplerRectangle representing an area of the page a #PopplerAnnot 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 a #PopplerAnnotMapping to copy Frees the given #PopplerAnnotMapping a #PopplerAnnotMapping Returns the date and time when the annotation was created a #GDate representing the date and time when the annotation was created, or %NULL a #PopplerAnnotMarkup Gets the external data type of @poppler_annot. #PopplerAnnotExternalDataType of @poppler_annot. a #PopplerAnnotMarkup Retrieves the label text of @poppler_annot. the label text of @poppler_annot. a #PopplerAnnotMarkup Retrieves the opacity value of @poppler_annot. the opacity value of @poppler_annot, between 0 (transparent) and 1 (opaque) a #PopplerAnnotMarkup Retrieves the state of the popup window related to @poppler_annot. the state of @poppler_annot. %TRUE if it's open, %FALSE in other case. a #PopplerAnnotMarkup Retrieves the rectangle of the popup window related to @poppler_annot. %TRUE if #PopplerRectangle was correctly filled, %FALSE otherwise a #PopplerAnnotMarkup a #PopplerRectangle to store the popup rectangle Gets the reply type of @poppler_annot. #PopplerAnnotMarkupReplyType of @poppler_annot. a #PopplerAnnotMarkup Retrives the subject text of @poppler_annot. the subject text of @poppler_annot. a #PopplerAnnotMarkup Return %TRUE if the markup annotation has a popup window associated %TRUE, if @poppler_annot has popup, %FALSE otherwise a #PopplerAnnotMarkup Sets the label text of @poppler_annot, replacing the current one a #PopplerAnnotMarkup 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 #PopplerAnnotMarkup 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 #PopplerAnnotMarkup a #PopplerRectangle Sets the state of the popup window related to @poppler_annot. a #PopplerAnnotMarkup whether popup window should initially be displayed open Sets the rectangle of the popup window related to @poppler_annot. This doesn't have any effect if @poppler_annot doesn't have a popup associated, use poppler_annot_markup_set_popup() to associate a popup window to a #PopplerAnnotMarkup. a #PopplerAnnotMarkup a #PopplerRectangle to set Retrieves the movie object (PopplerMovie) stored in the @poppler_annot. the movie object stored in the @poppler_annot. The returned object is owned by #PopplerAnnotMovie and should not be freed a #PopplerAnnotMovie Retrieves the movie title of @poppler_annot. the title text of @poppler_annot. a #PopplerAnnotMovie Retrieves the action (#PopplerAction) that shall be performed when @poppler_annot is activated the action to perform. The returned object is owned by @poppler_annot and should not be freed a #PopplerAnnotScreen Creates a new Square annotation that will be located on @rect when added to a page. See poppler_page_add_annot() a newly created #PopplerAnnotSquare annotation a #PopplerDocument a #PopplerRectangle Retrieves the interior color of @poppler_annot. a new allocated #PopplerColor with the color values of @poppler_annot, or %NULL. It must be freed with g_free() when done. a #PopplerAnnotSquare Sets the interior color of @poppler_annot. a #PopplerAnnotSquare a #PopplerColor, or %NULL 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 a #PopplerAnnotText Retrieves the state of @poppler_annot. the state of @poppler_annot. %TRUE if it's open, %FALSE in other case. a #PopplerAnnotText Retrieves the state of @poppler_annot. #PopplerAnnotTextState of @poppler_annot. a #PopplerAnnotText 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> a #PopplerAnnotText the name of an icon Sets whether @poppler_annot should initially be displayed open a #PopplerAnnotText whether annotation should initially be displayed open Creates a new Highlight Text annotation that will be located on @rect when added to a page. See poppler_page_add_annot() A newly created #PopplerAnnotTextMarkup annotation a #PopplerDocument a #PopplerRectangle A #GArray of #PopplerQuadrilateral<!-- -->s Creates a new Squiggly Text annotation that will be located on @rect when added to a page. See poppler_page_add_annot() A newly created #PopplerAnnotTextMarkup annotation a #PopplerDocument a #PopplerRectangle A #GArray of #PopplerQuadrilateral<!-- -->s Creates a new Strike Out Text annotation that will be located on @rect when added to a page. See poppler_page_add_annot() A newly created #PopplerAnnotTextMarkup annotation a #PopplerDocument a #PopplerRectangle A #GArray of #PopplerQuadrilateral<!-- -->s Creates a new Underline Text annotation that will be located on @rect when added to a page. See poppler_page_add_annot() A newly created #PopplerAnnotTextMarkup annotation a #PopplerDocument a #PopplerRectangle A #GArray of #PopplerQuadrilateral<!-- -->s Returns a #GArray of #PopplerQuadrilateral items that map from a location on @page to a #PopplerAnnotTextMarkup. This array must be freed when done. A #GArray of #PopplerQuadrilateral A #PopplerAnnotTextMarkup Set the regions (Quadrilaterals) to apply the text markup in @poppler_annot. A #PopplerAnnotTextMarkup A #GArray of #PopplerQuadrilateral<!-- -->s 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 A #PopplerAttachment. 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 #PopplerAttachment. 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. %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_attachment_save_to_callback() Backend codes returned by poppler_get_backend(). Unknown backend Splash backend Cairo backend Checks the version fo the poppler library major version (e.g. 0 for version 0.1.2) minor version (e.g. 1 for version 0.1.2) micro version (e.g. 2 for version 0.1.2) A #PopplerColor describes a RGB color. Color components are values between 0 and 65535 the red component of color the green component of color the blue component of color 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 a #PopplerColor to copy Frees the given #PopplerColor a #PopplerColor Data structure for holding a destination Note that @named_dest is the string representation of the named destination. This is the right form to pass to poppler functions, e.g. poppler_document_find_dest(), but to get the destination as it appears in the PDF itself, you need to convert it to a bytestring with poppler_named_dest_to_bytestring() first. Also note that @named_dest does not have a defined encoding and is not in a form suitable to be displayed to the user. type of destination page number left coordinate bottom coordinate right coordinate top coordinate scale factor name of the destination (#POPPLER_DEST_NAMED only) whether left coordinate should be changed whether top coordinate should be changed whether scale factor should be changed Copies @dest, creating an identical #PopplerDest. a new destination identical to @dest a #PopplerDest Frees @dest a #PopplerDest Destination types unknown destination 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 go to page with its contents magnified just enough to fit the entire page within the window both horizontally and vertically 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 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 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 go to page with its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically 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 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 got to page specified by a name. See poppler_document_find_dest() Creates a new #PopplerDocument from @bytes. The returned document will hold a reference to @bytes. On error, %NULL is returned, with @error set. Possible errors include those in the #POPPLER_ERROR and #G_FILE_ERROR domains. a newly created #PopplerDocument, or %NULL a #GBytes 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. Note that @data must remain valid for as long as the returned document exists. Prefer using poppler_document_new_from_bytes(). A newly created #PopplerDocument, or %NULL the pdf data 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 Creates a new #PopplerDocument reading the PDF contents from @file. Possible errors include those in the #POPPLER_ERROR and #G_FILE_ERROR domains. a new #PopplerDocument, or %NULL a #GFile to load password to unlock the file with, or %NULL a #GCancellable, or %NULL Creates a new #PopplerDocument reading the PDF contents from @stream. Note that the given #GInputStream must be seekable or %G_IO_ERROR_NOT_SUPPORTED will be returned. Possible errors include those in the #POPPLER_ERROR, #G_FILE_ERROR and #G_IO_ERROR domains. a new #PopplerDocument, or %NULL a #GInputStream to read from the stream length, or -1 if not known password to unlock the file with, or %NULL a #GCancellable, or %NULL Creates named destinations balanced binary tree in @document The tree key is strings in the form returned by poppler_named_dest_bytestring() which constains a destination name. The tree value is the #PopplerDest* which contains a named destination. The return value must be freed with #g_tree_destroy. the #GTree, or %NULL A #PopplerDocument Creates a #PopplerDest for the named destination @link_name in @document. Note that named destinations are bytestrings, not string. That means that unless @link_name was returned by a poppler function (e.g. is #PopplerDest.named_dest), it needs to be converted to string using poppler_named_dest_from_bytestring() before being passed to this function. The returned value must be freed with poppler_dest_free(). a new #PopplerDest destination, or %NULL if @link_name is not a destination. A #PopplerDocument 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. A #PopplerDocument Returns the author of the document a new allocated string containing the author of @document, or %NULL A #PopplerDocument Returns the date the document was created as seconds since the Epoch the date the document was created, or -1 A #PopplerDocument 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. a new allocated string containing the creator of @document, or %NULL A #PopplerDocument Returns the #PopplerFormField for the given @id. It must be freed with g_object_unref() a new #PopplerFormField or %NULL if not found a #PopplerDocument 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 A #PopplerDocument 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 a new allocated string containing keywords associated to @document, or %NULL A #PopplerDocument Returns the XML metadata string of the document a new allocated string containing the XML metadata, or %NULL A #PopplerDocument Returns the date the document was most recently modified as seconds since the Epoch the date the document was most recently modified, or -1 A #PopplerDocument Returns the number of attachments in a loaded document. See also poppler_document_get_attachments() Number of attachments A #PopplerDocument Returns the number of pages in a loaded document. Number of pages A #PopplerDocument Returns the #PopplerPage indexed at @index. This object is owned by the caller. The #PopplerPage at @index A #PopplerDocument 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 #PopplerDocument 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 A #PopplerDocument Returns a #PopplerPageMode representing how the document should be initially displayed when opened. a #PopplerPageMode that should be used when document is opened A #PopplerDocument Returns the conformance level of the @document as #PopplerPDFConformance. the document's subtype conformance level A #PopplerDocument Returns the part of the conforming standard that the @document adheres to as a #PopplerPDFSubtype. the document's subtype part A #PopplerDocument Returns the subtype of @document as a #PopplerPDFSubtype. the document's subtype A #PopplerDocument Returns the PDF subtype version of @document as a string. a newly allocated string containing the PDF subtype version of @document, or %NULL A #PopplerDocument A #PopplerDocument 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) a new allocated string containing the PDF version of @document, or %NULL A #PopplerDocument Returns the flags specifying which operations are permitted when the document is opened. a set of flags from #PopplerPermissions enumeration A #PopplerDocument Returns the duplex mode value suggested for printing by author of the document. Value POPPLER_PRINT_DUPLEX_NONE means that the document does not specify this preference. a #PopplerPrintDuplex that should be used when document is printed A #PopplerDocument Returns the suggested number of copies to be printed. This preference should be applied only if returned value is greater than 1 since value 1 usually means that the document does not specify it. Number of copies A #PopplerDocument Returns the suggested page ranges to print in the form of array of #PopplerPageRanges and number of ranges. NULL pointer means that the document does not specify page ranges for printing. an array of #PopplerPageRanges or NULL. Free the array when it is no longer needed. A #PopplerDocument return location for number of ranges Returns the print scaling value suggested by author of the document. a #PopplerPrintScaling that should be used when document is printed A #PopplerDocument 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 a new allocated string containing the producer of @document, or %NULL A #PopplerDocument Returns the subject of the document a new allocated string containing the subject of @document, or %NULL A #PopplerDocument Returns the document's title a new allocated string containing the title of @document, or %NULL A #PopplerDocument Returns %TRUE of @document has any attachments. %TRUE, if @document has attachments. A #PopplerDocument 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 otherwise A #PopplerDocument 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 a #PopplerDocument 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 a #PopplerDocument uri of file to save Sets the document's author. If @author is %NULL, Author entry is removed from the document's Info dictionary. A #PopplerDocument A new author Sets the document's creation date. If @creation_date is -1, CreationDate entry is removed from the document's Info dictionary. A #PopplerDocument A new creation date Sets the document's creator. If @creator is %NULL, Creator entry is removed from the document's Info dictionary. A #PopplerDocument A new creator Sets the document's keywords. If @keywords is %NULL, Keywords entry is removed from the document's Info dictionary. A #PopplerDocument New keywords Sets the document's modification date. If @modification_date is -1, ModDate entry is removed from the document's Info dictionary. A #PopplerDocument A new modification date Sets the document's producer. If @producer is %NULL, Producer entry is removed from the document's Info dictionary. A #PopplerDocument A new producer Sets the document's subject. If @subject is %NULL, Subject entry is removed from the document's Info dictionary. A #PopplerDocument A new subject Sets the document's title. If @title is %NULL, Title entry is removed from the document's Info dictionary. A #PopplerDocument A new title 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 Suggested number of copies to be printed for this document The producer of the document. See also poppler_document_get_producer() The subject of the document Document PDF subtype type Document PDF subtype conformance Document PDF subtype part Document PDF subtype. See also poppler_document_get_pdf_subtype_string() The document's title or %NULL Error codes returned by #PopplerDocument Generic error when a document operation fails Document is encrypted File could not be opened for writing when saving document Failed to read the document catalog Document is damaged Flags using while searching text in a page use default search settings do case sensitive search search backwards search only whole words do diacritics insensitive search, i.e. ignore accents, umlauts, diaeresis,etc. while matching. This option will be ignored if the search term is not pure ascii. Since 0.73. 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 a #PopplerFontInfo number of pages to scan return location for a #PopplerFontsIter Font types unknown font type Type 1 font type Type 1 font type embedded in Compact Font Format (CFF) font program Type 1 font type embedded in OpenType font program A font type that is defined with PDF graphics operators TrueType font type TrueType font type embedded in OpenType font program CIDFont type based on Type 1 font technology CIDFont type based on Type 1 font technology embedded in CFF font program CIDFont type based on Type 1 font technology embedded in OpenType font program CIDFont type based on TrueType font technology CIDFont type based on TrueType font technology embedded in OpenType font program Creates a copy of @iter a new allocated copy of @iter a #PopplerFontsIter to copy Frees the given #PopplerFontsIter a #PopplerFontsIter Returns the encoding of the font associated with @iter the font encoding a #PopplerFontsIter 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 a #PopplerFontsIter Returns the type of the font associated with @iter the font type a #PopplerFontsIter Returns the full name of the font associated with @iter the font full name a #PopplerFontsIter Returns the name of the font associated with @iter the font name a #PopplerFontsIter 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 a #PopplerFontsIter Returns whether the font associated with @iter is embedded in the document %TRUE if font is embedded, %FALSE otherwise a #PopplerFontsIter Returns whether the font associated with @iter is a subset of another font %TRUE if font is a subset, %FALSE otherwise a #PopplerFontsIter Sets @iter to point to the next font %TRUE, if @iter was set to the next font a #PopplerFontsIter Gets the button type of @field #PopplerFormButtonType of @field a #PopplerFormField 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 a #PopplerFormField Sets the status of @field. Set to %TRUE if you want the #PopplerFormField to be 'pressed in', and %FALSE to raise it. a #PopplerFormField %TRUE or %FALSE Checks whether @field allows multiple choices to be selected %TRUE if @field allows multiple choices to be selected a #PopplerFormField Checks whether spell checking should be done for the contents of @field %TRUE if spell checking should be done for @field a #PopplerFormField Gets the choice type of @field #PopplerFormChoiceType of @field a #PopplerFormField 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. a #PopplerFormField the index of the item Returns the number of items on @field the number of items on @field a #PopplerFormField Retrieves the contents of @field. a new allocated string. It must be freed with g_free() when done. a #PopplerFormField Checks whether @field is editable %TRUE if @field is editable a #PopplerFormField Checks whether the item at the given index on @field is currently selected %TRUE if item at @index is currently selected a #PopplerFormField the index of the item Selects the item at the given index on @field a #PopplerFormField the index of the item Sets the text in @field to the given value, replacing the current contents a #PopplerFormField the new text Changes the state of the item at the given index a #PopplerFormField the index of the item Unselects all the items on @field a #PopplerFormField Retrieves the action (#PopplerAction) that shall be performed when @field is activated, or %NULL the action to perform. The returned object is owned by @field and should not be freed a #PopplerFormField Retrieves the action (#PopplerAction) that shall be performed when an additional action is triggered on @field, or %NULL. the action to perform. The returned object is owned by @field and should not be freed. a #PopplerFormField the type of additional action Gets the type of @field #PopplerFormFieldType of @field a #PopplerFormField Gets the font size of @field WARNING: This function always returns 0. Contact the poppler mailing list if you're interested in implementing it properly the font size of @field a #PopplerFormField Gets the id of @field the id of @field a #PopplerFormField 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. a #PopplerFormField 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. a #PopplerFormField Gets the partial name of @field. a new allocated string. It must be freed with g_free() when done. a #PopplerFormField Checks whether @field is read only %TRUE if @field is read only a #PopplerFormField Checks whether spell checking should be done for the contents of @field %TRUE if spell checking should be done for @field a #PopplerFormField 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. a #PopplerFormField Retrieves the contents of @field. a new allocated string. It must be freed with g_free() when done. a #PopplerFormField Gets the text type of @field. #PopplerFormTextType of @field a #PopplerFormField Checks whether content of @field is a password and it must be hidden %TRUE if the content of @field is a password a #PopplerFormField Checks whether the contents of @field are rich text %TRUE if the contents of @field are rich text a #PopplerFormField Sets the text in @field to the given value, replacing the current contents. a #PopplerFormField the new text A #PopplerFormFieldMapping structure represents the location of @field on the page a #PopplerRectangle representing an area of the page a #PopplerFormField 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 a #PopplerFormFieldMapping to copy Frees the given #PopplerFormFieldMapping a #PopplerFormFieldMapping Defined if poppler was compiled with cairo support. A #PopplerImageMapping structure represents the location of an image on the page a #PopplerRectangle representing an area of the page an image identifier 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 a #PopplerImageMapping to copy Frees the given #PopplerImageMapping a #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 &mdash; 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 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 a #PopplerIndexIter Frees @iter. a #PopplerIndexIter Returns the #PopplerAction associated with @iter. It must be freed with poppler_action_free(). a new #PopplerAction a #PopplerIndexIter Returns a newly created child of @parent, or %NULL if the iter has no child. See poppler_index_iter_new() for more information on this function. a new #PopplerIndexIter a #PopplerIndexIter Returns whether this node should be expanded by default to the user. The document can provide a hint as to how the document's index should be expanded initially. %TRUE, if the document wants @iter to be expanded a #PopplerIndexIter 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 a #PopplerIndexIter Returns the numeric ID the radio button group associated with @layer. the ID of the radio button group associated with @layer, or 0 if the layer is not associated to any radio button group a #PopplerLayer 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 a #PopplerLayer 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 a #PopplerLayer Returns whether @layer is parent of other nested layers. %TRUE if @layer is a parent layer a #PopplerLayer Returns whether @layer is visible %TRUE if @layer is visible a #PopplerLayer Shows @layer a #PopplerLayer a #PopplerDocument Creates a new #PopplerLayersIter as a copy of @iter. This must be freed with poppler_layers_iter_free(). a new #PopplerLayersIter Since 0.12 a #PopplerLayersIter Frees @iter. a #PopplerLayersIter 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 a #PopplerLayersIter Returns the #PopplerLayer associated with @iter. a new #PopplerLayer, or %NULL if there isn't any layer associated with @iter a #PopplerLayersIter Returns the title associated with @iter. It must be freed with g_free(). 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. a #PopplerLayersIter 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 #PopplerLayersIter A #PopplerLinkMapping structure represents the location of @action on the page a #PopplerRectangle representing an area of the page a #PopplerAction 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 a #PopplerLinkMapping to copy Frees the given #PopplerLinkMapping a #PopplerLinkMapping The major version number of the poppler header files (e.g. in poppler version 0.1.2 this is 0.) The micro version number of the poppler header files (e.g. in poppler version 0.1.2 this is 2.) The major version number of the poppler header files (e.g. in poppler version 0.1.2 this is 1.) Returns the media clip filename, in case of non-embedded media. filename might be a local relative or absolute path or a URI a filename, return value is owned by #PopplerMedia and should not be freed a #PopplerMedia Returns the media clip mime-type the mime-type, return value is owned by #PopplerMedia and should not be freed a #PopplerMedia 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 a #PopplerMedia 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 a #PopplerMedia 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 #PopplerMedia 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 the duration of the movie playback the duration of the movie playback (in ns) a #PopplerMovie Returns the local filename identifying a self-describing movie file a local filename, return value is owned by #PopplerMovie and should not be freed a #PopplerMovie Returns the play mode of @poppler_movie. a #PopplerMoviePlayMode. a #PopplerMovie Returns the relative speed of the movie the relative speed of the movie (1 means no change) a #PopplerMovie Returns the rotation angle the number of degrees the movie should be rotated (positive, multiples of 90: 0, 90, 180, 270) a #PopplerMovie Returns the start position of the movie playback the start position of the movie playback (in ns) a #PopplerMovie Returns the playback audio volume volume setting for the movie (0.0 - 1.0) a #PopplerMovie Returns whether the user must wait for the movie to be finished before the PDF viewer accepts any interactive action %TRUE if yes, %FALSE otherwise a #PopplerMovie 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 a #PopplerMovie Returns whether to display a movie controller bar while playing the movie %TRUE if controller bar should be displayed, %FALSE otherwise a #PopplerMovie Play mode enum values. the movie should be played once and controls should be closed at the end. the movie should be played once, but controls should be left open. the movie should be played in loop, until manually stopped. the movie should be played forward and backward, forward and backward, and so forth, until manually stopped. PDF Subtype Conformance Null Level A (accessible) conformance (PDF/A) Level B (basic) conformance (PDF/A) Level G (external graphical content) (PDF/X) Level N (external ICC Profile) (PDF/X) Level P (ICC Profile) (PDF/X) Level PG (conjunction of P and G) (PDF/X) Level U (Unicode) conformance (PDF/A) No conformance level available PDF Subtype Part Null 1 2 3 4 5 6 7 8 No part available PDF Subtype Null ISO 19005 - Document management -- Electronic document file format for long-term preservation (PDF/A) ISO 24517 - Document management -- Engineering document format using PDF (PDF/E) ISO 14289 - Document management applications -- Electronic document file format enhancement for accessibility (PDF/UA) ISO 16612 - Graphic technology -- Variable data exchange (PDF/VT) ISO 15930 - Graphic technology -- Prepress digital data exchange (PDF/X) Not compliant with the above standards 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 a PopplerPSFile Enable or disable Duplex printing. a PopplerPSFile which was not yet printed to 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. a PopplerPSFile which was not yet printed to. 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 #PopplerPage a #PopplerAnnot to add Finds @text in @page with the default options (%POPPLER_FIND_DEFAULT) and returns a #GList of rectangles for each occurrence of the text on the page. The coordinates are in PDF points. a #GList of #PopplerRectangle, a #PopplerPage the text to search for (UTF-8 encoded) Finds @text in @page with the given #PopplerFindFlags options and returns a #GList of rectangles for each occurrence of the text on the page. The coordinates are in PDF points. a #GList of #PopplerRectangle, a #PopplerPage the text to search for (UTF-8 encoded) find options 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 A #PopplerPage Retrurns the crop box of @page a #PopplerPage a #PopplerRectangle to fill Returns the duration of @page duration in seconds of @page or -1. a #PopplerPage 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 A #PopplerPage Returns a cairo surface for the image of the @page A cairo surface for the image A #PopplerPage 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 A #PopplerPage Returns the index of @page index value of @page a #PopplerPage Returns the label of @page. Note that page labels and page indices might not coincide. a new allocated string containing the label of @page, or %NULL if @page doesn't have a label a #PopplerPage 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 A #PopplerPage 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 a #PopplerPage 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. a pointer to the contents of the @selection as a string a #PopplerPage 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(). Use poppler_page_get_selected_region() instead. a #GList of #PopplerRectangle a #PopplerPage 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. A #PopplerPage return location for the width of @page return location for the height of @page Retrieves the text of @page. a pointer to the text of the @page as a string a #PopplerPage 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() A #GList of #PopplerTextAttributes A #PopplerPage 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. A #GList of #PopplerTextAttributes A #PopplerPage a #PopplerRectangle Retrieves the text of @page contained in @area. a pointer to the text as a string a #PopplerPage a #PopplerRectangle 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() See also poppler_page_get_text_layout_for_area(). %TRUE if the page contains text, %FALSE otherwise A #PopplerPage return location for an array of #PopplerRectangle length of returned array 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() %TRUE if the page contains text, %FALSE otherwise A #PopplerPage a #PopplerRectangle return location for an array of #PopplerRectangle 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. the tumbnail as a cairo_surface_t or %NULL if the document doesn't have a thumbnail for this page. the #PopplerPage to get the thumbnail for 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. A #PopplerPage return location for width return location for height Returns the transition effect of @page a #PopplerPageTransition or %NULL. a #PopplerPage Removes annotation @annot from @page a #PopplerPage a #PopplerAnnot to remove 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. Please see the documentation for that function for the differences between rendering to the screen and rendering to a printer. the page to render from cairo context to render to Render the page to the given cairo context for printing with #POPPLER_PRINT_ALL flags selected. If you want a different set of flags, use poppler_page_render_for_printing_with_options(). The difference between poppler_page_render() and this function is that some things get rendered differently between screens and printers: <itemizedlist> <listitem> PDF annotations get rendered according to their #PopplerAnnotFlag value. For example, #POPPLER_ANNOT_FLAG_PRINT refers to whether an annotation is printed or not, whereas #POPPLER_ANNOT_FLAG_NO_VIEW refers to whether an annotation is invisible when displaying to the screen. </listitem> <listitem> PDF supports "hairlines" of width 0.0, which often get rendered as having a width of 1 device pixel. When displaying on a screen, Cairo may render such lines wide so that they are hard to see, and Poppler makes use of PDF's Stroke Adjust graphics parameter to make the lines easier to see. However, when printing, Poppler is able to directly use a printer's pixel size instead. </listitem> <listitem> Some advanced features in PDF may require an image to be rasterized before sending off to a printer. This may produce raster images which exceed Cairo's limits. The "printing" functions will detect this condition and try to down-scale the intermediate surfaces as appropriate. </listitem> </itemizedlist> the page to render from cairo context to render to Render the page to the given cairo context for printing with the specified options See the documentation for poppler_page_render_for_printing() for the differences between rendering to the screen and rendering to a printer. the page to render from 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. the #PopplerPage for which to render 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 a #PopplerPage the PopplerPSFile to render to The label of the page or %NULL. See also poppler_page_get_label() Page layout types no specific layout set one page at a time pages in one column pages in two columns with odd numbered pages on the left pages in two columns with odd numbered pages on the right two pages at a time with odd numbered pages on the left two pages at a time with odd numbered pages on the right Page modes no specific mode set neither document outline nor thumbnails visible document outline visible thumbnails visible full-screen mode layers panel visible attachments panel visible A #PopplerPageRange is used to specify a range of pages. first page in the range of pages last page in the range of pages A #PopplerPageTransition structures describes a visual transition to use when moving between pages during a presentation the type of transtition the dimension in which the transition effect shall occur. Only for #POPPLER_PAGE_TRANSITION_SPLIT and #POPPLER_PAGE_TRANSITION_BLINDS transition types the direction of motion for the transition effect. Only for #POPPLER_PAGE_TRANSITION_SPLIT, #POPPLER_PAGE_TRANSITION_BOX and #POPPLER_PAGE_TRANSITION_FLY transition types the duration of the transition effect 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 the starting or ending scale at which the changes shall be drawn. Only for #POPPLER_PAGE_TRANSITION_FLY transition type whether the area that will be flown is rectangular and opaque. Only for #POPPLER_PAGE_TRANSITION_FLY transition type 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 a #PopplerPageTransition to copy Frees the given #PopplerPageTransition a #PopplerPageTransition Page transition alignment types for #POPPLER_PAGE_TRANSITION_SPLIT and #POPPLER_PAGE_TRANSITION_BLINDS transition types horizontal dimension vertical dimension Page transition direction types for #POPPLER_PAGE_TRANSITION_SPLIT, #POPPLER_PAGE_TRANSITION_BOX and #POPPLER_PAGE_TRANSITION_FLY transition types inward from the edges of the page outward from the center of the page Page transition types the new page replace the old one two lines sweep across the screen, revealing the new page multiple lines, evenly spaced across the screen, synchronously sweep in the same direction to reveal the new page a rectangular box sweeps inward from the edges of the page or outward from the center revealing the new page a single line sweeps across the screen from one edge to the other revealing the new page the old page dissolves gradually to reveal the new one 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 changes are flown out or in to or from a location that is offscreen the old page slides off the screen while the new page slides in the new page slides on to the screen covering the old page the old page slides off the screen uncovering the new page the new page gradually becomes visible through the old one Permissions document can be printer document contents can be modified document can be copied annotations can added to the document interactive form fields can be filled in extract text and graphics (in support of accessibility to users with disabilities or for other purposes). Since 0.18 assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images). Since 0.18 document can be printer at high resolution. Since 0.18 document permits all operations A #PopplerPoint is used to describe a location point on a page x coordinate y coordinate Creates a new #PopplerPoint. It must be freed with poppler_point_free() after use. a new #PopplerPoint Creates a copy of @point. The copy must be freed with poppler_point_free() after use. a new allocated copy of @point a #PopplerPoint to copy Frees the memory used by @point a #PopplerPoint Duplex viewer preference No preference on duplex printing Print single-sided Duplex and flip on the short edge of the sheet Duplex and flip on the long edge of the sheet Printing flags print main document contents print document and markup annotations print document and only stamp annotations print main document contents and all markup annotations PrintScaling viewer preference application's default page scaling no page scaling A #PopplerQuadrilateral is used to describe rectangle-like polygon with arbitrary inclination on a page. Since: 0.26 a #PopplerPoint with the first vertex coordinates a #PopplerPoint with the second vertex coordinates a #PopplerPoint with the third vertex coordinates a #PopplerPoint with the fourth vertex coordinates Creates a new #PopplerQuadrilateral. It must be freed with poppler_quadrilateral_free() after use. a new #PopplerQuadrilateral. Creates a copy of @quad. The copy must be freed with poppler_quadrilateral_free() after use. a new allocated copy of @quad a #PopplerQuadrilateral to copy Frees the memory used by @quad a #PopplerQuadrilateral A #PopplerRectangle is used to describe locations on a page and bounding boxes x coordinate of lower left corner y coordinate of lower left corner x coordinate of upper right corner y coordinate of upper right corner 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 a #PopplerRectangle to copy Frees the given #PopplerRectangle a #PopplerRectangle Selection styles glyph is the minimum unit for selection word is the minimum unit for selection line is the minimum unit for selection Acronyms and abbreviations contained in elements of type #POPPLER_STRUCTURE_ELEMENT_SPAN may have an associated expanded text form, which can be retrieved using this function. Text of the expanded abbreviation if the element text is an abbreviation or acrony, %NULL if not. A #PopplerStructureElement 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 <emphasis>do</emphasis> 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. The actual text for the element, or %NULL if not defined. A #PopplerStructureElement 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. The alternate text representation for the element, or %NULL if not defined. A #PopplerStructureElement Obtains the background color of the element. If this attribute is not specified, the element shall be treated as if it were transparent. %TRUE if a color is defined for the element, %FALSE otherwise. A #PopplerStructureElement A #PopplerColor. Obtains how much the text contained in the inline-level structure element should be shifted, measuring from the baseline of the glyphs. A numeric value. A #PopplerStructureElement Obtains the block-alignment mode of the block-level structure element. A #PopplerStructureBlockAlign value. A #PopplerStructureElement 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. %TRUE if a color is defined for the element, %FALSE otherwise. A #PopplerStructureElement An array of four #PopplerColor. 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. A #PopplerStructureElement An array of four #PopplerStructureBorderStyle elements. 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. %TRUE if the border thickness attribute is defined for the element, %FALSE otherwise. A #PopplerStructureElement Array with the four values of border thicknesses. Obtains the size of the bounding box of a block-level structure element. %TRUE if a bounding box is defined for the element, %FALSE otherwise. A #PopplerStructureElement A #PopplerRectangle. 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. %TRUE if a color is defined for the element, %FALSE otherwise. A #PopplerStructureElement A #PopplerColor. Obtains the number of columns used to lay out the content contained in the grouping element. Number of columns. A #PopplerStructureElement 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. Array containing the values for the column gaps, or %NULL if the array is empty or the attribute is not defined. A #PopplerStructureElement Size of the returned array. 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. Array containing widths of the columns, or %NULL if the attribute is not defined. A #PopplerStructureElement Size of the returned array. Obtains the amount of indentation at the end of the block-level structure element. A numeric value. A #PopplerStructureElement 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. A string, or %NULL if the attribute is not defined. A #PopplerStructureElement 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. A #PopplerStructureFormRole value. A #PopplerStructureElement For a structure element that is a form field, obtains in which state the associated control is expected to be rendered. A #PopplerStructureFormState value. A #PopplerStructureElement Obtains the glyph orientation for the text contained in a inline-level structure element. A #PopplerStructureGlyphOrientation value. A #PopplerStructureElement 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. A positive value if a width is defined, or -1 if the height is to be calculated automatically. A #PopplerStructureElement Obtains the identifier of an element. The identifier of the element (if defined), or %NULL. A #PopplerStructureElement Obtains the inline-alignment mode of the block-level structure element. A #PopplerStructureInlineAlign value. A #PopplerStructureElement A #PopplerStructureElementKind value. A #PopplerStructureElement 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. language and country code, or %NULL. A #PopplerStructureElement 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. A positive value if a line height is defined, or -1 if the height is to be calculated automatically. A #PopplerStructureElement Obtains the list numbering style for list items. A #PopplerStructureListNumbering value. A #PopplerStructureElement 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. A #PopplerStructureElement Padding for the four sides of the element. Obtains the page number in which the element is contained. Number of the page that contains the element, of <code>-1</code> if not defined. A #PopplerStructureElement Obtains the placement type of the structure element. A #PopplerStructurePlacement value. A #PopplerStructureElement Obtains the alignment for the ruby text contained in a inline-level structure element. A #PopplerStructureRubyAlign value. A #PopplerStructureElement Obtains the position for the ruby text contained in a inline-level structure element. A #PopplerStructureRubyPosition value. A #PopplerStructureElement Obtains the amount of empty space after the block-level structure element. A positive value. A #PopplerStructureElement Obtains the amount of empty space before the block-level structure element. A positive value. A #PopplerStructureElement Obtains the amount of indentation at the beginning of the block-level structure element. A numeric value. A #PopplerStructureElement 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. A #PopplerStructureElement An array of four #PopplerStructureBorderStyle elements. Obtains the number of columns the table element spans to. A positive, non-zero value. A #PopplerStructureElement 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(). Zero-terminated array of strings with the table header names, or %NULL if the attribute is not defined. A #PopplerStructureElement 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). A #PopplerStructureElement Padding for the four sides of the element. Obtains the number of rows the table element spans to. A positive, non-zero value. A #PopplerStructureElement Obtains the scope of a table structure element. A #PopplerStructureTableScope value. A #PopplerStructureElement 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. A string, or %NULL if the attribute is not defined. A #PopplerStructureElement Obtains the text enclosed by an element, or the text enclosed by the elements in the subtree (including the element itself). A string. A #PopplerStructureElement A #PopplerStructureGetTextFlags value, or %POPPLER_STRUCTURE_GET_TEXT_NONE to disable all the flags. Obtains the text alignment mode of the text contained into a block-level structure element. A #PopplerStructureTextAlign value. A #PopplerStructureElement 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. %TRUE if a color is defined for the element, %FALSE otherwise. A #PopplerStructureElement A #PopplerColor. 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. Thickness of the text decoration, or NAN if not defined. A #PopplerStructureElement Obtains the text decoration type of the text contained in the inline-level structure element. A #PopplerStructureTextDecoration value. A #PopplerStructureElement Obtains the amount of indentation of the text contained in the block-level structure element. A numeric value. A #PopplerStructureElement 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> An array of #PopplerTextSpan elements. A #PopplerStructureElement A pointer to the location where the number of elements in the returned array will be stored. Obtains the title of an element. The title of the element, or %NULL. A #PopplerStructureElement 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. A positive value if a width is defined, or -1 if the width is to be calculated automatically. A #PopplerStructureElement Obtains the writing mode (writing direction) of the content associated with a structure element. A #PopplerStructureWritingMode value. A #PopplerStructureElement Checks whether an element is a block element. %TRUE if the element is a block element, or %FALSE otherwise. A #PopplerStructureElement Checks whether an element is actual document content. %TRUE if the element is content, or %FALSE otherwise. A #PopplerStructureElement Checks whether an element is a grouping element. %TRUE if the element is a grouping element, %FALSE otherwise. A #PopplerStructureElement Checks whether an element is an inline element. %TRUE if the element is an inline element, or %FALSE otherwise. A #PopplerStructureElement 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> a new #PopplerStructureElementIter, or %NULL if document doesn't have structure tree. a #PopplerDocument. Creates a new #PopplerStructureElementIter as a copy of @iter. The returned value must be freed with poppler_structure_element_iter_free(). a new #PopplerStructureElementIter a #PopplerStructureElementIter Frees @iter. a #PopplerStructureElementIter 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(). a new #PopplerStructureElementIter a #PopplerStructureElementIter Returns the #PopplerStructureElementIter associated with @iter. a new #PopplerStructureElementIter a #PopplerStructureElementIter 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. %TRUE, if @iter was set to the next structure element a #PopplerStructureElementIter No flags. For non-leaf, non-content elements, recursively obtain the text from all the elements enclosed in the subtree. A #PopplerTextAttributes is used to describe text attributes of a range of text font name font size if text is underlined a #PopplerColor, the foreground color start position this text attributes apply end position this text attributes apply 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 a #PopplerTextAttributes to copy Frees the given #PopplerTextAttributes a #PopplerTextAttributes Makes a copy of a text span. A new #PopplerTextSpan a #PopplerTextSpan Frees a text span. A #PopplerTextSpan Obtains the color in which the text is to be rendered. a #PopplerTextSpan a return location for a #PopplerColor Obtains the name of the font in which the span is to be rendered. A string containing the font name, or %NULL if a font is not defined. a #PopplerTextSpan Obtains the text contained in the span. A string. a #PopplerTextSpan Check whether a text span is meant to be rendered using a bold font. Whether the span uses bold font. a #PopplerTextSpan Check wether a text span is meant to be rendered using a fixed-width font. Whether the span uses a fixed-width font. a #PopplerTextSpan Check whether a text span is meant to be rendered using a serif font. Whether the span uses a serif font. a #PopplerTextSpan Viewer preferences no preferences set hider toolbars when document is active hide menu bar when document is active hide UI elements in document's window resize document's window to fit the size of the first displayed page position the document's window in the center of the screen display document title in window's title bar the predominant reading order for text is right to left 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. Converts a bytestring into a zero-terminated string suitable to pass to poppler_document_find_dest(). Note that the returned string has no defined encoding and is not suitable for display to the user. The returned data must be freed using g_free(). the named dest the bytestring data the bytestring length Converts a named dest string (e.g. from #PopplerDest.named_dest) into a bytestring, inverting the transformation of poppler_named_dest_from_bytestring(). Note that the returned data is not zero terminated and may also contains embedded NUL bytes. If @name is not a valid named dest string, returns %NULL. The returned data must be freed using g_free(). a new bytestring, or %NULL a location to store the length of the returned bytestring