← Back to branch summary

~ubuntu-branches/ubuntu/trusty/clutter-gtk/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/reference/html/clutter-gtk-1.0-Utility-Functions.html

  • Committer: Package Import Robot
  • Author(s): Michael Biebl, Laurent Bigonville, Michael Biebl
  • Date: 2013-08-27 18:23:21 UTC
  • mfrom: (6.1.10 experimental)
  • Revision ID: package-import@ubuntu.com-20130827182321-gkcwqu6cqrqike7a
Tags: 1.4.4-3
[ Laurent Bigonville ]
* debian/rules: Use DEB_LDFLAGS_MAINT_APPEND instead of LDFLAGS to not
  override hardening flags
* debian/control.in:
  - Use canonical URL's for the Vcs-* fields
  - Bump Standards-Version to 3.9.4 (no further changes)

[ Michael Biebl ]
* Upload to unstable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/clutter-gtk-1.0-Utility-Functions.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>Utility Functions</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7
 
<link rel="home" href="index.html" title="Clutter-Gtk 1.2.0 Reference Manual">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
 
7
<link rel="home" href="index.html" title="Clutter-Gtk 1.4.4 Reference Manual">
8
8
<link rel="up" href="ch03.html" title="Miscellaneous">
9
9
<link rel="prev" href="ch03.html" title="Miscellaneous">
10
10
<link rel="next" href="ix01.html" title="Index">
17
17
<td><a accesskey="p" href="ch03.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
18
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
 
<th width="100%" align="center">Clutter-Gtk 1.2.0
 
20
<th width="100%" align="center">Clutter-Gtk 1.4.4
21
21
 Reference Manual</th>
22
22
<td><a accesskey="n" href="ix01.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
23
</tr>
71
71
This function should be called instead of <code class="function">clutter_init()</code> and
72
72
<code class="function">gtk_init()</code>.
73
73
</p>
74
 
<div class="variablelist"><table border="0">
 
74
<div class="variablelist"><table border="0" class="variablelist">
 
75
<colgroup>
75
76
<col align="left" valign="top">
 
77
<col>
 
78
</colgroup>
76
79
<tbody>
77
80
<tr>
78
81
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
79
 
<td>pointer to the arguments count, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
82
<td>pointer to the arguments count, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
80
83
</td>
81
84
</tr>
82
85
<tr>
83
86
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
84
87
<td>pointer to the
85
 
arguments vector, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=argc][<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
88
arguments vector, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=argc][<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
86
89
</td>
87
90
</tr>
88
91
<tr>
107
110
This function should be called instead of <code class="function">clutter_init()</code> and
108
111
<code class="function">gtk_init_with_args()</code>.
109
112
</p>
110
 
<div class="variablelist"><table border="0">
 
113
<div class="variablelist"><table border="0" class="variablelist">
 
114
<colgroup>
111
115
<col align="left" valign="top">
 
116
<col>
 
117
</colgroup>
112
118
<tbody>
113
119
<tr>
114
120
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
115
121
<td>a pointer to the number of command line
116
 
arguments, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
122
arguments, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
117
123
</td>
118
124
</tr>
119
125
<tr>
120
126
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
121
127
<td>a pointer to the array
122
 
of command line arguments, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=argc]</span>
 
128
of command line arguments, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=argc]</span>
123
129
</td>
124
130
</tr>
125
131
<tr>
132
138
<tr>
133
139
<td><p><span class="term"><em class="parameter"><code>entries</code></em> :</span></p></td>
134
140
<td>a
135
 
<a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>-terminated array of <span class="type">GOptionEntry</span>s describing the
 
141
<code class="literal">NULL</code>-terminated array of <span class="type">GOptionEntry</span>s describing the
136
142
options of your program. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span>
137
143
</td>
138
144
</tr>
140
146
<td><p><span class="term"><em class="parameter"><code>translation_domain</code></em> :</span></p></td>
141
147
<td>a translation domain to use for
142
148
translating the <code class="option">--help</code> output for the options
143
 
in <em class="parameter"><code>entries</code></em> with <code class="function">gettext()</code>, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
149
in <em class="parameter"><code>entries</code></em> with <code class="function">gettext()</code>, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
144
150
</td>
145
151
</tr>
146
152
<tr>
147
153
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
148
 
<td>a return location for errors, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
154
<td>a return location for errors, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
149
155
</td>
150
156
</tr>
151
157
<tr>
198
204
<span class="function">g_option_context_add_group</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">context</span><span class="symbol">,</span><span class="normal"> </span><span class="function">cogl_get_option_group</span><span class="normal"> </span><span class="symbol">());</span>
199
205
<span class="function">g_option_context_add_group</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">context</span><span class="symbol">,</span><span class="normal"> </span><span class="function">clutter_get_option_group_without_init</span><span class="normal"> </span><span class="symbol">());</span>
200
206
<span class="function">g_option_context_add_group</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">context</span><span class="symbol">,</span><span class="normal"> </span><span class="function"><a href="clutter-gtk-1.0-Utility-Functions.html#gtk-clutter-get-option-group">gtk_clutter_get_option_group</a></span><span class="normal"> </span><span class="symbol">());</span>
201
 
<span class="normal">res </span><span class="symbol">=</span><span class="normal"> </span><span class="function">g_option_context_parse</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">context</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">argc</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">argc</span><span class="symbol">,</span><span class="normal"> <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS">NULL</a></span><span class="symbol">);</span></pre></td>
 
207
<span class="normal">res </span><span class="symbol">=</span><span class="normal"> </span><span class="function">g_option_context_parse</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">context</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">argc</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">argc</span><span class="symbol">,</span><span class="normal"> NULL</span><span class="symbol">);</span></pre></td>
202
208
      </tr>
203
209
    </tbody>
204
210
  </table>
229
235
the returned <span class="type">GOptionGroup</span> has returned <code class="literal">TRUE</code>, Clutter and GTK-Clutter are
230
236
guaranteed to be initialized.
231
237
</p>
232
 
<div class="variablelist"><table border="0">
 
238
<div class="variablelist"><table border="0" class="variablelist">
 
239
<colgroup>
233
240
<col align="left" valign="top">
 
241
<col>
 
242
</colgroup>
234
243
<tbody><tr>
235
244
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
236
245
<td>a <span class="type">GOptionGroup</span> for the commandline arguments