8
8
<link rel="up" href="ch01.html" title="Poppler">
9
9
<link rel="prev" href="poppler-poppler.html" title="poppler">
10
10
<link rel="next" href="PopplerPage.html" title="PopplerPage">
11
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
30
30
<a href="#PopplerDocument.properties" class="shortcut">Properties</a>
33
<div class="refentry" title="PopplerDocument">
33
<div class="refentry">
34
34
<a name="PopplerDocument"></a><div class="titlepage"></div>
35
35
<div class="refnamediv"><table width="100%"><tr>
40
40
<td valign="top" align="right"></td>
41
41
</tr></table></div>
42
<div class="refsynopsisdiv" title="Synopsis">
42
<div class="refsynopsisdiv">
43
43
<a name="PopplerDocument.synopsis"></a><h2>Synopsis</h2>
44
44
<pre class="synopsis">
45
45
#include <poppler.h>
141
141
<em class="parameter"><code><span class="type">gboolean</span> duplex</code></em>);
144
<div class="refsect1" title="Object Hierarchy">
144
<div class="refsect1">
145
145
<a name="PopplerDocument.object-hierarchy"></a><h2>Object Hierarchy</h2>
146
146
<pre class="synopsis">
148
148
+----PopplerDocument
151
<div class="refsect1" title="Properties">
151
<div class="refsect1">
152
152
<a name="PopplerDocument.properties"></a><h2>Properties</h2>
153
153
<pre class="synopsis">
154
154
"<a class="link" href="PopplerDocument.html#PopplerDocument--author" title='The "author" property'>author</a>" <span class="type">gchar</span>* : Read
170
170
"<a class="link" href="PopplerDocument.html#PopplerDocument--viewer-preferences" title='The "viewer-preferences" property'>viewer-preferences</a>" <a class="link" href="PopplerDocument.html#PopplerViewerPreferences" title="enum PopplerViewerPreferences"><span class="type">PopplerViewerPreferences</span></a> : Read
173
<div class="refsect1" title="Description">
173
<div class="refsect1">
174
174
<a name="PopplerDocument.description"></a><h2>Description</h2>
176
176
The <a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> is an object used to refer to a main document.
179
<div class="refsect1" title="Details">
179
<div class="refsect1">
180
180
<a name="PopplerDocument.details"></a><h2>Details</h2>
181
<div class="refsect2" title="PopplerDocument">
181
<div class="refsect2">
182
182
<a name="PopplerDocument-struct"></a><h3>PopplerDocument</h3>
183
183
<pre class="programlisting">typedef struct _PopplerDocument PopplerDocument;</pre>
186
<div class="refsect2" title="PopplerIndexIter">
186
<div class="refsect2">
187
187
<a name="PopplerIndexIter"></a><h3>PopplerIndexIter</h3>
188
188
<pre class="programlisting">typedef struct _PopplerIndexIter PopplerIndexIter;</pre>
191
<div class="refsect2" title="PopplerFontsIter">
191
<div class="refsect2">
192
192
<a name="PopplerFontsIter"></a><h3>PopplerFontsIter</h3>
193
193
<pre class="programlisting">typedef struct _PopplerFontsIter PopplerFontsIter;</pre>
196
<div class="refsect2" title="PopplerLayersIter">
196
<div class="refsect2">
197
197
<a name="PopplerLayersIter"></a><h3>PopplerLayersIter</h3>
198
198
<pre class="programlisting">typedef struct _PopplerLayersIter PopplerLayersIter;</pre>
201
<div class="refsect2" title="enum PopplerPageLayout">
201
<div class="refsect2">
202
202
<a name="PopplerPageLayout"></a><h3>enum PopplerPageLayout</h3>
203
203
<pre class="programlisting">typedef enum
317
<div class="refsect2" title="PopplerFontInfo">
317
<div class="refsect2">
318
318
<a name="PopplerFontInfo"></a><h3>PopplerFontInfo</h3>
319
319
<pre class="programlisting">typedef struct {
320
320
} PopplerFontInfo;
324
<div class="refsect2" title="enum PopplerFontType">
324
<div class="refsect2">
325
325
<a name="PopplerFontType"></a><h3>enum PopplerFontType</h3>
326
326
<pre class="programlisting">typedef enum
401
<div class="refsect2" title="PopplerPSFile">
401
<div class="refsect2">
402
402
<a name="PopplerPSFile"></a><h3>PopplerPSFile</h3>
403
403
<pre class="programlisting">typedef struct {
408
<div class="refsect2" title="enum PopplerViewerPreferences">
408
<div class="refsect2">
409
409
<a name="PopplerViewerPreferences"></a><h3>enum PopplerViewerPreferences</h3>
410
410
<pre class="programlisting">typedef enum /*< flags >*/
523
<div class="refsect2" title="poppler_document_new_from_file ()">
523
<div class="refsect2">
524
524
<a name="poppler-document-new-from-file"></a><h3>poppler_document_new_from_file ()</h3>
525
525
<pre class="programlisting"><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="returnvalue">PopplerDocument</span></a> * poppler_document_new_from_file (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
526
526
<em class="parameter"><code>const <span class="type">char</span> *password</code></em>,
537
537
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
538
<td>uri of the file to load
538
<td>uri of the file to load</td>
542
541
<td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
543
<td> password to unlock the file with, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
542
<td>password to unlock the file with, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
547
546
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
548
<td> Return location for an error, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
547
<td>Return location for an error, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
552
551
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
553
<td> A newly created <a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a>, or <code class="literal">NULL</code>
552
<td>A newly created <a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a>, or <code class="literal">NULL</code>
560
<div class="refsect2" title="poppler_document_new_from_data ()">
559
<div class="refsect2">
561
560
<a name="poppler-document-new-from-data"></a><h3>poppler_document_new_from_data ()</h3>
562
561
<pre class="programlisting"><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="returnvalue">PopplerDocument</span></a> * poppler_document_new_from_data (<em class="parameter"><code><span class="type">char</span> *data</code></em>,
563
562
<em class="parameter"><code><span class="type">int</span> length</code></em>,
575
574
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
576
<td>the pdf data contained in a char array
575
<td>the pdf data contained in a char array</td>
580
578
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
585
583
<td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
586
<td> password to unlock the file with, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
584
<td>password to unlock the file with, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
590
588
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
591
<td> Return location for an error, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
589
<td>Return location for an error, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
595
593
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
596
<td> A newly created <a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a>, or <code class="literal">NULL</code>
594
<td>A newly created <a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a>, or <code class="literal">NULL</code>
603
<div class="refsect2" title="poppler_document_save ()">
601
<div class="refsect2">
604
602
<a name="poppler-document-save"></a><h3>poppler_document_save ()</h3>
605
603
<pre class="programlisting"><span class="returnvalue">gboolean</span> poppler_document_save (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>,
606
604
<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
624
622
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
625
<td>uri of file to save
623
<td>uri of file to save</td>
629
626
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
630
<td> return location for an error, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
627
<td>return location for an error, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
634
631
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
635
<td> <code class="literal">TRUE</code>, if the document was successfully saved
633
<code class="literal">TRUE</code>, if the document was successfully saved</td>
642
<div class="refsect2" title="poppler_document_save_a_copy ()">
639
<div class="refsect2">
643
640
<a name="poppler-document-save-a-copy"></a><h3>poppler_document_save_a_copy ()</h3>
644
641
<pre class="programlisting"><span class="returnvalue">gboolean</span> poppler_document_save_a_copy (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>,
645
642
<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
663
660
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
664
<td>uri of file to save
661
<td>uri of file to save</td>
668
664
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
669
<td> return location for an error, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
665
<td>return location for an error, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
673
669
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
674
<td> <code class="literal">TRUE</code>, if the document was successfully saved
671
<code class="literal">TRUE</code>, if the document was successfully saved</td>
681
<div class="refsect2" title="poppler_document_get_id ()">
677
<div class="refsect2">
682
678
<a name="poppler-document-get-id"></a><h3>poppler_document_get_id ()</h3>
683
679
<pre class="programlisting"><span class="returnvalue">gboolean</span> poppler_document_get_id (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>,
684
680
<em class="parameter"><code><span class="type">gchar</span> **permanent_id</code></em>,
706
702
<td><p><span class="term"><em class="parameter"><code>permanent_id</code></em> :</span></p></td>
707
<td> location to store an allocated string, use <code class="function">g_free()</code> to free the returned string. <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>
703
<td>location to store an allocated string, use <code class="function">g_free()</code> to free the returned string. <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>
711
707
<td><p><span class="term"><em class="parameter"><code>update_id</code></em> :</span></p></td>
712
<td> location to store an allocated string, use <code class="function">g_free()</code> to free the returned string. <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>
708
<td>location to store an allocated string, use <code class="function">g_free()</code> to free the returned string. <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>
716
712
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
717
<td> <code class="literal">TRUE</code> if the <em class="parameter"><code>document</code></em> contains an id, <code class="literal">FALSE</code> otherwise
714
<code class="literal">TRUE</code> if the <em class="parameter"><code>document</code></em> contains an id, <code class="literal">FALSE</code> otherwise</td>
723
718
<p class="since">Since 0.16</p>
726
<div class="refsect2" title="poppler_document_get_pdf_version_string ()">
721
<div class="refsect2">
727
722
<a name="poppler-document-get-pdf-version-string"></a><h3>poppler_document_get_pdf_version_string ()</h3>
728
723
<pre class="programlisting"><span class="returnvalue">gchar</span> * poppler_document_get_pdf_version_string
729
724
(<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>);</pre>
742
737
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
743
<td> a new allocated string containing the PDF version
744
of <em class="parameter"><code>document</code></em>, or <code class="literal">NULL</code>
738
<td>a new allocated string containing the PDF version
739
of <em class="parameter"><code>document</code></em>, or <code class="literal">NULL</code>
750
744
<p class="since">Since 0.16</p>
753
<div class="refsect2" title="poppler_document_get_pdf_version ()">
747
<div class="refsect2">
754
748
<a name="poppler-document-get-pdf-version"></a><h3>poppler_document_get_pdf_version ()</h3>
755
749
<pre class="programlisting"><span class="returnvalue">void</span> poppler_document_get_pdf_version (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>,
756
750
<em class="parameter"><code><span class="type">guint</span> *major_version</code></em>,
767
761
<td><p><span class="term"><em class="parameter"><code>major_version</code></em> :</span></p></td>
768
<td> return location for the PDF major version number. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
762
<td>return location for the PDF major version number. <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>
772
766
<td><p><span class="term"><em class="parameter"><code>minor_version</code></em> :</span></p></td>
773
<td> return location for the PDF minor version number. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
767
<td>return location for the PDF minor version number. <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>
777
771
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
778
<td>the major and minor PDF version numbers.
772
<td>the major and minor PDF version numbers.</td>
784
776
<p class="since">Since 0.16</p>
787
<div class="refsect2" title="poppler_document_get_title ()">
779
<div class="refsect2">
788
780
<a name="poppler-document-get-title"></a><h3>poppler_document_get_title ()</h3>
789
781
<pre class="programlisting"><span class="returnvalue">gchar</span> * poppler_document_get_title (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>);</pre>
802
794
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
803
<td> a new allocated string containing the title
804
of <em class="parameter"><code>document</code></em>, or <code class="literal">NULL</code>
795
<td>a new allocated string containing the title
796
of <em class="parameter"><code>document</code></em>, or <code class="literal">NULL</code>
810
801
<p class="since">Since 0.16</p>
813
<div class="refsect2" title="poppler_document_get_author ()">
804
<div class="refsect2">
814
805
<a name="poppler-document-get-author"></a><h3>poppler_document_get_author ()</h3>
815
806
<pre class="programlisting"><span class="returnvalue">gchar</span> * poppler_document_get_author (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>);</pre>
828
819
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
829
<td> a new allocated string containing the author
830
of <em class="parameter"><code>document</code></em>, or <code class="literal">NULL</code>
820
<td>a new allocated string containing the author
821
of <em class="parameter"><code>document</code></em>, or <code class="literal">NULL</code>
836
826
<p class="since">Since 0.16</p>
839
<div class="refsect2" title="poppler_document_get_subject ()">
829
<div class="refsect2">
840
830
<a name="poppler-document-get-subject"></a><h3>poppler_document_get_subject ()</h3>
841
831
<pre class="programlisting"><span class="returnvalue">gchar</span> * poppler_document_get_subject (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>);</pre>
854
844
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
855
<td> a new allocated string containing the subject
856
of <em class="parameter"><code>document</code></em>, or <code class="literal">NULL</code>
845
<td>a new allocated string containing the subject
846
of <em class="parameter"><code>document</code></em>, or <code class="literal">NULL</code>
862
851
<p class="since">Since 0.16</p>
865
<div class="refsect2" title="poppler_document_get_keywords ()">
854
<div class="refsect2">
866
855
<a name="poppler-document-get-keywords"></a><h3>poppler_document_get_keywords ()</h3>
867
856
<pre class="programlisting"><span class="returnvalue">gchar</span> * poppler_document_get_keywords (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>);</pre>
880
869
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
881
<td> a new allocated string containing keywords associated
882
to <em class="parameter"><code>document</code></em>, or <code class="literal">NULL</code>
870
<td>a new allocated string containing keywords associated
871
to <em class="parameter"><code>document</code></em>, or <code class="literal">NULL</code>
888
876
<p class="since">Since 0.16</p>
891
<div class="refsect2" title="poppler_document_get_creator ()">
879
<div class="refsect2">
892
880
<a name="poppler-document-get-creator"></a><h3>poppler_document_get_creator ()</h3>
893
881
<pre class="programlisting"><span class="returnvalue">gchar</span> * poppler_document_get_creator (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>);</pre>
908
896
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
909
<td> a new allocated string containing the creator
910
of <em class="parameter"><code>document</code></em>, or <code class="literal">NULL</code>
897
<td>a new allocated string containing the creator
898
of <em class="parameter"><code>document</code></em>, or <code class="literal">NULL</code>
916
903
<p class="since">Since 0.16</p>
919
<div class="refsect2" title="poppler_document_get_producer ()">
906
<div class="refsect2">
920
907
<a name="poppler-document-get-producer"></a><h3>poppler_document_get_producer ()</h3>
921
908
<pre class="programlisting"><span class="returnvalue">gchar</span> * poppler_document_get_producer (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>);</pre>
936
923
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
937
<td> a new allocated string containing the producer
938
of <em class="parameter"><code>document</code></em>, or <code class="literal">NULL</code>
924
<td>a new allocated string containing the producer
925
of <em class="parameter"><code>document</code></em>, or <code class="literal">NULL</code>
944
930
<p class="since">Since 0.16</p>
947
<div class="refsect2" title="poppler_document_get_creation_date ()">
933
<div class="refsect2">
948
934
<a name="poppler-document-get-creation-date"></a><h3>poppler_document_get_creation_date ()</h3>
949
935
<pre class="programlisting"><span class="returnvalue">time_t</span> poppler_document_get_creation_date (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>);</pre>
962
948
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
963
<td> the date the document was created, or -1
949
<td>the date the document was created, or -1</td>
969
953
<p class="since">Since 0.16</p>
972
<div class="refsect2" title="poppler_document_get_modification_date ()">
956
<div class="refsect2">
973
957
<a name="poppler-document-get-modification-date"></a><h3>poppler_document_get_modification_date ()</h3>
974
958
<pre class="programlisting"><span class="returnvalue">time_t</span> poppler_document_get_modification_date
975
959
(<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>);</pre>
988
972
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
989
<td> the date the document was most recently modified, or -1
973
<td>the date the document was most recently modified, or -1</td>
995
977
<p class="since">Since 0.16</p>
998
<div class="refsect2" title="poppler_document_get_page_layout ()">
980
<div class="refsect2">
999
981
<a name="poppler-document-get-page-layout"></a><h3>poppler_document_get_page_layout ()</h3>
1000
982
<pre class="programlisting"><a class="link" href="PopplerDocument.html#PopplerPageLayout" title="enum PopplerPageLayout"><span class="returnvalue">PopplerPageLayout</span></a> poppler_document_get_page_layout (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>);</pre>
1013
995
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1014
<td> a <a class="link" href="PopplerDocument.html#PopplerPageLayout" title="enum PopplerPageLayout"><span class="type">PopplerPageLayout</span></a> that should be used when the document is opened
996
<td>a <a class="link" href="PopplerDocument.html#PopplerPageLayout" title="enum PopplerPageLayout"><span class="type">PopplerPageLayout</span></a> that should be used when the document is opened</td>
1020
1000
<p class="since">Since 0.16</p>
1023
<div class="refsect2" title="poppler_document_get_page_mode ()">
1003
<div class="refsect2">
1024
1004
<a name="poppler-document-get-page-mode"></a><h3>poppler_document_get_page_mode ()</h3>
1025
1005
<pre class="programlisting"><a class="link" href="PopplerDocument.html#PopplerPageMode" title="enum PopplerPageMode"><span class="returnvalue">PopplerPageMode</span></a> poppler_document_get_page_mode (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>);</pre>
1039
1019
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1040
<td> a <a class="link" href="PopplerDocument.html#PopplerPageMode" title="enum PopplerPageMode"><span class="type">PopplerPageMode</span></a> that should be used when document is opened
1020
<td>a <a class="link" href="PopplerDocument.html#PopplerPageMode" title="enum PopplerPageMode"><span class="type">PopplerPageMode</span></a> that should be used when document is opened</td>
1046
1024
<p class="since">Since 0.16</p>
1049
<div class="refsect2" title="poppler_document_get_permissions ()">
1027
<div class="refsect2">
1050
1028
<a name="poppler-document-get-permissions"></a><h3>poppler_document_get_permissions ()</h3>
1051
1029
<pre class="programlisting"><a class="link" href="PopplerDocument.html#PopplerPermissions" title="enum PopplerPermissions"><span class="returnvalue">PopplerPermissions</span></a> poppler_document_get_permissions (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>);</pre>
1064
1042
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1065
<td> a set of falgs from <a class="link" href="PopplerDocument.html#PopplerPermissions" title="enum PopplerPermissions"><span class="type">PopplerPermissions</span></a> enumeration
1043
<td>a set of falgs from <a class="link" href="PopplerDocument.html#PopplerPermissions" title="enum PopplerPermissions"><span class="type">PopplerPermissions</span></a> enumeration</td>
1071
1047
<p class="since">Since 0.16</p>
1074
<div class="refsect2" title="poppler_document_get_metadata ()">
1050
<div class="refsect2">
1075
1051
<a name="poppler-document-get-metadata"></a><h3>poppler_document_get_metadata ()</h3>
1076
1052
<pre class="programlisting"><span class="returnvalue">gchar</span> * poppler_document_get_metadata (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>);</pre>
1089
1065
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1090
<td> a new allocated string containing the XML
1091
metadata, or <code class="literal">NULL</code>
1066
<td>a new allocated string containing the XML
1067
metadata, or <code class="literal">NULL</code>
1097
1072
<p class="since">Since 0.16</p>
1100
<div class="refsect2" title="poppler_document_is_linearized ()">
1075
<div class="refsect2">
1101
1076
<a name="poppler-document-is-linearized"></a><h3>poppler_document_is_linearized ()</h3>
1102
1077
<pre class="programlisting"><span class="returnvalue">gboolean</span> poppler_document_is_linearized (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>);</pre>
1116
1091
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1117
<td> <code class="literal">TRUE</code> if <em class="parameter"><code>document</code></em> is linearized, <code class="literal">FALSE</code> otherwhise
1093
<code class="literal">TRUE</code> if <em class="parameter"><code>document</code></em> is linearized, <code class="literal">FALSE</code> otherwhise</td>
1123
1097
<p class="since">Since 0.16</p>
1126
<div class="refsect2" title="poppler_document_get_n_pages ()">
1100
<div class="refsect2">
1127
1101
<a name="poppler-document-get-n-pages"></a><h3>poppler_document_get_n_pages ()</h3>
1128
1102
<pre class="programlisting"><span class="returnvalue">int</span> poppler_document_get_n_pages (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>);</pre>
1141
1115
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1142
<td> Number of pages
1116
<td>Number of pages</td>
1149
<div class="refsect2" title="poppler_document_get_page ()">
1122
<div class="refsect2">
1150
1123
<a name="poppler-document-get-page"></a><h3>poppler_document_get_page ()</h3>
1151
1124
<pre class="programlisting"><a class="link" href="PopplerPage.html" title="PopplerPage"><span class="returnvalue">PopplerPage</span></a> * poppler_document_get_page (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>,
1152
1125
<em class="parameter"><code><span class="type">int</span> index</code></em>);</pre>
1166
1139
<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
1140
<td>a page index</td>
1171
1143
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1172
<td> (transfer full) : The <a class="link" href="PopplerPage.html" title="PopplerPage"><span class="type">PopplerPage</span></a> at <em class="parameter"><code>index</code></em>
1144
<td>(transfer full) : The <a class="link" href="PopplerPage.html" title="PopplerPage"><span class="type">PopplerPage</span></a> at <em class="parameter"><code>index</code></em>
1179
<div class="refsect2" title="poppler_document_get_page_by_label ()">
1151
<div class="refsect2">
1180
1152
<a name="poppler-document-get-page-by-label"></a><h3>poppler_document_get_page_by_label ()</h3>
1181
1153
<pre class="programlisting"><a class="link" href="PopplerPage.html" title="PopplerPage"><span class="returnvalue">PopplerPage</span></a> * poppler_document_get_page_by_label (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>,
1182
1154
<em class="parameter"><code>const <span class="type">char</span> *label</code></em>);</pre>
1200
1172
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
1173
<td>a page label</td>
1205
1176
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1206
<td> (transfer full) :The <a class="link" href="PopplerPage.html" title="PopplerPage"><span class="type">PopplerPage</span></a> referenced by <em class="parameter"><code>label</code></em>
1177
<td>(transfer full) :The <a class="link" href="PopplerPage.html" title="PopplerPage"><span class="type">PopplerPage</span></a> referenced by <em class="parameter"><code>label</code></em>
1213
<div class="refsect2" title="poppler_document_find_dest ()">
1184
<div class="refsect2">
1214
1185
<a name="poppler-document-find-dest"></a><h3>poppler_document_find_dest ()</h3>
1215
1186
<pre class="programlisting"><a class="link" href="poppler-PopplerAction.html#PopplerDest" title="PopplerDest"><span class="returnvalue">PopplerDest</span></a> * poppler_document_find_dest (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>,
1216
1187
<em class="parameter"><code>const <span class="type">gchar</span> *link_name</code></em>);</pre>
1229
1200
<td><p><span class="term"><em class="parameter"><code>link_name</code></em> :</span></p></td>
1230
<td>a named destination
1201
<td>a named destination</td>
1234
1204
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1235
<td> The <a class="link" href="poppler-PopplerAction.html#PopplerDest" title="PopplerDest"><span class="type">PopplerDest</span></a> destination or <code class="literal">NULL</code> if
1205
<td>The <a class="link" href="poppler-PopplerAction.html#PopplerDest" title="PopplerDest"><span class="type">PopplerDest</span></a> destination or <code class="literal">NULL</code> if
1236
1206
<em class="parameter"><code>link_name</code></em> is not a destination. Returned value must
1237
1207
be freed with <a class="link" href="poppler-PopplerAction.html#poppler-dest-free" title="poppler_dest_free ()"><span class="type">poppler_dest_free</span></a>
1244
<div class="refsect2" title="poppler_document_has_attachments ()">
1214
<div class="refsect2">
1245
1215
<a name="poppler-document-has-attachments"></a><h3>poppler_document_has_attachments ()</h3>
1246
1216
<pre class="programlisting"><span class="returnvalue">gboolean</span> poppler_document_has_attachments (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>);</pre>
1259
1229
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1260
<td> <code class="literal">TRUE</code>, if <em class="parameter"><code>document</code></em> has attachments.
1231
<code class="literal">TRUE</code>, if <em class="parameter"><code>document</code></em> has attachments.</td>
1267
<div class="refsect2" title="poppler_document_get_attachments ()">
1237
<div class="refsect2">
1268
1238
<a name="poppler-document-get-attachments"></a><h3>poppler_document_get_attachments ()</h3>
1269
1239
<pre class="programlisting"><span class="returnvalue">GList</span> * poppler_document_get_attachments (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>);</pre>
1284
1254
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1285
<td> a list of available attachments. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> PopplerAttachment][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym> PopplerAttachment]</span>
1255
<td>a list of available attachments. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> PopplerAttachment][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
1292
<div class="refsect2" title="poppler_document_get_form_field ()">
1262
<div class="refsect2">
1293
1263
<a name="poppler-document-get-form-field"></a><h3>poppler_document_get_form_field ()</h3>
1294
1264
<pre class="programlisting"><a class="link" href="PopplerFormField.html" title="PoppplerFormField"><span class="returnvalue">PopplerFormField</span></a> * poppler_document_get_form_field (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>,
1295
1265
<em class="parameter"><code><span class="type">gint</span> id</code></em>);</pre>
1314
1284
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1315
<td> a new <a class="link" href="PopplerFormField.html" title="PoppplerFormField"><span class="type">PopplerFormField</span></a> or NULL if not found
1285
<td>a new <a class="link" href="PopplerFormField.html" title="PoppplerFormField"><span class="type">PopplerFormField</span></a> or NULL if not found</td>
1322
<div class="refsect2" title="poppler_index_iter_new ()">
1291
<div class="refsect2">
1323
1292
<a name="poppler-index-iter-new"></a><h3>poppler_index_iter_new ()</h3>
1324
1293
<pre class="programlisting"><a class="link" href="PopplerDocument.html#PopplerIndexIter" title="PopplerIndexIter"><span class="returnvalue">PopplerIndexIter</span></a> * poppler_index_iter_new (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>);</pre>
1373
1342
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1374
<td> a new <a class="link" href="PopplerDocument.html#PopplerIndexIter" title="PopplerIndexIter"><span class="type">PopplerIndexIter</span></a>
1343
<td>a new <a class="link" href="PopplerDocument.html#PopplerIndexIter" title="PopplerIndexIter"><span class="type">PopplerIndexIter</span></a>
1381
<div class="refsect2" title="poppler_index_iter_copy ()">
1350
<div class="refsect2">
1382
1351
<a name="poppler-index-iter-copy"></a><h3>poppler_index_iter_copy ()</h3>
1383
1352
<pre class="programlisting"><a class="link" href="PopplerDocument.html#PopplerIndexIter" title="PopplerIndexIter"><span class="returnvalue">PopplerIndexIter</span></a> * poppler_index_iter_copy (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerIndexIter" title="PopplerIndexIter"><span class="type">PopplerIndexIter</span></a> *iter</code></em>);</pre>
1397
1366
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1398
<td> a new <a class="link" href="PopplerDocument.html#PopplerIndexIter" title="PopplerIndexIter"><span class="type">PopplerIndexIter</span></a>
1367
<td>a new <a class="link" href="PopplerDocument.html#PopplerIndexIter" title="PopplerIndexIter"><span class="type">PopplerIndexIter</span></a>
1405
<div class="refsect2" title="poppler_index_iter_free ()">
1374
<div class="refsect2">
1406
1375
<a name="poppler-index-iter-free"></a><h3>poppler_index_iter_free ()</h3>
1407
1376
<pre class="programlisting"><span class="returnvalue">void</span> poppler_index_iter_free (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerIndexIter" title="PopplerIndexIter"><span class="type">PopplerIndexIter</span></a> *iter</code></em>);</pre>
1421
<div class="refsect2" title="poppler_index_iter_get_child ()">
1390
<div class="refsect2">
1422
1391
<a name="poppler-index-iter-get-child"></a><h3>poppler_index_iter_get_child ()</h3>
1423
1392
<pre class="programlisting"><a class="link" href="PopplerDocument.html#PopplerIndexIter" title="PopplerIndexIter"><span class="returnvalue">PopplerIndexIter</span></a> * poppler_index_iter_get_child (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerIndexIter" title="PopplerIndexIter"><span class="type">PopplerIndexIter</span></a> *parent</code></em>);</pre>
1437
1406
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1438
<td> a new <a class="link" href="PopplerDocument.html#PopplerIndexIter" title="PopplerIndexIter"><span class="type">PopplerIndexIter</span></a>
1407
<td>a new <a class="link" href="PopplerDocument.html#PopplerIndexIter" title="PopplerIndexIter"><span class="type">PopplerIndexIter</span></a>
1445
<div class="refsect2" title="poppler_index_iter_is_open ()">
1414
<div class="refsect2">
1446
1415
<a name="poppler-index-iter-is-open"></a><h3>poppler_index_iter_is_open ()</h3>
1447
1416
<pre class="programlisting"><span class="returnvalue">gboolean</span> poppler_index_iter_is_open (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerIndexIter" title="PopplerIndexIter"><span class="type">PopplerIndexIter</span></a> *iter</code></em>);</pre>
1462
1431
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1463
<td> <code class="literal">TRUE</code>, if the document wants <em class="parameter"><code>iter</code></em> to be expanded
1433
<code class="literal">TRUE</code>, if the document wants <em class="parameter"><code>iter</code></em> to be expanded</td>
1470
<div class="refsect2" title="poppler_index_iter_get_action ()">
1439
<div class="refsect2">
1471
1440
<a name="poppler-index-iter-get-action"></a><h3>poppler_index_iter_get_action ()</h3>
1472
1441
<pre class="programlisting"><a class="link" href="poppler-PopplerAction.html#PopplerAction" title="union PopplerAction"><span class="returnvalue">PopplerAction</span></a> * poppler_index_iter_get_action (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerIndexIter" title="PopplerIndexIter"><span class="type">PopplerIndexIter</span></a> *iter</code></em>);</pre>
1486
1455
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1487
<td> a new <a class="link" href="poppler-PopplerAction.html#PopplerAction" title="union PopplerAction"><span class="type">PopplerAction</span></a>
1456
<td>a new <a class="link" href="poppler-PopplerAction.html#PopplerAction" title="union PopplerAction"><span class="type">PopplerAction</span></a>
1494
<div class="refsect2" title="poppler_index_iter_next ()">
1463
<div class="refsect2">
1495
1464
<a name="poppler-index-iter-next"></a><h3>poppler_index_iter_next ()</h3>
1496
1465
<pre class="programlisting"><span class="returnvalue">gboolean</span> poppler_index_iter_next (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerIndexIter" title="PopplerIndexIter"><span class="type">PopplerIndexIter</span></a> *iter</code></em>);</pre>
1510
1479
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1511
<td> <code class="literal">TRUE</code>, if <em class="parameter"><code>iter</code></em> was set to the next action
1481
<code class="literal">TRUE</code>, if <em class="parameter"><code>iter</code></em> was set to the next action</td>
1518
<div class="refsect2" title="poppler_font_info_new ()">
1487
<div class="refsect2">
1519
1488
<a name="poppler-font-info-new"></a><h3>poppler_font_info_new ()</h3>
1520
1489
<pre class="programlisting"><a class="link" href="PopplerDocument.html#PopplerFontInfo" title="PopplerFontInfo"><span class="returnvalue">PopplerFontInfo</span></a> * poppler_font_info_new (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>);</pre>
1533
1502
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1534
<td> a new <a class="link" href="PopplerDocument.html#PopplerFontInfo" title="PopplerFontInfo"><span class="type">PopplerFontInfo</span></a> instance
1503
<td>a new <a class="link" href="PopplerDocument.html#PopplerFontInfo" title="PopplerFontInfo"><span class="type">PopplerFontInfo</span></a> instance</td>
1541
<div class="refsect2" title="poppler_font_info_scan ()">
1509
<div class="refsect2">
1542
1510
<a name="poppler-font-info-scan"></a><h3>poppler_font_info_scan ()</h3>
1543
1511
<pre class="programlisting"><span class="returnvalue">gboolean</span> poppler_font_info_scan (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerFontInfo" title="PopplerFontInfo"><span class="type">PopplerFontInfo</span></a> *font_info</code></em>,
1544
1512
<em class="parameter"><code><span class="type">int</span> n_pages</code></em>,
1579
1547
<td><p><span class="term"><em class="parameter"><code>n_pages</code></em> :</span></p></td>
1580
<td>number of pages to scan
1548
<td>number of pages to scan</td>
1584
1551
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
1585
<td> return location for a <a class="link" href="PopplerDocument.html#PopplerFontsIter" title="PopplerFontsIter"><span class="type">PopplerFontsIter</span></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
1552
<td>return location for a <a class="link" href="PopplerDocument.html#PopplerFontsIter" title="PopplerFontsIter"><span class="type">PopplerFontsIter</span></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
1589
1556
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1590
<td> <code class="literal">TRUE</code>, if there are more fonts left to scan
1558
<code class="literal">TRUE</code>, if there are more fonts left to scan</td>
1597
<div class="refsect2" title="poppler_font_info_free ()">
1564
<div class="refsect2">
1598
1565
<a name="poppler-font-info-free"></a><h3>poppler_font_info_free ()</h3>
1599
1566
<pre class="programlisting"><span class="returnvalue">void</span> poppler_font_info_free (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerFontInfo" title="PopplerFontInfo"><span class="type">PopplerFontInfo</span></a> *font_info</code></em>);</pre>
1602
<div class="refsect2" title="poppler_fonts_iter_copy ()">
1569
<div class="refsect2">
1603
1570
<a name="poppler-fonts-iter-copy"></a><h3>poppler_fonts_iter_copy ()</h3>
1604
1571
<pre class="programlisting"><a class="link" href="PopplerDocument.html#PopplerFontsIter" title="PopplerFontsIter"><span class="returnvalue">PopplerFontsIter</span></a> * poppler_fonts_iter_copy (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerFontsIter" title="PopplerFontsIter"><span class="type">PopplerFontsIter</span></a> *iter</code></em>);</pre>
1612
1579
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
1613
<td>a <a class="link" href="PopplerDocument.html#PopplerFontsIter" title="PopplerFontsIter"><span class="type">PopplerFontsIter</span></a> to copy
1580
<td>a <a class="link" href="PopplerDocument.html#PopplerFontsIter" title="PopplerFontsIter"><span class="type">PopplerFontsIter</span></a> to copy</td>
1617
1583
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1618
<td> a new allocated copy of <em class="parameter"><code>iter</code></em>
1584
<td>a new allocated copy of <em class="parameter"><code>iter</code></em>
1625
<div class="refsect2" title="poppler_fonts_iter_free ()">
1591
<div class="refsect2">
1626
1592
<a name="poppler-fonts-iter-free"></a><h3>poppler_fonts_iter_free ()</h3>
1627
1593
<pre class="programlisting"><span class="returnvalue">void</span> poppler_fonts_iter_free (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerFontsIter" title="PopplerFontsIter"><span class="type">PopplerFontsIter</span></a> *iter</code></em>);</pre>
1641
<div class="refsect2" title="poppler_fonts_iter_get_name ()">
1607
<div class="refsect2">
1642
1608
<a name="poppler-fonts-iter-get-name"></a><h3>poppler_fonts_iter_get_name ()</h3>
1643
1609
<pre class="programlisting">const <span class="returnvalue">char</span> * poppler_fonts_iter_get_name (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerFontsIter" title="PopplerFontsIter"><span class="type">PopplerFontsIter</span></a> *iter</code></em>);</pre>
1656
1622
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1623
<td>the font name</td>
1664
<div class="refsect2" title="poppler_fonts_iter_get_full_name ()">
1629
<div class="refsect2">
1665
1630
<a name="poppler-fonts-iter-get-full-name"></a><h3>poppler_fonts_iter_get_full_name ()</h3>
1666
1631
<pre class="programlisting">const <span class="returnvalue">char</span> * poppler_fonts_iter_get_full_name (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerFontsIter" title="PopplerFontsIter"><span class="type">PopplerFontsIter</span></a> *iter</code></em>);</pre>
1679
1644
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1680
<td> the font full name
1645
<td>the font full name</td>
1687
<div class="refsect2" title="poppler_fonts_iter_get_font_type ()">
1651
<div class="refsect2">
1688
1652
<a name="poppler-fonts-iter-get-font-type"></a><h3>poppler_fonts_iter_get_font_type ()</h3>
1689
1653
<pre class="programlisting"><a class="link" href="PopplerDocument.html#PopplerFontType" title="enum PopplerFontType"><span class="returnvalue">PopplerFontType</span></a> poppler_fonts_iter_get_font_type (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerFontsIter" title="PopplerFontsIter"><span class="type">PopplerFontsIter</span></a> *iter</code></em>);</pre>
1702
1666
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1667
<td>the font type</td>
1710
<div class="refsect2" title="poppler_fonts_iter_get_file_name ()">
1673
<div class="refsect2">
1711
1674
<a name="poppler-fonts-iter-get-file-name"></a><h3>poppler_fonts_iter_get_file_name ()</h3>
1712
1675
<pre class="programlisting">const <span class="returnvalue">char</span> * poppler_fonts_iter_get_file_name (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerFontsIter" title="PopplerFontsIter"><span class="type">PopplerFontsIter</span></a> *iter</code></em>);</pre>
1726
1689
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1727
<td> the filename of the font or <code class="literal">NULL</code> y font is emebedded
1690
<td>the filename of the font or <code class="literal">NULL</code> y font is emebedded</td>
1734
<div class="refsect2" title="poppler_fonts_iter_is_embedded ()">
1696
<div class="refsect2">
1735
1697
<a name="poppler-fonts-iter-is-embedded"></a><h3>poppler_fonts_iter_is_embedded ()</h3>
1736
1698
<pre class="programlisting"><span class="returnvalue">gboolean</span> poppler_fonts_iter_is_embedded (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerFontsIter" title="PopplerFontsIter"><span class="type">PopplerFontsIter</span></a> *iter</code></em>);</pre>
1749
1711
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1750
<td> <code class="literal">TRUE</code> if font is emebdded, <code class="literal">FALSE</code> otherwise
1713
<code class="literal">TRUE</code> if font is emebdded, <code class="literal">FALSE</code> otherwise</td>
1757
<div class="refsect2" title="poppler_fonts_iter_is_subset ()">
1719
<div class="refsect2">
1758
1720
<a name="poppler-fonts-iter-is-subset"></a><h3>poppler_fonts_iter_is_subset ()</h3>
1759
1721
<pre class="programlisting"><span class="returnvalue">gboolean</span> poppler_fonts_iter_is_subset (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerFontsIter" title="PopplerFontsIter"><span class="type">PopplerFontsIter</span></a> *iter</code></em>);</pre>
1772
1734
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1773
<td> <code class="literal">TRUE</code> if font is a subset, <code class="literal">FALSE</code> otherwise
1736
<code class="literal">TRUE</code> if font is a subset, <code class="literal">FALSE</code> otherwise</td>
1780
<div class="refsect2" title="poppler_fonts_iter_next ()">
1742
<div class="refsect2">
1781
1743
<a name="poppler-fonts-iter-next"></a><h3>poppler_fonts_iter_next ()</h3>
1782
1744
<pre class="programlisting"><span class="returnvalue">gboolean</span> poppler_fonts_iter_next (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerFontsIter" title="PopplerFontsIter"><span class="type">PopplerFontsIter</span></a> *iter</code></em>);</pre>
1795
1757
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1796
<td> <code class="literal">TRUE</code>, if <em class="parameter"><code>iter</code></em> was set to the next font
1759
<code class="literal">TRUE</code>, if <em class="parameter"><code>iter</code></em> was set to the next font</td>
1803
<div class="refsect2" title="poppler_layers_iter_new ()">
1765
<div class="refsect2">
1804
1766
<a name="poppler-layers-iter-new"></a><h3>poppler_layers_iter_new ()</h3>
1805
1767
<pre class="programlisting"><a class="link" href="PopplerDocument.html#PopplerLayersIter" title="PopplerLayersIter"><span class="returnvalue">PopplerLayersIter</span></a> * poppler_layers_iter_new (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>);</pre>
1806
1768
<div class="variablelist"><table border="0">
1814
1776
<p class="since">Since 0.12</p>
1817
<div class="refsect2" title="poppler_layers_iter_copy ()">
1779
<div class="refsect2">
1818
1780
<a name="poppler-layers-iter-copy"></a><h3>poppler_layers_iter_copy ()</h3>
1819
1781
<pre class="programlisting"><a class="link" href="PopplerDocument.html#PopplerLayersIter" title="PopplerLayersIter"><span class="returnvalue">PopplerLayersIter</span></a> * poppler_layers_iter_copy (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerLayersIter" title="PopplerLayersIter"><span class="type">PopplerLayersIter</span></a> *iter</code></em>);</pre>
1833
1795
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1834
<td> a new <a class="link" href="PopplerDocument.html#PopplerLayersIter" title="PopplerLayersIter"><span class="type">PopplerLayersIter</span></a>
1796
<td>a new <a class="link" href="PopplerDocument.html#PopplerLayersIter" title="PopplerLayersIter"><span class="type">PopplerLayersIter</span></a>
1843
<div class="refsect2" title="poppler_layers_iter_free ()">
1803
<div class="refsect2">
1844
1804
<a name="poppler-layers-iter-free"></a><h3>poppler_layers_iter_free ()</h3>
1845
1805
<pre class="programlisting"><span class="returnvalue">void</span> poppler_layers_iter_free (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerLayersIter" title="PopplerLayersIter"><span class="type">PopplerLayersIter</span></a> *iter</code></em>);</pre>
1857
1817
<p class="since">Since 0.12</p>
1860
<div class="refsect2" title="poppler_layers_iter_get_child ()">
1820
<div class="refsect2">
1861
1821
<a name="poppler-layers-iter-get-child"></a><h3>poppler_layers_iter_get_child ()</h3>
1862
1822
<pre class="programlisting"><a class="link" href="PopplerDocument.html#PopplerLayersIter" title="PopplerLayersIter"><span class="returnvalue">PopplerLayersIter</span></a> * poppler_layers_iter_get_child (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerLayersIter" title="PopplerLayersIter"><span class="type">PopplerLayersIter</span></a> *parent</code></em>);</pre>
1876
1836
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1877
<td> a new <a class="link" href="PopplerDocument.html#PopplerLayersIter" title="PopplerLayersIter"><span class="type">PopplerLayersIter</span></a>, or <code class="literal">NULL</code>
1837
<td>a new <a class="link" href="PopplerDocument.html#PopplerLayersIter" title="PopplerLayersIter"><span class="type">PopplerLayersIter</span></a>, or <code class="literal">NULL</code>
1883
1842
<p class="since">Since 0.12</p>
1886
<div class="refsect2" title="poppler_layers_iter_get_layer ()">
1845
<div class="refsect2">
1887
1846
<a name="poppler-layers-iter-get-layer"></a><h3>poppler_layers_iter_get_layer ()</h3>
1888
1847
<pre class="programlisting"><a class="link" href="PopplerLayer.html" title="PopplerLayer"><span class="returnvalue">PopplerLayer</span></a> * poppler_layers_iter_get_layer (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerLayersIter" title="PopplerLayersIter"><span class="type">PopplerLayersIter</span></a> *iter</code></em>);</pre>
1902
1861
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1903
<td> a new <a class="link" href="PopplerLayer.html" title="PopplerLayer"><span class="type">PopplerLayer</span></a>, or <code class="literal">NULL</code> if there isn't any layer associated with <em class="parameter"><code>iter</code></em>
1862
<td>a new <a class="link" href="PopplerLayer.html" title="PopplerLayer"><span class="type">PopplerLayer</span></a>, or <code class="literal">NULL</code> if there isn't any layer associated with <em class="parameter"><code>iter</code></em>
1909
1867
<p class="since">Since 0.12</p>
1912
<div class="refsect2" title="poppler_layers_iter_get_title ()">
1870
<div class="refsect2">
1913
1871
<a name="poppler-layers-iter-get-title"></a><h3>poppler_layers_iter_get_title ()</h3>
1914
1872
<pre class="programlisting"><span class="returnvalue">gchar</span> * poppler_layers_iter_get_title (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerLayersIter" title="PopplerLayersIter"><span class="type">PopplerLayersIter</span></a> *iter</code></em>);</pre>
1928
1886
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1929
<td> a new string containing the <em class="parameter"><code>iter</code></em>'s title or <code class="literal">NULL</code> if <em class="parameter"><code>iter</code></em> doesn't have a title.
1930
The returned string should be freed with <code class="function">g_free()</code> when no longer needed.
1887
<td>a new string containing the <em class="parameter"><code>iter</code></em>'s title or <code class="literal">NULL</code> if <em class="parameter"><code>iter</code></em> doesn't have a title.
1888
The returned string should be freed with <code class="function">g_free()</code> when no longer needed.</td>
1936
1892
<p class="since">Since 0.12</p>
1939
<div class="refsect2" title="poppler_layers_iter_next ()">
1895
<div class="refsect2">
1940
1896
<a name="poppler-layers-iter-next"></a><h3>poppler_layers_iter_next ()</h3>
1941
1897
<pre class="programlisting"><span class="returnvalue">gboolean</span> poppler_layers_iter_next (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerLayersIter" title="PopplerLayersIter"><span class="type">PopplerLayersIter</span></a> *iter</code></em>);</pre>
1955
1911
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1956
<td> <code class="literal">TRUE</code>, if <em class="parameter"><code>iter</code></em> was set to the next action
1913
<code class="literal">TRUE</code>, if <em class="parameter"><code>iter</code></em> was set to the next action</td>
1962
1917
<p class="since">Since 0.12</p>
1965
<div class="refsect2" title="poppler_ps_file_new ()">
1920
<div class="refsect2">
1966
1921
<a name="poppler-ps-file-new"></a><h3>poppler_ps_file_new ()</h3>
1967
1922
<pre class="programlisting"><a class="link" href="PopplerDocument.html#PopplerPSFile" title="PopplerPSFile"><span class="returnvalue">PopplerPSFile</span></a> * poppler_ps_file_new (<em class="parameter"><code><a class="link" href="PopplerDocument.html" title="PopplerDocument"><span class="type">PopplerDocument</span></a> *document</code></em>,
1968
1923
<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
1983
1938
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
1984
<td>the path of the output filename
1939
<td>the path of the output filename</td>
1988
1942
<td><p><span class="term"><em class="parameter"><code>first_page</code></em> :</span></p></td>
1989
<td>the first page to print
1943
<td>the first page to print</td>
1993
1946
<td><p><span class="term"><em class="parameter"><code>n_pages</code></em> :</span></p></td>
1994
<td>the number of pages to print
1947
<td>the number of pages to print</td>
1998
1950
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1999
<td> a PopplerPSFile
1951
<td>a PopplerPSFile</td>
2006
<div class="refsect2" title="poppler_ps_file_free ()">
1957
<div class="refsect2">
2007
1958
<a name="poppler-ps-file-free"></a><h3>poppler_ps_file_free ()</h3>
2008
1959
<pre class="programlisting"><span class="returnvalue">void</span> poppler_ps_file_free (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerPSFile" title="PopplerPSFile"><span class="type">PopplerPSFile</span></a> *ps_file</code></em>);</pre>
2013
1964
<col align="left" valign="top">
2015
1966
<td><p><span class="term"><em class="parameter"><code>ps_file</code></em> :</span></p></td>
1967
<td>a PopplerPSFile</td>
2022
<div class="refsect2" title="poppler_ps_file_set_paper_size ()">
1972
<div class="refsect2">
2023
1973
<a name="poppler-ps-file-set-paper-size"></a><h3>poppler_ps_file_set_paper_size ()</h3>
2024
1974
<pre class="programlisting"><span class="returnvalue">void</span> poppler_ps_file_set_paper_size (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerPSFile" title="PopplerPSFile"><span class="type">PopplerPSFile</span></a> *ps_file</code></em>,
2025
1975
<em class="parameter"><code><span class="type">double</span> width</code></em>,
2036
1986
<td><p><span class="term"><em class="parameter"><code>ps_file</code></em> :</span></p></td>
2037
<td>a PopplerPSFile which was not yet printed to.
1987
<td>a PopplerPSFile which was not yet printed to.</td>
2041
1990
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
2042
<td>the paper width in 1/72 inch
1991
<td>the paper width in 1/72 inch</td>
2046
1994
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
2047
<td>the paper height in 1/72 inch
1995
<td>the paper height in 1/72 inch</td>
2054
<div class="refsect2" title="poppler_ps_file_set_duplex ()">
2001
<div class="refsect2">
2055
2002
<a name="poppler-ps-file-set-duplex"></a><h3>poppler_ps_file_set_duplex ()</h3>
2056
2003
<pre class="programlisting"><span class="returnvalue">void</span> poppler_ps_file_set_duplex (<em class="parameter"><code><a class="link" href="PopplerDocument.html#PopplerPSFile" title="PopplerPSFile"><span class="type">PopplerPSFile</span></a> *ps_file</code></em>,
2057
2004
<em class="parameter"><code><span class="type">gboolean</span> duplex</code></em>);</pre>
2065
2012
<td><p><span class="term"><em class="parameter"><code>ps_file</code></em> :</span></p></td>
2066
<td>a PopplerPSFile which was not yet printed to
2013
<td>a PopplerPSFile which was not yet printed to</td>
2070
2016
<td><p><span class="term"><em class="parameter"><code>duplex</code></em> :</span></p></td>
2071
<td>whether to force duplex printing (on printers which support this)
2017
<td>whether to force duplex printing (on printers which support this)</td>
2078
<div class="refsect1" title="Property Details">
2023
<div class="refsect1">
2079
2024
<a name="PopplerDocument.property-details"></a><h2>Property Details</h2>
2080
<div class="refsect2" title='The "author" property'>
2025
<div class="refsect2">
2081
2026
<a name="PopplerDocument--author"></a><h3>The <code class="literal">"author"</code> property</h3>
2082
2027
<pre class="programlisting"> "author" <span class="type">gchar</span>* : Read</pre>
2086
2031
<p>Default value: NULL</p>
2089
<div class="refsect2" title='The "creation-date" property'>
2034
<div class="refsect2">
2090
2035
<a name="PopplerDocument--creation-date"></a><h3>The <code class="literal">"creation-date"</code> property</h3>
2091
2036
<pre class="programlisting"> "creation-date" <span class="type">gint</span> : Read</pre>
2105
2050
<p>Default value: NULL</p>
2108
<div class="refsect2" title='The "format" property'>
2053
<div class="refsect2">
2109
2054
<a name="PopplerDocument--format"></a><h3>The <code class="literal">"format"</code> property</h3>
2110
2055
<pre class="programlisting"> "format" <span class="type">gchar</span>* : Read</pre>
2114
2059
<p>Default value: NULL</p>
2117
<div class="refsect2" title='The "format-major" property'>
2062
<div class="refsect2">
2118
2063
<a name="PopplerDocument--format-major"></a><h3>The <code class="literal">"format-major"</code> property</h3>
2119
2064
<pre class="programlisting"> "format-major" <span class="type">guint</span> : Read</pre>
2141
2086
<p>Default value: NULL</p>
2144
<div class="refsect2" title='The "linearized" property'>
2089
<div class="refsect2">
2145
2090
<a name="PopplerDocument--linearized"></a><h3>The <code class="literal">"linearized"</code> property</h3>
2146
2091
<pre class="programlisting"> "linearized" <span class="type">gboolean</span> : Read</pre>
2150
2095
<p>Default value: FALSE</p>
2153
<div class="refsect2" title='The "metadata" property'>
2098
<div class="refsect2">
2154
2099
<a name="PopplerDocument--metadata"></a><h3>The <code class="literal">"metadata"</code> property</h3>
2155
2100
<pre class="programlisting"> "metadata" <span class="type">gchar</span>* : Read</pre>
2159
2104
<p>Default value: NULL</p>
2162
<div class="refsect2" title='The "mod-date" property'>
2107
<div class="refsect2">
2163
2108
<a name="PopplerDocument--mod-date"></a><h3>The <code class="literal">"mod-date"</code> property</h3>
2164
2109
<pre class="programlisting"> "mod-date" <span class="type">gint</span> : Read</pre>
2178
2123
<p>Default value: POPPLER_PAGE_LAYOUT_UNSET</p>
2181
<div class="refsect2" title='The "page-mode" property'>
2126
<div class="refsect2">
2182
2127
<a name="PopplerDocument--page-mode"></a><h3>The <code class="literal">"page-mode"</code> property</h3>
2183
2128
<pre class="programlisting"> "page-mode" <a class="link" href="PopplerDocument.html#PopplerPageMode" title="enum PopplerPageMode"><span class="type">PopplerPageMode</span></a> : Read</pre>
2187
2132
<p>Default value: POPPLER_PAGE_MODE_UNSET</p>
2190
<div class="refsect2" title='The "permissions" property'>
2135
<div class="refsect2">
2191
2136
<a name="PopplerDocument--permissions"></a><h3>The <code class="literal">"permissions"</code> property</h3>
2192
2137
<pre class="programlisting"> "permissions" <a class="link" href="PopplerDocument.html#PopplerPermissions" title="enum PopplerPermissions"><span class="type">PopplerPermissions</span></a> : Read</pre>
2196
2141
<p>Default value: POPPLER_PERMISSIONS_OK_TO_PRINT|POPPLER_PERMISSIONS_OK_TO_MODIFY|POPPLER_PERMISSIONS_OK_TO_COPY|POPPLER_PERMISSIONS_OK_TO_ADD_NOTES|POPPLER_PERMISSIONS_OK_TO_FILL_FORM</p>
2199
<div class="refsect2" title='The "producer" property'>
2144
<div class="refsect2">
2200
2145
<a name="PopplerDocument--producer"></a><h3>The <code class="literal">"producer"</code> property</h3>
2201
2146
<pre class="programlisting"> "producer" <span class="type">gchar</span>* : Read</pre>
2205
2150
<p>Default value: NULL</p>
2208
<div class="refsect2" title='The "subject" property'>
2153
<div class="refsect2">
2209
2154
<a name="PopplerDocument--subject"></a><h3>The <code class="literal">"subject"</code> property</h3>
2210
2155
<pre class="programlisting"> "subject" <span class="type">gchar</span>* : Read</pre>
2214
2159
<p>Default value: NULL</p>
2217
<div class="refsect2" title='The "title" property'>
2162
<div class="refsect2">
2218
2163
<a name="PopplerDocument--title"></a><h3>The <code class="literal">"title"</code> property</h3>
2219
2164
<pre class="programlisting"> "title" <span class="type">gchar</span>* : Read</pre>
2223
2168
<p>Default value: NULL</p>
2226
<div class="refsect2" title='The "viewer-preferences" property'>
2171
<div class="refsect2">
2227
2172
<a name="PopplerDocument--viewer-preferences"></a><h3>The <code class="literal">"viewer-preferences"</code> property</h3>
2228
2173
<pre class="programlisting"> "viewer-preferences" <a class="link" href="PopplerDocument.html#PopplerViewerPreferences" title="enum PopplerViewerPreferences"><span class="type">PopplerViewerPreferences</span></a> : Read</pre>
2229
2174
<p>Viewer Preferences.</p>