← Back to branch summary

~ubuntu-branches/ubuntu/natty/luatex/natty

« back to all changes in this revision

Viewing changes to source/libs/poppler/poppler-0.12.4/glib/reference/xml/poppler-layer.xml

  • Committer: Package Import Robot
  • Author(s): Norbert Preining
  • Date: 2010-12-13 23:22:59 UTC
  • mfrom: (0.2.1) (1.5.4) (4.3.12 experimental)
  • Revision ID: package-import@ubuntu.com-20101213232259-nqq2mq5z5x6qldw3
Tags: 0.65.0-1
* new upstream release
* ship two source packages as they are distributed by upstream, only
  renamed to match source package requirements. Fix debian/rules
  to install the manual pdf from the right place

Show diffs side-by-side

added added

removed removed

Lines of Context:
source/libs/poppler/poppler-0.12.4/glib/reference/xml/poppler-layer.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
<refentry id="poppler-poppler-layer">
 
5
<refmeta>
 
6
<refentrytitle role="top_of_page" id="poppler-poppler-layer.top_of_page">PopplerLayer</refentrytitle>
 
7
<manvolnum>3</manvolnum>
 
8
<refmiscinfo>POPPLER Library</refmiscinfo>
 
9
</refmeta>
 
10
 
 
11
<refnamediv>
 
12
<refname>PopplerLayer</refname>
 
13
<refpurpose></refpurpose>
 
14
</refnamediv>
 
15
 
 
16
<refsynopsisdiv id="poppler-poppler-layer.synopsis" role="synopsis">
 
17
<title role="synopsis.title">Synopsis</title>
 
18
 
 
19
<synopsis>
 
20
<link linkend="GType">GType</link>               <link linkend="poppler-layer-get-type">poppler_layer_get_type</link>              (void);
 
21
const <link linkend="gchar">gchar</link> *       <link linkend="poppler-layer-get-title">poppler_layer_get_title</link>             (<link linkend="PopplerLayer">PopplerLayer</link> *layer);
 
22
<link linkend="gboolean">gboolean</link>            <link linkend="poppler-layer-is-visible">poppler_layer_is_visible</link>            (<link linkend="PopplerLayer">PopplerLayer</link> *layer);
 
23
<link linkend="void">void</link>                <link linkend="poppler-layer-show">poppler_layer_show</link>                  (<link linkend="PopplerLayer">PopplerLayer</link> *layer);
 
24
<link linkend="void">void</link>                <link linkend="poppler-layer-hide">poppler_layer_hide</link>                  (<link linkend="PopplerLayer">PopplerLayer</link> *layer);
 
25
<link linkend="gboolean">gboolean</link>            <link linkend="poppler-layer-is-parent">poppler_layer_is_parent</link>             (<link linkend="PopplerLayer">PopplerLayer</link> *layer);
 
26
<link linkend="gint">gint</link>                <link linkend="poppler-layer-get-radio-button-group-id">poppler_layer_get_radio_button_group_id</link>
 
27
                                                        (<link linkend="PopplerLayer">PopplerLayer</link> *layer);
 
28
</synopsis>
 
29
</refsynopsisdiv>
 
30
 
 
31
 
 
32
 
 
33
 
 
34
 
 
35
 
 
36
 
 
37
 
 
38
 
 
39
<refsect1 id="poppler-poppler-layer.description" role="desc">
 
40
<title role="desc.title">Description</title>
 
41
<para>
 
42
</para>
 
43
</refsect1>
 
44
 
 
45
<refsect1 id="poppler-poppler-layer.details" role="details">
 
46
<title role="details.title">Details</title>
 
47
<refsect2 id="poppler-layer-get-type" role="function">
 
48
<title>poppler_layer_get_type ()</title>
 
49
<indexterm zone="poppler-layer-get-type"><primary sortas="poppler_layer_get_type">poppler_layer_get_type</primary></indexterm><programlisting><link linkend="GType">GType</link>               poppler_layer_get_type              (void);</programlisting>
 
50
<para>
 
51
</para><variablelist role="params">
 
52
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
 
53
</simpara></listitem></varlistentry>
 
54
</variablelist></refsect2>
 
55
<refsect2 id="poppler-layer-get-title" role="function">
 
56
<title>poppler_layer_get_title ()</title>
 
57
<indexterm zone="poppler-layer-get-title"><primary sortas="poppler_layer_get_title">poppler_layer_get_title</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       poppler_layer_get_title             (<link linkend="PopplerLayer">PopplerLayer</link> *layer);</programlisting>
 
58
<para>
 
59
Returns the name of the layer suitable for
 
60
presentation as a title in a viewer's GUI</para>
 
61
<para>
 
62
</para><variablelist role="params">
 
63
<varlistentry><term><parameter>layer</parameter>&#160;:</term>
 
64
<listitem><simpara> a <link linkend="PopplerLayer"><type>PopplerLayer</type></link>
 
65
</simpara></listitem></varlistentry>
 
66
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a string containing the title of the layer
 
67
</simpara></listitem></varlistentry>
 
68
</variablelist></refsect2>
 
69
<refsect2 id="poppler-layer-is-visible" role="function">
 
70
<title>poppler_layer_is_visible ()</title>
 
71
<indexterm zone="poppler-layer-is-visible"><primary sortas="poppler_layer_is_visible">poppler_layer_is_visible</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            poppler_layer_is_visible            (<link linkend="PopplerLayer">PopplerLayer</link> *layer);</programlisting>
 
72
<para>
 
73
Returns whether <parameter>layer</parameter> is visible</para>
 
74
<para>
 
75
</para><variablelist role="params">
 
76
<varlistentry><term><parameter>layer</parameter>&#160;:</term>
 
77
<listitem><simpara> a <link linkend="PopplerLayer"><type>PopplerLayer</type></link>
 
78
</simpara></listitem></varlistentry>
 
79
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>layer</parameter> is visible
 
80
</simpara></listitem></varlistentry>
 
81
</variablelist></refsect2>
 
82
<refsect2 id="poppler-layer-show" role="function">
 
83
<title>poppler_layer_show ()</title>
 
84
<indexterm zone="poppler-layer-show"><primary sortas="poppler_layer_show">poppler_layer_show</primary></indexterm><programlisting><link linkend="void">void</link>                poppler_layer_show                  (<link linkend="PopplerLayer">PopplerLayer</link> *layer);</programlisting>
 
85
<para>
 
86
Shows <parameter>layer</parameter></para>
 
87
<para>
 
88
</para><variablelist role="params">
 
89
<varlistentry><term><parameter>layer</parameter>&#160;:</term>
 
90
<listitem><simpara> a <link linkend="PopplerLayer"><type>PopplerLayer</type></link>
 
91
</simpara></listitem></varlistentry>
 
92
</variablelist></refsect2>
 
93
<refsect2 id="poppler-layer-hide" role="function">
 
94
<title>poppler_layer_hide ()</title>
 
95
<indexterm zone="poppler-layer-hide"><primary sortas="poppler_layer_hide">poppler_layer_hide</primary></indexterm><programlisting><link linkend="void">void</link>                poppler_layer_hide                  (<link linkend="PopplerLayer">PopplerLayer</link> *layer);</programlisting>
 
96
<para>
 
97
Hides <parameter>layer</parameter>. If <parameter>layer</parameter> is the parent of other nested layers,
 
98
such layers will be also hidden and will be blocked until <parameter>layer</parameter>
 
99
is shown again</para>
 
100
<para>
 
101
</para><variablelist role="params">
 
102
<varlistentry><term><parameter>layer</parameter>&#160;:</term>
 
103
<listitem><simpara> a <link linkend="PopplerLayer"><type>PopplerLayer</type></link>
 
104
</simpara></listitem></varlistentry>
 
105
</variablelist></refsect2>
 
106
<refsect2 id="poppler-layer-is-parent" role="function">
 
107
<title>poppler_layer_is_parent ()</title>
 
108
<indexterm zone="poppler-layer-is-parent"><primary sortas="poppler_layer_is_parent">poppler_layer_is_parent</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            poppler_layer_is_parent             (<link linkend="PopplerLayer">PopplerLayer</link> *layer);</programlisting>
 
109
<para>
 
110
Returns whether <parameter>layer</parameter> is parent of other nested layers.</para>
 
111
<para>
 
112
</para><variablelist role="params">
 
113
<varlistentry><term><parameter>layer</parameter>&#160;:</term>
 
114
<listitem><simpara> a <link linkend="PopplerLayer"><type>PopplerLayer</type></link>
 
115
</simpara></listitem></varlistentry>
 
116
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>layer</parameter> is a parent layer
 
117
</simpara></listitem></varlistentry>
 
118
</variablelist></refsect2>
 
119
<refsect2 id="poppler-layer-get-radio-button-group-id" role="function">
 
120
<title>poppler_layer_get_radio_button_group_id ()</title>
 
121
<indexterm zone="poppler-layer-get-radio-button-group-id"><primary sortas="poppler_layer_get_radio_button_group_id">poppler_layer_get_radio_button_group_id</primary></indexterm><programlisting><link linkend="gint">gint</link>                poppler_layer_get_radio_button_group_id
 
122
                                                        (<link linkend="PopplerLayer">PopplerLayer</link> *layer);</programlisting>
 
123
<para>
 
124
Returns the numeric ID the radio button group associated with <parameter>layer</parameter>.</para>
 
125
<para>
 
126
</para><variablelist role="params">
 
127
<varlistentry><term><parameter>layer</parameter>&#160;:</term>
 
128
<listitem><simpara> a <link linkend="PopplerLayer"><type>PopplerLayer</type></link>
 
129
</simpara></listitem></varlistentry>
 
130
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the ID of the radio button group associated with <parameter>layer</parameter>,
 
131
or 0 if the layer is not associated to any radio button group
 
132
</simpara></listitem></varlistentry>
 
133
</variablelist></refsect2>
 
134
 
 
135
</refsect1>
 
136
 
 
137
 
 
138
 
 
139
 
 
140
</refentry>