libgda-5.0-doc 5.2.4-3 / usr / share / gtk-doc / html / libgda-5.0 / libgda-5.0-GdauiLogin.html

This file is indexed.

/usr/share/gtk-doc/html/libgda-5.0/libgda-5.0-GdauiLogin.html is in libgda-5.0-doc 5.2.4-3.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdauiLogin: GNOME Data Access 5 manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GNOME Data Access 5 manual">
<link rel="up" href="ch22.html" title="User interface API reference">
<link rel="prev" href="libgda-5.0-LibgdaUI-Initialization.html" title="Library initialization">
<link rel="next" href="libgda-5.0-GdauiProviderSelector.html" title="GdauiProviderSelector">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libgda-5.0-GdauiLogin.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch22.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgda-5.0-LibgdaUI-Initialization.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgda-5.0-GdauiProviderSelector.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgda-5.0-GdauiLogin"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgda-5.0-GdauiLogin.top_of_page"></a>GdauiLogin</span></h2>
<p>GdauiLogin — Connection opening widget</p>
</td>
<td class="gallery_image" valign="top" align="right"><img src="vi-login.png"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgda-5.0-GdauiLogin.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Stable"><span class="acronym">Stable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="libgda-5.0-GdauiLogin.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">GtkWidget</span> *
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdauiLogin.html#gdaui-login-new" title="gdaui_login_new ()">gdaui_login_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdauiLogin.html#gdaui-login-set-mode" title="gdaui_login_set_mode ()">gdaui_login_set_mode</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a class="link" href="libgda-5.0-Configuration.html#GdaDsnInfo" title="struct GdaDsnInfo"><span class="returnvalue">GdaDsnInfo</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdauiLogin.html#gdaui-login-get-connection-information" title="gdaui_login_get_connection_information ()">gdaui_login_get_connection_information</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdauiLogin.html#gdaui-login-set-dsn" title="gdaui_login_set_dsn ()">gdaui_login_set_dsn</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdauiLogin.html#gdaui-login-set-connection-information" title="gdaui_login_set_connection_information ()">gdaui_login_set_connection_information</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdauiLogin.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libgda-5.0-GdauiLogin.html#GdauiLogin" title="struct GdauiLogin">GdauiLogin</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="libgda-5.0-GdauiLogin.html#GdauiLoginMode" title="enum GdauiLoginMode">GdauiLoginMode</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdauiLogin.description"></a><h2>Description</h2>
<p>The <a class="link" href="libgda-5.0-GdauiLogin.html#GdauiLogin" title="struct GdauiLogin"><span class="type">GdauiLogin</span></a> widget can be used when the user needs to enter
data to open a connection. It can be customized in several ways:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>data source (DSN) selection can be shown or hidden</p></li>
<li class="listitem"><p>the button to launch the control center to declare new data sources can be
shown or hidden</p></li>
<li class="listitem"><p>the form to open a connection not using a DSN can be shown or hidden</p></li>
</ul></div>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdauiLogin.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gdaui-login-new"></a><h3>gdaui_login_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *
gdaui_login_new (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dsn</code></em>);</pre>
<p>Creates a new login widget which enables the user to specify connection parameters.</p>
<div class="refsect3">
<a name="gdaui-login-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>dsn</p></td>
<td class="parameter_description"><p> a data source name, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdaui-login-new.returns"></a><h4>Returns</h4>
<p> a new widget. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
<p class="since">Since: 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-login-set-mode"></a><h3>gdaui_login_set_mode ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdaui_login_set_mode (<em class="parameter"><code><a class="link" href="libgda-5.0-GdauiLogin.html#GdauiLogin" title="struct GdauiLogin"><span class="type">GdauiLogin</span></a> *login</code></em>,
                      <em class="parameter"><code><a class="link" href="libgda-5.0-GdauiLogin.html#GdauiLoginMode" title="enum GdauiLoginMode"><span class="type">GdauiLoginMode</span></a> mode</code></em>);</pre>
<p>Set how <em class="parameter"><code>login</code></em>
 operates</p>
<div class="refsect3">
<a name="gdaui-login-set-mode.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>login</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdauiLogin.html#GdauiLogin" title="struct GdauiLogin"><span class="type">GdauiLogin</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mode</p></td>
<td class="parameter_description"><p>a flag</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-login-get-connection-information"></a><h3>gdaui_login_get_connection_information ()</h3>
<pre class="programlisting">const <a class="link" href="libgda-5.0-Configuration.html#GdaDsnInfo" title="struct GdaDsnInfo"><span class="returnvalue">GdaDsnInfo</span></a> *
gdaui_login_get_connection_information
                               (<em class="parameter"><code><a class="link" href="libgda-5.0-GdauiLogin.html#GdauiLogin" title="struct GdauiLogin"><span class="type">GdauiLogin</span></a> *login</code></em>);</pre>
<p>Get the information specified in <em class="parameter"><code>login</code></em>
 as a pointer to a (read-only) <a class="link" href="libgda-5.0-Configuration.html#GdaDsnInfo" title="struct GdaDsnInfo"><span class="type">GdaDsnInfo</span></a>.
If the connection is not specified by a DSN, then the 'name' attribute of the returned
<a class="link" href="libgda-5.0-Configuration.html#GdaDsnInfo" title="struct GdaDsnInfo"><span class="type">GdaDsnInfo</span></a> will be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, and otherwise it will contain the name of the selected DSN.</p>
<div class="refsect3">
<a name="gdaui-login-get-connection-information.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>login</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdauiLogin.html#GdauiLogin" title="struct GdauiLogin"><span class="type">GdauiLogin</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdaui-login-get-connection-information.returns"></a><h4>Returns</h4>
<p> a pointer to a (read-only) <a class="link" href="libgda-5.0-Configuration.html#GdaDsnInfo" title="struct GdaDsnInfo"><span class="type">GdaDsnInfo</span></a>. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></p>
</div>
<p class="since">Since: 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-login-set-dsn"></a><h3>gdaui_login_set_dsn ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdaui_login_set_dsn (<em class="parameter"><code><a class="link" href="libgda-5.0-GdauiLogin.html#GdauiLogin" title="struct GdauiLogin"><span class="type">GdauiLogin</span></a> *login</code></em>,
                     <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dsn</code></em>);</pre>
<p>Changes the information displayed in <em class="parameter"><code>login</code></em>
, to represent <em class="parameter"><code>dsn</code></em>
.
If <em class="parameter"><code>login</code></em>
's mode has <a class="link" href="libgda-5.0-GdauiLogin.html#GDA-UI-LOGIN-HIDE-DSN-SELECTION-MODE:CAPS"><code class="literal">GDA_UI_LOGIN_HIDE_DSN_SELECTION_MODE</code></a>, then
the DSN information is extracted and displayed in the direct login area.</p>
<p>If <em class="parameter"><code>dsn</code></em>
 is not a declared data source name, then a warning is shown and the result
is the same as having passed <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the <em class="parameter"><code>dsn</code></em>
 argument.</p>
<p>In any case <em class="parameter"><code>login</code></em>
's mode (set by <a class="link" href="libgda-5.0-GdauiLogin.html#gdaui-login-set-mode" title="gdaui_login_set_mode ()"><code class="function">gdaui_login_set_mode()</code></a>) is not changed.</p>
<div class="refsect3">
<a name="gdaui-login-set-dsn.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>login</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdauiLogin.html#GdauiLogin" title="struct GdauiLogin"><span class="type">GdauiLogin</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dsn</p></td>
<td class="parameter_description"><p> a data source name, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-login-set-connection-information"></a><h3>gdaui_login_set_connection_information ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdaui_login_set_connection_information
                               (<em class="parameter"><code><a class="link" href="libgda-5.0-GdauiLogin.html#GdauiLogin" title="struct GdauiLogin"><span class="type">GdauiLogin</span></a> *login</code></em>,
                                <em class="parameter"><code>const <a class="link" href="libgda-5.0-Configuration.html#GdaDsnInfo" title="struct GdaDsnInfo"><span class="type">GdaDsnInfo</span></a> *cinfo</code></em>);</pre>
<p>Changes the information displayed in <em class="parameter"><code>login</code></em>
, to represent <em class="parameter"><code>cinfo</code></em>
.
If <em class="parameter"><code>login</code></em>
's mode has <a class="link" href="libgda-5.0-GdauiLogin.html#GDA-UI-LOGIN-HIDE-DIRECT-CONNECTION-MODE:CAPS"><code class="literal">GDA_UI_LOGIN_HIDE_DIRECT_CONNECTION_MODE</code></a>, then
if <em class="parameter"><code>cinfo-&gt;name</code></em>
 is not <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> it is displayed in the DSN selector, otherwise
a warning is shown and the result
is the same as having passed <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the <em class="parameter"><code>cinfo</code></em>
 argument.</p>
<p>In any case <em class="parameter"><code>login</code></em>
's mode (set by <a class="link" href="libgda-5.0-GdauiLogin.html#gdaui-login-set-mode" title="gdaui_login_set_mode ()"><code class="function">gdaui_login_set_mode()</code></a>) is not changed.</p>
<div class="refsect3">
<a name="gdaui-login-set-connection-information.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>login</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdauiLogin.html#GdauiLogin" title="struct GdauiLogin"><span class="type">GdauiLogin</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cinfo</p></td>
<td class="parameter_description"><p>a pointer to a structure representing the information to display.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdauiLogin.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GdauiLogin"></a><h3>struct GdauiLogin</h3>
<pre class="programlisting">struct GdauiLogin {
	GtkBox            parent;
	GdauiLoginPrivate *priv;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GdauiLoginMode"></a><h3>enum GdauiLoginMode</h3>
<p>Defines the aspect of the <a class="link" href="libgda-5.0-GdauiLogin.html#GdauiLogin" title="struct GdauiLogin"><span class="type">GdauiLogin</span></a> widget</p>
<div class="refsect3">
<a name="GdauiLoginMode.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GDA-UI-LOGIN-ENABLE-CONTROL-CENTRE-MODE:CAPS"></a>GDA_UI_LOGIN_ENABLE_CONTROL_CENTRE_MODE</p></td>
<td class="enum_member_description"> </td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDA-UI-LOGIN-HIDE-DSN-SELECTION-MODE:CAPS"></a>GDA_UI_LOGIN_HIDE_DSN_SELECTION_MODE</p></td>
<td class="enum_member_description"> </td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDA-UI-LOGIN-HIDE-DIRECT-CONNECTION-MODE:CAPS"></a>GDA_UI_LOGIN_HIDE_DIRECT_CONNECTION_MODE</p></td>
<td class="enum_member_description"> </td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.