/usr/share/gtk-doc/html/libgda-5.0/libgda-5.0-GdauiCombo.html is in libgda-5.0-doc 5.2.4-1ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdauiCombo: 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-GdauiRawGrid.html" title="GdauiRawGrid">
<link rel="next" href="libgda-5.0-GdauiCloud.html" title="GdauiCloud">
<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-GdauiCombo.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-GdauiRawGrid.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgda-5.0-GdauiCloud.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-GdauiCombo"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgda-5.0-GdauiCombo.top_of_page"></a>GdauiCombo</span></h2>
<p>GdauiCombo — Combo box to choose from the contents of a <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a></p>
</td>
<td class="gallery_image" valign="top" align="right"><img src="vi-combo.png"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgda-5.0-GdauiCombo.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-GdauiCombo.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-GdauiCombo.html#gdaui-combo-new" title="gdaui_combo_new ()">gdaui_combo_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GtkWidget</span> *
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdauiCombo.html#gdaui-combo-new-with-model" title="gdaui_combo_new_with_model ()">gdaui_combo_new_with_model</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-GdauiCombo.html#gdaui-combo-set-model" title="gdaui_combo_set_model ()">gdaui_combo_set_model</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-GdauiCombo.html#gdaui-combo-add-null" title="gdaui_combo_add_null ()">gdaui_combo_add_null</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgda-5.0-GdauiCombo.html#gdaui-combo-is-null-selected" title="gdaui_combo_is_null_selected ()">gdaui_combo_is_null_selected</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdauiCombo.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-GdauiCombo.html#GdauiCombo" title="struct GdauiCombo">GdauiCombo</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdauiCombo.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdauiCombo.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gdaui-combo-new"></a><h3>gdaui_combo_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *
gdaui_combo_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Create a new GdauiCombo widget.</p>
<div class="refsect3">
<a name="gdaui-combo-new.returns"></a><h4>Returns</h4>
<p> the newly-created 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-combo-new-with-model"></a><h3>gdaui_combo_new_with_model ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *
gdaui_combo_new_with_model (<em class="parameter"><code><a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> *model</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_cols</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *cols_index</code></em>);</pre>
<p>Create a new GdauiCombo widget with a model. See <a class="link" href="libgda-5.0-GdauiCombo.html#gdaui-combo-set-model" title="gdaui_combo_set_model ()"><code class="function">gdaui_combo_set_model()</code></a> for
more information about the <em class="parameter"><code>n_cols</code></em>
and <em class="parameter"><code>cols_index</code></em>
usage.</p>
<div class="refsect3">
<a name="gdaui-combo-new-with-model.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>model</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_cols</p></td>
<td class="parameter_description"><p>number of columns in the model to be shown</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cols_index</p></td>
<td class="parameter_description"><p>an array of columns to be shown, its size must be <em class="parameter"><code>n_cols</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdaui-combo-new-with-model.returns"></a><h4>Returns</h4>
<p> the newly-created 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-combo-set-model"></a><h3>gdaui_combo_set_model ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdaui_combo_set_model (<em class="parameter"><code><a class="link" href="libgda-5.0-GdauiCombo.html#GdauiCombo" title="struct GdauiCombo"><span class="type">GdauiCombo</span></a> *combo</code></em>,
<em class="parameter"><code><a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> *model</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_cols</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *cols_index</code></em>);</pre>
<div class="warning"><p><code class="literal">gdaui_combo_set_model</code> has been deprecated since version 5.2 and should not be used in newly-written code.</p></div>
<p>Makes <em class="parameter"><code>combo</code></em>
display data stored in <em class="parameter"><code>model</code></em>
(makes the
combo widget refresh its list of values and display the values contained
in the model). A NULL <em class="parameter"><code>model</code></em>
will make the combo empty
and disassociate the previous model, if any.</p>
<p>if <em class="parameter"><code>n_cols</code></em>
is <code class="literal">0</code>, then all the columns of <em class="parameter"><code>model</code></em>
will be displayed in <em class="parameter"><code>combo</code></em>
.</p>
<p><span class="annotation">[<a href="http://foldoc.org/skip"><span class="acronym">skip</span></a>]</span></p>
<div class="refsect3">
<a name="gdaui-combo-set-model.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>combo</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdauiCombo.html#GdauiCombo" title="struct GdauiCombo"><span class="type">GdauiCombo</span></a> widget.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>model</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaDataModel.html" title="GdaDataModel"><span class="type">GdaDataModel</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_cols</p></td>
<td class="parameter_description"><p>number of columns in the model to be shown</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cols_index</p></td>
<td class="parameter_description"><p> an array of columns to be shown, its size must be <em class="parameter"><code>n_cols</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/array"><span class="acronym">array</span></a> length=n_cols]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-combo-add-null"></a><h3>gdaui_combo_add_null ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdaui_combo_add_null (<em class="parameter"><code><a class="link" href="libgda-5.0-GdauiCombo.html#GdauiCombo" title="struct GdauiCombo"><span class="type">GdauiCombo</span></a> *combo</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> add_null</code></em>);</pre>
<p>Tells if <em class="parameter"><code>combo</code></em>
should add a special entry representing an "undefined choice", as a <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> entry. The default is
that only the available choices in <em class="parameter"><code>combo</code></em>
's model are presented.</p>
<div class="refsect3">
<a name="gdaui-combo-add-null.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>combo</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdauiCombo.html#GdauiCombo" title="struct GdauiCombo"><span class="type">GdauiCombo</span></a> widget</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>add_null</p></td>
<td class="parameter_description"><p>set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to add a NULL value to the combo box</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-combo-is-null-selected"></a><h3>gdaui_combo_is_null_selected ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gdaui_combo_is_null_selected (<em class="parameter"><code><a class="link" href="libgda-5.0-GdauiCombo.html#GdauiCombo" title="struct GdauiCombo"><span class="type">GdauiCombo</span></a> *combo</code></em>);</pre>
<p>Tell if the currently selected entry represents the "undefined choice" entry.</p>
<div class="refsect3">
<a name="gdaui-combo-is-null-selected.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>combo</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgda-5.0-GdauiCombo.html#GdauiCombo" title="struct GdauiCombo"><span class="type">GdauiCombo</span></a> widget</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdaui-combo-is-null-selected.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> value is selected</p>
</div>
<p class="since">Since: 4.2</p>
</div>
</div>
<div class="refsect1">
<a name="libgda-5.0-GdauiCombo.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GdauiCombo"></a><h3>struct GdauiCombo</h3>
<pre class="programlisting">struct GdauiCombo {
GtkComboBox object;
GdauiComboPrivate *priv;
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|