~ubuntu-branches/ubuntu/saucy/gconf/saucy

« back to all changes in this revision

Viewing changes to doc/gconf/tmpl/gconf-unused.sgml

  • Committer: Package Import Robot
  • Author(s): Jeremy Bicha
  • Date: 2011-11-01 08:48:09 UTC
  • mfrom: (1.2.1) (76.1.1 oneiric-proposed)
  • Revision ID: package-import@ubuntu.com-20111101084809-f6skp1hyp3gni1ru
Tags: 3.2.3-0ubuntu1
* New upstream release.
  - Fixes gconf crasher regression in 3.2.2 (LP: #882525)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!-- ##### SECTION ./tmpl/gconf-orbit.sgml:Long_Description ##### -->
 
2
<para>
 
3
GConf needs a connection to an ORB; it needs to be able to receive
 
4
CORBA requests and act on them; and it needs CORBA connection
 
5
authentication. There are two basic ways to do this; first, you 
 
6
can let GConf set things up by calling gconf_init_orb(); second, you
 
7
can set things up yourself (or let GNOME set things up), then call
 
8
gconf_set_orb() to tell the GConf library about it.
 
9
</para>
 
10
 
 
11
<para>
 
12
The problem right now is that <application>gconfd</application> only
 
13
speaks the authentication mechanism from gconf_init_orb(), since the 
 
14
GNOME authentication mechanism requires an X server connection. So 
 
15
right now if you use gnome_CORBA_init() then you can't talk to
 
16
<application>gconfd</application>. (If you use gconf_init_orb() in an
 
17
otherwise non-CORBA GNOME application then you can.) This will get
 
18
fixed by the time GNOME 2.0 is ready.
 
19
</para>
 
20
 
 
21
 
 
22
<!-- ##### SECTION ./tmpl/gconf-orbit.sgml:See_Also ##### -->
 
23
<para>
 
24
 
 
25
</para>
 
26
 
 
27
 
 
28
<!-- ##### SECTION ./tmpl/gconf-orbit.sgml:Short_Description ##### -->
 
29
 
 
30
Interface for setting up CORBA
 
31
 
 
32
 
 
33
<!-- ##### SECTION ./tmpl/gconf-orbit.sgml:Title ##### -->
 
34
 
 
35
GConf CORBA
 
36
 
 
37
 
 
38
<!-- ##### SECTION ./tmpl/gconf-unused.sgml:See_Also ##### -->
 
39
<para>
 
40
 
 
41
</para>
 
42
 
 
43
 
 
44
<!-- ##### MACRO GCONF_INTERNAL_VALUE_TYPE_VALID ##### -->
 
45
<para>
 
46
 
 
47
</para>
 
48
 
 
49
@x: 
 
50
 
 
51
<!-- ##### SIGNAL GConfClient::error ##### -->
 
52
<para>
 
53
Emitted whenever an error occurs inside a #GConfClient function. Depending on
 
54
the #GConfClientErrorHandlingMode, the default handler for this signal may or
 
55
may not display an error dialog.
 
56
</para>
 
57
 
 
58
@gconfclient: the object which received the signal.
 
59
@arg1: a #GError* (the error).
 
60
 
 
61
<!-- ##### SIGNAL GConfClient::unreturned-error ##### -->
 
62
<para>
 
63
Emitted when you pass <symbol>NULL</symbol> for the #GError** argument to
 
64
any #GConfClient function, and an error occurs. Depending on the
 
65
#GConfClientErrorHandlingMode, the default handler for this signal may or may
 
66
not display an error dialog.
 
67
</para>
 
68
 
 
69
@gconfclient: the object which received the signal.
 
70
@arg1: a #GError* (the unhandled error).
 
71
 
 
72
<!-- ##### SIGNAL GConfClient::value-changed ##### -->
 
73
<para>
 
74
Emitted when a key below one of the directories added with
 
75
gconf_client_add_dir() receives a new value or is unset. Because your signal
 
76
handler will have to use strcmp() to decide whether it cares about the
 
77
particular value that changed, it can be much more efficient to use
 
78
gconf_client_notify_add().
 
79
</para>
 
80
 
 
81
@gconfclient: the object which received the signal.
 
82
@arg1: a const #gchar* representing the changed key name
 
83
@arg2: a #GConfValue* representing the new value, or <symbol>NULL</symbol> for unset.
 
84
 
 
85
<!-- ##### USER_FUNCTION GConfClientParentWindowFunc ##### -->
 
86
<para>
 
87
If you're using the default #GConfClient error handlers, they can call this
 
88
function to set the parent of any dialogs they create. See
 
89
gnome_dialog_set_parent() in the GNOME documentation for details. The function
 
90
should return a pointer to a #GtkWindow.
 
91
</para>
 
92
 
 
93
@client: a #GConfClient.
 
94
@user_data: user data passed to gconf_client_set_error_handling().
 
95
@Returns: the parent window for #GConfClient's error dialogs.
 
96
 
 
97
<!-- ##### STRUCT GError ##### -->
 
98
<para>
 
99
This structure describes an error. The @str field gives a
 
100
human-readable description of the problem; the string is intended for
 
101
display to users. It will be internationalized and as informative as
 
102
possible. The @num field is intended for programs that want to
 
103
distinguish between different kinds of error. The @num and @str fields
 
104
are meant to be accessed directly, because it's convenient to write
 
105
err->code and err->message.
 
106
</para>
 
107
 
 
108
@domain: 
 
109
@code: 
 
110
@message: 
 
111
 
 
112
<!-- ##### FUNCTION corba_schema_from_gconf_schema ##### -->
 
113
<para>
 
114
 
 
115
</para>
 
116
 
 
117
@sc: 
 
118
@Returns: 
 
119
 
 
120
<!-- ##### FUNCTION corba_value_from_gconf_value ##### -->
 
121
<para>
 
122
 
 
123
</para>
 
124
 
 
125
@value: 
 
126
@Returns: 
 
127
 
 
128
<!-- ##### FUNCTION fill_corba_schema_from_gconf_schema ##### -->
 
129
<para>
 
130
 
 
131
</para>
 
132
 
 
133
@sc: 
 
134
@dest: 
 
135
 
 
136
<!-- ##### FUNCTION fill_corba_value_from_gconf_value ##### -->
 
137
<para>
 
138
 
 
139
</para>
 
140
 
 
141
@value: 
 
142
@dest: 
 
143
 
 
144
<!-- ##### FUNCTION g_clear_error ##### -->
 
145
<para>
 
146
Internal function.
 
147
</para>
 
148
 
 
149
@err: 
 
150
 
 
151
<!-- ##### FUNCTION g_error_copy ##### -->
 
152
<para>
 
153
Copies a #GError.
 
154
</para>
 
155
 
 
156
@error: 
 
157
@Returns: a new #GError.
 
158
@err: a #GError to copy.
 
159
 
 
160
<!-- ##### FUNCTION g_error_free ##### -->
 
161
<para>
 
162
Destroys a #GError. You must destroy any errors returned by GConf
 
163
functions.
 
164
</para>
 
165
 
 
166
@error: 
 
167
@err: a #GError to destroy.
 
168
 
 
169
<!-- ##### FUNCTION gconf_client_get_full ##### -->
 
170
<para>
 
171
 
 
172
</para>
 
173
 
 
174
@client: 
 
175
@key: 
 
176
@locale: 
 
177
@use_schema_default: 
 
178
@value_is_default: 
 
179
@err: 
 
180
@Returns: 
 
181
 
 
182
<!-- ##### FUNCTION gconf_get_orb ##### -->
 
183
<para>
 
184
Returns the ORB GConf is using.
 
185
</para>
 
186
 
 
187
@Returns: the ORB GConf is using.
 
188
 
 
189
<!-- ##### FUNCTION gconf_init_orb ##### -->
 
190
<para>
 
191
Initializes CORBA and a connection to the ORB, sets up authentication, 
 
192
and adds CORBA-related event handlers to your application's event
 
193
loop. Your application must be using the event loop from GLib; this is
 
194
the event loop all GTK+ applications use, but it also works in
 
195
non-GTK+ applications (such as <application>gconfd</application>, if
 
196
you're looking for some sample code).
 
197
</para>
 
198
 
 
199
<para>
 
200
gconf_init_orb() wants to see the command line arguments to check for
 
201
ORBit options. If it finds ORBit options it will remove them from @argc
 
202
and @argv. It returns an error if CORBA initialization failes.
 
203
</para>
 
204
 
 
205
@argc: address of argc.
 
206
@argv: argv.
 
207
@err: the return location for an allocated #GError, or <symbol>NULL</symbol> to ignore errors.
 
208
@Returns: the ORB object reference.
 
209
 
 
210
<!-- ##### FUNCTION gconf_quote_percents ##### -->
 
211
<para>
 
212
 
 
213
</para>
 
214
 
 
215
@src: 
 
216
@Returns: 
 
217
 
 
218
<!-- ##### FUNCTION gconf_read_server_ior ##### -->
 
219
<para>
 
220
 
 
221
</para>
 
222
 
 
223
@err: 
 
224
@Returns: 
 
225
 
 
226
<!-- ##### FUNCTION gconf_server_info_dir ##### -->
 
227
<para>
 
228
 
 
229
</para>
 
230
 
 
231
@Returns: 
 
232
 
 
233
<!-- ##### FUNCTION gconf_server_info_file ##### -->
 
234
<para>
 
235
 
 
236
</para>
 
237
 
 
238
@Returns: 
 
239
 
 
240
<!-- ##### FUNCTION gconf_set_orb ##### -->
 
241
<para>
 
242
gconf_set_orb() allows you to tell GConf about an ORB obtained by
 
243
means other than gconf_init_orb(). You should call gconf_init_orb()
 
244
<emphasis>or</emphasis> this function, never both.
 
245
</para>
 
246
 
 
247
@orb: the ORB GConf should use to communicate with <application>gconfd</application>.
 
248
 
 
249
<!-- ##### FUNCTION gconf_strerror ##### -->
 
250
<para>
 
251
Internal function.
 
252
</para>
 
253
 
 
254
@en: 
 
255
@Returns: 
 
256
 
 
257
<!-- ##### FUNCTION invalid_corba_value ##### -->
 
258
<para>
 
259
 
 
260
</para>
 
261
 
 
262
@Returns: 
 
263