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
|
<refentry id="libgnomeui-GnomeMultiScreen">
<refmeta>
<refentrytitle role="top_of_page">GnomeMultiScreen</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGNOMEUI Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GnomeMultiScreen</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <libgnomeui/libgnomeui.h>
<link linkend="gboolean">gboolean</link> <link linkend="gnome-url-show-on-screen">gnome_url_show_on_screen</link> (const <link linkend="char">char</link> *url,
<link linkend="GdkScreen">GdkScreen</link> *screen,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="gnome-help-display-on-screen">gnome_help_display_on_screen</link> (const <link linkend="char">char</link> *file_name,
const <link linkend="char">char</link> *link_id,
<link linkend="GdkScreen">GdkScreen</link> *screen,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="gnome-help-display-with-doc-id-on-screen">gnome_help_display_with_doc_id_on_screen</link>
(<link linkend="GnomeProgram">GnomeProgram</link> *program,
const <link linkend="char">char</link> *doc_id,
const <link linkend="char">char</link> *file_name,
const <link linkend="char">char</link> *link_id,
<link linkend="GdkScreen">GdkScreen</link> *screen,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="gnome-help-display-desktop-on-screen">gnome_help_display_desktop_on_screen</link>
(<link linkend="GnomeProgram">GnomeProgram</link> *program,
const <link linkend="char">char</link> *doc_id,
const <link linkend="char">char</link> *file_name,
const <link linkend="char">char</link> *link_id,
<link linkend="GdkScreen">GdkScreen</link> *screen,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="gnome-help-display-uri-on-screen">gnome_help_display_uri_on_screen</link> (const <link linkend="char">char</link> *help_uri,
<link linkend="GdkScreen">GdkScreen</link> *screen,
<link linkend="GError">GError</link> **error);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="gnome-url-show-on-screen" role="function" condition="since:2.6"/>gnome_url_show_on_screen ()</title>
<indexterm role="2.6"><primary>gnome_url_show_on_screen</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gnome_url_show_on_screen (const <link linkend="char">char</link> *url,
<link linkend="GdkScreen">GdkScreen</link> *screen,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Like <link linkend="gnome-url-show"><function>gnome_url_show()</function></link>, but ensures that the viewer application
appears on <parameter>screen</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>url</parameter> :</term>
<listitem><simpara> The url to display. Should begin with the protocol to use (e.g.
"http:", "ghelp:", etc)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>screen</parameter> :</term>
<listitem><simpara> a <link linkend="GdkScreen"><type>GdkScreen</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> Used to store any errors that result from trying to display the <parameter>url</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if everything went fine, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise (in which case
<parameter>error</parameter> will contain the actual error).
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.6
</para></refsect2>
<refsect2>
<title><anchor id="gnome-help-display-on-screen" role="function" condition="since:2.6"/>gnome_help_display_on_screen ()</title>
<indexterm role="2.6"><primary>gnome_help_display_on_screen</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gnome_help_display_on_screen (const <link linkend="char">char</link> *file_name,
const <link linkend="char">char</link> *link_id,
<link linkend="GdkScreen">GdkScreen</link> *screen,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Like <link linkend="gnome-help-display"><function>gnome_help_display()</function></link>, but ensures that the help viewer
application appears on <parameter>screen</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>file_name</parameter> :</term>
<listitem><simpara> The name of the help document to display.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>link_id</parameter> :</term>
<listitem><simpara> Can be <link linkend="NULL:CAPS"><literal>NULL</literal></link>. If set, refers to an anchor or section id within the
requested document.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>screen</parameter> :</term>
<listitem><simpara> a <link linkend="GdkScreen"><type>GdkScreen</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> A <link linkend="GError"><type>GError</type></link> instance that will hold the specifics of any error which
occurs during processing, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> on success, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise (in which case <parameter>error</parameter> will
contain the actual error).
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.6
</para></refsect2>
<refsect2>
<title><anchor id="gnome-help-display-with-doc-id-on-screen" role="function" condition="since:2.6"/>gnome_help_display_with_doc_id_on_screen ()</title>
<indexterm role="2.6"><primary>gnome_help_display_with_doc_id_on_screen</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gnome_help_display_with_doc_id_on_screen
(<link linkend="GnomeProgram">GnomeProgram</link> *program,
const <link linkend="char">char</link> *doc_id,
const <link linkend="char">char</link> *file_name,
const <link linkend="char">char</link> *link_id,
<link linkend="GdkScreen">GdkScreen</link> *screen,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Like <link linkend="gnome-help-display-with-doc-id"><function>gnome_help_display_with_doc_id()</function></link>, but ensures that the help
viewer application appears on <parameter>screen</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>program</parameter> :</term>
<listitem><simpara> The current application object, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> for the default one.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>doc_id</parameter> :</term>
<listitem><simpara> The document identifier, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to default to the application ID
(app_id) of the specified <parameter>program</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>file_name</parameter> :</term>
<listitem><simpara> The name of the help document to display.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>link_id</parameter> :</term>
<listitem><simpara> Can be <link linkend="NULL:CAPS"><literal>NULL</literal></link>. If set, refers to an anchor or section id within the
requested document.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>screen</parameter> :</term>
<listitem><simpara> a <link linkend="GdkScreen"><type>GdkScreen</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> A <link linkend="GError"><type>GError</type></link> instance that will hold the specifics of any error which
occurs during processing, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> on success, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise (in which case <parameter>error</parameter> will
contain the actual error).
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.6
</para></refsect2>
<refsect2>
<title><anchor id="gnome-help-display-desktop-on-screen" role="function" condition="since:2.6"/>gnome_help_display_desktop_on_screen ()</title>
<indexterm role="2.6"><primary>gnome_help_display_desktop_on_screen</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gnome_help_display_desktop_on_screen
(<link linkend="GnomeProgram">GnomeProgram</link> *program,
const <link linkend="char">char</link> *doc_id,
const <link linkend="char">char</link> *file_name,
const <link linkend="char">char</link> *link_id,
<link linkend="GdkScreen">GdkScreen</link> *screen,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Like <link linkend="gnome-help-display-desktop"><function>gnome_help_display_desktop()</function></link>, but ensures that the help
viewer application appears on <parameter>screen</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>program</parameter> :</term>
<listitem><simpara> The current application object, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> for the default one.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>doc_id</parameter> :</term>
<listitem><simpara> The name of the help file relative to the system's help domain
(<link linkend="GNOME-FILE-DOMAIN-HELP:CAPS"><type>GNOME_FILE_DOMAIN_HELP</type></link>).
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>file_name</parameter> :</term>
<listitem><simpara> The name of the help document to display.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>link_id</parameter> :</term>
<listitem><simpara> Can be <link linkend="NULL:CAPS"><literal>NULL</literal></link>. If set, refers to an anchor or section id within the
requested document.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>screen</parameter> :</term>
<listitem><simpara> a <link linkend="GdkScreen"><type>GdkScreen</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> A <link linkend="GError"><type>GError</type></link> instance that will hold the specifics of any error which
occurs during processing, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> on success, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise (in which case <parameter>error</parameter> will
contain the actual error).
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.6
</para></refsect2>
<refsect2>
<title><anchor id="gnome-help-display-uri-on-screen" role="function" condition="since:2.6"/>gnome_help_display_uri_on_screen ()</title>
<indexterm role="2.6"><primary>gnome_help_display_uri_on_screen</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gnome_help_display_uri_on_screen (const <link linkend="char">char</link> *help_uri,
<link linkend="GdkScreen">GdkScreen</link> *screen,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Like <link linkend="gnome-help-display-uri"><function>gnome_help_display_uri()</function></link>, but ensures that the help viewer
application appears on <parameter>screen</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>help_uri</parameter> :</term>
<listitem><simpara> The URI to display.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>screen</parameter> :</term>
<listitem><simpara> a <link linkend="GdkScreen"><type>GdkScreen</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> A <link linkend="GError"><type>GError</type></link> instance that will hold the specifics of any error which
occurs during processing, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> on success, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise (in which case <parameter>error</parameter> will
contain the actual error).
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.6
</para></refsect2>
</refsect1>
</refentry>
|
