2
<!-- This file was automatically generated from C sources - DO NOT EDIT!
3
To affect the contents of this file, edit the original C definitions,
4
and/or use gtk-doc annotations. -->
5
<repository version="1.2"
6
xmlns="http://www.gtk.org/introspection/core/1.0"
7
xmlns:c="http://www.gtk.org/introspection/c/1.0"
8
xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
9
<include name="GLib" version="2.0"/>
10
<include name="GModule" version="2.0"/>
11
<include name="GObject" version="2.0"/>
12
<include name="Gdk" version="2.0"/>
13
<include name="GdkPixbuf" version="2.0"/>
14
<include name="Gio" version="2.0"/>
15
<include name="Pango" version="1.0"/>
16
<include name="cairo" version="1.0"/>
17
<namespace name="Poppler"
19
shared-library="libpoppler-glib.so.6"
20
c:identifier-prefixes="Poppler"
21
c:symbol-prefixes="poppler">
22
<constant name="ANNOT_TEXT_ICON_CIRCLE" value="Circle">
23
<type name="utf8" c:type="gchar*"/>
25
<constant name="ANNOT_TEXT_ICON_COMMENT" value="Comment">
26
<type name="utf8" c:type="gchar*"/>
28
<constant name="ANNOT_TEXT_ICON_CROSS" value="Cross">
29
<type name="utf8" c:type="gchar*"/>
31
<constant name="ANNOT_TEXT_ICON_HELP" value="Help">
32
<type name="utf8" c:type="gchar*"/>
34
<constant name="ANNOT_TEXT_ICON_INSERT" value="Insert">
35
<type name="utf8" c:type="gchar*"/>
37
<constant name="ANNOT_TEXT_ICON_KEY" value="Key">
38
<type name="utf8" c:type="gchar*"/>
40
<constant name="ANNOT_TEXT_ICON_NEW_PARAGRAPH" value="NewParagraph">
41
<type name="utf8" c:type="gchar*"/>
43
<constant name="ANNOT_TEXT_ICON_NOTE" value="Note">
44
<type name="utf8" c:type="gchar*"/>
46
<constant name="ANNOT_TEXT_ICON_PARAGRAPH" value="Paragraph">
47
<type name="utf8" c:type="gchar*"/>
50
c:type="PopplerAction"
51
glib:type-name="PopplerAction"
52
glib:get-type="poppler_action_get_type"
53
c:symbol-prefix="action">
54
<doc xml:whitespace="preserve">A data structure for holding actions</doc>
55
<field name="type" writable="1">
56
<type name="ActionType" c:type="PopplerActionType"/>
58
<field name="any" writable="1">
59
<type name="ActionAny" c:type="PopplerActionAny"/>
61
<field name="goto_dest" writable="1">
62
<type name="ActionGotoDest" c:type="PopplerActionGotoDest"/>
64
<field name="goto_remote" writable="1">
65
<type name="ActionGotoRemote" c:type="PopplerActionGotoRemote"/>
67
<field name="launch" writable="1">
68
<type name="ActionLaunch" c:type="PopplerActionLaunch"/>
70
<field name="uri" writable="1">
71
<type name="ActionUri" c:type="PopplerActionUri"/>
73
<field name="named" writable="1">
74
<type name="ActionNamed" c:type="PopplerActionNamed"/>
76
<field name="movie" writable="1">
77
<type name="ActionMovie" c:type="PopplerActionMovie"/>
79
<field name="rendition" writable="1">
80
<type name="ActionRendition" c:type="PopplerActionRendition"/>
82
<field name="ocg_state" writable="1">
83
<type name="ActionOCGState" c:type="PopplerActionOCGState"/>
85
<method name="copy" c:identifier="poppler_action_copy">
86
<doc xml:whitespace="preserve">Copies @action, creating an identical #PopplerAction.</doc>
87
<return-value transfer-ownership="full">
88
<doc xml:whitespace="preserve">a new action identical to @action</doc>
89
<type name="Action" c:type="PopplerAction*"/>
92
<method name="free" c:identifier="poppler_action_free">
93
<doc xml:whitespace="preserve">Frees @action</doc>
94
<return-value transfer-ownership="none">
95
<type name="none" c:type="void"/>
99
<record name="ActionAny" c:type="PopplerActionAny">
100
<field name="type" writable="1">
101
<type name="ActionType" c:type="PopplerActionType"/>
103
<field name="title" writable="1">
104
<type name="utf8" c:type="gchar*"/>
107
<record name="ActionGotoDest" c:type="PopplerActionGotoDest">
108
<field name="type" writable="1">
109
<type name="ActionType" c:type="PopplerActionType"/>
111
<field name="title" writable="1">
112
<type name="utf8" c:type="gchar*"/>
114
<field name="dest" writable="1">
115
<type name="Dest" c:type="PopplerDest*"/>
118
<record name="ActionGotoRemote" c:type="PopplerActionGotoRemote">
119
<field name="type" writable="1">
120
<type name="ActionType" c:type="PopplerActionType"/>
122
<field name="title" writable="1">
123
<type name="utf8" c:type="gchar*"/>
125
<field name="file_name" writable="1">
126
<type name="utf8" c:type="gchar*"/>
128
<field name="dest" writable="1">
129
<type name="Dest" c:type="PopplerDest*"/>
132
<record name="ActionLaunch" c:type="PopplerActionLaunch">
133
<field name="type" writable="1">
134
<type name="ActionType" c:type="PopplerActionType"/>
136
<field name="title" writable="1">
137
<type name="utf8" c:type="gchar*"/>
139
<field name="file_name" writable="1">
140
<type name="utf8" c:type="gchar*"/>
142
<field name="params" writable="1">
143
<type name="utf8" c:type="gchar*"/>
146
<record name="ActionLayer" c:type="PopplerActionLayer">
147
<doc xml:whitespace="preserve">Action to perform over a list of layers</doc>
148
<field name="action" writable="1">
149
<type name="ActionLayerAction" c:type="PopplerActionLayerAction"/>
151
<field name="layers" writable="1">
152
<type name="GLib.List" c:type="GList*">
153
<type name="gpointer" c:type="gpointer"/>
157
<enumeration name="ActionLayerAction"
159
glib:type-name="PopplerActionLayerAction"
160
glib:get-type="poppler_action_layer_action_get_type"
161
c:type="PopplerActionLayerAction">
162
<doc xml:whitespace="preserve">Layer actions</doc>
165
c:identifier="POPPLER_ACTION_LAYER_ON"
169
c:identifier="POPPLER_ACTION_LAYER_OFF"
171
<member name="toggle"
173
c:identifier="POPPLER_ACTION_LAYER_TOGGLE"
176
<record name="ActionMovie" c:type="PopplerActionMovie">
177
<field name="type" writable="1">
178
<type name="ActionType" c:type="PopplerActionType"/>
180
<field name="title" writable="1">
181
<type name="utf8" c:type="gchar*"/>
183
<field name="operation" writable="1">
184
<type name="ActionMovieOperation"
185
c:type="PopplerActionMovieOperation"/>
187
<field name="movie" writable="1">
188
<type name="Movie" c:type="PopplerMovie*"/>
191
<enumeration name="ActionMovieOperation"
193
glib:type-name="PopplerActionMovieOperation"
194
glib:get-type="poppler_action_movie_operation_get_type"
195
c:type="PopplerActionMovieOperation">
196
<doc xml:whitespace="preserve">Movie operations</doc>
199
c:identifier="POPPLER_ACTION_MOVIE_PLAY"
203
c:identifier="POPPLER_ACTION_MOVIE_PAUSE"
205
<member name="resume"
207
c:identifier="POPPLER_ACTION_MOVIE_RESUME"
211
c:identifier="POPPLER_ACTION_MOVIE_STOP"
214
<record name="ActionNamed" c:type="PopplerActionNamed">
215
<field name="type" writable="1">
216
<type name="ActionType" c:type="PopplerActionType"/>
218
<field name="title" writable="1">
219
<type name="utf8" c:type="gchar*"/>
221
<field name="named_dest" writable="1">
222
<type name="utf8" c:type="gchar*"/>
225
<record name="ActionOCGState" c:type="PopplerActionOCGState">
226
<field name="type" writable="1">
227
<type name="ActionType" c:type="PopplerActionType"/>
229
<field name="title" writable="1">
230
<type name="utf8" c:type="gchar*"/>
232
<field name="state_list" writable="1">
233
<type name="GLib.List" c:type="GList*">
234
<type name="gpointer" c:type="gpointer"/>
238
<record name="ActionRendition" c:type="PopplerActionRendition">
239
<field name="type" writable="1">
240
<type name="ActionType" c:type="PopplerActionType"/>
242
<field name="title" writable="1">
243
<type name="utf8" c:type="gchar*"/>
245
<field name="op" writable="1">
246
<type name="gint" c:type="gint"/>
248
<field name="media" writable="1">
249
<type name="Media" c:type="PopplerMedia*"/>
252
<enumeration name="ActionType"
253
glib:type-name="PopplerActionType"
254
glib:get-type="poppler_action_type_get_type"
255
c:type="PopplerActionType">
256
<doc xml:whitespace="preserve">Action types</doc>
257
<member name="unknown"
259
c:identifier="POPPLER_ACTION_UNKNOWN"
260
glib:nick="unknown"/>
263
c:identifier="POPPLER_ACTION_NONE"
265
<member name="goto_dest"
267
c:identifier="POPPLER_ACTION_GOTO_DEST"
268
glib:nick="goto-dest"/>
269
<member name="goto_remote"
271
c:identifier="POPPLER_ACTION_GOTO_REMOTE"
272
glib:nick="goto-remote"/>
273
<member name="launch"
275
c:identifier="POPPLER_ACTION_LAUNCH"
279
c:identifier="POPPLER_ACTION_URI"
283
c:identifier="POPPLER_ACTION_NAMED"
287
c:identifier="POPPLER_ACTION_MOVIE"
289
<member name="rendition"
291
c:identifier="POPPLER_ACTION_RENDITION"
292
glib:nick="rendition"/>
293
<member name="ocg_state"
295
c:identifier="POPPLER_ACTION_OCG_STATE"
296
glib:nick="ocg-state"/>
298
<record name="ActionUri" c:type="PopplerActionUri">
299
<field name="type" writable="1">
300
<type name="ActionType" c:type="PopplerActionType"/>
302
<field name="title" writable="1">
303
<type name="utf8" c:type="gchar*"/>
305
<field name="uri" writable="1">
306
<type name="utf8" c:type="char*"/>
310
c:symbol-prefix="annot"
311
c:type="PopplerAnnot"
312
parent="GObject.Object"
313
glib:type-name="PopplerAnnot"
314
glib:get-type="poppler_annot_get_type">
315
<method name="get_annot_type"
316
c:identifier="poppler_annot_get_annot_type">
317
<doc xml:whitespace="preserve">Gets the type of @poppler_annot</doc>
318
<return-value transfer-ownership="none">
319
<doc xml:whitespace="preserve">#PopplerAnnotType of @poppler_annot.</doc>
320
<type name="AnnotType" c:type="PopplerAnnotType"/>
323
<method name="get_color" c:identifier="poppler_annot_get_color">
324
<doc xml:whitespace="preserve">Retrieves the color of @poppler_annot.</doc>
325
<return-value transfer-ownership="full">
326
<doc xml:whitespace="preserve">a new allocated #PopplerColor with the color values of</doc>
327
<type name="Color" c:type="PopplerColor*"/>
330
<method name="get_contents" c:identifier="poppler_annot_get_contents">
331
<doc xml:whitespace="preserve">Retrieves the contents of @poppler_annot.
332
must be freed with g_free() when done.</doc>
333
<return-value transfer-ownership="full">
334
<doc xml:whitespace="preserve">a new allocated string with the contents of @poppler_annot. It</doc>
335
<type name="utf8" c:type="gchar*"/>
338
<method name="get_flags" c:identifier="poppler_annot_get_flags">
339
<return-value transfer-ownership="none">
340
<type name="AnnotFlag" c:type="PopplerAnnotFlag"/>
343
<method name="get_modified" c:identifier="poppler_annot_get_modified">
344
<doc xml:whitespace="preserve">Retrieves the last modification data of @poppler_annot. The returned
345
string will be either a PDF format date or a text string.
346
See also #poppler_date_parse()</doc>
347
<return-value transfer-ownership="full">
348
<doc xml:whitespace="preserve">a new allocated string with the last modification data of</doc>
349
<type name="utf8" c:type="gchar*"/>
352
<method name="get_name" c:identifier="poppler_annot_get_name">
353
<doc xml:whitespace="preserve">Retrieves the name of @poppler_annot.
354
be freed with g_free() when done.</doc>
355
<return-value transfer-ownership="full">
356
<doc xml:whitespace="preserve">a new allocated string with the name of @poppler_annot. It must</doc>
357
<type name="utf8" c:type="gchar*"/>
360
<method name="get_page_index"
361
c:identifier="poppler_annot_get_page_index"
363
<doc xml:whitespace="preserve">Returns the page index to which @poppler_annot is associated, or -1 if unknown</doc>
364
<return-value transfer-ownership="none">
365
<doc xml:whitespace="preserve">page index or -1</doc>
366
<type name="gint" c:type="gint"/>
369
<method name="set_color"
370
c:identifier="poppler_annot_set_color"
372
<doc xml:whitespace="preserve">Sets the color of @poppler_annot.</doc>
373
<return-value transfer-ownership="none">
374
<type name="none" c:type="void"/>
377
<parameter name="poppler_color"
378
transfer-ownership="none"
380
<doc xml:whitespace="preserve">a #PopplerColor, or %NULL</doc>
381
<type name="Color" c:type="PopplerColor*"/>
385
<method name="set_contents"
386
c:identifier="poppler_annot_set_contents"
388
<doc xml:whitespace="preserve">Sets the contents of @poppler_annot to the given value,
389
replacing the current contents.</doc>
390
<return-value transfer-ownership="none">
391
<type name="none" c:type="void"/>
394
<parameter name="contents" transfer-ownership="none">
395
<doc xml:whitespace="preserve">a text string containing the new contents</doc>
396
<type name="utf8" c:type="gchar*"/>
401
<record name="AnnotCalloutLine"
402
c:type="PopplerAnnotCalloutLine"
403
glib:type-name="PopplerAnnotCalloutLine"
404
glib:get-type="poppler_annot_callout_line_get_type"
405
c:symbol-prefix="annot_callout_line">
406
<field name="multiline" writable="1">
407
<type name="gboolean" c:type="gboolean"/>
409
<field name="x1" writable="1">
410
<type name="gdouble" c:type="gdouble"/>
412
<field name="y1" writable="1">
413
<type name="gdouble" c:type="gdouble"/>
415
<field name="x2" writable="1">
416
<type name="gdouble" c:type="gdouble"/>
418
<field name="y2" writable="1">
419
<type name="gdouble" c:type="gdouble"/>
421
<field name="x3" writable="1">
422
<type name="gdouble" c:type="gdouble"/>
424
<field name="y3" writable="1">
425
<type name="gdouble" c:type="gdouble"/>
427
<constructor name="new" c:identifier="poppler_annot_callout_line_new">
428
<doc xml:whitespace="preserve">Creates a new empty #PopplerAnnotCalloutLine.
429
It must be freed when done.</doc>
430
<return-value transfer-ownership="full">
431
<doc xml:whitespace="preserve">a new allocated #PopplerAnnotCalloutLine, NULL in other case.</doc>
432
<type name="AnnotCalloutLine" c:type="PopplerAnnotCalloutLine*"/>
435
<method name="copy" c:identifier="poppler_annot_callout_line_copy">
436
<doc xml:whitespace="preserve">It does copy @callout to a new #PopplerAnnotCalloutLine.</doc>
437
<return-value transfer-ownership="full">
438
<doc xml:whitespace="preserve">a new allocated #PopplerAnnotCalloutLine as exact copy of</doc>
439
<type name="AnnotCalloutLine" c:type="PopplerAnnotCalloutLine*"/>
442
<method name="free" c:identifier="poppler_annot_callout_line_free">
443
<doc xml:whitespace="preserve">Frees the memory used by #PopplerAnnotCalloutLine.</doc>
444
<return-value transfer-ownership="none">
445
<type name="none" c:type="void"/>
449
<enumeration name="AnnotExternalDataType"
450
glib:type-name="PopplerAnnotExternalDataType"
451
glib:get-type="poppler_annot_external_data_type_get_type"
452
c:type="PopplerAnnotExternalDataType">
455
c:identifier="POPPLER_ANNOT_EXTERNAL_DATA_MARKUP_3D"
457
<member name="unknown"
459
c:identifier="POPPLER_ANNOT_EXTERNAL_DATA_MARKUP_UNKNOWN"
460
glib:nick="unknown"/>
462
<class name="AnnotFileAttachment"
463
c:symbol-prefix="annot_file_attachment"
464
c:type="PopplerAnnotFileAttachment"
466
glib:type-name="PopplerAnnotFileAttachment"
467
glib:get-type="poppler_annot_file_attachment_get_type">
468
<method name="get_attachment"
469
c:identifier="poppler_annot_file_attachment_get_attachment"
472
<doc xml:whitespace="preserve">Creates a #PopplerAttachment for the file of the file attachment annotation @annot.
473
The #PopplerAttachment must be unrefed with g_object_unref by the caller.</doc>
475
<doc xml:whitespace="preserve">@PopplerAttachment</doc>
476
<type name="Attachment" c:type="PopplerAttachment*"/>
479
<method name="get_name"
480
c:identifier="poppler_annot_file_attachment_get_name"
482
<doc xml:whitespace="preserve">Retrieves the name of @poppler_annot.
483
be freed with g_free() when done.</doc>
484
<return-value transfer-ownership="full">
485
<doc xml:whitespace="preserve">a new allocated string with the name of @poppler_annot. It must</doc>
486
<type name="utf8" c:type="gchar*"/>
490
<bitfield name="AnnotFlag"
491
glib:type-name="PopplerAnnotFlag"
492
glib:get-type="poppler_annot_flag_get_type"
493
c:type="PopplerAnnotFlag">
494
<member name="unknown"
496
c:identifier="POPPLER_ANNOT_FLAG_UNKNOWN"
497
glib:nick="unknown"/>
498
<member name="invisible"
500
c:identifier="POPPLER_ANNOT_FLAG_INVISIBLE"
501
glib:nick="invisible"/>
502
<member name="hidden"
504
c:identifier="POPPLER_ANNOT_FLAG_HIDDEN"
508
c:identifier="POPPLER_ANNOT_FLAG_PRINT"
510
<member name="no_zoom"
512
c:identifier="POPPLER_ANNOT_FLAG_NO_ZOOM"
513
glib:nick="no-zoom"/>
514
<member name="no_rotate"
516
c:identifier="POPPLER_ANNOT_FLAG_NO_ROTATE"
517
glib:nick="no-rotate"/>
518
<member name="no_view"
520
c:identifier="POPPLER_ANNOT_FLAG_NO_VIEW"
521
glib:nick="no-view"/>
522
<member name="read_only"
524
c:identifier="POPPLER_ANNOT_FLAG_READ_ONLY"
525
glib:nick="read-only"/>
526
<member name="locked"
528
c:identifier="POPPLER_ANNOT_FLAG_LOCKED"
530
<member name="toggle_no_view"
532
c:identifier="POPPLER_ANNOT_FLAG_TOGGLE_NO_VIEW"
533
glib:nick="toggle-no-view"/>
534
<member name="locked_contents"
536
c:identifier="POPPLER_ANNOT_FLAG_LOCKED_CONTENTS"
537
glib:nick="locked-contents"/>
539
<class name="AnnotFreeText"
540
c:symbol-prefix="annot_free_text"
541
c:type="PopplerAnnotFreeText"
543
glib:type-name="PopplerAnnotFreeText"
544
glib:get-type="poppler_annot_free_text_get_type">
545
<method name="get_callout_line"
546
c:identifier="poppler_annot_free_text_get_callout_line">
547
<doc xml:whitespace="preserve">Retrieves a #PopplerCalloutLine of four or six numbers specifying a callout
548
line attached to the @poppler_annot.
549
line, NULL in other case. It must be freed with g_free() when
551
<return-value transfer-ownership="full">
552
<doc xml:whitespace="preserve">a new allocated #PopplerCalloutLine if the annot has a callout</doc>
553
<type name="AnnotCalloutLine" c:type="PopplerAnnotCalloutLine*"/>
556
<method name="get_quadding"
557
c:identifier="poppler_annot_free_text_get_quadding">
558
<doc xml:whitespace="preserve">Retrieves the justification of the text of @poppler_annot.</doc>
559
<return-value transfer-ownership="none">
560
<doc xml:whitespace="preserve">#PopplerAnnotFreeTextQuadding of @poppler_annot.</doc>
561
<type name="AnnotFreeTextQuadding"
562
c:type="PopplerAnnotFreeTextQuadding"/>
566
<enumeration name="AnnotFreeTextQuadding"
567
glib:type-name="PopplerAnnotFreeTextQuadding"
568
glib:get-type="poppler_annot_free_text_quadding_get_type"
569
c:type="PopplerAnnotFreeTextQuadding">
570
<member name="left_justified"
572
c:identifier="POPPLER_ANNOT_FREE_TEXT_QUADDING_LEFT_JUSTIFIED"
573
glib:nick="left-justified"/>
574
<member name="centered"
576
c:identifier="POPPLER_ANNOT_FREE_TEXT_QUADDING_CENTERED"
577
glib:nick="centered"/>
578
<member name="right_justified"
580
c:identifier="POPPLER_ANNOT_FREE_TEXT_QUADDING_RIGHT_JUSTIFIED"
581
glib:nick="right-justified"/>
583
<record name="AnnotMapping"
584
c:type="PopplerAnnotMapping"
585
glib:type-name="PopplerAnnotMapping"
586
glib:get-type="poppler_annot_mapping_get_type"
587
c:symbol-prefix="annot_mapping">
588
<doc xml:whitespace="preserve">A #PopplerAnnotMapping structure represents the location
589
of @annot on the page</doc>
590
<field name="area" writable="1">
591
<type name="Rectangle" c:type="PopplerRectangle"/>
593
<field name="annot" writable="1">
594
<type name="Annot" c:type="PopplerAnnot*"/>
596
<constructor name="new" c:identifier="poppler_annot_mapping_new">
597
<doc xml:whitespace="preserve">Creates a new #PopplerAnnotMapping</doc>
598
<return-value transfer-ownership="full">
599
<doc xml:whitespace="preserve">a new #PopplerAnnotMapping, use poppler_annot_mapping_free() to free it</doc>
600
<type name="AnnotMapping" c:type="PopplerAnnotMapping*"/>
603
<method name="copy" c:identifier="poppler_annot_mapping_copy">
604
<doc xml:whitespace="preserve">Creates a copy of @mapping</doc>
605
<return-value transfer-ownership="full">
606
<doc xml:whitespace="preserve">a new allocated copy of @mapping</doc>
607
<type name="AnnotMapping" c:type="PopplerAnnotMapping*"/>
610
<method name="free" c:identifier="poppler_annot_mapping_free">
611
<doc xml:whitespace="preserve">Frees the given #PopplerAnnotMapping</doc>
612
<return-value transfer-ownership="none">
613
<type name="none" c:type="void"/>
617
<class name="AnnotMarkup"
618
c:symbol-prefix="annot_markup"
619
c:type="PopplerAnnotMarkup"
621
glib:type-name="PopplerAnnotMarkup"
622
glib:get-type="poppler_annot_markup_get_type">
623
<method name="get_date"
624
c:identifier="poppler_annot_markup_get_date"
626
<doc xml:whitespace="preserve">Returns the date and time when the annotation was created
627
when the annotation was created, or %NULL</doc>
628
<return-value transfer-ownership="full">
629
<doc xml:whitespace="preserve">a #GDate representing the date and time</doc>
630
<type name="GLib.Date" c:type="GDate*"/>
633
<method name="get_external_data"
634
c:identifier="poppler_annot_markup_get_external_data">
635
<return-value transfer-ownership="none">
636
<type name="AnnotExternalDataType"
637
c:type="PopplerAnnotExternalDataType"/>
640
<method name="get_label" c:identifier="poppler_annot_markup_get_label">
641
<doc xml:whitespace="preserve">Retrieves the label text of @poppler_annot.</doc>
642
<return-value transfer-ownership="full">
643
<doc xml:whitespace="preserve">the label text of @poppler_annot.</doc>
644
<type name="utf8" c:type="gchar*"/>
647
<method name="get_opacity"
648
c:identifier="poppler_annot_markup_get_opacity">
649
<doc xml:whitespace="preserve">Retrieves the opacity value of @poppler_annot.
650
between 0 (transparent) and 1 (opaque)</doc>
651
<return-value transfer-ownership="none">
652
<doc xml:whitespace="preserve">the opacity value of @poppler_annot,</doc>
653
<type name="gdouble" c:type="gdouble"/>
656
<method name="get_popup_is_open"
657
c:identifier="poppler_annot_markup_get_popup_is_open">
658
<doc xml:whitespace="preserve">Retrieves the state of the popup window related to @poppler_annot.
660
<return-value transfer-ownership="none">
661
<doc xml:whitespace="preserve">the state of @poppler_annot. %TRUE if it's open, %FALSE in</doc>
662
<type name="gboolean" c:type="gboolean"/>
665
<method name="get_popup_rectangle"
666
c:identifier="poppler_annot_markup_get_popup_rectangle"
668
<doc xml:whitespace="preserve">Retrieves the rectangle of the popup window related to @poppler_annot.</doc>
669
<return-value transfer-ownership="none">
670
<doc xml:whitespace="preserve">%TRUE if #PopplerRectangle was correctly filled, %FALSE otherwise</doc>
671
<type name="gboolean" c:type="gboolean"/>
674
<parameter name="poppler_rect"
677
transfer-ownership="none">
678
<doc xml:whitespace="preserve">a #PopplerRectangle to store the popup rectangle</doc>
679
<type name="Rectangle" c:type="PopplerRectangle*"/>
683
<method name="get_reply_to"
684
c:identifier="poppler_annot_markup_get_reply_to">
685
<return-value transfer-ownership="none">
686
<type name="AnnotMarkupReplyType"
687
c:type="PopplerAnnotMarkupReplyType"/>
690
<method name="get_subject"
691
c:identifier="poppler_annot_markup_get_subject">
692
<return-value transfer-ownership="full">
693
<type name="utf8" c:type="gchar*"/>
696
<method name="has_popup"
697
c:identifier="poppler_annot_markup_has_popup"
699
<doc xml:whitespace="preserve">Return %TRUE if the markup annotation has a popup window associated</doc>
700
<return-value transfer-ownership="none">
701
<doc xml:whitespace="preserve">%TRUE, if @poppler_annot has popup, %FALSE otherwise</doc>
702
<type name="gboolean" c:type="gboolean"/>
705
<method name="set_label"
706
c:identifier="poppler_annot_markup_set_label"
708
<doc xml:whitespace="preserve">Sets the label text of @poppler_annot, replacing the current one</doc>
709
<return-value transfer-ownership="none">
710
<type name="none" c:type="void"/>
713
<parameter name="label" transfer-ownership="none" allow-none="1">
714
<doc xml:whitespace="preserve">a text string containing the new label, or %NULL</doc>
715
<type name="utf8" c:type="gchar*"/>
719
<method name="set_opacity"
720
c:identifier="poppler_annot_markup_set_opacity"
722
<doc xml:whitespace="preserve">Sets the opacity of @poppler_annot. This value applies to
723
all visible elements of @poppler_annot in its closed state,
724
but not to the pop-up window that appears when it's openened</doc>
725
<return-value transfer-ownership="none">
726
<type name="none" c:type="void"/>
729
<parameter name="opacity" transfer-ownership="none">
730
<doc xml:whitespace="preserve">a constant opacity value, between 0 (transparent) and 1 (opaque)</doc>
731
<type name="gdouble" c:type="gdouble"/>
735
<method name="set_popup"
736
c:identifier="poppler_annot_markup_set_popup"
738
<doc xml:whitespace="preserve">Associates a new popup window for editing contents of @poppler_annot.
739
Popup window shall be displayed by viewers at @popup_rect on the page.</doc>
740
<return-value transfer-ownership="none">
741
<type name="none" c:type="void"/>
744
<parameter name="popup_rect" transfer-ownership="none">
745
<doc xml:whitespace="preserve">a #PopplerRectangle</doc>
746
<type name="Rectangle" c:type="PopplerRectangle*"/>
750
<method name="set_popup_is_open"
751
c:identifier="poppler_annot_markup_set_popup_is_open"
753
<doc xml:whitespace="preserve">Sets the state of the popup window related to @poppler_annot.</doc>
754
<return-value transfer-ownership="none">
755
<type name="none" c:type="void"/>
758
<parameter name="is_open" transfer-ownership="none">
759
<doc xml:whitespace="preserve">whether popup window should initially be displayed open</doc>
760
<type name="gboolean" c:type="gboolean"/>
765
<enumeration name="AnnotMarkupReplyType"
766
glib:type-name="PopplerAnnotMarkupReplyType"
767
glib:get-type="poppler_annot_markup_reply_type_get_type"
768
c:type="PopplerAnnotMarkupReplyType">
771
c:identifier="POPPLER_ANNOT_MARKUP_REPLY_TYPE_R"
775
c:identifier="POPPLER_ANNOT_MARKUP_REPLY_TYPE_GROUP"
778
<class name="AnnotMovie"
779
c:symbol-prefix="annot_movie"
780
c:type="PopplerAnnotMovie"
782
glib:type-name="PopplerAnnotMovie"
783
glib:get-type="poppler_annot_movie_get_type">
784
<method name="get_movie"
785
c:identifier="poppler_annot_movie_get_movie"
787
<doc xml:whitespace="preserve">Retrieves the movie object (PopplerMovie) stored in the @poppler_annot.
788
object is owned by #PopplerAnnotMovie and should not be freed</doc>
789
<return-value transfer-ownership="none">
790
<doc xml:whitespace="preserve">the movie object stored in the @poppler_annot. The returned</doc>
791
<type name="Movie" c:type="PopplerMovie*"/>
794
<method name="get_title"
795
c:identifier="poppler_annot_movie_get_title"
797
<doc xml:whitespace="preserve">Retrieves the movie title of @poppler_annot.</doc>
798
<return-value transfer-ownership="full">
799
<doc xml:whitespace="preserve">the title text of @poppler_annot.</doc>
800
<type name="utf8" c:type="gchar*"/>
804
<class name="AnnotScreen"
805
c:symbol-prefix="annot_screen"
806
c:type="PopplerAnnotScreen"
808
glib:type-name="PopplerAnnotScreen"
809
glib:get-type="poppler_annot_screen_get_type">
810
<method name="get_action"
811
c:identifier="poppler_annot_screen_get_action"
813
<doc xml:whitespace="preserve">Retrieves the action (#PopplerAction) that shall be performed when @poppler_annot is activated
814
object is owned by @poppler_annot and should not be freed</doc>
815
<return-value transfer-ownership="none">
816
<doc xml:whitespace="preserve">the action to perform. The returned</doc>
817
<type name="Action" c:type="PopplerAction*"/>
821
<class name="AnnotText"
822
c:symbol-prefix="annot_text"
823
c:type="PopplerAnnotText"
825
glib:type-name="PopplerAnnotText"
826
glib:get-type="poppler_annot_text_get_type">
827
<constructor name="new"
828
c:identifier="poppler_annot_text_new"
830
<doc xml:whitespace="preserve">Creates a new Text annotation that will be
831
located on @rect when added to a page. See
832
poppler_page_add_annot()</doc>
833
<return-value transfer-ownership="full">
834
<doc xml:whitespace="preserve">A newly created #PopplerAnnotText annotation</doc>
835
<type name="Annot" c:type="PopplerAnnot*"/>
838
<parameter name="doc" transfer-ownership="none">
839
<doc xml:whitespace="preserve">a #PopplerDocument</doc>
840
<type name="Document" c:type="PopplerDocument*"/>
842
<parameter name="rect" transfer-ownership="none">
843
<doc xml:whitespace="preserve">a #PopplerRectangle</doc>
844
<type name="Rectangle" c:type="PopplerRectangle*"/>
848
<method name="get_icon" c:identifier="poppler_annot_text_get_icon">
849
<doc xml:whitespace="preserve">Gets name of the icon of @poppler_annot.</doc>
850
<return-value transfer-ownership="full">
851
<doc xml:whitespace="preserve">a new allocated string containing the icon name</doc>
852
<type name="utf8" c:type="gchar*"/>
855
<method name="get_is_open" c:identifier="poppler_annot_text_get_is_open">
856
<doc xml:whitespace="preserve">Retrieves the state of @poppler_annot.
858
<return-value transfer-ownership="none">
859
<doc xml:whitespace="preserve">the state of @poppler_annot. %TRUE if it's open, %FALSE in</doc>
860
<type name="gboolean" c:type="gboolean"/>
863
<method name="get_state" c:identifier="poppler_annot_text_get_state">
864
<doc xml:whitespace="preserve">Retrieves the state of @poppler_annot.</doc>
865
<return-value transfer-ownership="none">
866
<doc xml:whitespace="preserve">#PopplerAnnotTextState of @poppler_annot.</doc>
867
<type name="AnnotTextState" c:type="PopplerAnnotTextState"/>
870
<method name="set_icon"
871
c:identifier="poppler_annot_text_set_icon"
873
<doc xml:whitespace="preserve">Sets the icon of @poppler_annot. The following predefined
874
icons are currently supported:
877
<term>#POPPLER_ANNOT_TEXT_ICON_NOTE</term>
878
</varlistentry>
880
<term>#POPPLER_ANNOT_TEXT_ICON_COMMENT</term>
881
</varlistentry>
883
<term>#POPPLER_ANNOT_TEXT_ICON_KEY</term>
884
</varlistentry>
886
<term>#POPPLER_ANNOT_TEXT_ICON_HELP</term>
887
</varlistentry>
889
<term>#POPPLER_ANNOT_TEXT_ICON_NEW_PARAGRAPH</term>
890
</varlistentry>
892
<term>#POPPLER_ANNOT_TEXT_ICON_PARAGRAPH</term>
893
</varlistentry>
895
<term>#POPPLER_ANNOT_TEXT_ICON_INSERT</term>
896
</varlistentry>
898
<term>#POPPLER_ANNOT_TEXT_ICON_CROSS</term>
899
</varlistentry>
901
<term>#POPPLER_ANNOT_TEXT_ICON_CIRCLE</term>
902
</varlistentry>
903
</variablelist></doc>
904
<return-value transfer-ownership="none">
905
<type name="none" c:type="void"/>
908
<parameter name="icon" transfer-ownership="none">
909
<doc xml:whitespace="preserve">the name of an icon</doc>
910
<type name="utf8" c:type="gchar*"/>
914
<method name="set_is_open"
915
c:identifier="poppler_annot_text_set_is_open"
917
<doc xml:whitespace="preserve">Sets whether @poppler_annot should initially be displayed open</doc>
918
<return-value transfer-ownership="none">
919
<type name="none" c:type="void"/>
922
<parameter name="is_open" transfer-ownership="none">
923
<doc xml:whitespace="preserve">whether annotation should initially be displayed open</doc>
924
<type name="gboolean" c:type="gboolean"/>
929
<enumeration name="AnnotTextState"
930
glib:type-name="PopplerAnnotTextState"
931
glib:get-type="poppler_annot_text_state_get_type"
932
c:type="PopplerAnnotTextState">
933
<member name="marked"
935
c:identifier="POPPLER_ANNOT_TEXT_STATE_MARKED"
937
<member name="unmarked"
939
c:identifier="POPPLER_ANNOT_TEXT_STATE_UNMARKED"
940
glib:nick="unmarked"/>
941
<member name="accepted"
943
c:identifier="POPPLER_ANNOT_TEXT_STATE_ACCEPTED"
944
glib:nick="accepted"/>
945
<member name="rejected"
947
c:identifier="POPPLER_ANNOT_TEXT_STATE_REJECTED"
948
glib:nick="rejected"/>
949
<member name="cancelled"
951
c:identifier="POPPLER_ANNOT_TEXT_STATE_CANCELLED"
952
glib:nick="cancelled"/>
953
<member name="completed"
955
c:identifier="POPPLER_ANNOT_TEXT_STATE_COMPLETED"
956
glib:nick="completed"/>
959
c:identifier="POPPLER_ANNOT_TEXT_STATE_NONE"
961
<member name="unknown"
963
c:identifier="POPPLER_ANNOT_TEXT_STATE_UNKNOWN"
964
glib:nick="unknown"/>
966
<enumeration name="AnnotType"
967
glib:type-name="PopplerAnnotType"
968
glib:get-type="poppler_annot_type_get_type"
969
c:type="PopplerAnnotType">
970
<member name="unknown"
972
c:identifier="POPPLER_ANNOT_UNKNOWN"
973
glib:nick="unknown"/>
976
c:identifier="POPPLER_ANNOT_TEXT"
980
c:identifier="POPPLER_ANNOT_LINK"
982
<member name="free_text"
984
c:identifier="POPPLER_ANNOT_FREE_TEXT"
985
glib:nick="free-text"/>
988
c:identifier="POPPLER_ANNOT_LINE"
990
<member name="square"
992
c:identifier="POPPLER_ANNOT_SQUARE"
994
<member name="circle"
996
c:identifier="POPPLER_ANNOT_CIRCLE"
998
<member name="polygon"
1000
c:identifier="POPPLER_ANNOT_POLYGON"
1001
glib:nick="polygon"/>
1002
<member name="poly_line"
1004
c:identifier="POPPLER_ANNOT_POLY_LINE"
1005
glib:nick="poly-line"/>
1006
<member name="highlight"
1008
c:identifier="POPPLER_ANNOT_HIGHLIGHT"
1009
glib:nick="highlight"/>
1010
<member name="underline"
1012
c:identifier="POPPLER_ANNOT_UNDERLINE"
1013
glib:nick="underline"/>
1014
<member name="squiggly"
1016
c:identifier="POPPLER_ANNOT_SQUIGGLY"
1017
glib:nick="squiggly"/>
1018
<member name="strike_out"
1020
c:identifier="POPPLER_ANNOT_STRIKE_OUT"
1021
glib:nick="strike-out"/>
1022
<member name="stamp"
1024
c:identifier="POPPLER_ANNOT_STAMP"
1026
<member name="caret"
1028
c:identifier="POPPLER_ANNOT_CARET"
1032
c:identifier="POPPLER_ANNOT_INK"
1034
<member name="popup"
1036
c:identifier="POPPLER_ANNOT_POPUP"
1038
<member name="file_attachment"
1040
c:identifier="POPPLER_ANNOT_FILE_ATTACHMENT"
1041
glib:nick="file-attachment"/>
1042
<member name="sound"
1044
c:identifier="POPPLER_ANNOT_SOUND"
1046
<member name="movie"
1048
c:identifier="POPPLER_ANNOT_MOVIE"
1050
<member name="widget"
1052
c:identifier="POPPLER_ANNOT_WIDGET"
1053
glib:nick="widget"/>
1054
<member name="screen"
1056
c:identifier="POPPLER_ANNOT_SCREEN"
1057
glib:nick="screen"/>
1058
<member name="printer_mark"
1060
c:identifier="POPPLER_ANNOT_PRINTER_MARK"
1061
glib:nick="printer-mark"/>
1062
<member name="trap_net"
1064
c:identifier="POPPLER_ANNOT_TRAP_NET"
1065
glib:nick="trap-net"/>
1066
<member name="watermark"
1068
c:identifier="POPPLER_ANNOT_WATERMARK"
1069
glib:nick="watermark"/>
1072
c:identifier="POPPLER_ANNOT_3D"
1075
<class name="Attachment"
1076
c:symbol-prefix="attachment"
1077
c:type="PopplerAttachment"
1078
parent="GObject.Object"
1079
glib:type-name="PopplerAttachment"
1080
glib:get-type="poppler_attachment_get_type">
1081
<method name="save" c:identifier="poppler_attachment_save" throws="1">
1082
<doc xml:whitespace="preserve">Saves @attachment to a file indicated by @filename. If @error is set, %FALSE
1083
will be returned. Possible errors include those in the #G_FILE_ERROR domain
1084
and whatever the save function generates.</doc>
1085
<return-value transfer-ownership="none">
1086
<doc xml:whitespace="preserve">%TRUE, if the file successfully saved</doc>
1087
<type name="gboolean" c:type="gboolean"/>
1090
<parameter name="filename" transfer-ownership="none">
1091
<doc xml:whitespace="preserve">name of file to save</doc>
1092
<type name="utf8" c:type="char*"/>
1096
<method name="save_to_callback"
1097
c:identifier="poppler_attachment_save_to_callback"
1099
<doc xml:whitespace="preserve">Saves @attachment by feeding the produced data to @save_func. Can be used
1100
when you want to store the attachment to something other than a file, such as
1101
an in-memory buffer or a socket. If @error is set, %FALSE will be
1102
returned. Possible errors include those in the #G_FILE_ERROR domain and
1103
whatever the save function generates.</doc>
1104
<return-value transfer-ownership="none">
1105
<doc xml:whitespace="preserve">%TRUE, if the save successfully completed</doc>
1106
<type name="gboolean" c:type="gboolean"/>
1109
<parameter name="save_func"
1110
transfer-ownership="none"
1113
<doc xml:whitespace="preserve">a function that is called to save each block of data that the save routine generates.</doc>
1114
<type name="AttachmentSaveFunc"
1115
c:type="PopplerAttachmentSaveFunc"/>
1117
<parameter name="user_data" transfer-ownership="none">
1118
<doc xml:whitespace="preserve">user data to pass to the save function.</doc>
1119
<type name="gpointer" c:type="gpointer"/>
1123
<field name="parent">
1124
<type name="GObject.Object" c:type="GObject"/>
1127
<type name="utf8" c:type="gchar*"/>
1129
<field name="description">
1130
<type name="utf8" c:type="gchar*"/>
1133
<type name="gulong" c:type="gsize"/>
1135
<field name="mtime">
1136
<type name="GLib.Time" c:type="GTime"/>
1138
<field name="ctime">
1139
<type name="GLib.Time" c:type="GTime"/>
1141
<field name="checksum">
1142
<type name="GLib.String" c:type="GString*"/>
1145
<callback name="AttachmentSaveFunc"
1146
c:type="PopplerAttachmentSaveFunc"
1148
<doc xml:whitespace="preserve">Specifies the type of the function passed to
1149
poppler_attachment_save_to_callback(). It is called once for each block of
1150
bytes that is "written" by poppler_attachment_save_to_callback(). If
1151
successful it should return %TRUE. If an error occurs it should set
1152
will fail with the same error.</doc>
1153
<return-value transfer-ownership="none">
1154
<type name="gboolean" c:type="gboolean"/>
1157
<parameter name="buf" transfer-ownership="none">
1158
<doc xml:whitespace="preserve">buffer containing bytes to be written.</doc>
1159
<type name="utf8" c:type="gchar*"/>
1161
<parameter name="count" transfer-ownership="none">
1162
<doc xml:whitespace="preserve">number of bytes in @buf.</doc>
1163
<type name="gulong" c:type="gsize"/>
1165
<parameter name="data" transfer-ownership="none">
1166
<doc xml:whitespace="preserve">user data passed to poppler_attachment_save_to_callback()</doc>
1167
<type name="gpointer" c:type="gpointer"/>
1171
<enumeration name="Backend"
1172
glib:type-name="PopplerBackend"
1173
glib:get-type="poppler_backend_get_type"
1174
c:type="PopplerBackend">
1175
<member name="unknown"
1177
c:identifier="POPPLER_BACKEND_UNKNOWN"
1178
glib:nick="unknown"/>
1179
<member name="splash"
1181
c:identifier="POPPLER_BACKEND_SPLASH"
1182
glib:nick="splash"/>
1183
<member name="cairo"
1185
c:identifier="POPPLER_BACKEND_CAIRO"
1188
<record name="Color"
1189
c:type="PopplerColor"
1190
glib:type-name="PopplerColor"
1191
glib:get-type="poppler_color_get_type"
1192
c:symbol-prefix="color">
1193
<doc xml:whitespace="preserve">A #PopplerColor describes a RGB color. Color components
1194
are values between 0 and 65535</doc>
1195
<field name="red" writable="1">
1196
<type name="guint16" c:type="guint16"/>
1198
<field name="green" writable="1">
1199
<type name="guint16" c:type="guint16"/>
1201
<field name="blue" writable="1">
1202
<type name="guint16" c:type="guint16"/>
1204
<constructor name="new" c:identifier="poppler_color_new">
1205
<doc xml:whitespace="preserve">Creates a new #PopplerColor</doc>
1206
<return-value transfer-ownership="full">
1207
<doc xml:whitespace="preserve">a new #PopplerColor, use poppler_color_free() to free it</doc>
1208
<type name="Color" c:type="PopplerColor*"/>
1211
<method name="copy" c:identifier="poppler_color_copy">
1212
<doc xml:whitespace="preserve">Creates a copy of @color</doc>
1213
<return-value transfer-ownership="full">
1214
<doc xml:whitespace="preserve">a new allocated copy of @color</doc>
1215
<type name="Color" c:type="PopplerColor*"/>
1218
<method name="free" c:identifier="poppler_color_free">
1219
<doc xml:whitespace="preserve">Frees the given #PopplerColor</doc>
1220
<return-value transfer-ownership="none">
1221
<type name="none" c:type="void"/>
1226
c:type="PopplerDest"
1227
glib:type-name="PopplerDest"
1228
glib:get-type="poppler_dest_get_type"
1229
c:symbol-prefix="dest">
1230
<doc xml:whitespace="preserve">Data structure for holding a destination</doc>
1231
<field name="type" writable="1">
1232
<type name="DestType" c:type="PopplerDestType"/>
1234
<field name="page_num" writable="1">
1235
<type name="gint" c:type="int"/>
1237
<field name="left" writable="1">
1238
<type name="gdouble" c:type="double"/>
1240
<field name="bottom" writable="1">
1241
<type name="gdouble" c:type="double"/>
1243
<field name="right" writable="1">
1244
<type name="gdouble" c:type="double"/>
1246
<field name="top" writable="1">
1247
<type name="gdouble" c:type="double"/>
1249
<field name="zoom" writable="1">
1250
<type name="gdouble" c:type="double"/>
1252
<field name="named_dest" writable="1">
1253
<type name="utf8" c:type="gchar*"/>
1255
<field name="change_left" writable="1" bits="1">
1256
<type name="guint" c:type="guint"/>
1258
<field name="change_top" writable="1" bits="1">
1259
<type name="guint" c:type="guint"/>
1261
<field name="change_zoom" writable="1" bits="1">
1262
<type name="guint" c:type="guint"/>
1264
<method name="copy" c:identifier="poppler_dest_copy">
1265
<doc xml:whitespace="preserve">Copies @dest, creating an identical #PopplerDest.</doc>
1266
<return-value transfer-ownership="full">
1267
<doc xml:whitespace="preserve">a new destination identical to @dest</doc>
1268
<type name="Dest" c:type="PopplerDest*"/>
1271
<method name="free" c:identifier="poppler_dest_free">
1272
<doc xml:whitespace="preserve">Frees @dest</doc>
1273
<return-value transfer-ownership="none">
1274
<type name="none" c:type="void"/>
1278
<enumeration name="DestType"
1279
glib:type-name="PopplerDestType"
1280
glib:get-type="poppler_dest_type_get_type"
1281
c:type="PopplerDestType">
1282
<doc xml:whitespace="preserve">Destination types</doc>
1283
<member name="unknown"
1285
c:identifier="POPPLER_DEST_UNKNOWN"
1286
glib:nick="unknown"/>
1289
c:identifier="POPPLER_DEST_XYZ"
1293
c:identifier="POPPLER_DEST_FIT"
1297
c:identifier="POPPLER_DEST_FITH"
1301
c:identifier="POPPLER_DEST_FITV"
1305
c:identifier="POPPLER_DEST_FITR"
1309
c:identifier="POPPLER_DEST_FITB"
1311
<member name="fitbh"
1313
c:identifier="POPPLER_DEST_FITBH"
1315
<member name="fitbv"
1317
c:identifier="POPPLER_DEST_FITBV"
1319
<member name="named"
1321
c:identifier="POPPLER_DEST_NAMED"
1324
<class name="Document"
1325
c:symbol-prefix="document"
1326
c:type="PopplerDocument"
1327
parent="GObject.Object"
1328
glib:type-name="PopplerDocument"
1329
glib:get-type="poppler_document_get_type">
1330
<constructor name="new_from_data"
1331
c:identifier="poppler_document_new_from_data"
1333
<doc xml:whitespace="preserve">Creates a new #PopplerDocument. If %NULL is returned, then @error will be
1334
set. Possible errors include those in the #POPPLER_ERROR and #G_FILE_ERROR
1336
<return-value transfer-ownership="full">
1337
<doc xml:whitespace="preserve">A newly created #PopplerDocument, or %NULL</doc>
1338
<type name="Document" c:type="PopplerDocument*"/>
1341
<parameter name="data" transfer-ownership="none">
1342
<doc xml:whitespace="preserve">the pdf data contained in a char array</doc>
1343
<type name="utf8" c:type="char*"/>
1345
<parameter name="length" transfer-ownership="none">
1346
<doc xml:whitespace="preserve">the length of #data</doc>
1347
<type name="gint" c:type="int"/>
1349
<parameter name="password" transfer-ownership="none" allow-none="1">
1350
<doc xml:whitespace="preserve">password to unlock the file with, or %NULL</doc>
1351
<type name="utf8" c:type="char*"/>
1355
<constructor name="new_from_file"
1356
c:identifier="poppler_document_new_from_file"
1358
<doc xml:whitespace="preserve">Creates a new #PopplerDocument. If %NULL is returned, then @error will be
1359
set. Possible errors include those in the #POPPLER_ERROR and #G_FILE_ERROR
1361
<return-value transfer-ownership="full">
1362
<doc xml:whitespace="preserve">A newly created #PopplerDocument, or %NULL</doc>
1363
<type name="Document" c:type="PopplerDocument*"/>
1366
<parameter name="uri" transfer-ownership="none">
1367
<doc xml:whitespace="preserve">uri of the file to load</doc>
1368
<type name="utf8" c:type="char*"/>
1370
<parameter name="password" transfer-ownership="none" allow-none="1">
1371
<doc xml:whitespace="preserve">password to unlock the file with, or %NULL</doc>
1372
<type name="utf8" c:type="char*"/>
1376
<method name="find_dest" c:identifier="poppler_document_find_dest">
1377
<doc xml:whitespace="preserve">Finds named destination @link_name in @document
1378
be freed with #poppler_dest_free</doc>
1379
<return-value transfer-ownership="full">
1380
<doc xml:whitespace="preserve">The #PopplerDest destination or %NULL if</doc>
1381
<type name="Dest" c:type="PopplerDest*"/>
1384
<parameter name="link_name" transfer-ownership="none">
1385
<doc xml:whitespace="preserve">a named destination</doc>
1386
<type name="utf8" c:type="gchar*"/>
1390
<method name="get_attachments"
1391
c:identifier="poppler_document_get_attachments">
1392
<doc xml:whitespace="preserve">Returns a #GList containing #PopplerAttachment<!-- -->s. These attachments
1393
are unowned, and must be unreffed, and the list must be freed with
1394
g_list_free().</doc>
1395
<return-value transfer-ownership="full">
1396
<doc xml:whitespace="preserve">a list of available attachments.</doc>
1397
<type name="GLib.List" c:type="GList*">
1398
<type name="Attachment"/>
1402
<method name="get_author"
1403
c:identifier="poppler_document_get_author"
1405
<doc xml:whitespace="preserve">Returns the author of the document
1406
of @document, or %NULL</doc>
1407
<return-value transfer-ownership="full">
1408
<doc xml:whitespace="preserve">a new allocated string containing the author</doc>
1409
<type name="utf8" c:type="gchar*"/>
1412
<method name="get_creation_date"
1413
c:identifier="poppler_document_get_creation_date"
1415
<doc xml:whitespace="preserve">Returns the date the document was created as seconds since the Epoch</doc>
1416
<return-value transfer-ownership="none">
1417
<doc xml:whitespace="preserve">the date the document was created, or -1</doc>
1418
<type name="glong" c:type="time_t"/>
1421
<method name="get_creator"
1422
c:identifier="poppler_document_get_creator"
1424
<doc xml:whitespace="preserve">Returns the creator of the document. If the document was converted
1425
from another format, the creator is the name of the product
1426
that created the original document from which it was converted.
1427
of @document, or %NULL</doc>
1428
<return-value transfer-ownership="full">
1429
<doc xml:whitespace="preserve">a new allocated string containing the creator</doc>
1430
<type name="utf8" c:type="gchar*"/>
1433
<method name="get_form_field"
1434
c:identifier="poppler_document_get_form_field"
1436
<doc xml:whitespace="preserve">Returns the #PopplerFormField for the given @id. It must be freed with
1437
g_object_unref()</doc>
1439
<doc xml:whitespace="preserve">a new #PopplerFormField or NULL if not found</doc>
1440
<type name="FormField" c:type="PopplerFormField*"/>
1443
<parameter name="id" transfer-ownership="none">
1444
<doc xml:whitespace="preserve">an id of a #PopplerFormField</doc>
1445
<type name="gint" c:type="gint"/>
1449
<method name="get_id"
1450
c:identifier="poppler_document_get_id"
1452
<doc xml:whitespace="preserve">Returns the PDF file identifier represented as two byte string arrays of size 32.
1453
contents at the time it was originally created, so that this identifer
1454
never changes. @update_id is the update identifier that is built based on
1455
the file contents at the time it was last updated.
1456
Note that returned strings are not null-terminated, they have a fixed
1457
size of 32 bytes.</doc>
1458
<return-value transfer-ownership="none">
1459
<doc xml:whitespace="preserve">%TRUE if the @document contains an id, %FALSE otherwise</doc>
1460
<type name="gboolean" c:type="gboolean"/>
1463
<parameter name="permanent_id"
1465
caller-allocates="0"
1466
transfer-ownership="full"
1468
<doc xml:whitespace="preserve">location to store an allocated string, use g_free() to free the returned string</doc>
1469
<type name="utf8" c:type="gchar**"/>
1471
<parameter name="update_id"
1473
caller-allocates="0"
1474
transfer-ownership="full"
1476
<doc xml:whitespace="preserve">location to store an allocated string, use g_free() to free the returned string</doc>
1477
<type name="utf8" c:type="gchar**"/>
1481
<method name="get_keywords"
1482
c:identifier="poppler_document_get_keywords"
1484
<doc xml:whitespace="preserve">Returns the keywords associated to the document
1485
to @document, or %NULL</doc>
1486
<return-value transfer-ownership="full">
1487
<doc xml:whitespace="preserve">a new allocated string containing keywords associated</doc>
1488
<type name="utf8" c:type="gchar*"/>
1491
<method name="get_metadata"
1492
c:identifier="poppler_document_get_metadata"
1494
<doc xml:whitespace="preserve">Returns the XML metadata string of the document
1495
metadata, or %NULL</doc>
1496
<return-value transfer-ownership="full">
1497
<doc xml:whitespace="preserve">a new allocated string containing the XML</doc>
1498
<type name="utf8" c:type="gchar*"/>
1501
<method name="get_modification_date"
1502
c:identifier="poppler_document_get_modification_date"
1504
<doc xml:whitespace="preserve">Returns the date the document was most recently modified as seconds since the Epoch</doc>
1505
<return-value transfer-ownership="none">
1506
<doc xml:whitespace="preserve">the date the document was most recently modified, or -1</doc>
1507
<type name="glong" c:type="time_t"/>
1510
<method name="get_n_pages" c:identifier="poppler_document_get_n_pages">
1511
<doc xml:whitespace="preserve">Returns the number of pages in a loaded document.</doc>
1512
<return-value transfer-ownership="none">
1513
<doc xml:whitespace="preserve">Number of pages</doc>
1514
<type name="gint" c:type="int"/>
1517
<method name="get_page" c:identifier="poppler_document_get_page">
1518
<doc xml:whitespace="preserve">Returns the #PopplerPage indexed at @index. This object is owned by the
1520
<return-value transfer-ownership="full">
1521
<doc xml:whitespace="preserve">The #PopplerPage at @index</doc>
1522
<type name="Page" c:type="PopplerPage*"/>
1525
<parameter name="index" transfer-ownership="none">
1526
<doc xml:whitespace="preserve">a page index</doc>
1527
<type name="gint" c:type="int"/>
1531
<method name="get_page_by_label"
1532
c:identifier="poppler_document_get_page_by_label">
1533
<doc xml:whitespace="preserve">Returns the #PopplerPage reference by @label. This object is owned by the
1534
caller. @label is a human-readable string representation of the page number,
1535
and can be document specific. Typically, it is a value such as "iii" or "3".
1536
By default, "1" refers to the first page.</doc>
1537
<return-value transfer-ownership="full">
1538
<doc xml:whitespace="preserve">The #PopplerPage referenced by @label</doc>
1539
<type name="Page" c:type="PopplerPage*"/>
1542
<parameter name="label" transfer-ownership="none">
1543
<doc xml:whitespace="preserve">a page label</doc>
1544
<type name="utf8" c:type="char*"/>
1548
<method name="get_page_layout"
1549
c:identifier="poppler_document_get_page_layout"
1551
<doc xml:whitespace="preserve">Returns the page layout that should be used when the document is opened</doc>
1552
<return-value transfer-ownership="none">
1553
<doc xml:whitespace="preserve">a #PopplerPageLayout that should be used when the document is opened</doc>
1554
<type name="PageLayout" c:type="PopplerPageLayout"/>
1557
<method name="get_page_mode"
1558
c:identifier="poppler_document_get_page_mode"
1560
<doc xml:whitespace="preserve">Returns a #PopplerPageMode representing how the document should
1561
be initially displayed when opened.</doc>
1562
<return-value transfer-ownership="none">
1563
<doc xml:whitespace="preserve">a #PopplerPageMode that should be used when document is opened</doc>
1564
<type name="PageMode" c:type="PopplerPageMode"/>
1567
<method name="get_pdf_version"
1568
c:identifier="poppler_document_get_pdf_version"
1570
<doc xml:whitespace="preserve">Returns the major and minor PDF version numbers.</doc>
1571
<return-value transfer-ownership="none">
1572
<type name="none" c:type="void"/>
1575
<parameter name="major_version"
1577
caller-allocates="0"
1578
transfer-ownership="full"
1580
<doc xml:whitespace="preserve">return location for the PDF major version number</doc>
1581
<type name="guint" c:type="guint*"/>
1583
<parameter name="minor_version"
1585
caller-allocates="0"
1586
transfer-ownership="full"
1588
<doc xml:whitespace="preserve">return location for the PDF minor version number</doc>
1589
<type name="guint" c:type="guint*"/>
1593
<method name="get_pdf_version_string"
1594
c:identifier="poppler_document_get_pdf_version_string"
1596
<doc xml:whitespace="preserve">Returns the PDF version of @document as a string (e.g. PDF-1.6)
1597
of @document, or %NULL</doc>
1598
<return-value transfer-ownership="full">
1599
<doc xml:whitespace="preserve">a new allocated string containing the PDF version</doc>
1600
<type name="utf8" c:type="gchar*"/>
1603
<method name="get_permissions"
1604
c:identifier="poppler_document_get_permissions"
1606
<doc xml:whitespace="preserve">Returns the flags specifying which operations are permitted when the document is opened.</doc>
1607
<return-value transfer-ownership="none">
1608
<doc xml:whitespace="preserve">a set of falgs from #PopplerPermissions enumeration</doc>
1609
<type name="Permissions" c:type="PopplerPermissions"/>
1612
<method name="get_producer"
1613
c:identifier="poppler_document_get_producer"
1615
<doc xml:whitespace="preserve">Returns the producer of the document. If the document was converted
1616
from another format, the producer is the name of the product
1617
that converted it to PDF
1618
of @document, or %NULL</doc>
1619
<return-value transfer-ownership="full">
1620
<doc xml:whitespace="preserve">a new allocated string containing the producer</doc>
1621
<type name="utf8" c:type="gchar*"/>
1624
<method name="get_subject"
1625
c:identifier="poppler_document_get_subject"
1627
<doc xml:whitespace="preserve">Returns the subject of the document
1628
of @document, or %NULL</doc>
1629
<return-value transfer-ownership="full">
1630
<doc xml:whitespace="preserve">a new allocated string containing the subject</doc>
1631
<type name="utf8" c:type="gchar*"/>
1634
<method name="get_title"
1635
c:identifier="poppler_document_get_title"
1637
<doc xml:whitespace="preserve">Returns the document's title
1638
of @document, or %NULL</doc>
1639
<return-value transfer-ownership="full">
1640
<doc xml:whitespace="preserve">a new allocated string containing the title</doc>
1641
<type name="utf8" c:type="gchar*"/>
1644
<method name="has_attachments"
1645
c:identifier="poppler_document_has_attachments">
1646
<doc xml:whitespace="preserve">Returns %TRUE of @document has any attachments.</doc>
1647
<return-value transfer-ownership="none">
1648
<doc xml:whitespace="preserve">%TRUE, if @document has attachments.</doc>
1649
<type name="gboolean" c:type="gboolean"/>
1652
<method name="is_linearized"
1653
c:identifier="poppler_document_is_linearized"
1655
<doc xml:whitespace="preserve">Returns whether @document is linearized or not. Linearization of PDF
1656
enables efficient incremental access of the PDF file in a network environment.</doc>
1657
<return-value transfer-ownership="none">
1658
<doc xml:whitespace="preserve">%TRUE if @document is linearized, %FALSE otherwhise</doc>
1659
<type name="gboolean" c:type="gboolean"/>
1662
<method name="save" c:identifier="poppler_document_save" throws="1">
1663
<doc xml:whitespace="preserve">Saves @document. Any change made in the document such as
1664
form fields filled, annotations added or modified
1666
If @error is set, %FALSE will be returned. Possible errors
1667
include those in the #G_FILE_ERROR domain.</doc>
1668
<return-value transfer-ownership="none">
1669
<doc xml:whitespace="preserve">%TRUE, if the document was successfully saved</doc>
1670
<type name="gboolean" c:type="gboolean"/>
1673
<parameter name="uri" transfer-ownership="none">
1674
<doc xml:whitespace="preserve">uri of file to save</doc>
1675
<type name="utf8" c:type="char*"/>
1679
<method name="save_a_copy"
1680
c:identifier="poppler_document_save_a_copy"
1682
<doc xml:whitespace="preserve">Saves a copy of the original @document.
1683
Any change made in the document such as
1684
form fields filled by the user will not be saved.
1685
If @error is set, %FALSE will be returned. Possible errors
1686
include those in the #G_FILE_ERROR domain.</doc>
1687
<return-value transfer-ownership="none">
1688
<doc xml:whitespace="preserve">%TRUE, if the document was successfully saved</doc>
1689
<type name="gboolean" c:type="gboolean"/>
1692
<parameter name="uri" transfer-ownership="none">
1693
<doc xml:whitespace="preserve">uri of file to save</doc>
1694
<type name="utf8" c:type="char*"/>
1698
<property name="author" transfer-ownership="none">
1699
<doc xml:whitespace="preserve">The author of the document</doc>
1702
<property name="creation-date" transfer-ownership="none">
1703
<doc xml:whitespace="preserve">The date the document was created as seconds since the Epoch, or -1</doc>
1706
<property name="creator" transfer-ownership="none">
1707
<doc xml:whitespace="preserve">The creator of the document. See also poppler_document_get_creator()</doc>
1710
<property name="format" transfer-ownership="none">
1711
<doc xml:whitespace="preserve">The PDF version as string. See also poppler_document_get_pdf_version_string()</doc>
1714
<property name="format-major" transfer-ownership="none">
1715
<doc xml:whitespace="preserve">The PDF major version number. See also poppler_document_get_pdf_version()</doc>
1716
<type name="guint"/>
1718
<property name="format-minor" transfer-ownership="none">
1719
<doc xml:whitespace="preserve">The PDF minor version number. See also poppler_document_get_pdf_version()</doc>
1720
<type name="guint"/>
1722
<property name="keywords" transfer-ownership="none">
1723
<doc xml:whitespace="preserve">The keywords associated to the document</doc>
1726
<property name="linearized" transfer-ownership="none">
1727
<doc xml:whitespace="preserve">Whether document is linearized. See also poppler_document_is_linearized()</doc>
1728
<type name="gboolean"/>
1730
<property name="metadata" transfer-ownership="none">
1731
<doc xml:whitespace="preserve">Document metadata in XML format, or %NULL</doc>
1734
<property name="mod-date" transfer-ownership="none">
1735
<doc xml:whitespace="preserve">The date the document was most recently modified as seconds since the Epoch, or -1</doc>
1738
<property name="page-layout" transfer-ownership="none">
1739
<doc xml:whitespace="preserve">The page layout that should be used when the document is opened</doc>
1740
<type name="PageLayout"/>
1742
<property name="page-mode" transfer-ownership="none">
1743
<doc xml:whitespace="preserve">The mode that should be used when the document is opened</doc>
1744
<type name="PageMode"/>
1746
<property name="permissions" transfer-ownership="none">
1747
<doc xml:whitespace="preserve">Flags specifying which operations are permitted when the document is opened</doc>
1748
<type name="Permissions"/>
1750
<property name="producer" transfer-ownership="none">
1751
<doc xml:whitespace="preserve">The producer of the document. See also poppler_document_get_producer()</doc>
1754
<property name="subject" transfer-ownership="none">
1755
<doc xml:whitespace="preserve">The subject of the document</doc>
1758
<property name="title" transfer-ownership="none">
1759
<doc xml:whitespace="preserve">The document's title or %NULL</doc>
1762
<property name="viewer-preferences" transfer-ownership="none">
1763
<type name="ViewerPreferences"/>
1766
<enumeration name="Error"
1767
glib:type-name="PopplerError"
1768
glib:get-type="poppler_error_get_type"
1769
c:type="PopplerError"
1770
glib:error-quark="poppler_error_quark">
1771
<doc xml:whitespace="preserve">Error codes returned by #PopplerDocument</doc>
1772
<member name="invalid"
1774
c:identifier="POPPLER_ERROR_INVALID"
1775
glib:nick="invalid"/>
1776
<member name="encrypted"
1778
c:identifier="POPPLER_ERROR_ENCRYPTED"
1779
glib:nick="encrypted"/>
1780
<member name="open_file"
1782
c:identifier="POPPLER_ERROR_OPEN_FILE"
1783
glib:nick="open-file"/>
1784
<member name="bad_catalog"
1786
c:identifier="POPPLER_ERROR_BAD_CATALOG"
1787
glib:nick="bad-catalog"/>
1788
<member name="damaged"
1790
c:identifier="POPPLER_ERROR_DAMAGED"
1791
glib:nick="damaged"/>
1793
<class name="FontInfo"
1794
c:symbol-prefix="font_info"
1795
c:type="PopplerFontInfo"
1796
parent="GObject.Object"
1797
glib:type-name="PopplerFontInfo"
1798
glib:get-type="poppler_font_info_get_type">
1799
<constructor name="new" c:identifier="poppler_font_info_new">
1800
<doc xml:whitespace="preserve">Creates a new #PopplerFontInfo object</doc>
1801
<return-value transfer-ownership="full">
1802
<doc xml:whitespace="preserve">a new #PopplerFontInfo instance</doc>
1803
<type name="FontInfo" c:type="PopplerFontInfo*"/>
1806
<parameter name="document" transfer-ownership="none">
1807
<doc xml:whitespace="preserve">a #PopplerDocument</doc>
1808
<type name="Document" c:type="PopplerDocument*"/>
1812
<method name="free" c:identifier="poppler_font_info_free">
1813
<return-value transfer-ownership="none">
1814
<type name="none" c:type="void"/>
1817
<method name="scan" c:identifier="poppler_font_info_scan">
1818
<doc xml:whitespace="preserve">Scans the document associated with @font_info for fonts. At most
1819
point to the first font scanned.
1820
Here is a simple example of code to scan fonts in a document
1821
<informalexample><programlisting>
1822
font_info = poppler_font_info_new (document);
1823
while (poppler_font_info_scan (font_info, 20, &fonts_iter)) {
1825
continue; /<!-- -->* No fonts found in these 20 pages *<!-- -->/
1827
/<!-- -->* Do something with font iter *<!-- -->/
1828
} while (poppler_fonts_iter_next (fonts_iter));
1829
poppler_fonts_iter_free (fonts_iter);
1831
</programlisting></informalexample></doc>
1832
<return-value transfer-ownership="none">
1833
<doc xml:whitespace="preserve">%TRUE, if there are more fonts left to scan</doc>
1834
<type name="gboolean" c:type="gboolean"/>
1837
<parameter name="n_pages" transfer-ownership="none">
1838
<doc xml:whitespace="preserve">number of pages to scan</doc>
1839
<type name="gint" c:type="int"/>
1841
<parameter name="iter"
1843
caller-allocates="0"
1844
transfer-ownership="full">
1845
<doc xml:whitespace="preserve">return location for a #PopplerFontsIter</doc>
1846
<type name="FontsIter" c:type="PopplerFontsIter**"/>
1851
<enumeration name="FontType"
1852
glib:type-name="PopplerFontType"
1853
glib:get-type="poppler_font_type_get_type"
1854
c:type="PopplerFontType">
1855
<doc xml:whitespace="preserve">Font types</doc>
1856
<member name="unknown"
1858
c:identifier="POPPLER_FONT_TYPE_UNKNOWN"
1859
glib:nick="unknown"/>
1860
<member name="type1"
1862
c:identifier="POPPLER_FONT_TYPE_TYPE1"
1864
<member name="type1c"
1866
c:identifier="POPPLER_FONT_TYPE_TYPE1C"
1867
glib:nick="type1c"/>
1868
<member name="type1cot"
1870
c:identifier="POPPLER_FONT_TYPE_TYPE1COT"
1871
glib:nick="type1cot"/>
1872
<member name="type3"
1874
c:identifier="POPPLER_FONT_TYPE_TYPE3"
1876
<member name="truetype"
1878
c:identifier="POPPLER_FONT_TYPE_TRUETYPE"
1879
glib:nick="truetype"/>
1880
<member name="truetypeot"
1882
c:identifier="POPPLER_FONT_TYPE_TRUETYPEOT"
1883
glib:nick="truetypeot"/>
1884
<member name="cid_type0"
1886
c:identifier="POPPLER_FONT_TYPE_CID_TYPE0"
1887
glib:nick="cid-type0"/>
1888
<member name="cid_type0c"
1890
c:identifier="POPPLER_FONT_TYPE_CID_TYPE0C"
1891
glib:nick="cid-type0c"/>
1892
<member name="cid_type0cot"
1894
c:identifier="POPPLER_FONT_TYPE_CID_TYPE0COT"
1895
glib:nick="cid-type0cot"/>
1896
<member name="cid_type2"
1898
c:identifier="POPPLER_FONT_TYPE_CID_TYPE2"
1899
glib:nick="cid-type2"/>
1900
<member name="cid_type2ot"
1902
c:identifier="POPPLER_FONT_TYPE_CID_TYPE2OT"
1903
glib:nick="cid-type2ot"/>
1905
<record name="FontsIter"
1906
c:type="PopplerFontsIter"
1907
glib:type-name="PopplerFontsIter"
1908
glib:get-type="poppler_fonts_iter_get_type"
1909
c:symbol-prefix="fonts_iter">
1910
<method name="copy" c:identifier="poppler_fonts_iter_copy">
1911
<doc xml:whitespace="preserve">Creates a copy of @iter</doc>
1912
<return-value transfer-ownership="full">
1913
<doc xml:whitespace="preserve">a new allocated copy of @iter</doc>
1914
<type name="FontsIter" c:type="PopplerFontsIter*"/>
1917
<method name="free" c:identifier="poppler_fonts_iter_free">
1918
<doc xml:whitespace="preserve">Frees the given #PopplerFontsIter</doc>
1919
<return-value transfer-ownership="none">
1920
<type name="none" c:type="void"/>
1923
<method name="get_file_name"
1924
c:identifier="poppler_fonts_iter_get_file_name">
1925
<doc xml:whitespace="preserve">The filename of the font associated with @iter or %NULL if
1926
the font is embedded</doc>
1927
<return-value transfer-ownership="none">
1928
<doc xml:whitespace="preserve">the filename of the font or %NULL y font is emebedded</doc>
1929
<type name="utf8" c:type="char*"/>
1932
<method name="get_font_type"
1933
c:identifier="poppler_fonts_iter_get_font_type">
1934
<doc xml:whitespace="preserve">Returns the type of the font associated with @iter</doc>
1935
<return-value transfer-ownership="none">
1936
<doc xml:whitespace="preserve">the font type</doc>
1937
<type name="FontType" c:type="PopplerFontType"/>
1940
<method name="get_full_name"
1941
c:identifier="poppler_fonts_iter_get_full_name">
1942
<doc xml:whitespace="preserve">Returns the full name of the font associated with @iter</doc>
1943
<return-value transfer-ownership="none">
1944
<doc xml:whitespace="preserve">the font full name</doc>
1945
<type name="utf8" c:type="char*"/>
1948
<method name="get_name" c:identifier="poppler_fonts_iter_get_name">
1949
<doc xml:whitespace="preserve">Returns the name of the font associated with @iter</doc>
1950
<return-value transfer-ownership="none">
1951
<doc xml:whitespace="preserve">the font name</doc>
1952
<type name="utf8" c:type="char*"/>
1955
<method name="is_embedded" c:identifier="poppler_fonts_iter_is_embedded">
1956
<doc xml:whitespace="preserve">Returns whether the font associated with @iter is embedded in the document</doc>
1957
<return-value transfer-ownership="none">
1958
<doc xml:whitespace="preserve">%TRUE if font is emebdded, %FALSE otherwise</doc>
1959
<type name="gboolean" c:type="gboolean"/>
1962
<method name="is_subset" c:identifier="poppler_fonts_iter_is_subset">
1963
<doc xml:whitespace="preserve">Returns whether the font associated with @iter is a subset of another font</doc>
1964
<return-value transfer-ownership="none">
1965
<doc xml:whitespace="preserve">%TRUE if font is a subset, %FALSE otherwise</doc>
1966
<type name="gboolean" c:type="gboolean"/>
1969
<method name="next" c:identifier="poppler_fonts_iter_next">
1970
<doc xml:whitespace="preserve">Sets @iter to point to the next font</doc>
1971
<return-value transfer-ownership="none">
1972
<doc xml:whitespace="preserve">%TRUE, if @iter was set to the next font</doc>
1973
<type name="gboolean" c:type="gboolean"/>
1977
<enumeration name="FormButtonType"
1978
glib:type-name="PopplerFormButtonType"
1979
glib:get-type="poppler_form_button_type_get_type"
1980
c:type="PopplerFormButtonType">
1983
c:identifier="POPPLER_FORM_BUTTON_PUSH"
1985
<member name="check"
1987
c:identifier="POPPLER_FORM_BUTTON_CHECK"
1989
<member name="radio"
1991
c:identifier="POPPLER_FORM_BUTTON_RADIO"
1994
<enumeration name="FormChoiceType"
1995
glib:type-name="PopplerFormChoiceType"
1996
glib:get-type="poppler_form_choice_type_get_type"
1997
c:type="PopplerFormChoiceType">
1998
<member name="combo"
2000
c:identifier="POPPLER_FORM_CHOICE_COMBO"
2004
c:identifier="POPPLER_FORM_CHOICE_LIST"
2007
<class name="FormField"
2008
c:symbol-prefix="form_field"
2009
c:type="PopplerFormField"
2010
parent="GObject.Object"
2011
glib:type-name="PopplerFormField"
2012
glib:get-type="poppler_form_field_get_type">
2013
<method name="button_get_button_type"
2014
c:identifier="poppler_form_field_button_get_button_type">
2015
<return-value transfer-ownership="none">
2016
<type name="FormButtonType" c:type="PopplerFormButtonType"/>
2019
<method name="button_get_state"
2020
c:identifier="poppler_form_field_button_get_state">
2021
<return-value transfer-ownership="none">
2022
<type name="gboolean" c:type="gboolean"/>
2025
<method name="button_set_state"
2026
c:identifier="poppler_form_field_button_set_state">
2027
<return-value transfer-ownership="none">
2028
<type name="none" c:type="void"/>
2031
<parameter name="state" transfer-ownership="none">
2032
<type name="gboolean" c:type="gboolean"/>
2036
<method name="choice_can_select_multiple"
2037
c:identifier="poppler_form_field_choice_can_select_multiple">
2038
<doc xml:whitespace="preserve">Checks whether @field allows multiple choices to be selected</doc>
2039
<return-value transfer-ownership="none">
2040
<doc xml:whitespace="preserve">%TRUE if @field allows multiple choices to be selected</doc>
2041
<type name="gboolean" c:type="gboolean"/>
2044
<method name="choice_commit_on_change"
2045
c:identifier="poppler_form_field_choice_commit_on_change">
2046
<return-value transfer-ownership="none">
2047
<type name="gboolean" c:type="gboolean"/>
2050
<method name="choice_do_spell_check"
2051
c:identifier="poppler_form_field_choice_do_spell_check">
2052
<doc xml:whitespace="preserve">Checks whether spell checking should be done for the contents of @field</doc>
2053
<return-value transfer-ownership="none">
2054
<doc xml:whitespace="preserve">%TRUE if spell checking should be done for @field</doc>
2055
<type name="gboolean" c:type="gboolean"/>
2058
<method name="choice_get_choice_type"
2059
c:identifier="poppler_form_field_choice_get_choice_type">
2060
<doc xml:whitespace="preserve">Gets the choice type of @field</doc>
2061
<return-value transfer-ownership="none">
2062
<doc xml:whitespace="preserve">#PopplerFormChoiceType of @field</doc>
2063
<type name="FormChoiceType" c:type="PopplerFormChoiceType"/>
2066
<method name="choice_get_item"
2067
c:identifier="poppler_form_field_choice_get_item">
2068
<doc xml:whitespace="preserve">Returns the contents of the item on @field at the given index</doc>
2069
<return-value transfer-ownership="full">
2070
<doc xml:whitespace="preserve">a new allocated string. It must be freed with g_free() when done.</doc>
2071
<type name="utf8" c:type="gchar*"/>
2074
<parameter name="index" transfer-ownership="none">
2075
<doc xml:whitespace="preserve">the index of the item</doc>
2076
<type name="gint" c:type="gint"/>
2080
<method name="choice_get_n_items"
2081
c:identifier="poppler_form_field_choice_get_n_items">
2082
<doc xml:whitespace="preserve">Returns the number of items on @field</doc>
2083
<return-value transfer-ownership="none">
2084
<doc xml:whitespace="preserve">the number of items on @field</doc>
2085
<type name="gint" c:type="gint"/>
2088
<method name="choice_get_text"
2089
c:identifier="poppler_form_field_choice_get_text">
2090
<doc xml:whitespace="preserve">Retrieves the contents of @field.</doc>
2091
<return-value transfer-ownership="full">
2092
<doc xml:whitespace="preserve">a new allocated string. It must be freed with g_free() when done.</doc>
2093
<type name="utf8" c:type="gchar*"/>
2096
<method name="choice_is_editable"
2097
c:identifier="poppler_form_field_choice_is_editable">
2098
<doc xml:whitespace="preserve">Checks whether @field is editable</doc>
2099
<return-value transfer-ownership="none">
2100
<doc xml:whitespace="preserve">%TRUE if @field is editable</doc>
2101
<type name="gboolean" c:type="gboolean"/>
2104
<method name="choice_is_item_selected"
2105
c:identifier="poppler_form_field_choice_is_item_selected">
2106
<doc xml:whitespace="preserve">Checks whether the item at the given index on @field is currently selected</doc>
2107
<return-value transfer-ownership="none">
2108
<doc xml:whitespace="preserve">%TRUE if item at @index is currently selected</doc>
2109
<type name="gboolean" c:type="gboolean"/>
2112
<parameter name="index" transfer-ownership="none">
2113
<doc xml:whitespace="preserve">the index of the item</doc>
2114
<type name="gint" c:type="gint"/>
2118
<method name="choice_select_item"
2119
c:identifier="poppler_form_field_choice_select_item">
2120
<doc xml:whitespace="preserve">Selects the item at the given index on @field</doc>
2121
<return-value transfer-ownership="none">
2122
<type name="none" c:type="void"/>
2125
<parameter name="index" transfer-ownership="none">
2126
<doc xml:whitespace="preserve">the index of the item</doc>
2127
<type name="gint" c:type="gint"/>
2131
<method name="choice_set_text"
2132
c:identifier="poppler_form_field_choice_set_text">
2133
<doc xml:whitespace="preserve">Sets the text in @field to the given value, replacing the current contents</doc>
2134
<return-value transfer-ownership="none">
2135
<type name="none" c:type="void"/>
2138
<parameter name="text" transfer-ownership="none">
2139
<doc xml:whitespace="preserve">the new text</doc>
2140
<type name="utf8" c:type="gchar*"/>
2144
<method name="choice_toggle_item"
2145
c:identifier="poppler_form_field_choice_toggle_item">
2146
<doc xml:whitespace="preserve">Changes the state of the item at the given index</doc>
2147
<return-value transfer-ownership="none">
2148
<type name="none" c:type="void"/>
2151
<parameter name="index" transfer-ownership="none">
2152
<doc xml:whitespace="preserve">the index of the item</doc>
2153
<type name="gint" c:type="gint"/>
2157
<method name="choice_unselect_all"
2158
c:identifier="poppler_form_field_choice_unselect_all">
2159
<doc xml:whitespace="preserve">Unselects all the items on @field</doc>
2160
<return-value transfer-ownership="none">
2161
<type name="none" c:type="void"/>
2164
<method name="get_field_type"
2165
c:identifier="poppler_form_field_get_field_type">
2166
<doc xml:whitespace="preserve">Gets the type of @field</doc>
2167
<return-value transfer-ownership="none">
2168
<doc xml:whitespace="preserve">#PopplerFormFieldType of @field</doc>
2169
<type name="FormFieldType" c:type="PopplerFormFieldType"/>
2172
<method name="get_font_size"
2173
c:identifier="poppler_form_field_get_font_size">
2174
<return-value transfer-ownership="none">
2175
<type name="gdouble" c:type="gdouble"/>
2178
<method name="get_id" c:identifier="poppler_form_field_get_id">
2179
<doc xml:whitespace="preserve">Gets the id of @field</doc>
2180
<return-value transfer-ownership="none">
2181
<doc xml:whitespace="preserve">the id of @field</doc>
2182
<type name="gint" c:type="gint"/>
2185
<method name="get_mapping_name"
2186
c:identifier="poppler_form_field_get_mapping_name"
2188
<doc xml:whitespace="preserve">Gets the mapping name of @field that is used when
2189
exporting interactive form field data from the document</doc>
2190
<return-value transfer-ownership="full">
2191
<doc xml:whitespace="preserve">a new allocated string. It must be freed with g_free() when done.</doc>
2192
<type name="utf8" c:type="gchar*"/>
2195
<method name="get_name"
2196
c:identifier="poppler_form_field_get_name"
2198
<doc xml:whitespace="preserve">Gets the fully qualified name of @field. It's constructed by concatenating
2199
the partial field names of the field and all of its ancestors.</doc>
2200
<return-value transfer-ownership="full">
2201
<doc xml:whitespace="preserve">a new allocated string. It must be freed with g_free() when done.</doc>
2202
<type name="utf8" c:type="gchar*"/>
2205
<method name="get_partial_name"
2206
c:identifier="poppler_form_field_get_partial_name"
2208
<doc xml:whitespace="preserve">Gets the partial name of @field.</doc>
2209
<return-value transfer-ownership="full">
2210
<doc xml:whitespace="preserve">a new allocated string. It must be freed with g_free() when done.</doc>
2211
<type name="utf8" c:type="gchar*"/>
2214
<method name="is_read_only"
2215
c:identifier="poppler_form_field_is_read_only">
2216
<return-value transfer-ownership="none">
2217
<type name="gboolean" c:type="gboolean"/>
2220
<method name="text_do_scroll"
2221
c:identifier="poppler_form_field_text_do_scroll">
2222
<return-value transfer-ownership="none">
2223
<type name="gboolean" c:type="gboolean"/>
2226
<method name="text_do_spell_check"
2227
c:identifier="poppler_form_field_text_do_spell_check">
2228
<doc xml:whitespace="preserve">Checks whether spell checking should be done for the contents of @field</doc>
2229
<return-value transfer-ownership="none">
2230
<doc xml:whitespace="preserve">%TRUE if spell checking should be done for @field</doc>
2231
<type name="gboolean" c:type="gboolean"/>
2234
<method name="text_get_max_len"
2235
c:identifier="poppler_form_field_text_get_max_len">
2236
<doc xml:whitespace="preserve">Retrieves the maximum allowed length of the text in @field</doc>
2237
<return-value transfer-ownership="none">
2238
<doc xml:whitespace="preserve">the maximum allowed number of characters in @field, or -1 if there is no maximum.</doc>
2239
<type name="gint" c:type="gint"/>
2242
<method name="text_get_text"
2243
c:identifier="poppler_form_field_text_get_text">
2244
<doc xml:whitespace="preserve">Retrieves the contents of @field.</doc>
2245
<return-value transfer-ownership="full">
2246
<doc xml:whitespace="preserve">a new allocated string. It must be freed with g_free() when done.</doc>
2247
<type name="utf8" c:type="gchar*"/>
2250
<method name="text_get_text_type"
2251
c:identifier="poppler_form_field_text_get_text_type">
2252
<doc xml:whitespace="preserve">Gets the text type of @field.</doc>
2253
<return-value transfer-ownership="none">
2254
<doc xml:whitespace="preserve">#PopplerFormTextType of @field</doc>
2255
<type name="FormTextType" c:type="PopplerFormTextType"/>
2258
<method name="text_is_password"
2259
c:identifier="poppler_form_field_text_is_password">
2260
<doc xml:whitespace="preserve">Checks whether content of @field is a password and it must be hidden</doc>
2261
<return-value transfer-ownership="none">
2262
<doc xml:whitespace="preserve">%TRUE if the content of @field is a password</doc>
2263
<type name="gboolean" c:type="gboolean"/>
2266
<method name="text_is_rich_text"
2267
c:identifier="poppler_form_field_text_is_rich_text">
2268
<doc xml:whitespace="preserve">Checks whether the contents of @field are rich text</doc>
2269
<return-value transfer-ownership="none">
2270
<doc xml:whitespace="preserve">%TRUE if the contents of @field are rich text</doc>
2271
<type name="gboolean" c:type="gboolean"/>
2274
<method name="text_set_text"
2275
c:identifier="poppler_form_field_text_set_text">
2276
<doc xml:whitespace="preserve">Sets the text in @field to the given value, replacing the current contents.</doc>
2277
<return-value transfer-ownership="none">
2278
<type name="none" c:type="void"/>
2281
<parameter name="text" transfer-ownership="none">
2282
<doc xml:whitespace="preserve">the new text</doc>
2283
<type name="utf8" c:type="gchar*"/>
2288
<record name="FormFieldMapping"
2289
c:type="PopplerFormFieldMapping"
2290
glib:type-name="PopplerFormFieldMapping"
2291
glib:get-type="poppler_form_field_mapping_get_type"
2292
c:symbol-prefix="form_field_mapping">
2293
<doc xml:whitespace="preserve">A #PopplerFormFieldMapping structure represents the location
2294
of @field on the page</doc>
2295
<field name="area" writable="1">
2296
<type name="Rectangle" c:type="PopplerRectangle"/>
2298
<field name="field" writable="1">
2299
<type name="FormField" c:type="PopplerFormField*"/>
2301
<constructor name="new" c:identifier="poppler_form_field_mapping_new">
2302
<doc xml:whitespace="preserve">Creates a new #PopplerFormFieldMapping</doc>
2303
<return-value transfer-ownership="full">
2304
<doc xml:whitespace="preserve">a new #PopplerFormFieldMapping, use poppler_form_field_mapping_free() to free it</doc>
2305
<type name="FormFieldMapping" c:type="PopplerFormFieldMapping*"/>
2308
<method name="copy" c:identifier="poppler_form_field_mapping_copy">
2309
<doc xml:whitespace="preserve">Creates a copy of @mapping</doc>
2310
<return-value transfer-ownership="full">
2311
<doc xml:whitespace="preserve">a new allocated copy of @mapping</doc>
2312
<type name="FormFieldMapping" c:type="PopplerFormFieldMapping*"/>
2315
<method name="free" c:identifier="poppler_form_field_mapping_free">
2316
<doc xml:whitespace="preserve">Frees the given #PopplerFormFieldMapping</doc>
2317
<return-value transfer-ownership="none">
2318
<type name="none" c:type="void"/>
2322
<enumeration name="FormFieldType"
2323
glib:type-name="PopplerFormFieldType"
2324
glib:get-type="poppler_form_field_type_get_type"
2325
c:type="PopplerFormFieldType">
2326
<member name="unknown"
2328
c:identifier="POPPLER_FORM_FIELD_UNKNOWN"
2329
glib:nick="unknown"/>
2330
<member name="button"
2332
c:identifier="POPPLER_FORM_FIELD_BUTTON"
2333
glib:nick="button"/>
2336
c:identifier="POPPLER_FORM_FIELD_TEXT"
2338
<member name="choice"
2340
c:identifier="POPPLER_FORM_FIELD_CHOICE"
2341
glib:nick="choice"/>
2342
<member name="signature"
2344
c:identifier="POPPLER_FORM_FIELD_SIGNATURE"
2345
glib:nick="signature"/>
2347
<enumeration name="FormTextType"
2348
glib:type-name="PopplerFormTextType"
2349
glib:get-type="poppler_form_text_type_get_type"
2350
c:type="PopplerFormTextType">
2351
<member name="normal"
2353
c:identifier="POPPLER_FORM_TEXT_NORMAL"
2354
glib:nick="normal"/>
2355
<member name="multiline"
2357
c:identifier="POPPLER_FORM_TEXT_MULTILINE"
2358
glib:nick="multiline"/>
2359
<member name="file_select"
2361
c:identifier="POPPLER_FORM_TEXT_FILE_SELECT"
2362
glib:nick="file-select"/>
2364
<record name="ImageMapping"
2365
c:type="PopplerImageMapping"
2366
glib:type-name="PopplerImageMapping"
2367
glib:get-type="poppler_image_mapping_get_type"
2368
c:symbol-prefix="image_mapping">
2369
<doc xml:whitespace="preserve">A #PopplerImageMapping structure represents the location
2370
of an image on the page</doc>
2371
<field name="area" writable="1">
2372
<type name="Rectangle" c:type="PopplerRectangle"/>
2374
<field name="image_id" writable="1">
2375
<type name="gint" c:type="gint"/>
2377
<constructor name="new" c:identifier="poppler_image_mapping_new">
2378
<doc xml:whitespace="preserve">Creates a new #PopplerImageMapping</doc>
2379
<return-value transfer-ownership="full">
2380
<doc xml:whitespace="preserve">a new #PopplerImageMapping, use poppler_image_mapping_free() to free it</doc>
2381
<type name="ImageMapping" c:type="PopplerImageMapping*"/>
2384
<method name="copy" c:identifier="poppler_image_mapping_copy">
2385
<doc xml:whitespace="preserve">Creates a copy of @mapping</doc>
2386
<return-value transfer-ownership="full">
2387
<doc xml:whitespace="preserve">a new allocated copy of @mapping</doc>
2388
<type name="ImageMapping" c:type="PopplerImageMapping*"/>
2391
<method name="free" c:identifier="poppler_image_mapping_free">
2392
<doc xml:whitespace="preserve">Frees the given #PopplerImageMapping</doc>
2393
<return-value transfer-ownership="none">
2394
<type name="none" c:type="void"/>
2398
<record name="IndexIter"
2399
c:type="PopplerIndexIter"
2400
glib:type-name="PopplerIndexIter"
2401
glib:get-type="poppler_index_iter_get_type"
2402
c:symbol-prefix="index_iter">
2403
<constructor name="new" c:identifier="poppler_index_iter_new">
2404
<doc xml:whitespace="preserve">Returns the root #PopplerIndexIter for @document, or %NULL. This must be
2405
freed with poppler_index_iter_free().
2406
Certain documents have an index associated with them. This index can be used
2407
to help the user navigate the document, and is similar to a table of
2408
contents. Each node in the index will contain a #PopplerAction that can be
2409
displayed to the user &mdash; typically a #POPPLER_ACTION_GOTO_DEST or a
2410
#POPPLER_ACTION_URI<!-- -->.
2411
Here is a simple example of some code that walks the full index:
2412
<informalexample><programlisting>
2414
walk_index (PopplerIndexIter *iter)
2418
/<!-- -->* Get the the action and do something with it *<!-- -->/
2419
PopplerIndexIter *child = poppler_index_iter_get_child (iter);
2422
poppler_index_iter_free (child);
2424
while (poppler_index_iter_next (iter));
2428
iter = poppler_index_iter_new (document);
2430
poppler_index_iter_free (iter);
2432
</programlisting></informalexample></doc>
2433
<return-value transfer-ownership="full">
2434
<doc xml:whitespace="preserve">a new #PopplerIndexIter</doc>
2435
<type name="IndexIter" c:type="PopplerIndexIter*"/>
2438
<parameter name="document" transfer-ownership="none">
2439
<doc xml:whitespace="preserve">a #PopplerDocument</doc>
2440
<type name="Document" c:type="PopplerDocument*"/>
2444
<method name="copy" c:identifier="poppler_index_iter_copy">
2445
<doc xml:whitespace="preserve">Creates a new #PopplerIndexIter as a copy of @iter. This must be freed with
2446
poppler_index_iter_free().</doc>
2447
<return-value transfer-ownership="full">
2448
<doc xml:whitespace="preserve">a new #PopplerIndexIter</doc>
2449
<type name="IndexIter" c:type="PopplerIndexIter*"/>
2452
<method name="free" c:identifier="poppler_index_iter_free">
2453
<doc xml:whitespace="preserve">Frees @iter.</doc>
2454
<return-value transfer-ownership="none">
2455
<type name="none" c:type="void"/>
2458
<method name="get_action" c:identifier="poppler_index_iter_get_action">
2459
<doc xml:whitespace="preserve">Returns the #PopplerAction associated with @iter. It must be freed with
2460
poppler_action_free().</doc>
2461
<return-value transfer-ownership="full">
2462
<doc xml:whitespace="preserve">a new #PopplerAction</doc>
2463
<type name="Action" c:type="PopplerAction*"/>
2466
<method name="get_child" c:identifier="poppler_index_iter_get_child">
2467
<doc xml:whitespace="preserve">Returns a newly created child of @parent, or %NULL if the iter has no child.
2468
See poppler_index_iter_new() for more information on this function.</doc>
2469
<return-value transfer-ownership="full">
2470
<doc xml:whitespace="preserve">a new #PopplerIndexIter</doc>
2471
<type name="IndexIter" c:type="PopplerIndexIter*"/>
2474
<method name="is_open" c:identifier="poppler_index_iter_is_open">
2475
<doc xml:whitespace="preserve">Returns whether this node should be expanded by default to the user. The
2476
document can provide a hint as to how the document's index should be expanded
2478
<return-value transfer-ownership="none">
2479
<doc xml:whitespace="preserve">%TRUE, if the document wants @iter to be expanded</doc>
2480
<type name="gboolean" c:type="gboolean"/>
2483
<method name="next" c:identifier="poppler_index_iter_next">
2484
<doc xml:whitespace="preserve">Sets @iter to point to the next action at the current level, if valid. See
2485
poppler_index_iter_new() for more information.</doc>
2486
<return-value transfer-ownership="none">
2487
<doc xml:whitespace="preserve">%TRUE, if @iter was set to the next action</doc>
2488
<type name="gboolean" c:type="gboolean"/>
2493
c:symbol-prefix="layer"
2494
c:type="PopplerLayer"
2495
parent="GObject.Object"
2496
glib:type-name="PopplerLayer"
2497
glib:get-type="poppler_layer_get_type">
2498
<method name="get_radio_button_group_id"
2499
c:identifier="poppler_layer_get_radio_button_group_id">
2500
<return-value transfer-ownership="none">
2501
<type name="gint" c:type="gint"/>
2504
<method name="get_title" c:identifier="poppler_layer_get_title">
2505
<return-value transfer-ownership="none">
2506
<type name="utf8" c:type="gchar*"/>
2509
<method name="hide" c:identifier="poppler_layer_hide">
2510
<return-value transfer-ownership="none">
2511
<type name="none" c:type="void"/>
2514
<method name="is_parent" c:identifier="poppler_layer_is_parent">
2515
<return-value transfer-ownership="none">
2516
<type name="gboolean" c:type="gboolean"/>
2519
<method name="is_visible" c:identifier="poppler_layer_is_visible">
2520
<return-value transfer-ownership="none">
2521
<type name="gboolean" c:type="gboolean"/>
2524
<method name="show" c:identifier="poppler_layer_show">
2525
<return-value transfer-ownership="none">
2526
<type name="none" c:type="void"/>
2530
<record name="LayersIter"
2531
c:type="PopplerLayersIter"
2532
glib:type-name="PopplerLayersIter"
2533
glib:get-type="poppler_layers_iter_get_type"
2534
c:symbol-prefix="layers_iter">
2535
<constructor name="new"
2536
c:identifier="poppler_layers_iter_new"
2538
<return-value transfer-ownership="full">
2539
<type name="LayersIter" c:type="PopplerLayersIter*"/>
2542
<parameter name="document" transfer-ownership="none">
2543
<doc xml:whitespace="preserve">a #PopplerDocument</doc>
2544
<type name="Document" c:type="PopplerDocument*"/>
2548
<method name="copy" c:identifier="poppler_layers_iter_copy">
2549
<doc xml:whitespace="preserve">Creates a new #PopplerLayersIter as a copy of @iter. This must be freed with
2550
poppler_layers_iter_free().
2552
<return-value transfer-ownership="full">
2553
<doc xml:whitespace="preserve">a new #PopplerLayersIter</doc>
2554
<type name="LayersIter" c:type="PopplerLayersIter*"/>
2558
c:identifier="poppler_layers_iter_free"
2560
<doc xml:whitespace="preserve">Frees @iter.</doc>
2561
<return-value transfer-ownership="none">
2562
<type name="none" c:type="void"/>
2565
<method name="get_child"
2566
c:identifier="poppler_layers_iter_get_child"
2568
<doc xml:whitespace="preserve">Returns a newly created child of @parent, or %NULL if the iter has no child.
2569
See poppler_layers_iter_new() for more information on this function.</doc>
2570
<return-value transfer-ownership="full">
2571
<doc xml:whitespace="preserve">a new #PopplerLayersIter, or %NULL</doc>
2572
<type name="LayersIter" c:type="PopplerLayersIter*"/>
2575
<method name="get_layer"
2576
c:identifier="poppler_layers_iter_get_layer"
2579
<doc xml:whitespace="preserve">Returns the #PopplerLayer associated with @iter. It must be freed with
2580
poppler_layer_free().</doc>
2582
<doc xml:whitespace="preserve">a new #PopplerLayer, or %NULL if there isn't any layer associated with @iter</doc>
2583
<type name="Layer" c:type="PopplerLayer*"/>
2586
<method name="get_title"
2587
c:identifier="poppler_layers_iter_get_title"
2589
<doc xml:whitespace="preserve">Returns the title associated with @iter. It must be freed with
2591
The returned string should be freed with g_free() when no longer needed.</doc>
2592
<return-value transfer-ownership="full">
2593
<doc xml:whitespace="preserve">a new string containing the @iter's title or %NULL if @iter doesn't have a title.</doc>
2594
<type name="utf8" c:type="gchar*"/>
2598
c:identifier="poppler_layers_iter_next"
2600
<doc xml:whitespace="preserve">Sets @iter to point to the next action at the current level, if valid. See
2601
poppler_layers_iter_new() for more information.</doc>
2602
<return-value transfer-ownership="none">
2603
<doc xml:whitespace="preserve">%TRUE, if @iter was set to the next action</doc>
2604
<type name="gboolean" c:type="gboolean"/>
2608
<record name="LinkMapping"
2609
c:type="PopplerLinkMapping"
2610
glib:type-name="PopplerLinkMapping"
2611
glib:get-type="poppler_link_mapping_get_type"
2612
c:symbol-prefix="link_mapping">
2613
<doc xml:whitespace="preserve">A #PopplerLinkMapping structure represents the location
2614
of @action on the page</doc>
2615
<field name="area" writable="1">
2616
<type name="Rectangle" c:type="PopplerRectangle"/>
2618
<field name="action" writable="1">
2619
<type name="Action" c:type="PopplerAction*"/>
2621
<constructor name="new" c:identifier="poppler_link_mapping_new">
2622
<doc xml:whitespace="preserve">Creates a new #PopplerLinkMapping</doc>
2623
<return-value transfer-ownership="full">
2624
<doc xml:whitespace="preserve">a new #PopplerLinkMapping, use poppler_link_mapping_free() to free it</doc>
2625
<type name="LinkMapping" c:type="PopplerLinkMapping*"/>
2628
<method name="copy" c:identifier="poppler_link_mapping_copy">
2629
<doc xml:whitespace="preserve">Creates a copy of @mapping</doc>
2630
<return-value transfer-ownership="full">
2631
<doc xml:whitespace="preserve">a new allocated copy of @mapping</doc>
2632
<type name="LinkMapping" c:type="PopplerLinkMapping*"/>
2635
<method name="free" c:identifier="poppler_link_mapping_free">
2636
<doc xml:whitespace="preserve">Frees the given #PopplerLinkMapping</doc>
2637
<return-value transfer-ownership="none">
2638
<type name="none" c:type="void"/>
2643
c:symbol-prefix="media"
2644
c:type="PopplerMedia"
2645
parent="GObject.Object"
2646
glib:type-name="PopplerMedia"
2647
glib:get-type="poppler_media_get_type">
2648
<method name="get_filename" c:identifier="poppler_media_get_filename">
2649
<return-value transfer-ownership="none">
2650
<type name="utf8" c:type="gchar*"/>
2653
<method name="get_mime_type"
2654
c:identifier="poppler_media_get_mime_type"
2656
<doc xml:whitespace="preserve">Returns the media clip mime-type</doc>
2657
<return-value transfer-ownership="none">
2658
<doc xml:whitespace="preserve">the mime-type, return value is owned by #PopplerMedia and should not be freed</doc>
2659
<type name="utf8" c:type="gchar*"/>
2662
<method name="is_embedded"
2663
c:identifier="poppler_media_is_embedded"
2665
<doc xml:whitespace="preserve">Whether the media clip is embedded in the PDF. If the result is %TRUE, the embedded stream
2666
can be saved with poppler_media_save() or poppler_media_save_to_callback() function.
2667
If the result is %FALSE, the media clip filename can be retrieved with
2668
poppler_media_get_file_name() function.</doc>
2669
<return-value transfer-ownership="none">
2670
<doc xml:whitespace="preserve">%TRUE if media clip is embedded, %FALSE otherwise</doc>
2671
<type name="gboolean" c:type="gboolean"/>
2675
c:identifier="poppler_media_save"
2678
<doc xml:whitespace="preserve">Saves embedded stream of @poppler_media to a file indicated by @filename.
2679
If @error is set, %FALSE will be returned.
2680
Possible errors include those in the #G_FILE_ERROR domain
2681
and whatever the save function generates.</doc>
2682
<return-value transfer-ownership="none">
2683
<doc xml:whitespace="preserve">%TRUE, if the file successfully saved</doc>
2684
<type name="gboolean" c:type="gboolean"/>
2687
<parameter name="filename" transfer-ownership="none">
2688
<doc xml:whitespace="preserve">name of file to save</doc>
2689
<type name="utf8" c:type="char*"/>
2693
<method name="save_to_callback"
2694
c:identifier="poppler_media_save_to_callback"
2697
<doc xml:whitespace="preserve">Saves embedded stream of @poppler_media by feeding the produced data to @save_func. Can be used
2698
when you want to store the media clip stream to something other than a file, such as
2699
an in-memory buffer or a socket. If @error is set, %FALSE will be
2700
returned. Possible errors include those in the #G_FILE_ERROR domain and
2701
whatever the save function generates.</doc>
2702
<return-value transfer-ownership="none">
2703
<doc xml:whitespace="preserve">%TRUE, if the save successfully completed</doc>
2704
<type name="gboolean" c:type="gboolean"/>
2707
<parameter name="save_func"
2708
transfer-ownership="none"
2711
<doc xml:whitespace="preserve">a function that is called to save each block of data that the save routine generates.</doc>
2712
<type name="MediaSaveFunc" c:type="PopplerMediaSaveFunc"/>
2714
<parameter name="user_data" transfer-ownership="none">
2715
<doc xml:whitespace="preserve">user data to pass to the save function.</doc>
2716
<type name="gpointer" c:type="gpointer"/>
2721
<callback name="MediaSaveFunc"
2722
c:type="PopplerMediaSaveFunc"
2725
<doc xml:whitespace="preserve">Specifies the type of the function passed to
2726
poppler_media_save_to_callback(). It is called once for each block of
2727
bytes that is "written" by poppler_media_save_to_callback(). If
2728
successful it should return %TRUE. If an error occurs it should set
2729
will fail with the same error.</doc>
2730
<return-value transfer-ownership="none">
2731
<doc xml:whitespace="preserve">%TRUE if successful, %FALSE (with @error set) if failed.</doc>
2732
<type name="gboolean" c:type="gboolean"/>
2735
<parameter name="buf" transfer-ownership="none">
2736
<doc xml:whitespace="preserve">buffer containing bytes to be written.</doc>
2737
<type name="utf8" c:type="gchar*"/>
2739
<parameter name="count" transfer-ownership="none">
2740
<doc xml:whitespace="preserve">number of bytes in @buf.</doc>
2741
<type name="gulong" c:type="gsize"/>
2743
<parameter name="data" transfer-ownership="none">
2744
<doc xml:whitespace="preserve">user data passed to poppler_media_save_to_callback()</doc>
2745
<type name="gpointer" c:type="gpointer"/>
2750
c:symbol-prefix="movie"
2751
c:type="PopplerMovie"
2752
parent="GObject.Object"
2753
glib:type-name="PopplerMovie"
2754
glib:get-type="poppler_movie_get_type">
2755
<method name="get_filename" c:identifier="poppler_movie_get_filename">
2756
<return-value transfer-ownership="none">
2757
<type name="utf8" c:type="gchar*"/>
2760
<method name="need_poster"
2761
c:identifier="poppler_movie_need_poster"
2763
<doc xml:whitespace="preserve">Returns whether a poster image representing the Movie
2764
shall be displayed. The poster image must be retrieved
2765
from the movie file.</doc>
2766
<return-value transfer-ownership="none">
2767
<doc xml:whitespace="preserve">%TRUE if move needs a poster image, %FALSE otherwise</doc>
2768
<type name="gboolean" c:type="gboolean"/>
2771
<method name="show_controls"
2772
c:identifier="poppler_movie_show_controls"
2774
<doc xml:whitespace="preserve">Returns whether to display a movie controller bar while playing the movie</doc>
2775
<return-value transfer-ownership="none">
2776
<doc xml:whitespace="preserve">%TRUE if controller bar should be displayed, %FALSE otherwise</doc>
2777
<type name="gboolean" c:type="gboolean"/>
2781
<enumeration name="Orientation"
2782
glib:type-name="PopplerOrientation"
2783
glib:get-type="poppler_orientation_get_type"
2784
c:type="PopplerOrientation">
2785
<member name="portrait"
2787
c:identifier="POPPLER_ORIENTATION_PORTRAIT"
2788
glib:nick="portrait"/>
2789
<member name="landscape"
2791
c:identifier="POPPLER_ORIENTATION_LANDSCAPE"
2792
glib:nick="landscape"/>
2793
<member name="upsidedown"
2795
c:identifier="POPPLER_ORIENTATION_UPSIDEDOWN"
2796
glib:nick="upsidedown"/>
2797
<member name="seascape"
2799
c:identifier="POPPLER_ORIENTATION_SEASCAPE"
2800
glib:nick="seascape"/>
2802
<class name="PSFile"
2803
c:symbol-prefix="ps_file"
2804
c:type="PopplerPSFile"
2805
parent="GObject.Object"
2806
glib:type-name="PopplerPSFile"
2807
glib:get-type="poppler_ps_file_get_type">
2808
<constructor name="new" c:identifier="poppler_ps_file_new">
2809
<doc xml:whitespace="preserve">Create a new postscript file to render to</doc>
2810
<return-value transfer-ownership="full">
2811
<doc xml:whitespace="preserve">a PopplerPSFile</doc>
2812
<type name="PSFile" c:type="PopplerPSFile*"/>
2815
<parameter name="document" transfer-ownership="none">
2816
<doc xml:whitespace="preserve">a #PopplerDocument</doc>
2817
<type name="Document" c:type="PopplerDocument*"/>
2819
<parameter name="filename" transfer-ownership="none">
2820
<doc xml:whitespace="preserve">the path of the output filename</doc>
2821
<type name="utf8" c:type="char*"/>
2823
<parameter name="first_page" transfer-ownership="none">
2824
<doc xml:whitespace="preserve">the first page to print</doc>
2825
<type name="gint" c:type="int"/>
2827
<parameter name="n_pages" transfer-ownership="none">
2828
<doc xml:whitespace="preserve">the number of pages to print</doc>
2829
<type name="gint" c:type="int"/>
2833
<method name="free" c:identifier="poppler_ps_file_free">
2834
<doc xml:whitespace="preserve">Frees @ps_file</doc>
2835
<return-value transfer-ownership="none">
2836
<type name="none" c:type="void"/>
2839
<method name="set_duplex" c:identifier="poppler_ps_file_set_duplex">
2840
<doc xml:whitespace="preserve">Enable or disable Duplex printing.</doc>
2841
<return-value transfer-ownership="none">
2842
<type name="none" c:type="void"/>
2845
<parameter name="duplex" transfer-ownership="none">
2846
<doc xml:whitespace="preserve">whether to force duplex printing (on printers which support this)</doc>
2847
<type name="gboolean" c:type="gboolean"/>
2851
<method name="set_paper_size"
2852
c:identifier="poppler_ps_file_set_paper_size">
2853
<doc xml:whitespace="preserve">Set the output paper size. These values will end up in the
2854
DocumentMedia, the BoundingBox DSC comments and other places in the
2855
generated PostScript.</doc>
2856
<return-value transfer-ownership="none">
2857
<type name="none" c:type="void"/>
2860
<parameter name="width" transfer-ownership="none">
2861
<doc xml:whitespace="preserve">the paper width in 1/72 inch</doc>
2862
<type name="gdouble" c:type="double"/>
2864
<parameter name="height" transfer-ownership="none">
2865
<doc xml:whitespace="preserve">the paper height in 1/72 inch</doc>
2866
<type name="gdouble" c:type="double"/>
2872
c:symbol-prefix="page"
2873
c:type="PopplerPage"
2874
parent="GObject.Object"
2875
glib:type-name="PopplerPage"
2876
glib:get-type="poppler_page_get_type">
2877
<function name="free_annot_mapping"
2878
c:identifier="poppler_page_free_annot_mapping">
2879
<doc xml:whitespace="preserve">Frees a list of #PopplerAnnotMapping<!-- -->s allocated by
2880
poppler_page_get_annot_mapping(). It also frees the #PopplerAnnot<!-- -->s
2881
that each mapping contains, so if you want to keep them around, you need to
2882
copy them with poppler_annot_copy().</doc>
2883
<return-value transfer-ownership="none">
2884
<type name="none" c:type="void"/>
2887
<parameter name="list" transfer-ownership="none">
2888
<doc xml:whitespace="preserve">A list of #PopplerAnnotMapping<!-- -->s</doc>
2889
<type name="GLib.List" c:type="GList*">
2890
<type name="gpointer" c:type="gpointer"/>
2895
<function name="free_form_field_mapping"
2896
c:identifier="poppler_page_free_form_field_mapping">
2897
<doc xml:whitespace="preserve">Frees a list of #PopplerFormFieldMapping<!-- -->s allocated by
2898
poppler_page_get_form_field_mapping().</doc>
2899
<return-value transfer-ownership="none">
2900
<type name="none" c:type="void"/>
2903
<parameter name="list" transfer-ownership="none">
2904
<doc xml:whitespace="preserve">A list of #PopplerFormFieldMapping<!-- -->s</doc>
2905
<type name="GLib.List" c:type="GList*">
2906
<type name="gpointer" c:type="gpointer"/>
2911
<function name="free_image_mapping"
2912
c:identifier="poppler_page_free_image_mapping">
2913
<doc xml:whitespace="preserve">Frees a list of #PopplerImageMapping<!-- -->s allocated by
2914
poppler_page_get_image_mapping().</doc>
2915
<return-value transfer-ownership="none">
2916
<type name="none" c:type="void"/>
2919
<parameter name="list" transfer-ownership="none">
2920
<doc xml:whitespace="preserve">A list of #PopplerImageMapping<!-- -->s</doc>
2921
<type name="GLib.List" c:type="GList*">
2922
<type name="gpointer" c:type="gpointer"/>
2927
<function name="free_link_mapping"
2928
c:identifier="poppler_page_free_link_mapping">
2929
<doc xml:whitespace="preserve">Frees a list of #PopplerLinkMapping<!-- -->s allocated by
2930
poppler_page_get_link_mapping(). It also frees the #PopplerAction<!-- -->s
2931
that each mapping contains, so if you want to keep them around, you need to
2932
copy them with poppler_action_copy().</doc>
2933
<return-value transfer-ownership="none">
2934
<type name="none" c:type="void"/>
2937
<parameter name="list" transfer-ownership="none">
2938
<doc xml:whitespace="preserve">A list of #PopplerLinkMapping<!-- -->s</doc>
2939
<type name="GLib.List" c:type="GList*">
2940
<type name="gpointer" c:type="gpointer"/>
2945
<function name="selection_region_free"
2946
c:identifier="poppler_page_selection_region_free"
2948
<doc xml:whitespace="preserve">Frees @region</doc>
2949
<return-value transfer-ownership="none">
2950
<type name="none" c:type="void"/>
2953
<parameter name="region" transfer-ownership="none">
2954
<doc xml:whitespace="preserve">a #GList of #PopplerRectangle</doc>
2955
<type name="GLib.List" c:type="GList*">
2956
<type name="gpointer" c:type="gpointer"/>
2961
<method name="add_annot"
2962
c:identifier="poppler_page_add_annot"
2964
<doc xml:whitespace="preserve">Adds annotation @annot to @page.</doc>
2965
<return-value transfer-ownership="none">
2966
<type name="none" c:type="void"/>
2969
<parameter name="annot" transfer-ownership="none">
2970
<doc xml:whitespace="preserve">a #PopplerAnnot to add</doc>
2971
<type name="Annot" c:type="PopplerAnnot*"/>
2975
<method name="find_text" c:identifier="poppler_page_find_text">
2976
<doc xml:whitespace="preserve">A #GList of rectangles for each occurance of the text on the page.
2977
The coordinates are in PDF points.</doc>
2978
<return-value transfer-ownership="full">
2979
<doc xml:whitespace="preserve">a #GList of #PopplerRectangle,</doc>
2980
<type name="GLib.List" c:type="GList*">
2981
<type name="Rectangle"/>
2985
<parameter name="text" transfer-ownership="none">
2986
<doc xml:whitespace="preserve">the text to search for (UTF-8 encoded)</doc>
2987
<type name="utf8" c:type="char*"/>
2991
<method name="get_annot_mapping"
2992
c:identifier="poppler_page_get_annot_mapping">
2993
<doc xml:whitespace="preserve">Returns a list of #PopplerAnnotMapping items that map from a location on
2994
poppler_page_free_annot_mapping() when done.</doc>
2995
<return-value transfer-ownership="full">
2996
<doc xml:whitespace="preserve">A #GList of #PopplerAnnotMapping</doc>
2997
<type name="GLib.List" c:type="GList*">
2998
<type name="AnnotMapping"/>
3002
<method name="get_crop_box" c:identifier="poppler_page_get_crop_box">
3003
<doc xml:whitespace="preserve">Retrurns the crop box of @page</doc>
3004
<return-value transfer-ownership="none">
3005
<type name="none" c:type="void"/>
3008
<parameter name="rect"
3010
caller-allocates="1"
3011
transfer-ownership="none">
3012
<doc xml:whitespace="preserve">a #PopplerRectangle to fill</doc>
3013
<type name="Rectangle" c:type="PopplerRectangle*"/>
3017
<method name="get_duration" c:identifier="poppler_page_get_duration">
3018
<doc xml:whitespace="preserve">Returns the duration of @page</doc>
3019
<return-value transfer-ownership="none">
3020
<doc xml:whitespace="preserve">duration in seconds of @page or -1.</doc>
3021
<type name="gdouble" c:type="double"/>
3024
<method name="get_form_field_mapping"
3025
c:identifier="poppler_page_get_form_field_mapping">
3026
<doc xml:whitespace="preserve">Returns a list of #PopplerFormFieldMapping items that map from a
3027
location on @page to a form field. This list must be freed
3028
with poppler_page_free_form_field_mapping() when done.</doc>
3029
<return-value transfer-ownership="full">
3030
<doc xml:whitespace="preserve">A #GList of #PopplerFormFieldMapping</doc>
3031
<type name="GLib.List" c:type="GList*">
3032
<type name="FormFieldMapping"/>
3036
<method name="get_image" c:identifier="poppler_page_get_image">
3037
<doc xml:whitespace="preserve">Returns a cairo surface for the image of the @page</doc>
3038
<return-value transfer-ownership="full">
3039
<doc xml:whitespace="preserve">A cairo surface for the image</doc>
3040
<type name="cairo.Surface" c:type="cairo_surface_t*"/>
3043
<parameter name="image_id" transfer-ownership="none">
3044
<doc xml:whitespace="preserve">The image identificator</doc>
3045
<type name="gint" c:type="gint"/>
3049
<method name="get_image_mapping"
3050
c:identifier="poppler_page_get_image_mapping">
3051
<doc xml:whitespace="preserve">Returns a list of #PopplerImageMapping items that map from a
3052
location on @page to an image of the page. This list must be freed
3053
with poppler_page_free_image_mapping() when done.</doc>
3054
<return-value transfer-ownership="full">
3055
<doc xml:whitespace="preserve">A #GList of #PopplerImageMapping</doc>
3056
<type name="GLib.List" c:type="GList*">
3057
<type name="ImageMapping"/>
3061
<method name="get_index" c:identifier="poppler_page_get_index">
3062
<doc xml:whitespace="preserve">Returns the index of @page</doc>
3063
<return-value transfer-ownership="none">
3064
<doc xml:whitespace="preserve">index value of @page</doc>
3065
<type name="gint" c:type="int"/>
3068
<method name="get_label"
3069
c:identifier="poppler_page_get_label"
3071
<doc xml:whitespace="preserve">Returns the label of @page. Note that page labels
3072
and page indices might not coincide.
3073
or %NULL if @page doesn't have a label</doc>
3074
<return-value transfer-ownership="full">
3075
<doc xml:whitespace="preserve">a new allocated string containing the label of @page,</doc>
3076
<type name="utf8" c:type="gchar*"/>
3079
<method name="get_link_mapping"
3080
c:identifier="poppler_page_get_link_mapping">
3081
<doc xml:whitespace="preserve">Returns a list of #PopplerLinkMapping items that map from a
3082
location on @page to a #PopplerAction. This list must be freed
3083
with poppler_page_free_link_mapping() when done.</doc>
3084
<return-value transfer-ownership="full">
3085
<doc xml:whitespace="preserve">A #GList of #PopplerLinkMapping</doc>
3086
<type name="GLib.List" c:type="GList*">
3087
<type name="LinkMapping"/>
3091
<method name="get_selected_region"
3092
c:identifier="poppler_page_get_selected_region"
3094
<doc xml:whitespace="preserve">Returns a region containing the area that would be rendered by
3095
poppler_page_render_selection() or
3096
poppler_page_render_selection_to_pixbuf().
3097
The returned region must be freed with cairo_region_destroy()</doc>
3098
<return-value transfer-ownership="full">
3099
<doc xml:whitespace="preserve">a cairo_region_t</doc>
3100
<type name="cairo.Region" c:type="cairo_region_t*"/>
3103
<parameter name="scale" transfer-ownership="none">
3104
<doc xml:whitespace="preserve">scale specified as pixels per point</doc>
3105
<type name="gdouble" c:type="gdouble"/>
3107
<parameter name="style" transfer-ownership="none">
3108
<doc xml:whitespace="preserve">a #PopplerSelectionStyle</doc>
3109
<type name="SelectionStyle" c:type="PopplerSelectionStyle"/>
3111
<parameter name="selection" transfer-ownership="none">
3112
<doc xml:whitespace="preserve">start and end point of selection as a rectangle</doc>
3113
<type name="Rectangle" c:type="PopplerRectangle*"/>
3117
<method name="get_selected_text"
3118
c:identifier="poppler_page_get_selected_text"
3120
<doc xml:whitespace="preserve">Retrieves the contents of the specified @selection as text.
3122
<return-value transfer-ownership="full">
3123
<doc xml:whitespace="preserve">a pointer to the contents of the @selection</doc>
3124
<type name="utf8" c:type="char*"/>
3127
<parameter name="style" transfer-ownership="none">
3128
<doc xml:whitespace="preserve">a #PopplerSelectionStyle</doc>
3129
<type name="SelectionStyle" c:type="PopplerSelectionStyle"/>
3131
<parameter name="selection" transfer-ownership="none">
3132
<doc xml:whitespace="preserve">the #PopplerRectangle including the text</doc>
3133
<type name="Rectangle" c:type="PopplerRectangle*"/>
3137
<method name="get_selection_region"
3138
c:identifier="poppler_page_get_selection_region"
3139
deprecated="Use poppler_page_get_selected_region() instead."
3140
deprecated-version="0.16">
3141
<doc xml:whitespace="preserve">Returns a region containing the area that would be rendered by
3142
poppler_page_render_selection() or
3143
poppler_page_render_selection_to_pixbuf() as a #GList of
3144
#PopplerRectangle. The returned list must be freed with
3145
poppler_page_selection_region_free().</doc>
3146
<return-value transfer-ownership="full">
3147
<doc xml:whitespace="preserve">a #GList of #PopplerRectangle</doc>
3148
<type name="GLib.List" c:type="GList*">
3149
<type name="Rectangle"/>
3153
<parameter name="scale" transfer-ownership="none">
3154
<doc xml:whitespace="preserve">scale specified as pixels per point</doc>
3155
<type name="gdouble" c:type="gdouble"/>
3157
<parameter name="style" transfer-ownership="none">
3158
<doc xml:whitespace="preserve">a #PopplerSelectionStyle</doc>
3159
<type name="SelectionStyle" c:type="PopplerSelectionStyle"/>
3161
<parameter name="selection" transfer-ownership="none">
3162
<doc xml:whitespace="preserve">start and end point of selection as a rectangle</doc>
3163
<type name="Rectangle" c:type="PopplerRectangle*"/>
3167
<method name="get_size" c:identifier="poppler_page_get_size">
3168
<doc xml:whitespace="preserve">Gets the size of @page at the current scale and rotation.</doc>
3169
<return-value transfer-ownership="none">
3170
<type name="none" c:type="void"/>
3173
<parameter name="width"
3175
caller-allocates="0"
3176
transfer-ownership="full"
3178
<doc xml:whitespace="preserve">return location for the width of @page</doc>
3179
<type name="gdouble" c:type="double*"/>
3181
<parameter name="height"
3183
caller-allocates="0"
3184
transfer-ownership="full"
3186
<doc xml:whitespace="preserve">return location for the height of @page</doc>
3187
<type name="gdouble" c:type="double*"/>
3191
<method name="get_text"
3192
c:identifier="poppler_page_get_text"
3194
<doc xml:whitespace="preserve">Retrieves the text of @page.
3196
<return-value transfer-ownership="full">
3197
<doc xml:whitespace="preserve">a pointer to the text of the @page</doc>
3198
<type name="utf8" c:type="char*"/>
3201
<method name="get_text_layout"
3202
c:identifier="poppler_page_get_text_layout"
3204
<doc xml:whitespace="preserve">Obtains the layout of the text as a list of #PopplerRectangle
3205
This array must be freed with g_free () when done.
3206
The position in the array represents an offset in the text returned by
3207
poppler_page_get_text()</doc>
3208
<return-value transfer-ownership="none">
3209
<doc xml:whitespace="preserve">%TRUE if the page contains text, %FALSE otherwise</doc>
3210
<type name="gboolean" c:type="gboolean"/>
3213
<parameter name="rectangles"
3215
caller-allocates="0"
3216
transfer-ownership="container">
3217
<doc xml:whitespace="preserve">return location for an array of #PopplerRectangle</doc>
3218
<array length="1" c:type="PopplerRectangle**">
3219
<type name="Rectangle"/>
3222
<parameter name="n_rectangles"
3224
caller-allocates="0"
3225
transfer-ownership="full">
3226
<doc xml:whitespace="preserve">(out) length of returned array</doc>
3227
<type name="guint" c:type="guint*"/>
3231
<method name="get_thumbnail" c:identifier="poppler_page_get_thumbnail">
3232
<doc xml:whitespace="preserve">Get the embedded thumbnail for the specified page. If the document
3233
doesn't have an embedded thumbnail for the page, this function
3235
doesn't have a thumbnail for this page.</doc>
3236
<return-value transfer-ownership="full">
3237
<doc xml:whitespace="preserve">the tumbnail as a cairo_surface_t or %NULL if the document</doc>
3238
<type name="cairo.Surface" c:type="cairo_surface_t*"/>
3241
<method name="get_thumbnail_pixbuf"
3242
c:identifier="poppler_page_get_thumbnail_pixbuf"
3245
<doc xml:whitespace="preserve">Get the embedded thumbnail for the specified page. If the document
3246
doesn't have an embedded thumbnail for the page, this function
3248
doesn't have a thumbnail for this page.</doc>
3250
<doc xml:whitespace="preserve">the tumbnail as a #GdkPixbuf or %NULL if the document</doc>
3251
<type name="GdkPixbuf.Pixbuf" c:type="GdkPixbuf*"/>
3254
<method name="get_thumbnail_size"
3255
c:identifier="poppler_page_get_thumbnail_size">
3256
<doc xml:whitespace="preserve">Returns %TRUE if @page has a thumbnail associated with it. It also
3257
fills in @width and @height with the width and height of the
3258
thumbnail. The values of width and height are not changed if no
3259
appropriate thumbnail exists.</doc>
3260
<return-value transfer-ownership="none">
3261
<doc xml:whitespace="preserve">%TRUE, if @page has a thumbnail associated with it.</doc>
3262
<type name="gboolean" c:type="gboolean"/>
3265
<parameter name="width" transfer-ownership="none">
3266
<doc xml:whitespace="preserve">(out) return location for width</doc>
3267
<type name="gint" c:type="int*"/>
3269
<parameter name="height" transfer-ownership="none">
3270
<doc xml:whitespace="preserve">(out) return location for height</doc>
3271
<type name="gint" c:type="int*"/>
3275
<method name="get_transition" c:identifier="poppler_page_get_transition">
3276
<doc xml:whitespace="preserve">Returns the transition effect of @page</doc>
3277
<return-value transfer-ownership="full">
3278
<doc xml:whitespace="preserve">a #PopplerPageTransition or NULL.</doc>
3279
<type name="PageTransition" c:type="PopplerPageTransition*"/>
3282
<method name="render" c:identifier="poppler_page_render">
3283
<doc xml:whitespace="preserve">Render the page to the given cairo context. This function
3284
is for rendering a page that will be displayed. If you want
3285
to render a page that will be printed use
3286
poppler_page_render_for_printing() instead</doc>
3287
<return-value transfer-ownership="none">
3288
<type name="none" c:type="void"/>
3291
<parameter name="cairo" transfer-ownership="none">
3292
<doc xml:whitespace="preserve">cairo context to render to</doc>
3293
<type name="cairo.Context" c:type="cairo_t*"/>
3297
<method name="render_for_printing"
3298
c:identifier="poppler_page_render_for_printing">
3299
<doc xml:whitespace="preserve">Render the page to the given cairo context for printing.</doc>
3300
<return-value transfer-ownership="none">
3301
<type name="none" c:type="void"/>
3304
<parameter name="cairo" transfer-ownership="none">
3305
<doc xml:whitespace="preserve">cairo context to render to</doc>
3306
<type name="cairo.Context" c:type="cairo_t*"/>
3310
<method name="render_for_printing_with_options"
3311
c:identifier="poppler_page_render_for_printing_with_options"
3313
<doc xml:whitespace="preserve">Render the page to the given cairo context for printing
3314
with the specified options</doc>
3315
<return-value transfer-ownership="none">
3316
<type name="none" c:type="void"/>
3319
<parameter name="cairo" transfer-ownership="none">
3320
<doc xml:whitespace="preserve">cairo context to render to</doc>
3321
<type name="cairo.Context" c:type="cairo_t*"/>
3323
<parameter name="options" transfer-ownership="none">
3324
<doc xml:whitespace="preserve">print options</doc>
3325
<type name="PrintFlags" c:type="PopplerPrintFlags"/>
3329
<method name="render_selection"
3330
c:identifier="poppler_page_render_selection">
3331
<doc xml:whitespace="preserve">Render the selection specified by @selection for @page to
3332
the given cairo context. The selection will be rendered, using
3334
If non-NULL, @old_selection specifies the selection that is already
3335
rendered to @cairo, in which case this function will (some day)
3336
only render the changed part of the selection.</doc>
3337
<return-value transfer-ownership="none">
3338
<type name="none" c:type="void"/>
3341
<parameter name="cairo" transfer-ownership="none">
3342
<doc xml:whitespace="preserve">cairo context to render to</doc>
3343
<type name="cairo.Context" c:type="cairo_t*"/>
3345
<parameter name="selection" transfer-ownership="none">
3346
<doc xml:whitespace="preserve">start and end point of selection as a rectangle</doc>
3347
<type name="Rectangle" c:type="PopplerRectangle*"/>
3349
<parameter name="old_selection" transfer-ownership="none">
3350
<doc xml:whitespace="preserve">previous selection</doc>
3351
<type name="Rectangle" c:type="PopplerRectangle*"/>
3353
<parameter name="style" transfer-ownership="none">
3354
<doc xml:whitespace="preserve">a #PopplerSelectionStyle</doc>
3355
<type name="SelectionStyle" c:type="PopplerSelectionStyle"/>
3357
<parameter name="glyph_color" transfer-ownership="none">
3358
<doc xml:whitespace="preserve">color to use for drawing glyphs</doc>
3359
<type name="Color" c:type="PopplerColor*"/>
3361
<parameter name="background_color" transfer-ownership="none">
3362
<doc xml:whitespace="preserve">color to use for the selection background</doc>
3363
<type name="Color" c:type="PopplerColor*"/>
3367
<method name="render_selection_to_pixbuf"
3368
c:identifier="poppler_page_render_selection_to_pixbuf"
3370
<doc xml:whitespace="preserve">Render the selection specified by @selection for @page into
3372
If non-NULL, @old_selection specifies the selection that is already
3373
rendered in @pixbuf, in which case this function will (some day)
3374
only render the changed part of the selection.</doc>
3375
<return-value transfer-ownership="none">
3376
<type name="none" c:type="void"/>
3379
<parameter name="scale" transfer-ownership="none">
3380
<doc xml:whitespace="preserve">scale specified as pixels per point</doc>
3381
<type name="gdouble" c:type="gdouble"/>
3383
<parameter name="rotation" transfer-ownership="none">
3384
<doc xml:whitespace="preserve">rotate the document by the specified degree</doc>
3385
<type name="gint" c:type="int"/>
3387
<parameter name="pixbuf" transfer-ownership="none">
3388
<doc xml:whitespace="preserve">pixbuf to render to</doc>
3389
<type name="GdkPixbuf.Pixbuf" c:type="GdkPixbuf*"/>
3391
<parameter name="selection" transfer-ownership="none">
3392
<doc xml:whitespace="preserve">start and end point of selection as a rectangle</doc>
3393
<type name="Rectangle" c:type="PopplerRectangle*"/>
3395
<parameter name="old_selection" transfer-ownership="none">
3396
<doc xml:whitespace="preserve">previous selection</doc>
3397
<type name="Rectangle" c:type="PopplerRectangle*"/>
3399
<parameter name="style" transfer-ownership="none">
3400
<doc xml:whitespace="preserve">a #PopplerSelectionStyle</doc>
3401
<type name="SelectionStyle" c:type="PopplerSelectionStyle"/>
3403
<parameter name="glyph_color" transfer-ownership="none">
3404
<doc xml:whitespace="preserve">color to use for drawing glyphs</doc>
3405
<type name="Gdk.Color" c:type="GdkColor*"/>
3407
<parameter name="background_color" transfer-ownership="none">
3408
<doc xml:whitespace="preserve">color to use for the selection background</doc>
3409
<type name="Gdk.Color" c:type="GdkColor*"/>
3413
<method name="render_to_pixbuf"
3414
c:identifier="poppler_page_render_to_pixbuf"
3416
<doc xml:whitespace="preserve">First scale the document to match the specified pixels per point,
3417
then render the rectangle given by the upper left corner at
3418
(src_x, src_y) and src_width and src_height.
3419
This function is for rendering a page that will be displayed.
3420
If you want to render a page that will be printed use
3421
poppler_page_render_to_pixbuf_for_printing() instead</doc>
3422
<return-value transfer-ownership="none">
3423
<type name="none" c:type="void"/>
3426
<parameter name="src_x" transfer-ownership="none">
3427
<doc xml:whitespace="preserve">x coordinate of upper left corner</doc>
3428
<type name="gint" c:type="int"/>
3430
<parameter name="src_y" transfer-ownership="none">
3431
<doc xml:whitespace="preserve">y coordinate of upper left corner</doc>
3432
<type name="gint" c:type="int"/>
3434
<parameter name="src_width" transfer-ownership="none">
3435
<doc xml:whitespace="preserve">width of rectangle to render</doc>
3436
<type name="gint" c:type="int"/>
3438
<parameter name="src_height" transfer-ownership="none">
3439
<doc xml:whitespace="preserve">height of rectangle to render</doc>
3440
<type name="gint" c:type="int"/>
3442
<parameter name="scale" transfer-ownership="none">
3443
<doc xml:whitespace="preserve">scale specified as pixels per point</doc>
3444
<type name="gdouble" c:type="double"/>
3446
<parameter name="rotation" transfer-ownership="none">
3447
<doc xml:whitespace="preserve">rotate the document by the specified degree</doc>
3448
<type name="gint" c:type="int"/>
3450
<parameter name="pixbuf" transfer-ownership="none">
3451
<doc xml:whitespace="preserve">pixbuf to render into</doc>
3452
<type name="GdkPixbuf.Pixbuf" c:type="GdkPixbuf*"/>
3456
<method name="render_to_pixbuf_for_printing"
3457
c:identifier="poppler_page_render_to_pixbuf_for_printing"
3459
<doc xml:whitespace="preserve">First scale the document to match the specified pixels per point,
3460
then render the rectangle given by the upper left corner at
3461
(src_x, src_y) and src_width and src_height.
3462
This function is for rendering a page that will be printed.</doc>
3463
<return-value transfer-ownership="none">
3464
<type name="none" c:type="void"/>
3467
<parameter name="src_x" transfer-ownership="none">
3468
<doc xml:whitespace="preserve">x coordinate of upper left corner</doc>
3469
<type name="gint" c:type="int"/>
3471
<parameter name="src_y" transfer-ownership="none">
3472
<doc xml:whitespace="preserve">y coordinate of upper left corner</doc>
3473
<type name="gint" c:type="int"/>
3475
<parameter name="src_width" transfer-ownership="none">
3476
<doc xml:whitespace="preserve">width of rectangle to render</doc>
3477
<type name="gint" c:type="int"/>
3479
<parameter name="src_height" transfer-ownership="none">
3480
<doc xml:whitespace="preserve">height of rectangle to render</doc>
3481
<type name="gint" c:type="int"/>
3483
<parameter name="scale" transfer-ownership="none">
3484
<doc xml:whitespace="preserve">scale specified as pixels per point</doc>
3485
<type name="gdouble" c:type="double"/>
3487
<parameter name="rotation" transfer-ownership="none">
3488
<doc xml:whitespace="preserve">rotate the document by the specified degree</doc>
3489
<type name="gint" c:type="int"/>
3491
<parameter name="pixbuf" transfer-ownership="none">
3492
<doc xml:whitespace="preserve">pixbuf to render into</doc>
3493
<type name="GdkPixbuf.Pixbuf" c:type="GdkPixbuf*"/>
3497
<method name="render_to_ps" c:identifier="poppler_page_render_to_ps">
3498
<doc xml:whitespace="preserve">Render the page on a postscript file</doc>
3499
<return-value transfer-ownership="none">
3500
<type name="none" c:type="void"/>
3503
<parameter name="ps_file" transfer-ownership="none">
3504
<doc xml:whitespace="preserve">the PopplerPSFile to render to</doc>
3505
<type name="PSFile" c:type="PopplerPSFile*"/>
3509
<property name="label" transfer-ownership="none">
3510
<doc xml:whitespace="preserve">The label of the page or %NULL. See also poppler_page_get_label()</doc>
3514
<enumeration name="PageLayout"
3515
glib:type-name="PopplerPageLayout"
3516
glib:get-type="poppler_page_layout_get_type"
3517
c:type="PopplerPageLayout">
3518
<doc xml:whitespace="preserve">Page layout types</doc>
3519
<member name="unset"
3521
c:identifier="POPPLER_PAGE_LAYOUT_UNSET"
3523
<member name="single_page"
3525
c:identifier="POPPLER_PAGE_LAYOUT_SINGLE_PAGE"
3526
glib:nick="single-page"/>
3527
<member name="one_column"
3529
c:identifier="POPPLER_PAGE_LAYOUT_ONE_COLUMN"
3530
glib:nick="one-column"/>
3531
<member name="two_column_left"
3533
c:identifier="POPPLER_PAGE_LAYOUT_TWO_COLUMN_LEFT"
3534
glib:nick="two-column-left"/>
3535
<member name="two_column_right"
3537
c:identifier="POPPLER_PAGE_LAYOUT_TWO_COLUMN_RIGHT"
3538
glib:nick="two-column-right"/>
3539
<member name="two_page_left"
3541
c:identifier="POPPLER_PAGE_LAYOUT_TWO_PAGE_LEFT"
3542
glib:nick="two-page-left"/>
3543
<member name="two_page_right"
3545
c:identifier="POPPLER_PAGE_LAYOUT_TWO_PAGE_RIGHT"
3546
glib:nick="two-page-right"/>
3548
<enumeration name="PageMode"
3549
glib:type-name="PopplerPageMode"
3550
glib:get-type="poppler_page_mode_get_type"
3551
c:type="PopplerPageMode">
3552
<doc xml:whitespace="preserve">Page modes</doc>
3553
<member name="unset"
3555
c:identifier="POPPLER_PAGE_MODE_UNSET"
3559
c:identifier="POPPLER_PAGE_MODE_NONE"
3561
<member name="use_outlines"
3563
c:identifier="POPPLER_PAGE_MODE_USE_OUTLINES"
3564
glib:nick="use-outlines"/>
3565
<member name="use_thumbs"
3567
c:identifier="POPPLER_PAGE_MODE_USE_THUMBS"
3568
glib:nick="use-thumbs"/>
3569
<member name="full_screen"
3571
c:identifier="POPPLER_PAGE_MODE_FULL_SCREEN"
3572
glib:nick="full-screen"/>
3573
<member name="use_oc"
3575
c:identifier="POPPLER_PAGE_MODE_USE_OC"
3576
glib:nick="use-oc"/>
3577
<member name="use_attachments"
3579
c:identifier="POPPLER_PAGE_MODE_USE_ATTACHMENTS"
3580
glib:nick="use-attachments"/>
3582
<record name="PageTransition"
3583
c:type="PopplerPageTransition"
3584
glib:type-name="PopplerPageTransition"
3585
glib:get-type="poppler_page_transition_get_type"
3586
c:symbol-prefix="page_transition">
3587
<doc xml:whitespace="preserve">A #PopplerPageTransition structures describes a visual transition
3588
to use when moving between pages during a presentation</doc>
3589
<field name="type" writable="1">
3590
<type name="PageTransitionType" c:type="PopplerPageTransitionType"/>
3592
<field name="alignment" writable="1">
3593
<type name="PageTransitionAlignment"
3594
c:type="PopplerPageTransitionAlignment"/>
3596
<field name="direction" writable="1">
3597
<type name="PageTransitionDirection"
3598
c:type="PopplerPageTransitionDirection"/>
3600
<field name="duration" writable="1">
3601
<type name="gint" c:type="gint"/>
3603
<field name="angle" writable="1">
3604
<type name="gint" c:type="gint"/>
3606
<field name="scale" writable="1">
3607
<type name="gdouble" c:type="gdouble"/>
3609
<field name="rectangular" writable="1">
3610
<type name="gboolean" c:type="gboolean"/>
3612
<constructor name="new" c:identifier="poppler_page_transition_new">
3613
<doc xml:whitespace="preserve">Creates a new #PopplerPageTransition</doc>
3614
<return-value transfer-ownership="full">
3615
<doc xml:whitespace="preserve">a new #PopplerPageTransition, use poppler_page_transition_free() to free it</doc>
3616
<type name="PageTransition" c:type="PopplerPageTransition*"/>
3619
<method name="copy" c:identifier="poppler_page_transition_copy">
3620
<doc xml:whitespace="preserve">Creates a copy of @transition</doc>
3621
<return-value transfer-ownership="full">
3622
<doc xml:whitespace="preserve">a new allocated copy of @transition</doc>
3623
<type name="PageTransition" c:type="PopplerPageTransition*"/>
3626
<method name="free" c:identifier="poppler_page_transition_free">
3627
<doc xml:whitespace="preserve">Frees the given #PopplerPageTransition</doc>
3628
<return-value transfer-ownership="none">
3629
<type name="none" c:type="void"/>
3633
<enumeration name="PageTransitionAlignment"
3634
glib:type-name="PopplerPageTransitionAlignment"
3635
glib:get-type="poppler_page_transition_alignment_get_type"
3636
c:type="PopplerPageTransitionAlignment">
3637
<doc xml:whitespace="preserve">Page transition alignment types for #POPPLER_PAGE_TRANSITION_SPLIT
3638
and #POPPLER_PAGE_TRANSITION_BLINDS transition types</doc>
3639
<member name="horizontal"
3641
c:identifier="POPPLER_PAGE_TRANSITION_HORIZONTAL"
3642
glib:nick="horizontal"/>
3643
<member name="vertical"
3645
c:identifier="POPPLER_PAGE_TRANSITION_VERTICAL"
3646
glib:nick="vertical"/>
3648
<enumeration name="PageTransitionDirection"
3649
glib:type-name="PopplerPageTransitionDirection"
3650
glib:get-type="poppler_page_transition_direction_get_type"
3651
c:type="PopplerPageTransitionDirection">
3652
<doc xml:whitespace="preserve">Page transition direction types for #POPPLER_PAGE_TRANSITION_SPLIT,
3653
#POPPLER_PAGE_TRANSITION_BOX and #POPPLER_PAGE_TRANSITION_FLY transition types</doc>
3654
<member name="inward"
3656
c:identifier="POPPLER_PAGE_TRANSITION_INWARD"
3657
glib:nick="inward"/>
3658
<member name="outward"
3660
c:identifier="POPPLER_PAGE_TRANSITION_OUTWARD"
3661
glib:nick="outward"/>
3663
<enumeration name="PageTransitionType"
3664
glib:type-name="PopplerPageTransitionType"
3665
glib:get-type="poppler_page_transition_type_get_type"
3666
c:type="PopplerPageTransitionType">
3667
<doc xml:whitespace="preserve">Page transition types</doc>
3668
<member name="replace"
3670
c:identifier="POPPLER_PAGE_TRANSITION_REPLACE"
3671
glib:nick="replace"/>
3672
<member name="split"
3674
c:identifier="POPPLER_PAGE_TRANSITION_SPLIT"
3676
<member name="blinds"
3678
c:identifier="POPPLER_PAGE_TRANSITION_BLINDS"
3679
glib:nick="blinds"/>
3682
c:identifier="POPPLER_PAGE_TRANSITION_BOX"
3686
c:identifier="POPPLER_PAGE_TRANSITION_WIPE"
3688
<member name="dissolve"
3690
c:identifier="POPPLER_PAGE_TRANSITION_DISSOLVE"
3691
glib:nick="dissolve"/>
3692
<member name="glitter"
3694
c:identifier="POPPLER_PAGE_TRANSITION_GLITTER"
3695
glib:nick="glitter"/>
3698
c:identifier="POPPLER_PAGE_TRANSITION_FLY"
3702
c:identifier="POPPLER_PAGE_TRANSITION_PUSH"
3704
<member name="cover"
3706
c:identifier="POPPLER_PAGE_TRANSITION_COVER"
3708
<member name="uncover"
3710
c:identifier="POPPLER_PAGE_TRANSITION_UNCOVER"
3711
glib:nick="uncover"/>
3714
c:identifier="POPPLER_PAGE_TRANSITION_FADE"
3717
<bitfield name="Permissions"
3718
glib:type-name="PopplerPermissions"
3719
glib:get-type="poppler_permissions_get_type"
3720
c:type="PopplerPermissions">
3721
<doc xml:whitespace="preserve">Permissions</doc>
3722
<member name="ok_to_print"
3724
c:identifier="POPPLER_PERMISSIONS_OK_TO_PRINT"
3725
glib:nick="ok-to-print"/>
3726
<member name="ok_to_modify"
3728
c:identifier="POPPLER_PERMISSIONS_OK_TO_MODIFY"
3729
glib:nick="ok-to-modify"/>
3730
<member name="ok_to_copy"
3732
c:identifier="POPPLER_PERMISSIONS_OK_TO_COPY"
3733
glib:nick="ok-to-copy"/>
3734
<member name="ok_to_add_notes"
3736
c:identifier="POPPLER_PERMISSIONS_OK_TO_ADD_NOTES"
3737
glib:nick="ok-to-add-notes"/>
3738
<member name="ok_to_fill_form"
3740
c:identifier="POPPLER_PERMISSIONS_OK_TO_FILL_FORM"
3741
glib:nick="ok-to-fill-form"/>
3744
c:identifier="POPPLER_PERMISSIONS_FULL"
3747
<bitfield name="PrintFlags"
3749
glib:type-name="PopplerPrintFlags"
3750
glib:get-type="poppler_print_flags_get_type"
3751
c:type="PopplerPrintFlags">
3752
<doc xml:whitespace="preserve">Printing flags</doc>
3753
<member name="document"
3755
c:identifier="POPPLER_PRINT_DOCUMENT"
3756
glib:nick="document"/>
3757
<member name="markup_annots"
3759
c:identifier="POPPLER_PRINT_MARKUP_ANNOTS"
3760
glib:nick="markup-annots"/>
3761
<member name="stamp_annots_only"
3763
c:identifier="POPPLER_PRINT_STAMP_ANNOTS_ONLY"
3764
glib:nick="stamp-annots-only"/>
3767
c:identifier="POPPLER_PRINT_ALL"
3770
<record name="Rectangle"
3771
c:type="PopplerRectangle"
3772
glib:type-name="PopplerRectangle"
3773
glib:get-type="poppler_rectangle_get_type"
3774
c:symbol-prefix="rectangle">
3775
<doc xml:whitespace="preserve">A #PopplerRectangle is used to describe
3776
locations on a page and bounding boxes</doc>
3777
<field name="x1" writable="1">
3778
<type name="gdouble" c:type="gdouble"/>
3780
<field name="y1" writable="1">
3781
<type name="gdouble" c:type="gdouble"/>
3783
<field name="x2" writable="1">
3784
<type name="gdouble" c:type="gdouble"/>
3786
<field name="y2" writable="1">
3787
<type name="gdouble" c:type="gdouble"/>
3789
<constructor name="new" c:identifier="poppler_rectangle_new">
3790
<doc xml:whitespace="preserve">Creates a new #PopplerRectangle</doc>
3791
<return-value transfer-ownership="full">
3792
<doc xml:whitespace="preserve">a new #PopplerRectangle, use poppler_rectangle_free() to free it</doc>
3793
<type name="Rectangle" c:type="PopplerRectangle*"/>
3796
<method name="copy" c:identifier="poppler_rectangle_copy">
3797
<doc xml:whitespace="preserve">Creates a copy of @rectangle</doc>
3798
<return-value transfer-ownership="full">
3799
<doc xml:whitespace="preserve">a new allocated copy of @rectangle</doc>
3800
<type name="Rectangle" c:type="PopplerRectangle*"/>
3803
<method name="free" c:identifier="poppler_rectangle_free">
3804
<doc xml:whitespace="preserve">Frees the given #PopplerRectangle</doc>
3805
<return-value transfer-ownership="none">
3806
<type name="none" c:type="void"/>
3810
<enumeration name="SelectionStyle"
3811
glib:type-name="PopplerSelectionStyle"
3812
glib:get-type="poppler_selection_style_get_type"
3813
c:type="PopplerSelectionStyle">
3814
<doc xml:whitespace="preserve">Selection styles</doc>
3815
<member name="glyph"
3817
c:identifier="POPPLER_SELECTION_GLYPH"
3821
c:identifier="POPPLER_SELECTION_WORD"
3825
c:identifier="POPPLER_SELECTION_LINE"
3828
<bitfield name="ViewerPreferences"
3829
glib:type-name="PopplerViewerPreferences"
3830
glib:get-type="poppler_viewer_preferences_get_type"
3831
c:type="PopplerViewerPreferences">
3832
<doc xml:whitespace="preserve">Viewer preferences</doc>
3833
<member name="unset"
3835
c:identifier="POPPLER_VIEWER_PREFERENCES_UNSET"
3837
<member name="hide_toolbar"
3839
c:identifier="POPPLER_VIEWER_PREFERENCES_HIDE_TOOLBAR"
3840
glib:nick="hide-toolbar"/>
3841
<member name="hide_menubar"
3843
c:identifier="POPPLER_VIEWER_PREFERENCES_HIDE_MENUBAR"
3844
glib:nick="hide-menubar"/>
3845
<member name="hide_windowui"
3847
c:identifier="POPPLER_VIEWER_PREFERENCES_HIDE_WINDOWUI"
3848
glib:nick="hide-windowui"/>
3849
<member name="fit_window"
3851
c:identifier="POPPLER_VIEWER_PREFERENCES_FIT_WINDOW"
3852
glib:nick="fit-window"/>
3853
<member name="center_window"
3855
c:identifier="POPPLER_VIEWER_PREFERENCES_CENTER_WINDOW"
3856
glib:nick="center-window"/>
3857
<member name="display_doc_title"
3859
c:identifier="POPPLER_VIEWER_PREFERENCES_DISPLAY_DOC_TITLE"
3860
glib:nick="display-doc-title"/>
3861
<member name="direction_rtl"
3863
c:identifier="POPPLER_VIEWER_PREFERENCES_DIRECTION_RTL"
3864
glib:nick="direction-rtl"/>
3866
<record name="_AttachmentClass" c:type="_PopplerAttachmentClass">
3867
<field name="parent_class" writable="1">
3868
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
3871
<function name="date_parse"
3872
c:identifier="poppler_date_parse"
3874
<doc xml:whitespace="preserve">Parses a PDF format date string and converts it to a #time_t. Returns #FALSE
3875
if the parsing fails or the input string is not a valid PDF format date string</doc>
3876
<return-value transfer-ownership="none">
3877
<doc xml:whitespace="preserve">#TRUE, if @timet was set</doc>
3878
<type name="gboolean" c:type="gboolean"/>
3881
<parameter name="date" transfer-ownership="none">
3882
<doc xml:whitespace="preserve">string to parse</doc>
3883
<type name="utf8" c:type="gchar*"/>
3885
<parameter name="timet" transfer-ownership="none">
3886
<doc xml:whitespace="preserve">an uninitialized #time_t</doc>
3887
<type name="glong" c:type="time_t*"/>
3891
<function name="error_quark" c:identifier="poppler_error_quark">
3892
<return-value transfer-ownership="none">
3893
<type name="GLib.Quark" c:type="GQuark"/>
3896
<function name="get_backend" c:identifier="poppler_get_backend">
3897
<doc xml:whitespace="preserve">Returns the backend compiled into the poppler library.</doc>
3898
<return-value transfer-ownership="none">
3899
<doc xml:whitespace="preserve">The backend used by poppler</doc>
3900
<type name="Backend" c:type="PopplerBackend"/>
3903
<function name="get_version" c:identifier="poppler_get_version">
3904
<doc xml:whitespace="preserve">Returns the version of poppler in use. This result is not to be freed.</doc>
3905
<return-value transfer-ownership="none">
3906
<doc xml:whitespace="preserve">the version of poppler.</doc>
3907
<type name="utf8" c:type="char*"/>
added
removed
tests/poppler/glib/Poppler-0.16.gir
