/usr/share/gir-1.0/GXPS-0.1.gir is in libgxps-dev 0.2.2-2ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 | <?xml version="1.0"?>
<!-- This file was automatically generated from C sources - DO NOT EDIT!
To affect the contents of this file, edit the original C definitions,
and/or use gtk-doc annotations. -->
<repository version="1.2"
xmlns="http://www.gtk.org/introspection/core/1.0"
xmlns:c="http://www.gtk.org/introspection/c/1.0"
xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
<include name="GLib" version="2.0"/>
<include name="GObject" version="2.0"/>
<include name="Gio" version="2.0"/>
<include name="cairo" version="1.0"/>
<namespace name="GXPS"
version="0.1"
shared-library="libgxps.so.2"
c:identifier-prefixes="GXPS"
c:symbol-prefixes="gxps">
<class name="Document"
c:symbol-prefix="document"
c:type="GXPSDocument"
parent="GObject.Object"
glib:type-name="GXPSDocument"
glib:get-type="gxps_document_get_type"
glib:type-struct="DocumentClass">
<doc xml:whitespace="preserve">The <structname>GXPSDocument</structname> struct contains
only private fields and should not be directly accessed.</doc>
<implements name="Gio.Initable"/>
<method name="get_n_pages" c:identifier="gxps_document_get_n_pages">
<doc xml:whitespace="preserve">Gets the number of pages in @doc.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the number of pages.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="doc" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSDocument</doc>
<type name="Document" c:type="GXPSDocument*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_page" c:identifier="gxps_document_get_page" throws="1">
<doc xml:whitespace="preserve">Creates a new #GXPSPage representing the page at
index @n_doc in @doc document.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a new #GXPSPage or %NULL on error. Free the returned object with g_object_unref().</doc>
<type name="Page" c:type="GXPSPage*"/>
</return-value>
<parameters>
<instance-parameter name="doc" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSDocument</doc>
<type name="Document" c:type="GXPSDocument*"/>
</instance-parameter>
<parameter name="n_page" transfer-ownership="none">
<doc xml:whitespace="preserve">the index of the page to get</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="get_page_for_anchor"
c:identifier="gxps_document_get_page_for_anchor">
<doc xml:whitespace="preserve">Gets the index of the page in @doc where the given
anchor is.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the page index of the given anchor.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="doc" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSDocument</doc>
<type name="Document" c:type="GXPSDocument*"/>
</instance-parameter>
<parameter name="anchor" transfer-ownership="none">
<doc xml:whitespace="preserve">the name of an anchor</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_page_size" c:identifier="gxps_document_get_page_size">
<doc xml:whitespace="preserve">Gets the typical size of the page at index @n_page in @doc document.
This function is useful to get the advisory size of pages in a document
without creating #GXPSPage objects. This page size might be different than
the actual page size so page dimension might need to be updated once the
page is loaded. Advisory page sizes are not always available in @doc,
in which case this function returns %FALSE.
To get the authoritative size of a page you should use gxps_page_get_size()
instead.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE if the page size information is available in @doc, %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="doc" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSDocument</doc>
<type name="Document" c:type="GXPSDocument*"/>
</instance-parameter>
<parameter name="n_page" transfer-ownership="none">
<doc xml:whitespace="preserve">the index of a page in @doc</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="width"
direction="out"
caller-allocates="0"
transfer-ownership="full"
allow-none="1">
<doc xml:whitespace="preserve">return location for the width of @n_page</doc>
<type name="gdouble" c:type="gdouble*"/>
</parameter>
<parameter name="height"
direction="out"
caller-allocates="0"
transfer-ownership="full"
allow-none="1">
<doc xml:whitespace="preserve">return location for the height of @n_page</doc>
<type name="gdouble" c:type="gdouble*"/>
</parameter>
</parameters>
</method>
<method name="get_structure" c:identifier="gxps_document_get_structure">
<doc xml:whitespace="preserve">Creates a new #GXPSDocumentStructure representing the document
structure of @doc.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a new #GXPSDocumentStructure or %NULL if document doesn't have a structure. Free the returned object with g_object_unref().</doc>
<type name="DocumentStructure" c:type="GXPSDocumentStructure*"/>
</return-value>
<parameters>
<instance-parameter name="doc" transfer-ownership="none">
<doc xml:whitespace="preserve">a a #GXPSDocument</doc>
<type name="Document" c:type="GXPSDocument*"/>
</instance-parameter>
</parameters>
</method>
<property name="archive"
introspectable="0"
readable="0"
writable="1"
construct-only="1"
transfer-ownership="none">
<type/>
</property>
<property name="source"
readable="0"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="priv" readable="0" private="1">
<type name="DocumentPrivate" c:type="GXPSDocumentPrivate*"/>
</field>
</class>
<record name="DocumentClass"
c:type="GXPSDocumentClass"
glib:is-gtype-struct-for="Document">
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<record name="DocumentPrivate" c:type="GXPSDocumentPrivate" disguised="1">
</record>
<class name="DocumentStructure"
c:symbol-prefix="document_structure"
c:type="GXPSDocumentStructure"
parent="GObject.Object"
glib:type-name="GXPSDocumentStructure"
glib:get-type="gxps_document_structure_get_type"
glib:type-struct="DocumentStructureClass">
<doc xml:whitespace="preserve">The <structname>GXPSDocumentStructure</structname> struct contains
only private fields and should not be directly accessed.</doc>
<function name="outline_iter_init"
c:identifier="gxps_document_structure_outline_iter_init">
<doc xml:whitespace="preserve">Initializes @iter to the root item of the outline contained by @structure
and a associates it with @structure.
Here is a simple example of some code that walks the full outline:
<informalexample><programlisting>
static void
walk_outline (GXPSOutlineIter *iter)
{
do {
GXPSOutlineIter child_iter;
const gchar *description = gxps_outline_iter_get_description (iter);
GXPSLinkTarget *target = gxps_outline_iter_get_target (iter);
/<!-- -->* Do something with description and taregt *<!-- -->/
if (gxps_outline_iter_children (&child_iter, iter))
walk_outline (&child_iter);
} while (gxps_outline_iter_next (iter));
}
...
{
GXPSOutlineIter iter;
if (gxps_document_structure_outline_iter_init (&iter, structure))
walk_outline (&iter);
}
</programlisting></informalexample></doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE if @iter was successfully initialized to the root item, %FALSE if it failed or @structure does not have an outline.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="iter" transfer-ownership="none">
<doc xml:whitespace="preserve">an uninitialized #GXPSOutlineIter</doc>
<type name="OutlineIter" c:type="GXPSOutlineIter*"/>
</parameter>
<parameter name="structure" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSDocumentStructure</doc>
<type name="DocumentStructure" c:type="GXPSDocumentStructure*"/>
</parameter>
</parameters>
</function>
<method name="has_outline"
c:identifier="gxps_document_structure_has_outline">
<doc xml:whitespace="preserve">Whether @structure has an outline or not.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE if @structure has an outline, %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="structure" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSDocumentStructure</doc>
<type name="DocumentStructure" c:type="GXPSDocumentStructure*"/>
</instance-parameter>
</parameters>
</method>
<property name="archive"
introspectable="0"
readable="0"
writable="1"
construct-only="1"
transfer-ownership="none">
<type/>
</property>
<property name="source"
readable="0"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="priv" readable="0" private="1">
<type name="DocumentStructurePrivate"
c:type="GXPSDocumentStructurePrivate*"/>
</field>
</class>
<record name="DocumentStructureClass"
c:type="GXPSDocumentStructureClass"
glib:is-gtype-struct-for="DocumentStructure">
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<record name="DocumentStructurePrivate"
c:type="GXPSDocumentStructurePrivate"
disguised="1">
</record>
<enumeration name="Error"
c:type="GXPSError"
glib:error-domain="gxps-error-quark">
<doc xml:whitespace="preserve">Error codes returned by GXPS functions.</doc>
<member name="source_not_found"
value="0"
c:identifier="GXPS_ERROR_SOURCE_NOT_FOUND">
<doc xml:whitespace="preserve">Internal source file not found in XPS file</doc>
</member>
<member name="font" value="1" c:identifier="GXPS_ERROR_FONT">
<doc xml:whitespace="preserve">Error loading fonts</doc>
</member>
<member name="image" value="2" c:identifier="GXPS_ERROR_IMAGE">
<doc xml:whitespace="preserve">Error loading images</doc>
</member>
</enumeration>
<class name="File"
c:symbol-prefix="file"
c:type="GXPSFile"
parent="GObject.Object"
glib:type-name="GXPSFile"
glib:get-type="gxps_file_get_type"
glib:type-struct="FileClass">
<doc xml:whitespace="preserve">The <structname>GXPSFile</structname> struct contains
only private fields and should not be directly accessed.</doc>
<implements name="Gio.Initable"/>
<constructor name="new" c:identifier="gxps_file_new" throws="1">
<doc xml:whitespace="preserve">Creates a new #GXPSFile for the given #GFile.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a #GXPSFile or %NULL on error.</doc>
<type name="File" c:type="GXPSFile*"/>
</return-value>
<parameters>
<parameter name="filename" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GFile</doc>
<type name="Gio.File" c:type="GFile*"/>
</parameter>
</parameters>
</constructor>
<function name="error_quark" c:identifier="gxps_file_error_quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<method name="get_document"
c:identifier="gxps_file_get_document"
throws="1">
<doc xml:whitespace="preserve">Creates a new #GXPSDocument representing the document at
index @n_doc in @xps file.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a new #GXPSDocument or %NULL on error. Free the returned object with g_object_unref().</doc>
<type name="Document" c:type="GXPSDocument*"/>
</return-value>
<parameters>
<instance-parameter name="xps" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSFile</doc>
<type name="File" c:type="GXPSFile*"/>
</instance-parameter>
<parameter name="n_doc" transfer-ownership="none">
<doc xml:whitespace="preserve">the index of the document to get</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="get_document_for_link_target"
c:identifier="gxps_file_get_document_for_link_target">
<doc xml:whitespace="preserve">Gets the index of the document in @xps pointed by @target.
If the #GXPSLinkTarget does not reference a document, or
referenced document is not found in @xps file -1 will be
returned. In this case you can look for the page pointed by
the link target by calling gxps_document_get_page_for_anchor()
with the anchor of the #GXPSLinkTarget for every document in
@xps.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the index of the document pointed by the given #GXPSLinkTarget or -1.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="xps" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSFile</doc>
<type name="File" c:type="GXPSFile*"/>
</instance-parameter>
<parameter name="target" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSLinkTarget</doc>
<type name="LinkTarget" c:type="GXPSLinkTarget*"/>
</parameter>
</parameters>
</method>
<method name="get_n_documents" c:identifier="gxps_file_get_n_documents">
<doc xml:whitespace="preserve">Gets the number of documents in @xps.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the number of documents.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="xps" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSFile</doc>
<type name="File" c:type="GXPSFile*"/>
</instance-parameter>
</parameters>
</method>
<property name="file"
readable="0"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="Gio.File"/>
</property>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="priv" readable="0" private="1">
<type name="FilePrivate" c:type="GXPSFilePrivate*"/>
</field>
</class>
<record name="FileClass"
c:type="GXPSFileClass"
glib:is-gtype-struct-for="File">
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<enumeration name="FileError" c:type="GXPSFileError">
<doc xml:whitespace="preserve">Error codes returned by #GXPSFile functions.</doc>
<member name="file_error_invalid"
value="0"
c:identifier="GXPS_FILE_ERROR_INVALID">
<doc xml:whitespace="preserve">The XPS is invalid.</doc>
</member>
</enumeration>
<record name="FilePrivate" c:type="GXPSFilePrivate" disguised="1">
</record>
<record name="Link"
c:type="GXPSLink"
glib:type-name="GXPSLink"
glib:get-type="gxps_link_get_type"
c:symbol-prefix="link">
<doc xml:whitespace="preserve">GXPSLink maps a location in a page to a #GXPSLinkTarget.</doc>
<method name="copy" c:identifier="gxps_link_copy">
<doc xml:whitespace="preserve">Creates a copy of a #GXPSLink.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a copy of @link. Free the returned object with gxps_link_free().</doc>
<type name="Link" c:type="GXPSLink*"/>
</return-value>
<parameters>
<instance-parameter name="link" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSLink</doc>
<type name="Link" c:type="GXPSLink*"/>
</instance-parameter>
</parameters>
</method>
<method name="free" c:identifier="gxps_link_free">
<doc xml:whitespace="preserve">Frees a #GXPSLink.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="link" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSLink</doc>
<type name="Link" c:type="GXPSLink*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_area"
c:identifier="gxps_link_get_area"
introspectable="0">
<doc xml:whitespace="preserve">Gets the rectangle of a page where the #GXPSLinkTarget
mapped by @link is.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="link" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSLink</doc>
<type name="Link" c:type="GXPSLink*"/>
</instance-parameter>
<parameter name="area"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:whitespace="preserve">return location for page area</doc>
<type c:type="cairo_rectangle_t*"/>
</parameter>
</parameters>
</method>
<method name="get_target" c:identifier="gxps_link_get_target">
<doc xml:whitespace="preserve">Gets the #GXPSLinkTarget mapped by @link.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the #GXPSLinkTarget of @link.</doc>
<type name="LinkTarget" c:type="GXPSLinkTarget*"/>
</return-value>
<parameters>
<instance-parameter name="link" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSLink</doc>
<type name="Link" c:type="GXPSLink*"/>
</instance-parameter>
</parameters>
</method>
</record>
<record name="LinkTarget"
c:type="GXPSLinkTarget"
glib:type-name="GXPSLinkTarget"
glib:get-type="gxps_link_target_get_type"
c:symbol-prefix="link_target">
<doc xml:whitespace="preserve">GXPSLinkTarget represents a hyperlink source.</doc>
<method name="copy" c:identifier="gxps_link_target_copy">
<doc xml:whitespace="preserve">Creates a copy of a #GXPSLinkTarget</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a copy of @target. Free the returned object with gxps_link_target_free()</doc>
<type name="LinkTarget" c:type="GXPSLinkTarget*"/>
</return-value>
<parameters>
<instance-parameter name="target" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSLinkTarget</doc>
<type name="LinkTarget" c:type="GXPSLinkTarget*"/>
</instance-parameter>
</parameters>
</method>
<method name="free" c:identifier="gxps_link_target_free">
<doc xml:whitespace="preserve">Frees a #GXPSLinkTarget.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="target" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSLinkTarget</doc>
<type name="LinkTarget" c:type="GXPSLinkTarget*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_anchor" c:identifier="gxps_link_target_get_anchor">
<doc xml:whitespace="preserve">Gets the anchor name @target links to. If @target is
an internal #GXPSLinkTarget this function always returns
and anchor, if it is external it might return %NULL if the
@target does not have an anchor.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the name of the anchor of @target.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="target" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSLinkTarget</doc>
<type name="LinkTarget" c:type="GXPSLinkTarget*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_uri" c:identifier="gxps_link_target_get_uri">
<doc xml:whitespace="preserve">Gets the URI @target links to.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the URI of @target.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="target" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSLinkTarget</doc>
<type name="LinkTarget" c:type="GXPSLinkTarget*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_internal" c:identifier="gxps_link_target_is_internal">
<doc xml:whitespace="preserve">Gets whether @target destination is internal or not.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE if the #GXPSLinkTarget points to an internal location, %FALSE if it points to a external one.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="target" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSLinkTarget</doc>
<type name="LinkTarget" c:type="GXPSLinkTarget*"/>
</instance-parameter>
</parameters>
</method>
</record>
<record name="OutlineIter" c:type="GXPSOutlineIter">
<doc xml:whitespace="preserve">GXPSOutlineIter represents an iterator that can be
used to iterate over the items of an outline
contained in a #GXPSDocumentStructure</doc>
<field name="dummy1" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<field name="dummy2" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<method name="children" c:identifier="gxps_outline_iter_children">
<doc xml:whitespace="preserve">Initializes @iter to the first child item of @parent.
See gxps_document_structure_outline_iter_init() for
more details.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE if @iter was set to the first child of @parent, %FALSE if @parent does not have children.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="iter" transfer-ownership="none">
<doc xml:whitespace="preserve">an uninitialized #GXPSOutlineIter</doc>
<type name="OutlineIter" c:type="GXPSOutlineIter*"/>
</instance-parameter>
<parameter name="parent" transfer-ownership="none">
<doc xml:whitespace="preserve">an initialized #GXPSOutlineIter</doc>
<type name="OutlineIter" c:type="GXPSOutlineIter*"/>
</parameter>
</parameters>
</method>
<method name="get_description"
c:identifier="gxps_outline_iter_get_description">
<doc xml:whitespace="preserve">Gets the description of the outline item associated with @iter.
See gxps_document_structure_outline_iter_init() for
more details.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the description of the outline item</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="iter" transfer-ownership="none">
<doc xml:whitespace="preserve">an initialized #GXPSOutlineIter</doc>
<type name="OutlineIter" c:type="GXPSOutlineIter*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_target" c:identifier="gxps_outline_iter_get_target">
<doc xml:whitespace="preserve">Gets the #GXPSLinkTarget of the outline item associated with @iter.
See gxps_document_structure_outline_iter_init() for
more details.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a new allocated #GXPSLinkTarget. Free the returned object with gxps_link_target_free().</doc>
<type name="LinkTarget" c:type="GXPSLinkTarget*"/>
</return-value>
<parameters>
<instance-parameter name="iter" transfer-ownership="none">
<doc xml:whitespace="preserve">an initialized #GXPSOutlineIter</doc>
<type name="OutlineIter" c:type="GXPSOutlineIter*"/>
</instance-parameter>
</parameters>
</method>
<method name="next" c:identifier="gxps_outline_iter_next">
<doc xml:whitespace="preserve">Advances @iter to the next item at the current level.
See gxps_document_structure_outline_iter_init() for
more details.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE if @iter was set to the next item, %FALSE if the end of the current level has been reached</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="iter" transfer-ownership="none">
<doc xml:whitespace="preserve">an initialized #GXPSOutlineIter</doc>
<type name="OutlineIter" c:type="GXPSOutlineIter*"/>
</instance-parameter>
</parameters>
</method>
</record>
<class name="Page"
c:symbol-prefix="page"
c:type="GXPSPage"
parent="GObject.Object"
glib:type-name="GXPSPage"
glib:get-type="gxps_page_get_type"
glib:type-struct="PageClass">
<doc xml:whitespace="preserve">The <structname>GXPSPage</structname> struct contains
only private fields and should not be directly accessed.</doc>
<implements name="Gio.Initable"/>
<function name="error_quark" c:identifier="gxps_page_error_quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<method name="get_anchor_destination"
c:identifier="gxps_page_get_anchor_destination"
introspectable="0"
throws="1">
<doc xml:whitespace="preserve">Gets the rectangle of @page corresponding to the destination
of the given anchor. If @anchor is not found in @page, %FALSE
will be returned and @error will contain %GXPS_PAGE_ERROR_INVALID_ANCHOR</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE if the destination for the anchor was found in page and @area contains the rectangle, %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="page" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSPage</doc>
<type name="Page" c:type="GXPSPage*"/>
</instance-parameter>
<parameter name="anchor" transfer-ownership="none">
<doc xml:whitespace="preserve">the name of an anchor in @page</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="area"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:whitespace="preserve">return location for page area of @anchor</doc>
<type c:type="cairo_rectangle_t*"/>
</parameter>
</parameters>
</method>
<method name="get_links" c:identifier="gxps_page_get_links" throws="1">
<doc xml:whitespace="preserve">Gets a list of #GXPSLink items that map from a location
in @page to a #GXPSLinkTarget. Items in the list should
be freed with gxps_link_free() and the list itself with
g_list_free() when done.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a #GList of #GXPSLink items.</doc>
<type name="GLib.List" c:type="GList*">
<type name="Link"/>
</type>
</return-value>
<parameters>
<instance-parameter name="page" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSPage</doc>
<type name="Page" c:type="GXPSPage*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_size" c:identifier="gxps_page_get_size">
<doc xml:whitespace="preserve">Gets the size of the page.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="page" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSPage</doc>
<type name="Page" c:type="GXPSPage*"/>
</instance-parameter>
<parameter name="width"
direction="out"
caller-allocates="0"
transfer-ownership="full"
allow-none="1">
<doc xml:whitespace="preserve">return location for the page width</doc>
<type name="gdouble" c:type="gdouble*"/>
</parameter>
<parameter name="height"
direction="out"
caller-allocates="0"
transfer-ownership="full"
allow-none="1">
<doc xml:whitespace="preserve">return location for the page height</doc>
<type name="gdouble" c:type="gdouble*"/>
</parameter>
</parameters>
</method>
<method name="render" c:identifier="gxps_page_render" throws="1">
<doc xml:whitespace="preserve">Render the page to the given cairo context. In case of
error, %FALSE is returned and @error is filled with
information about error.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE if page was successfully rendered, %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="page" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GXPSPage</doc>
<type name="Page" c:type="GXPSPage*"/>
</instance-parameter>
<parameter name="cr" transfer-ownership="none">
<doc xml:whitespace="preserve">a cairo context to render to</doc>
<type name="cairo.Context" c:type="cairo_t*"/>
</parameter>
</parameters>
</method>
<property name="archive"
introspectable="0"
readable="0"
writable="1"
construct-only="1"
transfer-ownership="none">
<type/>
</property>
<property name="source"
readable="0"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="priv" readable="0" private="1">
<type name="PagePrivate" c:type="GXPSPagePrivate*"/>
</field>
</class>
<record name="PageClass"
c:type="GXPSPageClass"
glib:is-gtype-struct-for="Page">
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<enumeration name="PageError" c:type="GXPSPageError">
<doc xml:whitespace="preserve">Error codes returned by #GXPSPage functions</doc>
<member name="invalid" value="0" c:identifier="GXPS_PAGE_ERROR_INVALID">
<doc xml:whitespace="preserve">The page is invalid.</doc>
</member>
<member name="render" value="1" c:identifier="GXPS_PAGE_ERROR_RENDER">
<doc xml:whitespace="preserve">Error rendering the page.</doc>
</member>
<member name="invalid_anchor"
value="2"
c:identifier="GXPS_PAGE_ERROR_INVALID_ANCHOR">
<doc xml:whitespace="preserve">Anchor is invalid for the page.</doc>
</member>
</enumeration>
<record name="PagePrivate" c:type="GXPSPagePrivate" disguised="1">
</record>
<function name="error_quark" c:identifier="gxps_error_quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</namespace>
</repository>
|