/usr/share/gtk-doc/html/libgda-4.0/GdauiLogin.html is in libgda-4.0-doc 4.2.8-2build1.
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 | <!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</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GNOME Data Access 4 manual">
<link rel="up" href="ch21.html" title="User interface API reference">
<link rel="prev" href="libgda-4.0-LibgdaUI-Initialization.html" title="LibgdaUI Initialization">
<link rel="next" href="GdauiProviderSelector.html" title="GdauiProviderSelector">
<meta name="generator" content="GTK-Doc V1.17 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="libgda-4.0-LibgdaUI-Initialization.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch21.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GNOME Data Access 4 manual</th>
<td><a accesskey="n" href="GdauiProviderSelector.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GdauiLogin.synopsis" class="shortcut">Top</a>
|
<a href="#GdauiLogin.description" class="shortcut">Description</a>
|
<a href="#GdauiLogin.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GdauiLogin.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#GdauiLogin.properties" class="shortcut">Properties</a>
|
<a href="#GdauiLogin.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="GdauiLogin"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdauiLogin.top_of_page"></a>GdauiLogin</span></h2>
<p>GdauiLogin — Connection opening dialog</p>
</td>
<td valign="top" align="right"><img src="vi-login.png"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GdauiLogin.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="GdauiLogin.html#GdauiLogin-struct" title="struct GdauiLogin">GdauiLogin</a>;
<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GdauiLogin.html#gdaui-login-new" title="gdaui_login_new ()">gdaui_login_new</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dsn</code></em>);
enum <a class="link" href="GdauiLogin.html#GdauiLoginMode" title="enum GdauiLoginMode">GdauiLoginMode</a>;
<span class="returnvalue">void</span> <a class="link" href="GdauiLogin.html#gdaui-login-set-mode" title="gdaui_login_set_mode ()">gdaui_login_set_mode</a> (<em class="parameter"><code><a class="link" href="GdauiLogin.html" title="GdauiLogin"><span class="type">GdauiLogin</span></a> *login</code></em>,
<em class="parameter"><code><a class="link" href="GdauiLogin.html#GdauiLoginMode" title="enum GdauiLoginMode"><span class="type">GdauiLoginMode</span></a> mode</code></em>);
const <a class="link" href="libgda-4.0-Configuration.html#GdaDsnInfo" title="struct GdaDsnInfo"><span class="returnvalue">GdaDsnInfo</span></a> * <a class="link" href="GdauiLogin.html#gdaui-login-get-connection-information" title="gdaui_login_get_connection_information ()">gdaui_login_get_connection_information</a>
(<em class="parameter"><code><a class="link" href="GdauiLogin.html" title="GdauiLogin"><span class="type">GdauiLogin</span></a> *login</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GdauiLogin.html#gdaui-login-set-dsn" title="gdaui_login_set_dsn ()">gdaui_login_set_dsn</a> (<em class="parameter"><code><a class="link" href="GdauiLogin.html" title="GdauiLogin"><span class="type">GdauiLogin</span></a> *login</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dsn</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GdauiLogin.html#gdaui-login-set-connection-information" title="gdaui_login_set_connection_information ()">gdaui_login_set_connection_information</a>
(<em class="parameter"><code><a class="link" href="GdauiLogin.html" title="GdauiLogin"><span class="type">GdauiLogin</span></a> *login</code></em>,
<em class="parameter"><code>const <a class="link" href="libgda-4.0-Configuration.html#GdaDsnInfo" title="struct GdaDsnInfo"><span class="type">GdaDsnInfo</span></a> *cinfo</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GdauiLogin.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+----<a href="http://library.gnome.org/devel/gtk3/GtkObject.html">GtkObject</a>
+----<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html">GtkWidget</a>
+----<a href="http://library.gnome.org/devel/gtk3/GtkContainer.html">GtkContainer</a>
+----<a href="http://library.gnome.org/devel/gtk3/GtkBox.html">GtkBox</a>
+----<a href="http://library.gnome.org/devel/gtk3/GtkVBox.html">GtkVBox</a>
+----GdauiLogin
</pre>
</div>
<div class="refsect1">
<a name="GdauiLogin.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GdauiLogin implements
AtkImplementorIface, <a href="http://library.gnome.org/devel/gtk3/GtkBuildable.html">GtkBuildable</a> and <a href="http://library.gnome.org/devel/gtk3/gtk-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
</div>
<div class="refsect1">
<a name="GdauiLogin.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GdauiLogin.html#GdauiLogin--dsn" title='The "dsn" property'>dsn</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
"<a class="link" href="GdauiLogin.html#GdauiLogin--mode" title='The "mode" property'>mode</a>" <a class="link" href="GdauiLogin.html#GdauiLoginMode" title="enum GdauiLoginMode"><span class="type">GdauiLoginMode</span></a> : Read / Write
"<a class="link" href="GdauiLogin.html#GdauiLogin--valid" title='The "valid" property'>valid</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read
</pre>
</div>
<div class="refsect1">
<a name="GdauiLogin.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GdauiLogin.html#GdauiLogin-changed" title='The "changed" signal'>changed</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
</pre>
</div>
<div class="refsect1">
<a name="GdauiLogin.description"></a><h2>Description</h2>
<p>
The <a class="link" href="GdauiLogin.html" title="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" 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>
<p>
</p>
</div>
<div class="refsect1">
<a name="GdauiLogin.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GdauiLogin-struct"></a><h3>struct GdauiLogin</h3>
<pre class="programlisting">struct GdauiLogin;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-login-new"></a><h3>gdaui_login_new ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * gdaui_login_new (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dsn</code></em> :</span></p></td>
<td>a data source name, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new widget. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="GdauiLoginMode"></a><h3>enum GdauiLoginMode</h3>
<pre class="programlisting">typedef enum {
GDA_UI_LOGIN_ENABLE_CONTROL_CENTRE_MODE = 1 << 0,
GDA_UI_LOGIN_HIDE_DSN_SELECTION_MODE = 1 << 1,
GDA_UI_LOGIN_HIDE_DIRECT_CONNECTION_MODE = 1 << 2
} GdauiLoginMode;
</pre>
<p>
</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="GdauiLogin.html" title="GdauiLogin"><span class="type">GdauiLogin</span></a> *login</code></em>,
<em class="parameter"><code><a class="link" href="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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>login</code></em> :</span></p></td>
<td>a <a class="link" href="GdauiLogin.html" title="GdauiLogin"><span class="type">GdauiLogin</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
<td>a flag</td>
</tr>
</tbody>
</table></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-4.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="GdauiLogin.html" title="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-4.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-4.0-Configuration.html#GdaDsnInfo" title="struct GdaDsnInfo"><span class="type">GdaDsnInfo</span></a> will be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, and otherwise it will contain the name of the selected DSN.
</p>
<p>
Retuns: (transfer none): a pointer to a (read-only) <a class="link" href="libgda-4.0-Configuration.html#GdaDsnInfo" title="struct GdaDsnInfo"><span class="type">GdaDsnInfo</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>login</code></em> :</span></p></td>
<td>a <a class="link" href="GdauiLogin.html" title="GdauiLogin"><span class="type">GdauiLogin</span></a> object</td>
</tr></tbody>
</table></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="GdauiLogin.html" title="GdauiLogin"><span class="type">GdauiLogin</span></a> *login</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/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 <code class="literal">GDA_UI_LOGIN_HIDE_DSN_SELECTION_MODE</code>, 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="http://library.gnome.org/devel/glib/unstable/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="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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>login</code></em> :</span></p></td>
<td>a <a class="link" href="GdauiLogin.html" title="GdauiLogin"><span class="type">GdauiLogin</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dsn</code></em> :</span></p></td>
<td>a data source name, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></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="GdauiLogin.html" title="GdauiLogin"><span class="type">GdauiLogin</span></a> *login</code></em>,
<em class="parameter"><code>const <a class="link" href="libgda-4.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 <code class="literal">GDA_UI_LOGIN_HIDE_DIRECT_CONNECTION_MODE</code>, then
if <em class="parameter"><code>cinfo->name</code></em> is not <a href="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/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="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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>login</code></em> :</span></p></td>
<td>a <a class="link" href="GdauiLogin.html" title="GdauiLogin"><span class="type">GdauiLogin</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cinfo</code></em> :</span></p></td>
<td>a pointer to a structure representing the information to display.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GdauiLogin.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GdauiLogin--dsn"></a><h3>The <code class="literal">"dsn"</code> property</h3>
<pre class="programlisting"> "dsn" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p></p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GdauiLogin--mode"></a><h3>The <code class="literal">"mode"</code> property</h3>
<pre class="programlisting"> "mode" <a class="link" href="GdauiLogin.html#GdauiLoginMode" title="enum GdauiLoginMode"><span class="type">GdauiLoginMode</span></a> : Read / Write</pre>
<p></p>
</div>
<hr>
<div class="refsect2">
<a name="GdauiLogin--valid"></a><h3>The <code class="literal">"valid"</code> property</h3>
<pre class="programlisting"> "valid" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read</pre>
<p></p>
<p>Default value: FALSE</p>
</div>
</div>
<div class="refsect1">
<a name="GdauiLogin.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GdauiLogin-changed"></a><h3>The <code class="literal">"changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GdauiLogin.html" title="GdauiLogin"><span class="type">GdauiLogin</span></a> *gdauilogin,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> arg1,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gdauilogin</code></em> :</span></p></td>
<td>the object which received the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|