Spaces:
Running
Running
<html> | |
<head> | |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
<title>PopplerPage: Poppler Reference Manual</title> | |
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> | |
<link rel="home" href="index.html" title="Poppler Reference Manual"> | |
<link rel="up" href="ch01.html" title="Poppler"> | |
<link rel="prev" href="PopplerDocument.html" title="PopplerDocument"> | |
<link rel="next" href="PopplerAction.html" title="PopplerAction"> | |
<meta name="generator" content="GTK-Doc V1.34.0 (XML mode)"> | |
<link rel="stylesheet" href="style.css" type="text/css"> | |
</head> | |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> | |
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> | |
<td width="100%" align="left" class="shortcuts"> | |
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> | |
<a href="#poppler-Poppler-Page.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> | |
<a href="#poppler-Poppler-Page.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> | |
<a href="#poppler-Poppler-Page.properties" class="shortcut">Properties</a></span> | |
</td> | |
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> | |
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> | |
<td><a accesskey="p" href="PopplerDocument.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> | |
<td><a accesskey="n" href="PopplerAction.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> | |
</tr></table> | |
<div class="refentry"> | |
<a name="poppler-Poppler-Page"></a><div class="titlepage"></div> | |
<div class="refnamediv"><table width="100%"><tr> | |
<td valign="top"> | |
<h2><span class="refentrytitle"><a name="poppler-Poppler-Page.top_of_page"></a>PopplerPage</span></h2> | |
<p>PopplerPage — Information about a page in a document</p> | |
</td> | |
<td class="gallery_image" valign="top" align="right"></td> | |
</tr></table></div> | |
<div class="refsect1"> | |
<a name="poppler-Poppler-Page.functions"></a><h2>Functions</h2> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="functions_proto_type"> | |
<col class="functions_proto_name"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="function_type"> | |
<a class="link" href="poppler-Poppler-Page.html#PopplerAnnotMapping"><span class="returnvalue">PopplerAnnotMapping</span></a> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-annot-mapping-copy" title="poppler_annot_mapping_copy ()">poppler_annot_mapping_copy</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-annot-mapping-free" title="poppler_annot_mapping_free ()">poppler_annot_mapping_free</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<a class="link" href="poppler-Poppler-Page.html#PopplerAnnotMapping"><span class="returnvalue">PopplerAnnotMapping</span></a> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-annot-mapping-new" title="poppler_annot_mapping_new ()">poppler_annot_mapping_new</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<a class="link" href="poppler-Poppler-Page.html#PopplerFormFieldMapping"><span class="returnvalue">PopplerFormFieldMapping</span></a> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-form-field-mapping-copy" title="poppler_form_field_mapping_copy ()">poppler_form_field_mapping_copy</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-form-field-mapping-free" title="poppler_form_field_mapping_free ()">poppler_form_field_mapping_free</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<a class="link" href="poppler-Poppler-Page.html#PopplerFormFieldMapping"><span class="returnvalue">PopplerFormFieldMapping</span></a> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-form-field-mapping-new" title="poppler_form_field_mapping_new ()">poppler_form_field_mapping_new</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<a class="link" href="poppler-Poppler-Page.html#PopplerImageMapping"><span class="returnvalue">PopplerImageMapping</span></a> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-image-mapping-copy" title="poppler_image_mapping_copy ()">poppler_image_mapping_copy</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-image-mapping-free" title="poppler_image_mapping_free ()">poppler_image_mapping_free</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<a class="link" href="poppler-Poppler-Page.html#PopplerImageMapping"><span class="returnvalue">PopplerImageMapping</span></a> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-image-mapping-new" title="poppler_image_mapping_new ()">poppler_image_mapping_new</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<a class="link" href="poppler-Poppler-Page.html#PopplerLinkMapping"><span class="returnvalue">PopplerLinkMapping</span></a> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-link-mapping-copy" title="poppler_link_mapping_copy ()">poppler_link_mapping_copy</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-link-mapping-free" title="poppler_link_mapping_free ()">poppler_link_mapping_free</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<a class="link" href="poppler-Poppler-Page.html#PopplerLinkMapping"><span class="returnvalue">PopplerLinkMapping</span></a> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-link-mapping-new" title="poppler_link_mapping_new ()">poppler_link_mapping_new</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-add-annot" title="poppler_page_add_annot ()">poppler_page_add_annot</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">GList</span> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-find-text" title="poppler_page_find_text ()">poppler_page_find_text</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">GList</span> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-find-text-with-options" title="poppler_page_find_text_with_options ()">poppler_page_find_text_with_options</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-free-annot-mapping" title="poppler_page_free_annot_mapping ()">poppler_page_free_annot_mapping</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-free-form-field-mapping" title="poppler_page_free_form_field_mapping ()">poppler_page_free_form_field_mapping</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-free-image-mapping" title="poppler_page_free_image_mapping ()">poppler_page_free_image_mapping</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-free-link-mapping" title="poppler_page_free_link_mapping ()">poppler_page_free_link_mapping</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-free-text-attributes" title="poppler_page_free_text_attributes ()">poppler_page_free_text_attributes</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">GList</span> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-annot-mapping" title="poppler_page_get_annot_mapping ()">poppler_page_get_annot_mapping</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">gboolean</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-bounding-box" title="poppler_page_get_bounding_box ()">poppler_page_get_bounding_box</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-crop-box" title="poppler_page_get_crop_box ()">poppler_page_get_crop_box</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">double</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-duration" title="poppler_page_get_duration ()">poppler_page_get_duration</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">GList</span> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-form-field-mapping" title="poppler_page_get_form_field_mapping ()">poppler_page_get_form_field_mapping</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">cairo_surface_t</span> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-image" title="poppler_page_get_image ()">poppler_page_get_image</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">GList</span> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-image-mapping" title="poppler_page_get_image_mapping ()">poppler_page_get_image_mapping</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">int</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-index" title="poppler_page_get_index ()">poppler_page_get_index</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">gchar</span> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-label" title="poppler_page_get_label ()">poppler_page_get_label</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">GList</span> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-link-mapping" title="poppler_page_get_link_mapping ()">poppler_page_get_link_mapping</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">cairo_region_t</span> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-selected-region" title="poppler_page_get_selected_region ()">poppler_page_get_selected_region</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">char</span> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-selected-text" title="poppler_page_get_selected_text ()">poppler_page_get_selected_text</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">GList</span> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-selection-region" title="poppler_page_get_selection_region ()">poppler_page_get_selection_region</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-size" title="poppler_page_get_size ()">poppler_page_get_size</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">char</span> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-text" title="poppler_page_get_text ()">poppler_page_get_text</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">GList</span> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-text-attributes" title="poppler_page_get_text_attributes ()">poppler_page_get_text_attributes</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">GList</span> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-text-attributes-for-area" title="poppler_page_get_text_attributes_for_area ()">poppler_page_get_text_attributes_for_area</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">char</span> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-text-for-area" title="poppler_page_get_text_for_area ()">poppler_page_get_text_for_area</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">gboolean</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-text-layout" title="poppler_page_get_text_layout ()">poppler_page_get_text_layout</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">gboolean</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-text-layout-for-area" title="poppler_page_get_text_layout_for_area ()">poppler_page_get_text_layout_for_area</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">cairo_surface_t</span> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-thumbnail" title="poppler_page_get_thumbnail ()">poppler_page_get_thumbnail</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">gboolean</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-thumbnail-size" title="poppler_page_get_thumbnail_size ()">poppler_page_get_thumbnail_size</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<a class="link" href="poppler-Poppler-Page.html#PopplerPageTransition"><span class="returnvalue">PopplerPageTransition</span></a> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-transition" title="poppler_page_get_transition ()">poppler_page_get_transition</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-remove-annot" title="poppler_page_remove_annot ()">poppler_page_remove_annot</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-render" title="poppler_page_render ()">poppler_page_render</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-render-for-printing" title="poppler_page_render_for_printing ()">poppler_page_render_for_printing</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-render-for-printing-with-options" title="poppler_page_render_for_printing_with_options ()">poppler_page_render_for_printing_with_options</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-render-selection" title="poppler_page_render_selection ()">poppler_page_render_selection</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-render-to-ps" title="poppler_page_render_to_ps ()">poppler_page_render_to_ps</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-selection-region-free" title="poppler_page_selection_region_free ()">poppler_page_selection_region_free</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<a class="link" href="poppler-Poppler-Page.html#PopplerPageTransition"><span class="returnvalue">PopplerPageTransition</span></a> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-transition-copy" title="poppler_page_transition_copy ()">poppler_page_transition_copy</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-transition-free" title="poppler_page_transition_free ()">poppler_page_transition_free</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<a class="link" href="poppler-Poppler-Page.html#PopplerPageTransition"><span class="returnvalue">PopplerPageTransition</span></a> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-transition-new" title="poppler_page_transition_new ()">poppler_page_transition_new</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<a class="link" href="poppler-Poppler-Page.html#PopplerPoint"><span class="returnvalue">PopplerPoint</span></a> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-point-copy" title="poppler_point_copy ()">poppler_point_copy</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-point-free" title="poppler_point_free ()">poppler_point_free</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<a class="link" href="poppler-Poppler-Page.html#PopplerPoint"><span class="returnvalue">PopplerPoint</span></a> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-point-new" title="poppler_point_new ()">poppler_point_new</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<a class="link" href="poppler-Poppler-Page.html#PopplerQuadrilateral"><span class="returnvalue">PopplerQuadrilateral</span></a> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-quadrilateral-copy" title="poppler_quadrilateral_copy ()">poppler_quadrilateral_copy</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-quadrilateral-free" title="poppler_quadrilateral_free ()">poppler_quadrilateral_free</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<a class="link" href="poppler-Poppler-Page.html#PopplerQuadrilateral"><span class="returnvalue">PopplerQuadrilateral</span></a> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-quadrilateral-new" title="poppler_quadrilateral_new ()">poppler_quadrilateral_new</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="returnvalue">PopplerRectangle</span></a> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-rectangle-copy" title="poppler_rectangle_copy ()">poppler_rectangle_copy</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">gboolean</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-rectangle-find-get-match-continued" title="poppler_rectangle_find_get_match_continued ()">poppler_rectangle_find_get_match_continued</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">gboolean</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-rectangle-find-get-ignored-hyphen" title="poppler_rectangle_find_get_ignored_hyphen ()">poppler_rectangle_find_get_ignored_hyphen</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-rectangle-free" title="poppler_rectangle_free ()">poppler_rectangle_free</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="returnvalue">PopplerRectangle</span></a> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-rectangle-new" title="poppler_rectangle_new ()">poppler_rectangle_new</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<a class="link" href="poppler-Poppler-Page.html#PopplerTextAttributes"><span class="returnvalue">PopplerTextAttributes</span></a> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-text-attributes-copy" title="poppler_text_attributes_copy ()">poppler_text_attributes_copy</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<span class="returnvalue">void</span> | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-text-attributes-free" title="poppler_text_attributes_free ()">poppler_text_attributes_free</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
<tr> | |
<td class="function_type"> | |
<a class="link" href="poppler-Poppler-Page.html#PopplerTextAttributes"><span class="returnvalue">PopplerTextAttributes</span></a> * | |
</td> | |
<td class="function_name"> | |
<a class="link" href="poppler-Poppler-Page.html#poppler-text-attributes-new" title="poppler_text_attributes_new ()">poppler_text_attributes_new</a> <span class="c_punctuation">()</span> | |
</td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
<div class="refsect1"> | |
<a name="poppler-Poppler-Page.properties"></a><h2>Properties</h2> | |
<div class="informaltable"><table class="informaltable" border="0"> | |
<colgroup> | |
<col width="150px" class="properties_type"> | |
<col width="300px" class="properties_name"> | |
<col width="200px" class="properties_flags"> | |
</colgroup> | |
<tbody><tr> | |
<td class="property_type"> | |
<span class="type">char</span> *</td> | |
<td class="property_name"><a class="link" href="poppler-Poppler-Page.html#PopplerPage--label" title="The “label” property">label</a></td> | |
<td class="property_flags">Read</td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<a name="PopplerAnnotMapping"></a><a name="PopplerFormFieldMapping"></a><a name="PopplerImageMapping"></a><a name="PopplerLinkMapping"></a><a name="PopplerPage"></a><a name="PopplerPageTransition"></a><a name="PopplerPoint"></a><a name="PopplerQuadrilateral"></a><a name="PopplerRectangle"></a><a name="PopplerTextAttributes"></a><div class="refsect1"> | |
<a name="poppler-Poppler-Page.other"></a><h2>Types and Values</h2> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="other_proto_type"> | |
<col class="other_proto_name"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="datatype_keyword"> </td> | |
<td class="function_name"><a class="link" href="poppler-Poppler-Page.html#PopplerAnnotMapping-struct" title="PopplerAnnotMapping">PopplerAnnotMapping</a></td> | |
</tr> | |
<tr> | |
<td class="datatype_keyword">enum</td> | |
<td class="function_name"><a class="link" href="poppler-Poppler-Page.html#PopplerFindFlags" title="enum PopplerFindFlags">PopplerFindFlags</a></td> | |
</tr> | |
<tr> | |
<td class="datatype_keyword"> </td> | |
<td class="function_name"><a class="link" href="poppler-Poppler-Page.html#PopplerFormFieldMapping-struct" title="PopplerFormFieldMapping">PopplerFormFieldMapping</a></td> | |
</tr> | |
<tr> | |
<td class="datatype_keyword"> </td> | |
<td class="function_name"><a class="link" href="poppler-Poppler-Page.html#PopplerImageMapping-struct" title="PopplerImageMapping">PopplerImageMapping</a></td> | |
</tr> | |
<tr> | |
<td class="datatype_keyword"> </td> | |
<td class="function_name"><a class="link" href="poppler-Poppler-Page.html#PopplerLinkMapping-struct" title="PopplerLinkMapping">PopplerLinkMapping</a></td> | |
</tr> | |
<tr> | |
<td class="datatype_keyword"> </td> | |
<td class="function_name"><a class="link" href="poppler-Poppler-Page.html#PopplerPage-struct" title="PopplerPage">PopplerPage</a></td> | |
</tr> | |
<tr> | |
<td class="datatype_keyword"> </td> | |
<td class="function_name"><a class="link" href="poppler-Poppler-Page.html#PopplerPageTransition-struct" title="PopplerPageTransition">PopplerPageTransition</a></td> | |
</tr> | |
<tr> | |
<td class="datatype_keyword">enum</td> | |
<td class="function_name"><a class="link" href="poppler-Poppler-Page.html#PopplerPageTransitionAlignment" title="enum PopplerPageTransitionAlignment">PopplerPageTransitionAlignment</a></td> | |
</tr> | |
<tr> | |
<td class="datatype_keyword">enum</td> | |
<td class="function_name"><a class="link" href="poppler-Poppler-Page.html#PopplerPageTransitionDirection" title="enum PopplerPageTransitionDirection">PopplerPageTransitionDirection</a></td> | |
</tr> | |
<tr> | |
<td class="datatype_keyword">enum</td> | |
<td class="function_name"><a class="link" href="poppler-Poppler-Page.html#PopplerPageTransitionType" title="enum PopplerPageTransitionType">PopplerPageTransitionType</a></td> | |
</tr> | |
<tr> | |
<td class="datatype_keyword"> </td> | |
<td class="function_name"><a class="link" href="poppler-Poppler-Page.html#PopplerPoint-struct" title="PopplerPoint">PopplerPoint</a></td> | |
</tr> | |
<tr> | |
<td class="datatype_keyword">enum</td> | |
<td class="function_name"><a class="link" href="poppler-Poppler-Page.html#PopplerPrintFlags" title="enum PopplerPrintFlags">PopplerPrintFlags</a></td> | |
</tr> | |
<tr> | |
<td class="datatype_keyword"> </td> | |
<td class="function_name"><a class="link" href="poppler-Poppler-Page.html#PopplerQuadrilateral-struct" title="PopplerQuadrilateral">PopplerQuadrilateral</a></td> | |
</tr> | |
<tr> | |
<td class="datatype_keyword"> </td> | |
<td class="function_name"><a class="link" href="poppler-Poppler-Page.html#PopplerRectangle-struct" title="PopplerRectangle">PopplerRectangle</a></td> | |
</tr> | |
<tr> | |
<td class="datatype_keyword">enum</td> | |
<td class="function_name"><a class="link" href="poppler-Poppler-Page.html#PopplerSelectionStyle" title="enum PopplerSelectionStyle">PopplerSelectionStyle</a></td> | |
</tr> | |
<tr> | |
<td class="datatype_keyword"> </td> | |
<td class="function_name"><a class="link" href="poppler-Poppler-Page.html#PopplerTextAttributes-struct" title="PopplerTextAttributes">PopplerTextAttributes</a></td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
<div class="refsect1"> | |
<a name="poppler-Poppler-Page.object-hierarchy"></a><h2>Object Hierarchy</h2> | |
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a> | |
<span class="lineart">├──</span> PopplerAnnotMapping | |
<span class="lineart">├──</span> PopplerFormFieldMapping | |
<span class="lineart">├──</span> PopplerImageMapping | |
<span class="lineart">├──</span> PopplerLinkMapping | |
<span class="lineart">├──</span> PopplerPageTransition | |
<span class="lineart">├──</span> PopplerPoint | |
<span class="lineart">├──</span> PopplerQuadrilateral | |
<span class="lineart">├──</span> PopplerRectangle | |
<span class="lineart">╰──</span> PopplerTextAttributes | |
<a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a> | |
<span class="lineart">├──</span> PopplerPageTransitionAlignment | |
<span class="lineart">├──</span> PopplerPageTransitionDirection | |
<span class="lineart">├──</span> PopplerPageTransitionType | |
<span class="lineart">╰──</span> PopplerSelectionStyle | |
<a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GFlags</a> | |
<span class="lineart">├──</span> PopplerFindFlags | |
<span class="lineart">╰──</span> PopplerPrintFlags | |
GObject | |
<span class="lineart">╰──</span> PopplerPage | |
</pre> | |
</div> | |
<div class="refsect1"> | |
<a name="poppler-Poppler-Page.includes"></a><h2>Includes</h2> | |
<pre class="synopsis">#include <poppler.h> | |
</pre> | |
</div> | |
<div class="refsect1"> | |
<a name="poppler-Poppler-Page.description"></a><h2>Description</h2> | |
</div> | |
<div class="refsect1"> | |
<a name="poppler-Poppler-Page.functions_details"></a><h2>Functions</h2> | |
<div class="refsect2"> | |
<a name="poppler-annot-mapping-copy"></a><h3>poppler_annot_mapping_copy ()</h3> | |
<pre class="programlisting"><a class="link" href="poppler-Poppler-Page.html#PopplerAnnotMapping"><span class="returnvalue">PopplerAnnotMapping</span></a> * | |
poppler_annot_mapping_copy (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerAnnotMapping"><span class="type">PopplerAnnotMapping</span></a> *mapping</code></em>);</pre> | |
<p>Creates a copy of <em class="parameter"><code>mapping</code></em> | |
</p> | |
<div class="refsect3"> | |
<a name="poppler-annot-mapping-copy.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>mapping</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerAnnotMapping"><span class="type">PopplerAnnotMapping</span></a> to copy</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-annot-mapping-copy.returns"></a><h4>Returns</h4> | |
<p> a new allocated copy of <em class="parameter"><code>mapping</code></em> | |
</p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-annot-mapping-free"></a><h3>poppler_annot_mapping_free ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_annot_mapping_free (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerAnnotMapping"><span class="type">PopplerAnnotMapping</span></a> *mapping</code></em>);</pre> | |
<p>Frees the given <a class="link" href="poppler-Poppler-Page.html#PopplerAnnotMapping"><span class="type">PopplerAnnotMapping</span></a></p> | |
<div class="refsect3"> | |
<a name="poppler-annot-mapping-free.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>mapping</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerAnnotMapping"><span class="type">PopplerAnnotMapping</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-annot-mapping-new"></a><h3>poppler_annot_mapping_new ()</h3> | |
<pre class="programlisting"><a class="link" href="poppler-Poppler-Page.html#PopplerAnnotMapping"><span class="returnvalue">PopplerAnnotMapping</span></a> * | |
poppler_annot_mapping_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> | |
<p>Creates a new <a class="link" href="poppler-Poppler-Page.html#PopplerAnnotMapping"><span class="type">PopplerAnnotMapping</span></a></p> | |
<div class="refsect3"> | |
<a name="poppler-annot-mapping-new.returns"></a><h4>Returns</h4> | |
<p> a new <a class="link" href="poppler-Poppler-Page.html#PopplerAnnotMapping"><span class="type">PopplerAnnotMapping</span></a>, use <a class="link" href="poppler-Poppler-Page.html#poppler-annot-mapping-free" title="poppler_annot_mapping_free ()"><code class="function">poppler_annot_mapping_free()</code></a> to free it</p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-form-field-mapping-copy"></a><h3>poppler_form_field_mapping_copy ()</h3> | |
<pre class="programlisting"><a class="link" href="poppler-Poppler-Page.html#PopplerFormFieldMapping"><span class="returnvalue">PopplerFormFieldMapping</span></a> * | |
poppler_form_field_mapping_copy (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerFormFieldMapping"><span class="type">PopplerFormFieldMapping</span></a> *mapping</code></em>);</pre> | |
<p>Creates a copy of <em class="parameter"><code>mapping</code></em> | |
</p> | |
<div class="refsect3"> | |
<a name="poppler-form-field-mapping-copy.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>mapping</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerFormFieldMapping"><span class="type">PopplerFormFieldMapping</span></a> to copy</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-form-field-mapping-copy.returns"></a><h4>Returns</h4> | |
<p> a new allocated copy of <em class="parameter"><code>mapping</code></em> | |
</p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-form-field-mapping-free"></a><h3>poppler_form_field_mapping_free ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_form_field_mapping_free (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerFormFieldMapping"><span class="type">PopplerFormFieldMapping</span></a> *mapping</code></em>);</pre> | |
<p>Frees the given <a class="link" href="poppler-Poppler-Page.html#PopplerFormFieldMapping"><span class="type">PopplerFormFieldMapping</span></a></p> | |
<div class="refsect3"> | |
<a name="poppler-form-field-mapping-free.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>mapping</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerFormFieldMapping"><span class="type">PopplerFormFieldMapping</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-form-field-mapping-new"></a><h3>poppler_form_field_mapping_new ()</h3> | |
<pre class="programlisting"><a class="link" href="poppler-Poppler-Page.html#PopplerFormFieldMapping"><span class="returnvalue">PopplerFormFieldMapping</span></a> * | |
poppler_form_field_mapping_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> | |
<p>Creates a new <a class="link" href="poppler-Poppler-Page.html#PopplerFormFieldMapping"><span class="type">PopplerFormFieldMapping</span></a></p> | |
<div class="refsect3"> | |
<a name="poppler-form-field-mapping-new.returns"></a><h4>Returns</h4> | |
<p> a new <a class="link" href="poppler-Poppler-Page.html#PopplerFormFieldMapping"><span class="type">PopplerFormFieldMapping</span></a>, use <a class="link" href="poppler-Poppler-Page.html#poppler-form-field-mapping-free" title="poppler_form_field_mapping_free ()"><code class="function">poppler_form_field_mapping_free()</code></a> to free it</p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-image-mapping-copy"></a><h3>poppler_image_mapping_copy ()</h3> | |
<pre class="programlisting"><a class="link" href="poppler-Poppler-Page.html#PopplerImageMapping"><span class="returnvalue">PopplerImageMapping</span></a> * | |
poppler_image_mapping_copy (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerImageMapping"><span class="type">PopplerImageMapping</span></a> *mapping</code></em>);</pre> | |
<p>Creates a copy of <em class="parameter"><code>mapping</code></em> | |
</p> | |
<div class="refsect3"> | |
<a name="poppler-image-mapping-copy.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>mapping</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerImageMapping"><span class="type">PopplerImageMapping</span></a> to copy</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-image-mapping-copy.returns"></a><h4>Returns</h4> | |
<p> a new allocated copy of <em class="parameter"><code>mapping</code></em> | |
</p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-image-mapping-free"></a><h3>poppler_image_mapping_free ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_image_mapping_free (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerImageMapping"><span class="type">PopplerImageMapping</span></a> *mapping</code></em>);</pre> | |
<p>Frees the given <a class="link" href="poppler-Poppler-Page.html#PopplerImageMapping"><span class="type">PopplerImageMapping</span></a></p> | |
<div class="refsect3"> | |
<a name="poppler-image-mapping-free.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>mapping</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerImageMapping"><span class="type">PopplerImageMapping</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-image-mapping-new"></a><h3>poppler_image_mapping_new ()</h3> | |
<pre class="programlisting"><a class="link" href="poppler-Poppler-Page.html#PopplerImageMapping"><span class="returnvalue">PopplerImageMapping</span></a> * | |
poppler_image_mapping_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> | |
<p>Creates a new <a class="link" href="poppler-Poppler-Page.html#PopplerImageMapping"><span class="type">PopplerImageMapping</span></a></p> | |
<div class="refsect3"> | |
<a name="poppler-image-mapping-new.returns"></a><h4>Returns</h4> | |
<p> a new <a class="link" href="poppler-Poppler-Page.html#PopplerImageMapping"><span class="type">PopplerImageMapping</span></a>, use <a class="link" href="poppler-Poppler-Page.html#poppler-image-mapping-free" title="poppler_image_mapping_free ()"><code class="function">poppler_image_mapping_free()</code></a> to free it</p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-link-mapping-copy"></a><h3>poppler_link_mapping_copy ()</h3> | |
<pre class="programlisting"><a class="link" href="poppler-Poppler-Page.html#PopplerLinkMapping"><span class="returnvalue">PopplerLinkMapping</span></a> * | |
poppler_link_mapping_copy (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerLinkMapping"><span class="type">PopplerLinkMapping</span></a> *mapping</code></em>);</pre> | |
<p>Creates a copy of <em class="parameter"><code>mapping</code></em> | |
</p> | |
<div class="refsect3"> | |
<a name="poppler-link-mapping-copy.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>mapping</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerLinkMapping"><span class="type">PopplerLinkMapping</span></a> to copy</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-link-mapping-copy.returns"></a><h4>Returns</h4> | |
<p> a new allocated copy of <em class="parameter"><code>mapping</code></em> | |
</p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-link-mapping-free"></a><h3>poppler_link_mapping_free ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_link_mapping_free (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerLinkMapping"><span class="type">PopplerLinkMapping</span></a> *mapping</code></em>);</pre> | |
<p>Frees the given <a class="link" href="poppler-Poppler-Page.html#PopplerLinkMapping"><span class="type">PopplerLinkMapping</span></a></p> | |
<div class="refsect3"> | |
<a name="poppler-link-mapping-free.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>mapping</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerLinkMapping"><span class="type">PopplerLinkMapping</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-link-mapping-new"></a><h3>poppler_link_mapping_new ()</h3> | |
<pre class="programlisting"><a class="link" href="poppler-Poppler-Page.html#PopplerLinkMapping"><span class="returnvalue">PopplerLinkMapping</span></a> * | |
poppler_link_mapping_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> | |
<p>Creates a new <a class="link" href="poppler-Poppler-Page.html#PopplerLinkMapping"><span class="type">PopplerLinkMapping</span></a></p> | |
<div class="refsect3"> | |
<a name="poppler-link-mapping-new.returns"></a><h4>Returns</h4> | |
<p> a new <a class="link" href="poppler-Poppler-Page.html#PopplerLinkMapping"><span class="type">PopplerLinkMapping</span></a>, use <a class="link" href="poppler-Poppler-Page.html#poppler-link-mapping-free" title="poppler_link_mapping_free ()"><code class="function">poppler_link_mapping_free()</code></a> to free it</p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-add-annot"></a><h3>poppler_page_add_annot ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_page_add_annot (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>, | |
<em class="parameter"><code><a class="link" href="poppler-Poppler-Annotation.html#PopplerAnnot"><span class="type">PopplerAnnot</span></a> *annot</code></em>);</pre> | |
<p>Adds annotation <em class="parameter"><code>annot</code></em> | |
to <em class="parameter"><code>page</code></em> | |
.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-add-annot.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>annot</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Annotation.html#PopplerAnnot"><span class="type">PopplerAnnot</span></a> to add</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-16.html#api-index-0.16">0.16</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-find-text"></a><h3>poppler_page_find_text ()</h3> | |
<pre class="programlisting"><span class="returnvalue">GList</span> * | |
poppler_page_find_text (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>, | |
<em class="parameter"><code>const <span class="type">char</span> *text</code></em>);</pre> | |
<p>Finds <em class="parameter"><code>text</code></em> | |
in <em class="parameter"><code>page</code></em> | |
with the default options (<a class="link" href="poppler-Poppler-Page.html#POPPLER-FIND-DEFAULT:CAPS"><code class="literal">POPPLER_FIND_DEFAULT</code></a>) and | |
returns a <span class="type">GList</span> of rectangles for each occurrence of the text on the page. | |
The coordinates are in PDF points.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-find-text.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>text</p></td> | |
<td class="parameter_description"><p>the text to search for (UTF-8 encoded)</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-find-text.returns"></a><h4>Returns</h4> | |
<p>a <span class="type">GList</span> of <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a>,. </p> | |
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> PopplerRectangle][<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-find-text-with-options"></a><h3>poppler_page_find_text_with_options ()</h3> | |
<pre class="programlisting"><span class="returnvalue">GList</span> * | |
poppler_page_find_text_with_options (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>, | |
<em class="parameter"><code>const <span class="type">char</span> *text</code></em>, | |
<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerFindFlags" title="enum PopplerFindFlags"><span class="type">PopplerFindFlags</span></a> options</code></em>);</pre> | |
<p>Finds <em class="parameter"><code>text</code></em> | |
in <em class="parameter"><code>page</code></em> | |
with the given <a class="link" href="poppler-Poppler-Page.html#PopplerFindFlags" title="enum PopplerFindFlags"><span class="type">PopplerFindFlags</span></a> options and | |
returns a <span class="type">GList</span> of rectangles for each occurrence of the text on the page. | |
The coordinates are in PDF points.</p> | |
<p>When <a class="link" href="poppler-Poppler-Page.html#POPPLER-FIND-MULTILINE:CAPS"><code class="literal">POPPLER_FIND_MULTILINE</code></a> is passed in <em class="parameter"><code>options</code></em> | |
, matches may span more than | |
one line. In this case, the returned list will contain one <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> | |
for each part of a match. The function <a class="link" href="poppler-Poppler-Page.html#poppler-rectangle-find-get-match-continued" title="poppler_rectangle_find_get_match_continued ()"><code class="function">poppler_rectangle_find_get_match_continued()</code></a> | |
will return <code class="literal">TRUE</code> for all rectangles belonging to the same match, except for | |
the last one. If a hyphen was ignored at the end of the part of the match, | |
<a class="link" href="poppler-Poppler-Page.html#poppler-rectangle-find-get-ignored-hyphen" title="poppler_rectangle_find_get_ignored_hyphen ()"><code class="function">poppler_rectangle_find_get_ignored_hyphen()</code></a> will return <code class="literal">TRUE</code> for that | |
rectangle.</p> | |
<p>Note that currently matches spanning more than two lines are not found. | |
(This limitation may be lifted in a future version.)</p> | |
<p>Note also that currently finding multi-line matches backwards is not | |
implemented; if you pass <a class="link" href="poppler-Poppler-Page.html#POPPLER-FIND-BACKWARDS:CAPS"><code class="literal">POPPLER_FIND_BACKWARDS</code></a> and <a class="link" href="poppler-Poppler-Page.html#POPPLER-FIND-MULTILINE:CAPS"><code class="literal">POPPLER_FIND_MULTILINE</code></a> | |
together, <a class="link" href="poppler-Poppler-Page.html#POPPLER-FIND-MULTILINE:CAPS"><code class="literal">POPPLER_FIND_MULTILINE</code></a> will be ignored.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-find-text-with-options.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>text</p></td> | |
<td class="parameter_description"><p>the text to search for (UTF-8 encoded)</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>options</p></td> | |
<td class="parameter_description"><p>find options</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-find-text-with-options.returns"></a><h4>Returns</h4> | |
<p>a newly allocated list | |
of newly allocated <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a>. Free with <code class="function">g_list_free_full()</code> using <a class="link" href="poppler-Poppler-Page.html#poppler-rectangle-free" title="poppler_rectangle_free ()"><code class="function">poppler_rectangle_free()</code></a>. </p> | |
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> PopplerRectangle][<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-22.html#api-index-0.22">0.22</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-free-annot-mapping"></a><h3>poppler_page_free_annot_mapping ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_page_free_annot_mapping (<em class="parameter"><code><span class="type">GList</span> *list</code></em>);</pre> | |
<p>Frees a list of <a class="link" href="poppler-Poppler-Page.html#PopplerAnnotMapping"><span class="type">PopplerAnnotMapping</span></a>s allocated by | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-annot-mapping" title="poppler_page_get_annot_mapping ()"><code class="function">poppler_page_get_annot_mapping()</code></a>. It also unreferences the <a class="link" href="poppler-Poppler-Annotation.html#PopplerAnnot"><span class="type">PopplerAnnot</span></a>s | |
that each mapping contains, so if you want to keep them around, you need to | |
reference them with <code class="function">g_object_ref()</code>.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-free-annot-mapping.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>list</p></td> | |
<td class="parameter_description"><p>A list of | |
<a class="link" href="poppler-Poppler-Page.html#PopplerAnnotMapping"><span class="type">PopplerAnnotMapping</span></a>s. </p></td> | |
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> PopplerAnnotMapping]</span></td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-free-form-field-mapping"></a><h3>poppler_page_free_form_field_mapping ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_page_free_form_field_mapping (<em class="parameter"><code><span class="type">GList</span> *list</code></em>);</pre> | |
<p>Frees a list of <a class="link" href="poppler-Poppler-Page.html#PopplerFormFieldMapping"><span class="type">PopplerFormFieldMapping</span></a>s allocated by | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-form-field-mapping" title="poppler_page_get_form_field_mapping ()"><code class="function">poppler_page_get_form_field_mapping()</code></a>.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-free-form-field-mapping.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>list</p></td> | |
<td class="parameter_description"><p>A list of | |
<a class="link" href="poppler-Poppler-Page.html#PopplerFormFieldMapping"><span class="type">PopplerFormFieldMapping</span></a>s. </p></td> | |
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> PopplerFormFieldMapping]</span></td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-free-image-mapping"></a><h3>poppler_page_free_image_mapping ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_page_free_image_mapping (<em class="parameter"><code><span class="type">GList</span> *list</code></em>);</pre> | |
<p>Frees a list of <a class="link" href="poppler-Poppler-Page.html#PopplerImageMapping"><span class="type">PopplerImageMapping</span></a>s allocated by | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-image-mapping" title="poppler_page_get_image_mapping ()"><code class="function">poppler_page_get_image_mapping()</code></a>.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-free-image-mapping.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>list</p></td> | |
<td class="parameter_description"><p>A list of | |
<a class="link" href="poppler-Poppler-Page.html#PopplerImageMapping"><span class="type">PopplerImageMapping</span></a>s. </p></td> | |
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> PopplerImageMapping]</span></td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-free-link-mapping"></a><h3>poppler_page_free_link_mapping ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_page_free_link_mapping (<em class="parameter"><code><span class="type">GList</span> *list</code></em>);</pre> | |
<p>Frees a list of <a class="link" href="poppler-Poppler-Page.html#PopplerLinkMapping"><span class="type">PopplerLinkMapping</span></a>s allocated by | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-link-mapping" title="poppler_page_get_link_mapping ()"><code class="function">poppler_page_get_link_mapping()</code></a>. It also frees the <a class="link" href="PopplerAction.html" title="PopplerAction"><span class="type">PopplerAction</span></a>s | |
that each mapping contains, so if you want to keep them around, you need to | |
copy them with <a class="link" href="PopplerAction.html#poppler-action-copy" title="poppler_action_copy ()"><code class="function">poppler_action_copy()</code></a>.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-free-link-mapping.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>list</p></td> | |
<td class="parameter_description"><p>A list of | |
<a class="link" href="poppler-Poppler-Page.html#PopplerLinkMapping"><span class="type">PopplerLinkMapping</span></a>s. </p></td> | |
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> PopplerLinkMapping]</span></td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-free-text-attributes"></a><h3>poppler_page_free_text_attributes ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_page_free_text_attributes (<em class="parameter"><code><span class="type">GList</span> *list</code></em>);</pre> | |
<p>Frees a list of <a class="link" href="poppler-Poppler-Page.html#PopplerTextAttributes"><span class="type">PopplerTextAttributes</span></a>s allocated by | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-text-attributes" title="poppler_page_get_text_attributes ()"><code class="function">poppler_page_get_text_attributes()</code></a>.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-free-text-attributes.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>list</p></td> | |
<td class="parameter_description"><p>A list of | |
<a class="link" href="poppler-Poppler-Page.html#PopplerTextAttributes"><span class="type">PopplerTextAttributes</span></a>s. </p></td> | |
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> PopplerTextAttributes]</span></td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-18.html#api-index-0.18">0.18</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-annot-mapping"></a><h3>poppler_page_get_annot_mapping ()</h3> | |
<pre class="programlisting"><span class="returnvalue">GList</span> * | |
poppler_page_get_annot_mapping (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>);</pre> | |
<p>Returns a list of <a class="link" href="poppler-Poppler-Page.html#PopplerAnnotMapping"><span class="type">PopplerAnnotMapping</span></a> items that map from a location on | |
<em class="parameter"><code>page</code></em> | |
to a <a class="link" href="poppler-Poppler-Annotation.html#PopplerAnnot"><span class="type">PopplerAnnot</span></a>. This list must be freed with | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-free-annot-mapping" title="poppler_page_free_annot_mapping ()"><code class="function">poppler_page_free_annot_mapping()</code></a> when done.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-get-annot-mapping.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>A <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-get-annot-mapping.returns"></a><h4>Returns</h4> | |
<p>A <span class="type">GList</span> of <a class="link" href="poppler-Poppler-Page.html#PopplerAnnotMapping"><span class="type">PopplerAnnotMapping</span></a>. </p> | |
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> PopplerAnnotMapping][<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-bounding-box"></a><h3>poppler_page_get_bounding_box ()</h3> | |
<pre class="programlisting"><span class="returnvalue">gboolean</span> | |
poppler_page_get_bounding_box (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>, | |
<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> *rect</code></em>);</pre> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-crop-box"></a><h3>poppler_page_get_crop_box ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_page_get_crop_box (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>, | |
<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> *rect</code></em>);</pre> | |
<p>Retrurns the crop box of <em class="parameter"><code>page</code></em> | |
</p> | |
<div class="refsect3"> | |
<a name="poppler-page-get-crop-box.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>rect</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> to fill. </p></td> | |
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-duration"></a><h3>poppler_page_get_duration ()</h3> | |
<pre class="programlisting"><span class="returnvalue">double</span> | |
poppler_page_get_duration (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>);</pre> | |
<p>Returns the duration of <em class="parameter"><code>page</code></em> | |
</p> | |
<div class="refsect3"> | |
<a name="poppler-page-get-duration.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-get-duration.returns"></a><h4>Returns</h4> | |
<p> duration in seconds of <em class="parameter"><code>page</code></em> | |
or -1.</p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-form-field-mapping"></a><h3>poppler_page_get_form_field_mapping ()</h3> | |
<pre class="programlisting"><span class="returnvalue">GList</span> * | |
poppler_page_get_form_field_mapping (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>);</pre> | |
<p>Returns a list of <a class="link" href="poppler-Poppler-Page.html#PopplerFormFieldMapping"><span class="type">PopplerFormFieldMapping</span></a> items that map from a | |
location on <em class="parameter"><code>page</code></em> | |
to a form field. This list must be freed | |
with <a class="link" href="poppler-Poppler-Page.html#poppler-page-free-form-field-mapping" title="poppler_page_free_form_field_mapping ()"><code class="function">poppler_page_free_form_field_mapping()</code></a> when done.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-get-form-field-mapping.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>A <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-get-form-field-mapping.returns"></a><h4>Returns</h4> | |
<p>A <span class="type">GList</span> of <a class="link" href="poppler-Poppler-Page.html#PopplerFormFieldMapping"><span class="type">PopplerFormFieldMapping</span></a>. </p> | |
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> PopplerFormFieldMapping][<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-image"></a><h3>poppler_page_get_image ()</h3> | |
<pre class="programlisting"><span class="returnvalue">cairo_surface_t</span> * | |
poppler_page_get_image (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>, | |
<em class="parameter"><code><span class="type">gint</span> image_id</code></em>);</pre> | |
<p>Returns a cairo surface for the image of the <em class="parameter"><code>page</code></em> | |
</p> | |
<div class="refsect3"> | |
<a name="poppler-page-get-image.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>A <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>image_id</p></td> | |
<td class="parameter_description"><p>The image identifier</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-get-image.returns"></a><h4>Returns</h4> | |
<p> A cairo surface for the image</p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-image-mapping"></a><h3>poppler_page_get_image_mapping ()</h3> | |
<pre class="programlisting"><span class="returnvalue">GList</span> * | |
poppler_page_get_image_mapping (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>);</pre> | |
<p>Returns a list of <a class="link" href="poppler-Poppler-Page.html#PopplerImageMapping"><span class="type">PopplerImageMapping</span></a> items that map from a | |
location on <em class="parameter"><code>page</code></em> | |
to an image of the page. This list must be freed | |
with <a class="link" href="poppler-Poppler-Page.html#poppler-page-free-image-mapping" title="poppler_page_free_image_mapping ()"><code class="function">poppler_page_free_image_mapping()</code></a> when done.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-get-image-mapping.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>A <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-get-image-mapping.returns"></a><h4>Returns</h4> | |
<p>A <span class="type">GList</span> of <a class="link" href="poppler-Poppler-Page.html#PopplerImageMapping"><span class="type">PopplerImageMapping</span></a>. </p> | |
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> PopplerImageMapping][<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-index"></a><h3>poppler_page_get_index ()</h3> | |
<pre class="programlisting"><span class="returnvalue">int</span> | |
poppler_page_get_index (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>);</pre> | |
<p>Returns the index of <em class="parameter"><code>page</code></em> | |
</p> | |
<div class="refsect3"> | |
<a name="poppler-page-get-index.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-get-index.returns"></a><h4>Returns</h4> | |
<p> index value of <em class="parameter"><code>page</code></em> | |
</p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-label"></a><h3>poppler_page_get_label ()</h3> | |
<pre class="programlisting"><span class="returnvalue">gchar</span> * | |
poppler_page_get_label (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>);</pre> | |
<p>Returns the label of <em class="parameter"><code>page</code></em> | |
. Note that page labels | |
and page indices might not coincide.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-get-label.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-get-label.returns"></a><h4>Returns</h4> | |
<p> a new allocated string containing the label of <em class="parameter"><code>page</code></em> | |
, | |
or <code class="literal">NULL</code> if <em class="parameter"><code>page</code></em> | |
doesn't have a label</p> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-16.html#api-index-0.16">0.16</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-link-mapping"></a><h3>poppler_page_get_link_mapping ()</h3> | |
<pre class="programlisting"><span class="returnvalue">GList</span> * | |
poppler_page_get_link_mapping (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>);</pre> | |
<p>Returns a list of <a class="link" href="poppler-Poppler-Page.html#PopplerLinkMapping"><span class="type">PopplerLinkMapping</span></a> items that map from a | |
location on <em class="parameter"><code>page</code></em> | |
to a <a class="link" href="PopplerAction.html" title="PopplerAction"><span class="type">PopplerAction</span></a>. This list must be freed | |
with <a class="link" href="poppler-Poppler-Page.html#poppler-page-free-link-mapping" title="poppler_page_free_link_mapping ()"><code class="function">poppler_page_free_link_mapping()</code></a> when done.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-get-link-mapping.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>A <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-get-link-mapping.returns"></a><h4>Returns</h4> | |
<p>A <span class="type">GList</span> of <a class="link" href="poppler-Poppler-Page.html#PopplerLinkMapping"><span class="type">PopplerLinkMapping</span></a>. </p> | |
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> PopplerLinkMapping][<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-selected-region"></a><h3>poppler_page_get_selected_region ()</h3> | |
<pre class="programlisting"><span class="returnvalue">cairo_region_t</span> * | |
poppler_page_get_selected_region (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>, | |
<em class="parameter"><code><span class="type">gdouble</span> scale</code></em>, | |
<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerSelectionStyle" title="enum PopplerSelectionStyle"><span class="type">PopplerSelectionStyle</span></a> style</code></em>, | |
<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> *selection</code></em>);</pre> | |
<p>Returns a region containing the area that would be rendered by | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-render-selection" title="poppler_page_render_selection ()"><code class="function">poppler_page_render_selection()</code></a>. | |
The returned region must be freed with <code class="function">cairo_region_destroy()</code></p> | |
<div class="refsect3"> | |
<a name="poppler-page-get-selected-region.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>scale</p></td> | |
<td class="parameter_description"><p>scale specified as pixels per point</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>style</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerSelectionStyle" title="enum PopplerSelectionStyle"><span class="type">PopplerSelectionStyle</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>selection</p></td> | |
<td class="parameter_description"><p>start and end point of selection as a rectangle</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-get-selected-region.returns"></a><h4>Returns</h4> | |
<p>a cairo_region_t. </p> | |
<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-16.html#api-index-0.16">0.16</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-selected-text"></a><h3>poppler_page_get_selected_text ()</h3> | |
<pre class="programlisting"><span class="returnvalue">char</span> * | |
poppler_page_get_selected_text (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>, | |
<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerSelectionStyle" title="enum PopplerSelectionStyle"><span class="type">PopplerSelectionStyle</span></a> style</code></em>, | |
<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> *selection</code></em>);</pre> | |
<p>Retrieves the contents of the specified <em class="parameter"><code>selection</code></em> | |
as text.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-get-selected-text.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>style</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerSelectionStyle" title="enum PopplerSelectionStyle"><span class="type">PopplerSelectionStyle</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>selection</p></td> | |
<td class="parameter_description"><p>the <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> including the text</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-get-selected-text.returns"></a><h4>Returns</h4> | |
<p> a pointer to the contents of the <em class="parameter"><code>selection</code></em> | |
as a string</p> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-16.html#api-index-0.16">0.16</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-selection-region"></a><h3>poppler_page_get_selection_region ()</h3> | |
<pre class="programlisting"><span class="returnvalue">GList</span> * | |
poppler_page_get_selection_region (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>, | |
<em class="parameter"><code><span class="type">gdouble</span> scale</code></em>, | |
<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerSelectionStyle" title="enum PopplerSelectionStyle"><span class="type">PopplerSelectionStyle</span></a> style</code></em>, | |
<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> *selection</code></em>);</pre> | |
<div class="warning"> | |
<p><code class="literal">poppler_page_get_selection_region</code> has been deprecated since version 0.16 and should not be used in newly-written code.</p> | |
<p>Use <a class="link" href="poppler-Poppler-Page.html#poppler-page-get-selected-region" title="poppler_page_get_selected_region ()"><code class="function">poppler_page_get_selected_region()</code></a> instead.</p> | |
</div> | |
<p>Returns a region containing the area that would be rendered by | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-render-selection" title="poppler_page_render_selection ()"><code class="function">poppler_page_render_selection()</code></a> as a <span class="type">GList</span> of | |
<a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a>. The returned list must be freed with | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-selection-region-free" title="poppler_page_selection_region_free ()"><code class="function">poppler_page_selection_region_free()</code></a>.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-get-selection-region.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>scale</p></td> | |
<td class="parameter_description"><p>scale specified as pixels per point</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>style</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerSelectionStyle" title="enum PopplerSelectionStyle"><span class="type">PopplerSelectionStyle</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>selection</p></td> | |
<td class="parameter_description"><p>start and end point of selection as a rectangle</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-get-selection-region.returns"></a><h4>Returns</h4> | |
<p>a <span class="type">GList</span> of <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a>. </p> | |
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> PopplerRectangle][<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-size"></a><h3>poppler_page_get_size ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_page_get_size (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>, | |
<em class="parameter"><code><span class="type">double</span> *width</code></em>, | |
<em class="parameter"><code><span class="type">double</span> *height</code></em>);</pre> | |
<p>Gets the size of <em class="parameter"><code>page</code></em> | |
at the current scale and rotation.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-get-size.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>A <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>width</p></td> | |
<td class="parameter_description"><p>return location for the width of <em class="parameter"><code>page</code></em> | |
. </p></td> | |
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>height</p></td> | |
<td class="parameter_description"><p>return location for the height of <em class="parameter"><code>page</code></em> | |
. </p></td> | |
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-text"></a><h3>poppler_page_get_text ()</h3> | |
<pre class="programlisting"><span class="returnvalue">char</span> * | |
poppler_page_get_text (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>);</pre> | |
<p>Retrieves the text of <em class="parameter"><code>page</code></em> | |
.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-get-text.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-get-text.returns"></a><h4>Returns</h4> | |
<p> a pointer to the text of the <em class="parameter"><code>page</code></em> | |
as a string</p> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-16.html#api-index-0.16">0.16</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-text-attributes"></a><h3>poppler_page_get_text_attributes ()</h3> | |
<pre class="programlisting"><span class="returnvalue">GList</span> * | |
poppler_page_get_text_attributes (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>);</pre> | |
<p>Obtains the attributes of the text as a <span class="type">GList</span> of <a class="link" href="poppler-Poppler-Page.html#PopplerTextAttributes"><span class="type">PopplerTextAttributes</span></a>. | |
This list must be freed with <a class="link" href="poppler-Poppler-Page.html#poppler-page-free-text-attributes" title="poppler_page_free_text_attributes ()"><code class="function">poppler_page_free_text_attributes()</code></a> when done.</p> | |
<p>Each list element is a <a class="link" href="poppler-Poppler-Page.html#PopplerTextAttributes"><span class="type">PopplerTextAttributes</span></a> struct where start_index and | |
end_index indicates the range of text (as returned by <a class="link" href="poppler-Poppler-Page.html#poppler-page-get-text" title="poppler_page_get_text ()"><code class="function">poppler_page_get_text()</code></a>) | |
to which text attributes apply.</p> | |
<p>See also <a class="link" href="poppler-Poppler-Page.html#poppler-page-get-text-attributes-for-area" title="poppler_page_get_text_attributes_for_area ()"><code class="function">poppler_page_get_text_attributes_for_area()</code></a></p> | |
<div class="refsect3"> | |
<a name="poppler-page-get-text-attributes.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>A <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-get-text-attributes.returns"></a><h4>Returns</h4> | |
<p>A <span class="type">GList</span> of <a class="link" href="poppler-Poppler-Page.html#PopplerTextAttributes"><span class="type">PopplerTextAttributes</span></a>. </p> | |
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> PopplerTextAttributes][<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-18.html#api-index-0.18">0.18</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-text-attributes-for-area"></a><h3>poppler_page_get_text_attributes_for_area ()</h3> | |
<pre class="programlisting"><span class="returnvalue">GList</span> * | |
poppler_page_get_text_attributes_for_area | |
(<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>, | |
<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> *area</code></em>);</pre> | |
<p>Obtains the attributes of the text in <em class="parameter"><code>area</code></em> | |
as a <span class="type">GList</span> of <a class="link" href="poppler-Poppler-Page.html#PopplerTextAttributes"><span class="type">PopplerTextAttributes</span></a>. | |
This list must be freed with <a class="link" href="poppler-Poppler-Page.html#poppler-page-free-text-attributes" title="poppler_page_free_text_attributes ()"><code class="function">poppler_page_free_text_attributes()</code></a> when done.</p> | |
<p>Each list element is a <a class="link" href="poppler-Poppler-Page.html#PopplerTextAttributes"><span class="type">PopplerTextAttributes</span></a> struct where start_index and | |
end_index indicates the range of text (as returned by <a class="link" href="poppler-Poppler-Page.html#poppler-page-get-text-for-area" title="poppler_page_get_text_for_area ()"><code class="function">poppler_page_get_text_for_area()</code></a>) | |
to which text attributes apply.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-get-text-attributes-for-area.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>A <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>area</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-get-text-attributes-for-area.returns"></a><h4>Returns</h4> | |
<p>A <span class="type">GList</span> of <a class="link" href="poppler-Poppler-Page.html#PopplerTextAttributes"><span class="type">PopplerTextAttributes</span></a>. </p> | |
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> PopplerTextAttributes][<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-26.html#api-index-0.26">0.26</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-text-for-area"></a><h3>poppler_page_get_text_for_area ()</h3> | |
<pre class="programlisting"><span class="returnvalue">char</span> * | |
poppler_page_get_text_for_area (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>, | |
<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> *area</code></em>);</pre> | |
<p>Retrieves the text of <em class="parameter"><code>page</code></em> | |
contained in <em class="parameter"><code>area</code></em> | |
.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-get-text-for-area.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>area</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-get-text-for-area.returns"></a><h4>Returns</h4> | |
<p> a pointer to the text as a string</p> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-26.html#api-index-0.26">0.26</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-text-layout"></a><h3>poppler_page_get_text_layout ()</h3> | |
<pre class="programlisting"><span class="returnvalue">gboolean</span> | |
poppler_page_get_text_layout (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>, | |
<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> **rectangles</code></em>, | |
<em class="parameter"><code><span class="type">guint</span> *n_rectangles</code></em>);</pre> | |
<p>Obtains the layout of the text as a list of <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> | |
This array must be freed with <code class="function">g_free()</code> when done.</p> | |
<p>The position in the array represents an offset in the text returned by | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-text" title="poppler_page_get_text ()"><code class="function">poppler_page_get_text()</code></a></p> | |
<p>See also <a class="link" href="poppler-Poppler-Page.html#poppler-page-get-text-layout-for-area" title="poppler_page_get_text_layout_for_area ()"><code class="function">poppler_page_get_text_layout_for_area()</code></a>.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-get-text-layout.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>A <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>rectangles</p></td> | |
<td class="parameter_description"><p>return location for an array of <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a>. </p></td> | |
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_rectangles][<acronym title="The caller owns the data container, but not the data inside it."><span class="acronym">transfer container</span></acronym>]</span></td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>n_rectangles</p></td> | |
<td class="parameter_description"><p>length of returned array. </p></td> | |
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-get-text-layout.returns"></a><h4>Returns</h4> | |
<p> <code class="literal">TRUE</code> if the page contains text, <code class="literal">FALSE</code> otherwise</p> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-16.html#api-index-0.16">0.16</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-text-layout-for-area"></a><h3>poppler_page_get_text_layout_for_area ()</h3> | |
<pre class="programlisting"><span class="returnvalue">gboolean</span> | |
poppler_page_get_text_layout_for_area (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>, | |
<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> *area</code></em>, | |
<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> **rectangles</code></em>, | |
<em class="parameter"><code><span class="type">guint</span> *n_rectangles</code></em>);</pre> | |
<p>Obtains the layout of the text contained in <em class="parameter"><code>area</code></em> | |
as a list of <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> | |
This array must be freed with <code class="function">g_free()</code> when done.</p> | |
<p>The position in the array represents an offset in the text returned by | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-text-for-area" title="poppler_page_get_text_for_area ()"><code class="function">poppler_page_get_text_for_area()</code></a></p> | |
<div class="refsect3"> | |
<a name="poppler-page-get-text-layout-for-area.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>A <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>area</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>rectangles</p></td> | |
<td class="parameter_description"><p>return location for an array of <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a>. </p></td> | |
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_rectangles][<acronym title="The caller owns the data container, but not the data inside it."><span class="acronym">transfer container</span></acronym>]</span></td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>n_rectangles</p></td> | |
<td class="parameter_description"><p>length of returned array. </p></td> | |
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-get-text-layout-for-area.returns"></a><h4>Returns</h4> | |
<p> <code class="literal">TRUE</code> if the page contains text, <code class="literal">FALSE</code> otherwise</p> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-26.html#api-index-0.26">0.26</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-thumbnail"></a><h3>poppler_page_get_thumbnail ()</h3> | |
<pre class="programlisting"><span class="returnvalue">cairo_surface_t</span> * | |
poppler_page_get_thumbnail (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>);</pre> | |
<p>Get the embedded thumbnail for the specified page. If the document | |
doesn't have an embedded thumbnail for the page, this function | |
returns <code class="literal">NULL</code>.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-get-thumbnail.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>the <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> to get the thumbnail for</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-get-thumbnail.returns"></a><h4>Returns</h4> | |
<p> the tumbnail as a cairo_surface_t or <code class="literal">NULL</code> if the document | |
doesn't have a thumbnail for this page.</p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-thumbnail-size"></a><h3>poppler_page_get_thumbnail_size ()</h3> | |
<pre class="programlisting"><span class="returnvalue">gboolean</span> | |
poppler_page_get_thumbnail_size (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>, | |
<em class="parameter"><code><span class="type">int</span> *width</code></em>, | |
<em class="parameter"><code><span class="type">int</span> *height</code></em>);</pre> | |
<p>Returns <code class="literal">TRUE</code> if <em class="parameter"><code>page</code></em> | |
has a thumbnail associated with it. It also | |
fills in <em class="parameter"><code>width</code></em> | |
and <em class="parameter"><code>height</code></em> | |
with the width and height of the | |
thumbnail. The values of width and height are not changed if no | |
appropriate thumbnail exists.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-get-thumbnail-size.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>A <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>width</p></td> | |
<td class="parameter_description"><p>return location for width. </p></td> | |
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>height</p></td> | |
<td class="parameter_description"><p>return location for height. </p></td> | |
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-get-thumbnail-size.returns"></a><h4>Returns</h4> | |
<p> <code class="literal">TRUE</code>, if <em class="parameter"><code>page</code></em> | |
has a thumbnail associated with it.</p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-get-transition"></a><h3>poppler_page_get_transition ()</h3> | |
<pre class="programlisting"><a class="link" href="poppler-Poppler-Page.html#PopplerPageTransition"><span class="returnvalue">PopplerPageTransition</span></a> * | |
poppler_page_get_transition (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>);</pre> | |
<p>Returns the transition effect of <em class="parameter"><code>page</code></em> | |
</p> | |
<div class="refsect3"> | |
<a name="poppler-page-get-transition.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-get-transition.returns"></a><h4>Returns</h4> | |
<p> a <a class="link" href="poppler-Poppler-Page.html#PopplerPageTransition"><span class="type">PopplerPageTransition</span></a> or <code class="literal">NULL</code>.</p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-remove-annot"></a><h3>poppler_page_remove_annot ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_page_remove_annot (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>, | |
<em class="parameter"><code><a class="link" href="poppler-Poppler-Annotation.html#PopplerAnnot"><span class="type">PopplerAnnot</span></a> *annot</code></em>);</pre> | |
<p>Removes annotation <em class="parameter"><code>annot</code></em> | |
from <em class="parameter"><code>page</code></em> | |
</p> | |
<div class="refsect3"> | |
<a name="poppler-page-remove-annot.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>annot</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Annotation.html#PopplerAnnot"><span class="type">PopplerAnnot</span></a> to remove</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-22.html#api-index-0.22">0.22</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-render"></a><h3>poppler_page_render ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_page_render (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>, | |
<em class="parameter"><code><span class="type">cairo_t</span> *cairo</code></em>);</pre> | |
<p>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 | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-render-for-printing" title="poppler_page_render_for_printing ()"><code class="function">poppler_page_render_for_printing()</code></a> instead. Please see the documentation | |
for that function for the differences between rendering to the screen and | |
rendering to a printer.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-render.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>the page to render from</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>cairo</p></td> | |
<td class="parameter_description"><p>cairo context to render to</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-render-for-printing"></a><h3>poppler_page_render_for_printing ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_page_render_for_printing (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>, | |
<em class="parameter"><code><span class="type">cairo_t</span> *cairo</code></em>);</pre> | |
<p>Render the page to the given cairo context for printing with | |
<a class="link" href="poppler-Poppler-Page.html#POPPLER-PRINT-ALL:CAPS"><span class="type">POPPLER_PRINT_ALL</span></a> flags selected. If you want a different set of flags, | |
use <a class="link" href="poppler-Poppler-Page.html#poppler-page-render-for-printing-with-options" title="poppler_page_render_for_printing_with_options ()"><code class="function">poppler_page_render_for_printing_with_options()</code></a>.</p> | |
<p>The difference between <a class="link" href="poppler-Poppler-Page.html#poppler-page-render" title="poppler_page_render ()"><code class="function">poppler_page_render()</code></a> and this function is that some | |
things get rendered differently between screens and printers:</p> | |
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> | |
<li class="listitem"> | |
PDF annotations get rendered according to their <a class="link" href="poppler-Poppler-Annotation.html#PopplerAnnotFlag" title="enum PopplerAnnotFlag"><span class="type">PopplerAnnotFlag</span></a> value. | |
For example, <a class="link" href="poppler-Poppler-Annotation.html#POPPLER-ANNOT-FLAG-PRINT:CAPS"><span class="type">POPPLER_ANNOT_FLAG_PRINT</span></a> refers to whether an annotation | |
is printed or not, whereas <a class="link" href="poppler-Poppler-Annotation.html#POPPLER-ANNOT-FLAG-NO-VIEW:CAPS"><span class="type">POPPLER_ANNOT_FLAG_NO_VIEW</span></a> refers to whether | |
an annotation is invisible when displaying to the screen. | |
</li> | |
<li class="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. | |
</li> | |
<li class="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. | |
</li> | |
</ul></div> | |
<div class="refsect3"> | |
<a name="poppler-page-render-for-printing.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>the page to render from</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>cairo</p></td> | |
<td class="parameter_description"><p>cairo context to render to</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-render-for-printing-with-options"></a><h3>poppler_page_render_for_printing_with_options ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_page_render_for_printing_with_options | |
(<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>, | |
<em class="parameter"><code><span class="type">cairo_t</span> *cairo</code></em>, | |
<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPrintFlags" title="enum PopplerPrintFlags"><span class="type">PopplerPrintFlags</span></a> options</code></em>);</pre> | |
<p>Render the page to the given cairo context for printing | |
with the specified options</p> | |
<p>See the documentation for <a class="link" href="poppler-Poppler-Page.html#poppler-page-render-for-printing" title="poppler_page_render_for_printing ()"><code class="function">poppler_page_render_for_printing()</code></a> for the | |
differences between rendering to the screen and rendering to a printer.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-render-for-printing-with-options.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>the page to render from</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>cairo</p></td> | |
<td class="parameter_description"><p>cairo context to render to</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>options</p></td> | |
<td class="parameter_description"><p>print options</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-16.html#api-index-0.16">0.16</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-render-selection"></a><h3>poppler_page_render_selection ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_page_render_selection (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>, | |
<em class="parameter"><code><span class="type">cairo_t</span> *cairo</code></em>, | |
<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> *selection</code></em>, | |
<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> *old_selection</code></em>, | |
<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerSelectionStyle" title="enum PopplerSelectionStyle"><span class="type">PopplerSelectionStyle</span></a> style</code></em>, | |
<em class="parameter"><code><a class="link" href="poppler-Poppler-Color.html#PopplerColor"><span class="type">PopplerColor</span></a> *glyph_color</code></em>, | |
<em class="parameter"><code><a class="link" href="poppler-Poppler-Color.html#PopplerColor"><span class="type">PopplerColor</span></a> *background_color</code></em>);</pre> | |
<p>Render the selection specified by <em class="parameter"><code>selection</code></em> | |
for <em class="parameter"><code>page</code></em> | |
to | |
the given cairo context. The selection will be rendered, using | |
<em class="parameter"><code>glyph_color</code></em> | |
for the glyphs and <em class="parameter"><code>background_color</code></em> | |
for the selection | |
background.</p> | |
<p>If non-NULL, <em class="parameter"><code>old_selection</code></em> | |
specifies the selection that is already | |
rendered to <em class="parameter"><code>cairo</code></em> | |
, in which case this function will (some day) | |
only render the changed part of the selection.</p> | |
<div class="refsect3"> | |
<a name="poppler-page-render-selection.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>the <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> for which to render selection</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>cairo</p></td> | |
<td class="parameter_description"><p>cairo context to render to</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>selection</p></td> | |
<td class="parameter_description"><p>start and end point of selection as a rectangle</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>old_selection</p></td> | |
<td class="parameter_description"><p>previous selection</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>style</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerSelectionStyle" title="enum PopplerSelectionStyle"><span class="type">PopplerSelectionStyle</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>glyph_color</p></td> | |
<td class="parameter_description"><p>color to use for drawing glyphs</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>background_color</p></td> | |
<td class="parameter_description"><p>color to use for the selection background</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-render-to-ps"></a><h3>poppler_page_render_to_ps ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_page_render_to_ps (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a> *page</code></em>, | |
<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerPSFile"><span class="type">PopplerPSFile</span></a> *ps_file</code></em>);</pre> | |
<p>Render the page on a postscript file</p> | |
<div class="refsect3"> | |
<a name="poppler-page-render-to-ps.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="parameter_name"><p>page</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPage"><span class="type">PopplerPage</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="parameter_name"><p>ps_file</p></td> | |
<td class="parameter_description"><p>the PopplerPSFile to render to</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-selection-region-free"></a><h3>poppler_page_selection_region_free ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_page_selection_region_free (<em class="parameter"><code><span class="type">GList</span> *region</code></em>);</pre> | |
<div class="warning"> | |
<p><code class="literal">poppler_page_selection_region_free</code> has been deprecated since version 0.16 and should not be used in newly-written code.</p> | |
<p>Use only to free deprecated regions created by | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-selection-region" title="poppler_page_get_selection_region ()"><code class="function">poppler_page_get_selection_region()</code></a>. Regions created by | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-get-selected-region" title="poppler_page_get_selected_region ()"><code class="function">poppler_page_get_selected_region()</code></a> should be freed with | |
<code class="function">cairo_region_destroy()</code> instead.</p> | |
</div> | |
<p>Frees <em class="parameter"><code>region</code></em> | |
</p> | |
<div class="refsect3"> | |
<a name="poppler-page-selection-region-free.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>region</p></td> | |
<td class="parameter_description"><p>a <span class="type">GList</span> of | |
<a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a>. </p></td> | |
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> PopplerRectangle]</span></td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-transition-copy"></a><h3>poppler_page_transition_copy ()</h3> | |
<pre class="programlisting"><a class="link" href="poppler-Poppler-Page.html#PopplerPageTransition"><span class="returnvalue">PopplerPageTransition</span></a> * | |
poppler_page_transition_copy (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPageTransition"><span class="type">PopplerPageTransition</span></a> *transition</code></em>);</pre> | |
<p>Creates a copy of <em class="parameter"><code>transition</code></em> | |
</p> | |
<div class="refsect3"> | |
<a name="poppler-page-transition-copy.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>transition</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPageTransition"><span class="type">PopplerPageTransition</span></a> to copy</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-page-transition-copy.returns"></a><h4>Returns</h4> | |
<p> a new allocated copy of <em class="parameter"><code>transition</code></em> | |
</p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-transition-free"></a><h3>poppler_page_transition_free ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_page_transition_free (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPageTransition"><span class="type">PopplerPageTransition</span></a> *transition</code></em>);</pre> | |
<p>Frees the given <a class="link" href="poppler-Poppler-Page.html#PopplerPageTransition"><span class="type">PopplerPageTransition</span></a></p> | |
<div class="refsect3"> | |
<a name="poppler-page-transition-free.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>transition</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPageTransition"><span class="type">PopplerPageTransition</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-page-transition-new"></a><h3>poppler_page_transition_new ()</h3> | |
<pre class="programlisting"><a class="link" href="poppler-Poppler-Page.html#PopplerPageTransition"><span class="returnvalue">PopplerPageTransition</span></a> * | |
poppler_page_transition_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> | |
<p>Creates a new <a class="link" href="poppler-Poppler-Page.html#PopplerPageTransition"><span class="type">PopplerPageTransition</span></a></p> | |
<div class="refsect3"> | |
<a name="poppler-page-transition-new.returns"></a><h4>Returns</h4> | |
<p> a new <a class="link" href="poppler-Poppler-Page.html#PopplerPageTransition"><span class="type">PopplerPageTransition</span></a>, use <a class="link" href="poppler-Poppler-Page.html#poppler-page-transition-free" title="poppler_page_transition_free ()"><code class="function">poppler_page_transition_free()</code></a> to free it</p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-point-copy"></a><h3>poppler_point_copy ()</h3> | |
<pre class="programlisting"><a class="link" href="poppler-Poppler-Page.html#PopplerPoint"><span class="returnvalue">PopplerPoint</span></a> * | |
poppler_point_copy (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPoint"><span class="type">PopplerPoint</span></a> *point</code></em>);</pre> | |
<p>Creates a copy of <em class="parameter"><code>point</code></em> | |
. The copy must be freed with <a class="link" href="poppler-Poppler-Page.html#poppler-point-free" title="poppler_point_free ()"><code class="function">poppler_point_free()</code></a> | |
after use.</p> | |
<div class="refsect3"> | |
<a name="poppler-point-copy.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>point</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPoint"><span class="type">PopplerPoint</span></a> to copy</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-point-copy.returns"></a><h4>Returns</h4> | |
<p> a new allocated copy of <em class="parameter"><code>point</code></em> | |
</p> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-26.html#api-index-0.26">0.26</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-point-free"></a><h3>poppler_point_free ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_point_free (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerPoint"><span class="type">PopplerPoint</span></a> *point</code></em>);</pre> | |
<p>Frees the memory used by <em class="parameter"><code>point</code></em> | |
</p> | |
<div class="refsect3"> | |
<a name="poppler-point-free.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>point</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPoint"><span class="type">PopplerPoint</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-26.html#api-index-0.26">0.26</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-point-new"></a><h3>poppler_point_new ()</h3> | |
<pre class="programlisting"><a class="link" href="poppler-Poppler-Page.html#PopplerPoint"><span class="returnvalue">PopplerPoint</span></a> * | |
poppler_point_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> | |
<p>Creates a new <a class="link" href="poppler-Poppler-Page.html#PopplerPoint"><span class="type">PopplerPoint</span></a>. It must be freed with <a class="link" href="poppler-Poppler-Page.html#poppler-point-free" title="poppler_point_free ()"><code class="function">poppler_point_free()</code></a> after use.</p> | |
<div class="refsect3"> | |
<a name="poppler-point-new.returns"></a><h4>Returns</h4> | |
<p> a new <a class="link" href="poppler-Poppler-Page.html#PopplerPoint"><span class="type">PopplerPoint</span></a></p> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-26.html#api-index-0.26">0.26</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-quadrilateral-copy"></a><h3>poppler_quadrilateral_copy ()</h3> | |
<pre class="programlisting"><a class="link" href="poppler-Poppler-Page.html#PopplerQuadrilateral"><span class="returnvalue">PopplerQuadrilateral</span></a> * | |
poppler_quadrilateral_copy (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerQuadrilateral"><span class="type">PopplerQuadrilateral</span></a> *quad</code></em>);</pre> | |
<p>Creates a copy of <em class="parameter"><code>quad</code></em> | |
. The copy must be freed with <a class="link" href="poppler-Poppler-Page.html#poppler-quadrilateral-free" title="poppler_quadrilateral_free ()"><code class="function">poppler_quadrilateral_free()</code></a> after use.</p> | |
<div class="refsect3"> | |
<a name="poppler-quadrilateral-copy.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>quad</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerQuadrilateral"><span class="type">PopplerQuadrilateral</span></a> to copy</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-quadrilateral-copy.returns"></a><h4>Returns</h4> | |
<p> a new allocated copy of <em class="parameter"><code>quad</code></em> | |
</p> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-26.html#api-index-0.26">0.26</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-quadrilateral-free"></a><h3>poppler_quadrilateral_free ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_quadrilateral_free (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerQuadrilateral"><span class="type">PopplerQuadrilateral</span></a> *quad</code></em>);</pre> | |
<p>Frees the memory used by <em class="parameter"><code>quad</code></em> | |
</p> | |
<div class="refsect3"> | |
<a name="poppler-quadrilateral-free.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>quad</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerQuadrilateral"><span class="type">PopplerQuadrilateral</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-26.html#api-index-0.26">0.26</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-quadrilateral-new"></a><h3>poppler_quadrilateral_new ()</h3> | |
<pre class="programlisting"><a class="link" href="poppler-Poppler-Page.html#PopplerQuadrilateral"><span class="returnvalue">PopplerQuadrilateral</span></a> * | |
poppler_quadrilateral_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> | |
<p>Creates a new <a class="link" href="poppler-Poppler-Page.html#PopplerQuadrilateral"><span class="type">PopplerQuadrilateral</span></a>. It must be freed with <a class="link" href="poppler-Poppler-Page.html#poppler-quadrilateral-free" title="poppler_quadrilateral_free ()"><code class="function">poppler_quadrilateral_free()</code></a> after use.</p> | |
<div class="refsect3"> | |
<a name="poppler-quadrilateral-new.returns"></a><h4>Returns</h4> | |
<p> a new <a class="link" href="poppler-Poppler-Page.html#PopplerQuadrilateral"><span class="type">PopplerQuadrilateral</span></a>.</p> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-26.html#api-index-0.26">0.26</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-rectangle-copy"></a><h3>poppler_rectangle_copy ()</h3> | |
<pre class="programlisting"><a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="returnvalue">PopplerRectangle</span></a> * | |
poppler_rectangle_copy (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> *rectangle</code></em>);</pre> | |
<p>Creates a copy of <em class="parameter"><code>rectangle</code></em> | |
.</p> | |
<p>Note that you must only use this function on an allocated PopplerRectangle, as | |
returned by <a class="link" href="poppler-Poppler-Page.html#poppler-rectangle-new" title="poppler_rectangle_new ()"><code class="function">poppler_rectangle_new()</code></a>, <a class="link" href="poppler-Poppler-Page.html#poppler-rectangle-copy" title="poppler_rectangle_copy ()"><code class="function">poppler_rectangle_copy()</code></a>, or the list elements | |
returned from <a class="link" href="poppler-Poppler-Page.html#poppler-page-find-text" title="poppler_page_find_text ()"><code class="function">poppler_page_find_text()</code></a> or <a class="link" href="poppler-Poppler-Page.html#poppler-page-find-text-with-options" title="poppler_page_find_text_with_options ()"><code class="function">poppler_page_find_text_with_options()</code></a>.</p> | |
<div class="refsect3"> | |
<a name="poppler-rectangle-copy.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>rectangle</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> to copy</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-rectangle-copy.returns"></a><h4>Returns</h4> | |
<p> a new allocated copy of <em class="parameter"><code>rectangle</code></em> | |
</p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-rectangle-find-get-match-continued"></a><h3>poppler_rectangle_find_get_match_continued ()</h3> | |
<pre class="programlisting"><span class="returnvalue">gboolean</span> | |
poppler_rectangle_find_get_match_continued | |
(<em class="parameter"><code>const <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> *rectangle</code></em>);</pre> | |
<p>When using <a class="link" href="poppler-Poppler-Page.html#poppler-page-find-text-with-options" title="poppler_page_find_text_with_options ()"><code class="function">poppler_page_find_text_with_options()</code></a> with the | |
<a class="link" href="poppler-Poppler-Page.html#POPPLER-FIND-MULTILINE:CAPS"><code class="literal">POPPLER_FIND_MULTILINE</code></a> flag, a match may span more than one line | |
and thus consist of more than one rectangle. Every rectangle belonging | |
to the same match will return <code class="literal">TRUE</code> from this function, except for | |
the last rectangle, where this function will return <code class="literal">FALSE</code>.</p> | |
<p>Note that you must only call this function on a <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> | |
returned in the list from <a class="link" href="poppler-Poppler-Page.html#poppler-page-find-text" title="poppler_page_find_text ()"><code class="function">poppler_page_find_text()</code></a> or | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-find-text-with-options" title="poppler_page_find_text_with_options ()"><code class="function">poppler_page_find_text_with_options()</code></a>.</p> | |
<div class="refsect3"> | |
<a name="poppler-rectangle-find-get-match-continued.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>rectangle</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-rectangle-find-get-match-continued.returns"></a><h4>Returns</h4> | |
<p> whether there are more rectangles belonging to the same match</p> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-21-05-0.html#api-index-21.05.0">21.05.0</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-rectangle-find-get-ignored-hyphen"></a><h3>poppler_rectangle_find_get_ignored_hyphen ()</h3> | |
<pre class="programlisting"><span class="returnvalue">gboolean</span> | |
poppler_rectangle_find_get_ignored_hyphen | |
(<em class="parameter"><code>const <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> *rectangle</code></em>);</pre> | |
<p>When using <a class="link" href="poppler-Poppler-Page.html#poppler-page-find-text-with-options" title="poppler_page_find_text_with_options ()"><code class="function">poppler_page_find_text_with_options()</code></a> with the | |
<a class="link" href="poppler-Poppler-Page.html#POPPLER-FIND-MULTILINE:CAPS"><code class="literal">POPPLER_FIND_MULTILINE</code></a> flag, a match may span more than one line, | |
and may have been formed by ignoring a hyphen at the end of the line. | |
When this happens at the end of the line corresponding to <em class="parameter"><code>rectangle</code></em> | |
, | |
this function returns <code class="literal">TRUE</code> (and then <a class="link" href="poppler-Poppler-Page.html#poppler-rectangle-find-get-match-continued" title="poppler_rectangle_find_get_match_continued ()"><code class="function">poppler_rectangle_find_get_match_continued()</code></a> | |
will also return <code class="literal">TRUE</code>); otherwise it returns <code class="literal">FALSE</code>.</p> | |
<p>Note that you must only call this function on a <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> | |
returned in the list from <a class="link" href="poppler-Poppler-Page.html#poppler-page-find-text" title="poppler_page_find_text ()"><code class="function">poppler_page_find_text()</code></a> or | |
<a class="link" href="poppler-Poppler-Page.html#poppler-page-find-text-with-options" title="poppler_page_find_text_with_options ()"><code class="function">poppler_page_find_text_with_options()</code></a>.</p> | |
<div class="refsect3"> | |
<a name="poppler-rectangle-find-get-ignored-hyphen.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>rectangle</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-rectangle-find-get-ignored-hyphen.returns"></a><h4>Returns</h4> | |
<p> whether a hyphen was ignored at the end of the line corresponding to <em class="parameter"><code>rectangle</code></em> | |
.</p> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-21-05-0.html#api-index-21.05.0">21.05.0</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-rectangle-free"></a><h3>poppler_rectangle_free ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_rectangle_free (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> *rectangle</code></em>);</pre> | |
<p>Frees the given <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a>.</p> | |
<p>Note that you must only use this function on an allocated PopplerRectangle, as | |
returned by <a class="link" href="poppler-Poppler-Page.html#poppler-rectangle-new" title="poppler_rectangle_new ()"><code class="function">poppler_rectangle_new()</code></a>, <a class="link" href="poppler-Poppler-Page.html#poppler-rectangle-copy" title="poppler_rectangle_copy ()"><code class="function">poppler_rectangle_copy()</code></a>, or the list elements | |
returned from <a class="link" href="poppler-Poppler-Page.html#poppler-page-find-text" title="poppler_page_find_text ()"><code class="function">poppler_page_find_text()</code></a> or <a class="link" href="poppler-Poppler-Page.html#poppler-page-find-text-with-options" title="poppler_page_find_text_with_options ()"><code class="function">poppler_page_find_text_with_options()</code></a>.</p> | |
<div class="refsect3"> | |
<a name="poppler-rectangle-free.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>rectangle</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-rectangle-new"></a><h3>poppler_rectangle_new ()</h3> | |
<pre class="programlisting"><a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="returnvalue">PopplerRectangle</span></a> * | |
poppler_rectangle_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> | |
<p>Creates a new <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a></p> | |
<div class="refsect3"> | |
<a name="poppler-rectangle-new.returns"></a><h4>Returns</h4> | |
<p> a new <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a>, use <a class="link" href="poppler-Poppler-Page.html#poppler-rectangle-free" title="poppler_rectangle_free ()"><code class="function">poppler_rectangle_free()</code></a> to free it</p> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-text-attributes-copy"></a><h3>poppler_text_attributes_copy ()</h3> | |
<pre class="programlisting"><a class="link" href="poppler-Poppler-Page.html#PopplerTextAttributes"><span class="returnvalue">PopplerTextAttributes</span></a> * | |
poppler_text_attributes_copy (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerTextAttributes"><span class="type">PopplerTextAttributes</span></a> *text_attrs</code></em>);</pre> | |
<p>Creates a copy of <em class="parameter"><code>text_attrs</code></em> | |
</p> | |
<div class="refsect3"> | |
<a name="poppler-text-attributes-copy.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>text_attrs</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerTextAttributes"><span class="type">PopplerTextAttributes</span></a> to copy</p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<div class="refsect3"> | |
<a name="poppler-text-attributes-copy.returns"></a><h4>Returns</h4> | |
<p> a new allocated copy of <em class="parameter"><code>text_attrs</code></em> | |
</p> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-18.html#api-index-0.18">0.18</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-text-attributes-free"></a><h3>poppler_text_attributes_free ()</h3> | |
<pre class="programlisting"><span class="returnvalue">void</span> | |
poppler_text_attributes_free (<em class="parameter"><code><a class="link" href="poppler-Poppler-Page.html#PopplerTextAttributes"><span class="type">PopplerTextAttributes</span></a> *text_attrs</code></em>);</pre> | |
<p>Frees the given <a class="link" href="poppler-Poppler-Page.html#PopplerTextAttributes"><span class="type">PopplerTextAttributes</span></a></p> | |
<div class="refsect3"> | |
<a name="poppler-text-attributes-free.parameters"></a><h4>Parameters</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="150px" class="parameters_name"> | |
<col class="parameters_description"> | |
<col width="200px" class="parameters_annotations"> | |
</colgroup> | |
<tbody><tr> | |
<td class="parameter_name"><p>text_attrs</p></td> | |
<td class="parameter_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerTextAttributes"><span class="type">PopplerTextAttributes</span></a></p></td> | |
<td class="parameter_annotations"> </td> | |
</tr></tbody> | |
</table></div> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-18.html#api-index-0.18">0.18</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="poppler-text-attributes-new"></a><h3>poppler_text_attributes_new ()</h3> | |
<pre class="programlisting"><a class="link" href="poppler-Poppler-Page.html#PopplerTextAttributes"><span class="returnvalue">PopplerTextAttributes</span></a> * | |
poppler_text_attributes_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> | |
<p>Creates a new <a class="link" href="poppler-Poppler-Page.html#PopplerTextAttributes"><span class="type">PopplerTextAttributes</span></a></p> | |
<div class="refsect3"> | |
<a name="poppler-text-attributes-new.returns"></a><h4>Returns</h4> | |
<p> a new <a class="link" href="poppler-Poppler-Page.html#PopplerTextAttributes"><span class="type">PopplerTextAttributes</span></a>, use <a class="link" href="poppler-Poppler-Page.html#poppler-text-attributes-free" title="poppler_text_attributes_free ()"><code class="function">poppler_text_attributes_free()</code></a> to free it</p> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-18.html#api-index-0.18">0.18</a></p> | |
</div> | |
</div> | |
<div class="refsect1"> | |
<a name="poppler-Poppler-Page.other_details"></a><h2>Types and Values</h2> | |
<div class="refsect2"> | |
<a name="PopplerAnnotMapping-struct"></a><h3>PopplerAnnotMapping</h3> | |
<pre class="programlisting">typedef struct { | |
PopplerRectangle area; | |
PopplerAnnot *annot; | |
} PopplerAnnotMapping; | |
</pre> | |
<p>A <a class="link" href="poppler-Poppler-Page.html#PopplerAnnotMapping"><span class="type">PopplerAnnotMapping</span></a> structure represents the location | |
of <em class="parameter"><code>annot</code></em> | |
on the page</p> | |
<div class="refsect3"> | |
<a name="PopplerAnnotMapping.members"></a><h4>Members</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="300px" class="struct_members_name"> | |
<col class="struct_members_description"> | |
<col width="200px" class="struct_members_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="struct_member_name"><p><a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> <em class="structfield"><code><a name="PopplerAnnotMapping-struct.area"></a>area</code></em>;</p></td> | |
<td class="struct_member_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> representing an area of the page</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><a class="link" href="poppler-Poppler-Annotation.html#PopplerAnnot"><span class="type">PopplerAnnot</span></a> *<em class="structfield"><code><a name="PopplerAnnotMapping-struct.annot"></a>annot</code></em>;</p></td> | |
<td class="struct_member_description"><p>a <a class="link" href="poppler-Poppler-Annotation.html#PopplerAnnot"><span class="type">PopplerAnnot</span></a></p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="PopplerFindFlags"></a><h3>enum PopplerFindFlags</h3> | |
<p>Flags using while searching text in a page</p> | |
<div class="refsect3"> | |
<a name="PopplerFindFlags.members"></a><h4>Members</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="300px" class="enum_members_name"> | |
<col class="enum_members_description"> | |
<col width="200px" class="enum_members_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-FIND-DEFAULT:CAPS"></a>POPPLER_FIND_DEFAULT</p></td> | |
<td class="enum_member_description"> | |
<p>use default search settings</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-FIND-CASE-SENSITIVE:CAPS"></a>POPPLER_FIND_CASE_SENSITIVE</p></td> | |
<td class="enum_member_description"> | |
<p>do case sensitive search</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-FIND-BACKWARDS:CAPS"></a>POPPLER_FIND_BACKWARDS</p></td> | |
<td class="enum_member_description"> | |
<p>search backwards</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-FIND-WHOLE-WORDS-ONLY:CAPS"></a>POPPLER_FIND_WHOLE_WORDS_ONLY</p></td> | |
<td class="enum_member_description"> | |
<p>search only whole words</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-FIND-IGNORE-DIACRITICS:CAPS"></a>POPPLER_FIND_IGNORE_DIACRITICS</p></td> | |
<td class="enum_member_description"> | |
<p>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.</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-FIND-MULTILINE:CAPS"></a>POPPLER_FIND_MULTILINE</p></td> | |
<td class="enum_member_description"> | |
<p>allows to match on text spanning from | |
end of a line to the next line. (Currently it won't match on text spanning | |
more than two lines.) Automatically ignores hyphen at end of line, and | |
allows whitespace in search term to match on newline char. Since: 21.05.0.</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-22.html#api-index-0.22">0.22</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="PopplerFormFieldMapping-struct"></a><h3>PopplerFormFieldMapping</h3> | |
<pre class="programlisting">typedef struct { | |
PopplerRectangle area; | |
PopplerFormField *field; | |
} PopplerFormFieldMapping; | |
</pre> | |
<p>A <a class="link" href="poppler-Poppler-Page.html#PopplerFormFieldMapping"><span class="type">PopplerFormFieldMapping</span></a> structure represents the location | |
of <em class="parameter"><code>field</code></em> | |
on the page</p> | |
<div class="refsect3"> | |
<a name="PopplerFormFieldMapping.members"></a><h4>Members</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="300px" class="struct_members_name"> | |
<col class="struct_members_description"> | |
<col width="200px" class="struct_members_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="struct_member_name"><p><a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> <em class="structfield"><code><a name="PopplerFormFieldMapping-struct.area"></a>area</code></em>;</p></td> | |
<td class="struct_member_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> representing an area of the page</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><a class="link" href="PopplerFormField.html" title="PopplerFormField"><span class="type">PopplerFormField</span></a> *<em class="structfield"><code><a name="PopplerFormFieldMapping-struct.field"></a>field</code></em>;</p></td> | |
<td class="struct_member_description"><p>a <a class="link" href="PopplerFormField.html" title="PopplerFormField"><span class="type">PopplerFormField</span></a></p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="PopplerImageMapping-struct"></a><h3>PopplerImageMapping</h3> | |
<pre class="programlisting">typedef struct { | |
PopplerRectangle area; | |
gint image_id; | |
} PopplerImageMapping; | |
</pre> | |
<p>A <a class="link" href="poppler-Poppler-Page.html#PopplerImageMapping"><span class="type">PopplerImageMapping</span></a> structure represents the location | |
of an image on the page</p> | |
<div class="refsect3"> | |
<a name="PopplerImageMapping.members"></a><h4>Members</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="300px" class="struct_members_name"> | |
<col class="struct_members_description"> | |
<col width="200px" class="struct_members_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="struct_member_name"><p><a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> <em class="structfield"><code><a name="PopplerImageMapping-struct.area"></a>area</code></em>;</p></td> | |
<td class="struct_member_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> representing an area of the page</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="PopplerImageMapping-struct.image-id"></a>image_id</code></em>;</p></td> | |
<td class="struct_member_description"><p>an image identifier</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="PopplerLinkMapping-struct"></a><h3>PopplerLinkMapping</h3> | |
<pre class="programlisting">typedef struct { | |
PopplerRectangle area; | |
PopplerAction *action; | |
} PopplerLinkMapping; | |
</pre> | |
<p>A <a class="link" href="poppler-Poppler-Page.html#PopplerLinkMapping"><span class="type">PopplerLinkMapping</span></a> structure represents the location | |
of <em class="parameter"><code>action</code></em> | |
on the page</p> | |
<div class="refsect3"> | |
<a name="PopplerLinkMapping.members"></a><h4>Members</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="300px" class="struct_members_name"> | |
<col class="struct_members_description"> | |
<col width="200px" class="struct_members_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="struct_member_name"><p><a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> <em class="structfield"><code><a name="PopplerLinkMapping-struct.area"></a>area</code></em>;</p></td> | |
<td class="struct_member_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> representing an area of the page</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><a class="link" href="PopplerAction.html" title="PopplerAction"><span class="type">PopplerAction</span></a> *<em class="structfield"><code><a name="PopplerLinkMapping-struct.action"></a>action</code></em>;</p></td> | |
<td class="struct_member_description"><p>a <a class="link" href="PopplerAction.html" title="PopplerAction"><span class="type">PopplerAction</span></a></p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="PopplerPage-struct"></a><h3>PopplerPage</h3> | |
<pre class="programlisting">typedef struct _PopplerPage PopplerPage;</pre> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="PopplerPageTransition-struct"></a><h3>PopplerPageTransition</h3> | |
<pre class="programlisting">typedef struct { | |
PopplerPageTransitionType type; | |
PopplerPageTransitionAlignment alignment; | |
PopplerPageTransitionDirection direction; | |
gint duration; | |
gint angle; | |
gdouble scale; | |
gboolean rectangular; | |
gdouble duration_real; | |
} PopplerPageTransition; | |
</pre> | |
<p>A <a class="link" href="poppler-Poppler-Page.html#PopplerPageTransition"><span class="type">PopplerPageTransition</span></a> structures describes a visual transition | |
to use when moving between pages during a presentation</p> | |
<div class="refsect3"> | |
<a name="PopplerPageTransition.members"></a><h4>Members</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="300px" class="struct_members_name"> | |
<col class="struct_members_description"> | |
<col width="200px" class="struct_members_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="struct_member_name"><p><a class="link" href="poppler-Poppler-Page.html#PopplerPageTransitionType" title="enum PopplerPageTransitionType"><span class="type">PopplerPageTransitionType</span></a> <em class="structfield"><code><a name="PopplerPageTransition-struct.type"></a>type</code></em>;</p></td> | |
<td class="struct_member_description"><p>the type of transtition</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><a class="link" href="poppler-Poppler-Page.html#PopplerPageTransitionAlignment" title="enum PopplerPageTransitionAlignment"><span class="type">PopplerPageTransitionAlignment</span></a> <em class="structfield"><code><a name="PopplerPageTransition-struct.alignment"></a>alignment</code></em>;</p></td> | |
<td class="struct_member_description"><p>the dimension in which the transition effect shall occur. | |
Only for <a class="link" href="poppler-Poppler-Page.html#POPPLER-PAGE-TRANSITION-SPLIT:CAPS"><span class="type">POPPLER_PAGE_TRANSITION_SPLIT</span></a> and <a class="link" href="poppler-Poppler-Page.html#POPPLER-PAGE-TRANSITION-BLINDS:CAPS"><span class="type">POPPLER_PAGE_TRANSITION_BLINDS</span></a> transition types</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><a class="link" href="poppler-Poppler-Page.html#PopplerPageTransitionDirection" title="enum PopplerPageTransitionDirection"><span class="type">PopplerPageTransitionDirection</span></a> <em class="structfield"><code><a name="PopplerPageTransition-struct.direction"></a>direction</code></em>;</p></td> | |
<td class="struct_member_description"><p>the direction of motion for the transition effect. | |
Only for <a class="link" href="poppler-Poppler-Page.html#POPPLER-PAGE-TRANSITION-SPLIT:CAPS"><span class="type">POPPLER_PAGE_TRANSITION_SPLIT</span></a>, <a class="link" href="poppler-Poppler-Page.html#POPPLER-PAGE-TRANSITION-BOX:CAPS"><span class="type">POPPLER_PAGE_TRANSITION_BOX</span></a> and <a class="link" href="poppler-Poppler-Page.html#POPPLER-PAGE-TRANSITION-FLY:CAPS"><span class="type">POPPLER_PAGE_TRANSITION_FLY</span></a> | |
transition types</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="PopplerPageTransition-struct.duration"></a>duration</code></em>;</p></td> | |
<td class="struct_member_description"><p>the duration of the transition effect</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="PopplerPageTransition-struct.angle"></a>angle</code></em>;</p></td> | |
<td class="struct_member_description"><p>the direction in which the specified transition effect shall moves, | |
expressed in degrees counterclockwise starting from a left-to-right direction. | |
Only for <a class="link" href="poppler-Poppler-Page.html#POPPLER-PAGE-TRANSITION-WIPE:CAPS"><span class="type">POPPLER_PAGE_TRANSITION_WIPE</span></a>, <a class="link" href="poppler-Poppler-Page.html#POPPLER-PAGE-TRANSITION-GLITTER:CAPS"><span class="type">POPPLER_PAGE_TRANSITION_GLITTER</span></a>, <a class="link" href="poppler-Poppler-Page.html#POPPLER-PAGE-TRANSITION-FLY:CAPS"><span class="type">POPPLER_PAGE_TRANSITION_FLY</span></a>, | |
<a class="link" href="poppler-Poppler-Page.html#POPPLER-PAGE-TRANSITION-COVER:CAPS"><span class="type">POPPLER_PAGE_TRANSITION_COVER</span></a>, <a class="link" href="poppler-Poppler-Page.html#POPPLER-PAGE-TRANSITION-UNCOVER:CAPS"><span class="type">POPPLER_PAGE_TRANSITION_UNCOVER</span></a> and <a class="link" href="poppler-Poppler-Page.html#POPPLER-PAGE-TRANSITION-PUSH:CAPS"><span class="type">POPPLER_PAGE_TRANSITION_PUSH</span></a> | |
transition types</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><span class="type">gdouble</span> <em class="structfield"><code><a name="PopplerPageTransition-struct.scale"></a>scale</code></em>;</p></td> | |
<td class="struct_member_description"><p>the starting or ending scale at which the changes shall be drawn. | |
Only for <a class="link" href="poppler-Poppler-Page.html#POPPLER-PAGE-TRANSITION-FLY:CAPS"><span class="type">POPPLER_PAGE_TRANSITION_FLY</span></a> transition type</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><span class="type">gboolean</span> <em class="structfield"><code><a name="PopplerPageTransition-struct.rectangular"></a>rectangular</code></em>;</p></td> | |
<td class="struct_member_description"><p>whether the area that will be flown is rectangular and opaque. | |
Only for <a class="link" href="poppler-Poppler-Page.html#POPPLER-PAGE-TRANSITION-FLY:CAPS"><span class="type">POPPLER_PAGE_TRANSITION_FLY</span></a> transition type</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><span class="type">gdouble</span> <em class="structfield"><code><a name="PopplerPageTransition-struct.duration-real"></a>duration_real</code></em>;</p></td> | |
<td> </td> | |
<td> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="PopplerPageTransitionAlignment"></a><h3>enum PopplerPageTransitionAlignment</h3> | |
<p>Page transition alignment types for <a class="link" href="poppler-Poppler-Page.html#POPPLER-PAGE-TRANSITION-SPLIT:CAPS"><span class="type">POPPLER_PAGE_TRANSITION_SPLIT</span></a> | |
and <a class="link" href="poppler-Poppler-Page.html#POPPLER-PAGE-TRANSITION-BLINDS:CAPS"><span class="type">POPPLER_PAGE_TRANSITION_BLINDS</span></a> transition types</p> | |
<div class="refsect3"> | |
<a name="PopplerPageTransitionAlignment.members"></a><h4>Members</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="300px" class="enum_members_name"> | |
<col class="enum_members_description"> | |
<col width="200px" class="enum_members_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-PAGE-TRANSITION-HORIZONTAL:CAPS"></a>POPPLER_PAGE_TRANSITION_HORIZONTAL</p></td> | |
<td class="enum_member_description"> | |
<p>horizontal dimension</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-PAGE-TRANSITION-VERTICAL:CAPS"></a>POPPLER_PAGE_TRANSITION_VERTICAL</p></td> | |
<td class="enum_member_description"> | |
<p>vertical dimension</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="PopplerPageTransitionDirection"></a><h3>enum PopplerPageTransitionDirection</h3> | |
<p>Page transition direction types for <a class="link" href="poppler-Poppler-Page.html#POPPLER-PAGE-TRANSITION-SPLIT:CAPS"><span class="type">POPPLER_PAGE_TRANSITION_SPLIT</span></a>, | |
<a class="link" href="poppler-Poppler-Page.html#POPPLER-PAGE-TRANSITION-BOX:CAPS"><span class="type">POPPLER_PAGE_TRANSITION_BOX</span></a> and <a class="link" href="poppler-Poppler-Page.html#POPPLER-PAGE-TRANSITION-FLY:CAPS"><span class="type">POPPLER_PAGE_TRANSITION_FLY</span></a> transition types</p> | |
<div class="refsect3"> | |
<a name="PopplerPageTransitionDirection.members"></a><h4>Members</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="300px" class="enum_members_name"> | |
<col class="enum_members_description"> | |
<col width="200px" class="enum_members_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-PAGE-TRANSITION-INWARD:CAPS"></a>POPPLER_PAGE_TRANSITION_INWARD</p></td> | |
<td class="enum_member_description"> | |
<p>inward from the edges of the page</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-PAGE-TRANSITION-OUTWARD:CAPS"></a>POPPLER_PAGE_TRANSITION_OUTWARD</p></td> | |
<td class="enum_member_description"> | |
<p>outward from the center of the page</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="PopplerPageTransitionType"></a><h3>enum PopplerPageTransitionType</h3> | |
<p>Page transition types</p> | |
<div class="refsect3"> | |
<a name="PopplerPageTransitionType.members"></a><h4>Members</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="300px" class="enum_members_name"> | |
<col class="enum_members_description"> | |
<col width="200px" class="enum_members_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-PAGE-TRANSITION-REPLACE:CAPS"></a>POPPLER_PAGE_TRANSITION_REPLACE</p></td> | |
<td class="enum_member_description"> | |
<p>the new page replace the old one</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-PAGE-TRANSITION-SPLIT:CAPS"></a>POPPLER_PAGE_TRANSITION_SPLIT</p></td> | |
<td class="enum_member_description"> | |
<p>two lines sweep across the screen, revealing the new page</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-PAGE-TRANSITION-BLINDS:CAPS"></a>POPPLER_PAGE_TRANSITION_BLINDS</p></td> | |
<td class="enum_member_description"> | |
<p>multiple lines, evenly spaced across the screen, synchronously | |
sweep in the same direction to reveal the new page</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-PAGE-TRANSITION-BOX:CAPS"></a>POPPLER_PAGE_TRANSITION_BOX</p></td> | |
<td class="enum_member_description"> | |
<p>a rectangular box sweeps inward from the edges of the page or | |
outward from the center revealing the new page</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-PAGE-TRANSITION-WIPE:CAPS"></a>POPPLER_PAGE_TRANSITION_WIPE</p></td> | |
<td class="enum_member_description"> | |
<p>a single line sweeps across the screen from one edge to the other | |
revealing the new page</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-PAGE-TRANSITION-DISSOLVE:CAPS"></a>POPPLER_PAGE_TRANSITION_DISSOLVE</p></td> | |
<td class="enum_member_description"> | |
<p>the old page dissolves gradually to reveal the new one</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-PAGE-TRANSITION-GLITTER:CAPS"></a>POPPLER_PAGE_TRANSITION_GLITTER</p></td> | |
<td class="enum_member_description"> | |
<p>similar to <a class="link" href="poppler-Poppler-Page.html#POPPLER-PAGE-TRANSITION-DISSOLVE:CAPS"><span class="type">POPPLER_PAGE_TRANSITION_DISSOLVE</span></a>, except that the effect | |
sweeps across the page in a wide band moving from one side of the screen to the other</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-PAGE-TRANSITION-FLY:CAPS"></a>POPPLER_PAGE_TRANSITION_FLY</p></td> | |
<td class="enum_member_description"> | |
<p>changes are flown out or in to or from a location that is offscreen</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-PAGE-TRANSITION-PUSH:CAPS"></a>POPPLER_PAGE_TRANSITION_PUSH</p></td> | |
<td class="enum_member_description"> | |
<p>the old page slides off the screen while the new page slides in</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-PAGE-TRANSITION-COVER:CAPS"></a>POPPLER_PAGE_TRANSITION_COVER</p></td> | |
<td class="enum_member_description"> | |
<p>the new page slides on to the screen covering the old page</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-PAGE-TRANSITION-UNCOVER:CAPS"></a>POPPLER_PAGE_TRANSITION_UNCOVER</p></td> | |
<td class="enum_member_description"> | |
<p>the old page slides off the screen uncovering the new page</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-PAGE-TRANSITION-FADE:CAPS"></a>POPPLER_PAGE_TRANSITION_FADE</p></td> | |
<td class="enum_member_description"> | |
<p>the new page gradually becomes visible through the old one</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="PopplerPoint-struct"></a><h3>PopplerPoint</h3> | |
<pre class="programlisting">typedef struct { | |
gdouble x; | |
gdouble y; | |
} PopplerPoint; | |
</pre> | |
<p>A <a class="link" href="poppler-Poppler-Page.html#PopplerPoint"><span class="type">PopplerPoint</span></a> is used to describe a location point on a page</p> | |
<div class="refsect3"> | |
<a name="PopplerPoint.members"></a><h4>Members</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="300px" class="struct_members_name"> | |
<col class="struct_members_description"> | |
<col width="200px" class="struct_members_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="struct_member_name"><p><span class="type">gdouble</span> <em class="structfield"><code><a name="PopplerPoint-struct.x"></a>x</code></em>;</p></td> | |
<td class="struct_member_description"><p>x coordinate</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><span class="type">gdouble</span> <em class="structfield"><code><a name="PopplerPoint-struct.y"></a>y</code></em>;</p></td> | |
<td class="struct_member_description"><p>y coordinate</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="PopplerPrintFlags"></a><h3>enum PopplerPrintFlags</h3> | |
<p>Printing flags</p> | |
<div class="refsect3"> | |
<a name="PopplerPrintFlags.members"></a><h4>Members</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="300px" class="enum_members_name"> | |
<col class="enum_members_description"> | |
<col width="200px" class="enum_members_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-PRINT-DOCUMENT:CAPS"></a>POPPLER_PRINT_DOCUMENT</p></td> | |
<td class="enum_member_description"> | |
<p>print main document contents</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-PRINT-MARKUP-ANNOTS:CAPS"></a>POPPLER_PRINT_MARKUP_ANNOTS</p></td> | |
<td class="enum_member_description"> | |
<p>print document and markup annotations</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-PRINT-STAMP-ANNOTS-ONLY:CAPS"></a>POPPLER_PRINT_STAMP_ANNOTS_ONLY</p></td> | |
<td class="enum_member_description"> | |
<p>print document and only stamp annotations</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-PRINT-ALL:CAPS"></a>POPPLER_PRINT_ALL</p></td> | |
<td class="enum_member_description"> | |
<p>print main document contents and all markup annotations</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-16.html#api-index-0.16">0.16</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="PopplerQuadrilateral-struct"></a><h3>PopplerQuadrilateral</h3> | |
<pre class="programlisting">typedef struct { | |
PopplerPoint p1; | |
PopplerPoint p2; | |
PopplerPoint p3; | |
PopplerPoint p4; | |
} PopplerQuadrilateral; | |
</pre> | |
<p>A <a class="link" href="poppler-Poppler-Page.html#PopplerQuadrilateral"><span class="type">PopplerQuadrilateral</span></a> is used to describe rectangle-like polygon | |
with arbitrary inclination on a page.</p> | |
<div class="refsect3"> | |
<a name="PopplerQuadrilateral.members"></a><h4>Members</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="300px" class="struct_members_name"> | |
<col class="struct_members_description"> | |
<col width="200px" class="struct_members_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="struct_member_name"><p><a class="link" href="poppler-Poppler-Page.html#PopplerPoint"><span class="type">PopplerPoint</span></a> <em class="structfield"><code><a name="PopplerQuadrilateral-struct.p1"></a>p1</code></em>;</p></td> | |
<td class="struct_member_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPoint"><span class="type">PopplerPoint</span></a> with the first vertex coordinates</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><a class="link" href="poppler-Poppler-Page.html#PopplerPoint"><span class="type">PopplerPoint</span></a> <em class="structfield"><code><a name="PopplerQuadrilateral-struct.p2"></a>p2</code></em>;</p></td> | |
<td class="struct_member_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPoint"><span class="type">PopplerPoint</span></a> with the second vertex coordinates</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><a class="link" href="poppler-Poppler-Page.html#PopplerPoint"><span class="type">PopplerPoint</span></a> <em class="structfield"><code><a name="PopplerQuadrilateral-struct.p3"></a>p3</code></em>;</p></td> | |
<td class="struct_member_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPoint"><span class="type">PopplerPoint</span></a> with the third vertex coordinates</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><a class="link" href="poppler-Poppler-Page.html#PopplerPoint"><span class="type">PopplerPoint</span></a> <em class="structfield"><code><a name="PopplerQuadrilateral-struct.p4"></a>p4</code></em>;</p></td> | |
<td class="struct_member_description"><p>a <a class="link" href="poppler-Poppler-Page.html#PopplerPoint"><span class="type">PopplerPoint</span></a> with the fourth vertex coordinates</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-26.html#api-index-0.26">0.26</a></p> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="PopplerRectangle-struct"></a><h3>PopplerRectangle</h3> | |
<pre class="programlisting">typedef struct { | |
gdouble x1; | |
gdouble y1; | |
gdouble x2; | |
gdouble y2; | |
} PopplerRectangle; | |
</pre> | |
<p>A <a class="link" href="poppler-Poppler-Page.html#PopplerRectangle"><span class="type">PopplerRectangle</span></a> is used to describe | |
locations on a page and bounding boxes</p> | |
<div class="refsect3"> | |
<a name="PopplerRectangle.members"></a><h4>Members</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="300px" class="struct_members_name"> | |
<col class="struct_members_description"> | |
<col width="200px" class="struct_members_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="struct_member_name"><p><span class="type">gdouble</span> <em class="structfield"><code><a name="PopplerRectangle-struct.x1"></a>x1</code></em>;</p></td> | |
<td class="struct_member_description"><p>x coordinate of lower left corner</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><span class="type">gdouble</span> <em class="structfield"><code><a name="PopplerRectangle-struct.y1"></a>y1</code></em>;</p></td> | |
<td class="struct_member_description"><p>y coordinate of lower left corner</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><span class="type">gdouble</span> <em class="structfield"><code><a name="PopplerRectangle-struct.x2"></a>x2</code></em>;</p></td> | |
<td class="struct_member_description"><p>x coordinate of upper right corner</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><span class="type">gdouble</span> <em class="structfield"><code><a name="PopplerRectangle-struct.y2"></a>y2</code></em>;</p></td> | |
<td class="struct_member_description"><p>y coordinate of upper right corner</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="PopplerSelectionStyle"></a><h3>enum PopplerSelectionStyle</h3> | |
<p>Selection styles</p> | |
<div class="refsect3"> | |
<a name="PopplerSelectionStyle.members"></a><h4>Members</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="300px" class="enum_members_name"> | |
<col class="enum_members_description"> | |
<col width="200px" class="enum_members_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-SELECTION-GLYPH:CAPS"></a>POPPLER_SELECTION_GLYPH</p></td> | |
<td class="enum_member_description"> | |
<p>glyph is the minimum unit for selection</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-SELECTION-WORD:CAPS"></a>POPPLER_SELECTION_WORD</p></td> | |
<td class="enum_member_description"> | |
<p>word is the minimum unit for selection</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="enum_member_name"><p><a name="POPPLER-SELECTION-LINE:CAPS"></a>POPPLER_SELECTION_LINE</p></td> | |
<td class="enum_member_description"> | |
<p>line is the minimum unit for selection</p> | |
</td> | |
<td class="enum_member_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
</div> | |
<hr> | |
<div class="refsect2"> | |
<a name="PopplerTextAttributes-struct"></a><h3>PopplerTextAttributes</h3> | |
<pre class="programlisting">typedef struct { | |
gchar *font_name; | |
gdouble font_size; | |
gboolean is_underlined; | |
PopplerColor color; | |
gint start_index; | |
gint end_index; | |
} PopplerTextAttributes; | |
</pre> | |
<p>A <a class="link" href="poppler-Poppler-Page.html#PopplerTextAttributes"><span class="type">PopplerTextAttributes</span></a> is used to describe text attributes of a range of text</p> | |
<div class="refsect3"> | |
<a name="PopplerTextAttributes.members"></a><h4>Members</h4> | |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
<colgroup> | |
<col width="300px" class="struct_members_name"> | |
<col class="struct_members_description"> | |
<col width="200px" class="struct_members_annotations"> | |
</colgroup> | |
<tbody> | |
<tr> | |
<td class="struct_member_name"><p><span class="type">gchar</span> *<em class="structfield"><code><a name="PopplerTextAttributes-struct.font-name"></a>font_name</code></em>;</p></td> | |
<td class="struct_member_description"><p>font name</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><span class="type">gdouble</span> <em class="structfield"><code><a name="PopplerTextAttributes-struct.font-size"></a>font_size</code></em>;</p></td> | |
<td class="struct_member_description"><p>font size</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><span class="type">gboolean</span> <em class="structfield"><code><a name="PopplerTextAttributes-struct.is-underlined"></a>is_underlined</code></em>;</p></td> | |
<td class="struct_member_description"><p>if text is underlined</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><a class="link" href="poppler-Poppler-Color.html#PopplerColor"><span class="type">PopplerColor</span></a> <em class="structfield"><code><a name="PopplerTextAttributes-struct.color"></a>color</code></em>;</p></td> | |
<td class="struct_member_description"><p>a <a class="link" href="poppler-Poppler-Color.html#PopplerColor"><span class="type">PopplerColor</span></a>, the foreground color</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="PopplerTextAttributes-struct.start-index"></a>start_index</code></em>;</p></td> | |
<td class="struct_member_description"><p>start position this text attributes apply</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
<tr> | |
<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="PopplerTextAttributes-struct.end-index"></a>end_index</code></em>;</p></td> | |
<td class="struct_member_description"><p>end position this text attributes apply</p></td> | |
<td class="struct_member_annotations"> </td> | |
</tr> | |
</tbody> | |
</table></div> | |
</div> | |
<p class="since">Since: <a class="link" href="api-index-0-18.html#api-index-0.18">0.18</a></p> | |
</div> | |
</div> | |
<div class="refsect1"> | |
<a name="poppler-Poppler-Page.property-details"></a><h2>Property Details</h2> | |
<div class="refsect2"> | |
<a name="PopplerPage--label"></a><h3>The <code class="literal">“label”</code> property</h3> | |
<pre class="programlisting"> “label” <span class="type">char</span> *</pre> | |
<p>The label of the page or <code class="literal">NULL</code>. See also <a class="link" href="poppler-Poppler-Page.html#poppler-page-get-label" title="poppler_page_get_label ()"><code class="function">poppler_page_get_label()</code></a></p> | |
<p>Owner: PopplerPage</p> | |
<p>Flags: Read</p> | |
<p>Default value: NULL</p> | |
</div> | |
</div> | |
</div> | |
<div class="footer"> | |
<hr>Generated by GTK-Doc V1.34.0</div> | |
</body> | |
</html> |