~ubuntu-branches/ubuntu/trusty/gnome-shell/trusty

<pre class="synopsis">void <a class="link" href="shell-shell-util.html#shell-util-set-hidden-from-pick" title="shell_util_set_hidden_from_pick ()">shell_util_set_hidden_from_pick</a> (<code>ClutterActor *actor</code>,

<code>gboolean hidden</code>);

<pre class="synopsis">char * <a class="link" href="shell-shell-util.html#shell-get-file-contents-utf8-sync" title="shell_get_file_contents_utf8_sync ()">shell_get_file_contents_utf8_sync</a> (<code>const char *path</code>,

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);

<a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf">GdkPixbuf</a> * <a class="link" href="shell-shell-util.html#shell-util-create-pixbuf-from-data" title="shell_util_create_pixbuf_from_data ()">shell_util_create_pixbuf_from_data</a> (<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar">guchar</a> *data</code>,

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> len</code>,

<code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkColorspace">GdkColorspace</a> colorspace</code>,

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> has_alpha</code>,

<code>int bits_per_sample</code>,

<code>int width</code>,

<code>int height</code>,

<code>int rowstride</code>);

char * <a class="link" href="shell-shell-util.html#shell-util-format-date" title="shell_util_format_date ()">shell_util_format_date</a> (<code>const char *format</code>,

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64">gint64</a> time_ms</code>);

void <a class="link" href="shell-shell-util.html#shell-util-get-transformed-allocation" title="shell_util_get_transformed_allocation ()">shell_util_get_transformed_allocation</a>

(<code>ClutterActor *actor</code>,

<code>ClutterActorBox *box</code>);

(<code><a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html">ClutterActor</a> *actor</code>,

<code><a href="/usr/share/gtk-doc/html/clutter/clutter-Base-geometric-types.html#ClutterActorBox">ClutterActorBox</a> *box</code>);

int <a class="link" href="shell-shell-util.html#shell-util-get-week-start" title="shell_util_get_week_start ()">shell_util_get_week_start</a> (<code>void</code>);

char * <a class="link" href="shell-shell-util.html#shell-util-normalize-and-casefold" title="shell_util_normalize_and_casefold ()">shell_util_normalize_and_casefold</a> (<code>const char *str</code>);

char * <a class="link" href="shell-shell-util.html#shell-util-normalize-casefold-and-unaccent" title="shell_util_normalize_casefold_and_unaccent ()">shell_util_normalize_casefold_and_unaccent</a>

(<code>const char *str</code>);

<code>gint64 time_ms</code>);

gboolean <a class="link" href="shell-shell-util.html#shell-write-string-to-stream" title="shell_write_string_to_stream ()">shell_write_string_to_stream</a> (<code>GOutputStream *stream</code>,

<code>const char *str</code>,

<code>GError **error</code>);

char * <a class="link" href="shell-shell-util.html#shell-get-file-contents-utf8-sync" title="shell_get_file_contents_utf8_sync ()">shell_get_file_contents_utf8_sync</a> (<code>const char *path</code>,

<code>GError **error</code>);

gboolean <a class="link" href="shell-shell-util.html#shell-util-wifexited" title="shell_util_wifexited ()">shell_util_wifexited</a> (<code>int status</code>,

void <a class="link" href="shell-shell-util.html#shell-util-set-hidden-from-pick" title="shell_util_set_hidden_from_pick ()">shell_util_set_hidden_from_pick</a> (<code><a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html">ClutterActor</a> *actor</code>,

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> hidden</code>);

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="shell-shell-util.html#shell-util-wifexited" title="shell_util_wifexited ()">shell_util_wifexited</a> (<code>int status</code>,

<code>int *exit</code>);

GdkPixbuf * <a class="link" href="shell-shell-util.html#shell-util-create-pixbuf-from-data" title="shell_util_create_pixbuf_from_data ()">shell_util_create_pixbuf_from_data</a> (<code>const guchar *data</code>,

<code>gsize len</code>,

<code>GdkColorspace colorspace</code>,

<code>gboolean has_alpha</code>,

<code>int bits_per_sample</code>,

<code>int width</code>,

<code>int height</code>,

<code>int rowstride</code>);

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="shell-shell-util.html#shell-write-string-to-stream" title="shell_write_string_to_stream ()">shell_write_string_to_stream</a> (<code><a href="http://library.gnome.org/devel/gio/unstable/GOutputStream.html">GOutputStream</a> *stream</code>,

<code>const char *str</code>,

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);

</pre>

</div>

<a name="shell-shell-util.details"></a><h2>Details</h2>

<a name="shell-util-set-hidden-from-pick"></a><h3>shell_util_set_hidden_from_pick ()</h3>

<pre class="programlisting">void shell_util_set_hidden_from_pick (<code>ClutterActor *actor</code>,

<code>gboolean hidden</code>);</pre>

If <code>hidden</code> is <code class="literal">TRUE</code>, hide <code>actor</code> from pick even with a mode of

<code class="literal">CLUTTER_PICK_ALL</code>; if <code>hidden</code> is <code class="literal">FALSE</code>, unhide <code>actor</code>.

<col>

</colgroup>

<tbody>

<tr>

<td><code>actor</code> :</td>

<td>A ClutterActor

</td>

</tr>

<tr>

<td><code>hidden</code> :</td>

<td>Whether <code>actor</code> should be hidden from pick</td>

<a name="shell-get-file-contents-utf8-sync"></a><h3>shell_get_file_contents_utf8_sync ()</h3>

<pre class="programlisting">char * shell_get_file_contents_utf8_sync (<code>const char *path</code>,

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

Synchronously load the contents of a file as a NUL terminated

string, validating it as UTF-8. Embedded NUL characters count as

invalid content.

<col>

</colgroup>

<tbody>

<tr>

<td>UTF-8 encoded filename path</td>

</tr>

<tr>

<td><code>error</code> :</td>

<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a>

</td>

</tr>

<tr>

<td>Returns :</td>

<td>File contents. [<acronym title="Free data after the code is done.">transfer full</acronym>]

100

</td>

101

</tr>

102

</tbody>

103

</table></div>

104

</div>

105

<hr>

106

107

<a name="shell-util-create-pixbuf-from-data"></a><h3>shell_util_create_pixbuf_from_data ()</h3>

108

<pre class="programlisting"><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf">GdkPixbuf</a> * shell_util_create_pixbuf_from_data (<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar">guchar</a> *data</code>,

109

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> len</code>,

110

111

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> has_alpha</code>,

112

<code>int bits_per_sample</code>,

113

<code>int width</code>,

114

<code>int height</code>,

115

<code>int rowstride</code>);</pre>

116

117

Workaround for non-introspectability of <code class="function">gdk_pixbuf_from_data()</code>.

118

119

120

121

122

<col>

123

</colgroup>

124

<tbody>

125

<tr>

126

127

<td>. [<acronym title="Parameter points to an array of items.">array</acronym> length=len][<acronym title="Generics and defining elements of containers and arrays.">element-type</acronym> guint8][<acronym title="Free data after the code is done.">transfer full</acronym>]

128

</td>

129

</tr>

130

<tr>

131

<td>Returns :</td>

132

<td>. [<acronym title="Free data after the code is done.">transfer full</acronym>]

133

</td>

134

</tr>

135

</tbody>

136

</table></div>

137

</div>

138

<hr>

139

140

<a name="shell-util-format-date"></a><h3>shell_util_format_date ()</h3>

141

<pre class="programlisting">char * shell_util_format_date (<code>const char *format</code>,

142

143

144

Formats a date for the current locale. This should be

145

used instead of the Spidermonkey Date.toLocaleFormat()

146

extension because Date.toLocaleFormat() is buggy for

147

Unicode format strings:

148

https://bugzilla.mozilla.org/show_bug.cgi?id=508783

149

150

151

152

153

<col>

154

</colgroup>

155

<tbody>

156

<tr>

157

<td><code>format</code> :</td>

158

<td>a strftime-style string format, as parsed by

159

<a href="http://library.gnome.org/devel/glib/unstable/glib-GDateTime.html#g-date-time-format"><code class="function">g_date_time_format()</code></a>

160

</td>

161

</tr>

162

<tr>

163

164

<td>milliseconds since 1970-01-01 00:00:00 UTC; the

165

value returned by Date.getTime()</td>

166

</tr>

167

<tr>

168

<td>Returns :</td>

169

<td>the formatted date. If the date is

170

outside of the range of a GDateTime (which contains

171

any plausible dates we actually care about), will

172

return an empty string.</td>

173

</tr>

174

</tbody>

175

</table></div>

100

178

101

179

<a name="shell-util-get-transformed-allocation"></a><h3>shell_util_get_transformed_allocation ()</h3>

102

180

<pre class="programlisting">void shell_util_get_transformed_allocation

103

(<code>ClutterActor *actor</code>,

104

<code>ClutterActorBox *box</code>);</pre>

181

(<code><a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html">ClutterActor</a> *actor</code>,

182

<code><a href="/usr/share/gtk-doc/html/clutter/clutter-Base-geometric-types.html#ClutterActorBox">ClutterActorBox</a> *box</code>);</pre>

105

183

106

This function is similar to a combination of <code class="function">clutter_actor_get_transformed_position()</code>,

107

and <code class="function">clutter_actor_get_transformed_size()</code>, but unlike

108

<code class="function">clutter_actor_get_transformed_size()</code>, it always returns a transform

109

of the current allocation, while <code class="function">clutter_actor_get_transformed_size()</code> returns

184

This function is similar to a combination of <a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html#clutter-actor-get-transformed-position"><code class="function">clutter_actor_get_transformed_position()</code></a>,

185

and <a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html#clutter-actor-get-transformed-size"><code class="function">clutter_actor_get_transformed_size()</code></a>, but unlike

186

<a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html#clutter-actor-get-transformed-size"><code class="function">clutter_actor_get_transformed_size()</code></a>, it always returns a transform

187

of the current allocation, while <a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html#clutter-actor-get-transformed-size"><code class="function">clutter_actor_get_transformed_size()</code></a> returns

110

188

bad values (the transform of the requested size) if a relayout has been

111

189

queued.

112

190

113

191

114

192

This function is more convenient to use than

115

<code class="function">clutter_actor_get_abs_allocation_vertices()</code> if no transformation is in effect

193

<a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html#clutter-actor-get-abs-allocation-vertices"><code class="function">clutter_actor_get_abs_allocation_vertices()</code></a> if no transformation is in effect

116

194

and also works around limitations in the GJS binding of arrays.

117

195

118

196

123

201

<tbody>

124

202

<tr>

125

203

<td><code>actor</code> :</td>

126

<td>a ClutterActor

204

<td>a <a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html">ClutterActor</a>

127

205

</td>

128

206

</tr>

129

207

<tr>

168

246

</div>

169

247

<hr>

170

248

171

<a name="shell-util-format-date"></a><h3>shell_util_format_date ()</h3>

172

<pre class="programlisting">char * shell_util_format_date (<code>const char *format</code>,

173

174

175

Formats a date for the current locale. This should be

176

used instead of the Spidermonkey Date.toLocaleFormat()

177

extension because Date.toLocaleFormat() is buggy for

178

Unicode format strings:

179

https://bugzilla.mozilla.org/show_bug.cgi?id=508783

180

181

182

183

184

<col>

185

</colgroup>

186

<tbody>

187

<tr>

188

<td><code>format</code> :</td>

189

<td>a strftime-style string format, as parsed by

190

<code class="function">g_date_time_format()</code>

191

</td>

192

</tr>

193

<tr>

194

195

<td>milliseconds since 1970-01-01 00:00:00 UTC; the

196

value returned by Date.getTime()</td>

197

</tr>

198

<tr>

199

<td>Returns :</td>

200

<td>the formatted date. If the date is

201

outside of the range of a GDateTime (which contains

202

any plausible dates we actually care about), will

203

return an empty string.</td>

204

</tr>

205

</tbody>

206

</table></div>

207

</div>

208

<hr>

209

210

<a name="shell-write-string-to-stream"></a><h3>shell_write_string_to_stream ()</h3>

211

<pre class="programlisting">gboolean shell_write_string_to_stream (<code>GOutputStream *stream</code>,

212

<code>const char *str</code>,

213

<code>GError **error</code>);</pre>

214

215

Write a string to a GOutputStream as UTF-8. This is a workaround

216

for not having binary buffers in GJS.

217

218

219

220

221

<col>

222

</colgroup>

223

<tbody>

224

<tr>

225

<td><code>stream</code> :</td>

226

<td>a GOutputStream

227

</td>

228

</tr>

229

<tr>

230

231

<td>a UTF-8 string to write to <code>stream</code>

232

</td>

233

</tr>

234

<tr>

235

<td><code>error</code> :</td>

236

<td>location to store GError</td>

237

</tr>

238

<tr>

239

<td>Returns :</td>

240

<td>

241

<code class="literal">TRUE</code> if write succeeded</td>

242

</tr>

243

</tbody>

244

</table></div>

245

</div>

246

<hr>

247

248

<a name="shell-get-file-contents-utf8-sync"></a><h3>shell_get_file_contents_utf8_sync ()</h3>

249

<pre class="programlisting">char * shell_get_file_contents_utf8_sync (<code>const char *path</code>,

250

<code>GError **error</code>);</pre>

251

252

Synchronously load the contents of a file as a NUL terminated

253

string, validating it as UTF-8. Embedded NUL characters count as

254

invalid content.

255

256

257

258

259

<col>

260

</colgroup>

261

<tbody>

262

<tr>

263

264

<td>UTF-8 encoded filename path</td>

265

</tr>

266

<tr>

267

<td><code>error</code> :</td>

268

<td>a GError

269

</td>

270

</tr>

271

<tr>

272

<td>Returns :</td>

273

<td>File contents. [<acronym title="Free data after the code is done.">transfer full</acronym>]

274

</td>

249

<a name="shell-util-set-hidden-from-pick"></a><h3>shell_util_set_hidden_from_pick ()</h3>

250

<pre class="programlisting">void shell_util_set_hidden_from_pick (<code><a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html">ClutterActor</a> *actor</code>,

251

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> hidden</code>);</pre>

252

253

If <code>hidden</code> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, hide <code>actor</code> from pick even with a mode of

254

<a href="/usr/share/gtk-doc/html/clutter/ClutterStage.html#CLUTTER-PICK-ALL:CAPS"><code class="literal">CLUTTER_PICK_ALL</code></a>; if <code>hidden</code> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, unhide <code>actor</code>.

255

256

257

258

259

<col>

260

</colgroup>

261

<tbody>

262

<tr>

263

<td><code>actor</code> :</td>

264

<td>A <a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html">ClutterActor</a>

265

</td>

266

</tr>

267

<tr>

268

<td><code>hidden</code> :</td>

269

<td>Whether <code>actor</code> should be hidden from pick</td>

275

270

</tr>

276

271

</tbody>

277

272

</table></div>

279

274

<hr>

280

275

281

276

<a name="shell-util-wifexited"></a><h3>shell_util_wifexited ()</h3>

282

<pre class="programlisting">gboolean shell_util_wifexited (<code>int status</code>,

277

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> shell_util_wifexited (<code>int status</code>,

283

278

284

279

285

280

Implements libc standard WIFEXITED, that cannot be used JS

310

305

</div>

311

306

<hr>

312

307

313

<a name="shell-util-create-pixbuf-from-data"></a><h3>shell_util_create_pixbuf_from_data ()</h3>

314

<pre class="programlisting">GdkPixbuf * shell_util_create_pixbuf_from_data (<code>const guchar *data</code>,

315

<code>gsize len</code>,

316

<code>GdkColorspace colorspace</code>,

317

<code>gboolean has_alpha</code>,

318

<code>int bits_per_sample</code>,

319

<code>int width</code>,

320

<code>int height</code>,

321

<code>int rowstride</code>);</pre>

308

<a name="shell-write-string-to-stream"></a><h3>shell_write_string_to_stream ()</h3>

309

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> shell_write_string_to_stream (<code><a href="http://library.gnome.org/devel/gio/unstable/GOutputStream.html">GOutputStream</a> *stream</code>,

310

<code>const char *str</code>,

311

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

322

312

323

Workaround for non-introspectability of <code class="function">gdk_pixbuf_from_data()</code>.

313

Write a string to a GOutputStream as UTF-8. This is a workaround

314

for not having binary buffers in GJS.

324

315

325

316

326

317

329

320

</colgroup>

330

321

<tbody>

331

322

<tr>

332

333

334

</td>

323

<td><code>stream</code> :</td>

324

<td>a <a href="http://library.gnome.org/devel/gio/unstable/GOutputStream.html">GOutputStream</a>

325

</td>

326

</tr>

327

<tr>

328

329

<td>a UTF-8 string to write to <code>stream</code>

330

</td>

331

</tr>

332

<tr>

333

<td><code>error</code> :</td>

334

<td>location to store GError</td>

335

</tr>

336

<tr>

337

<td>Returns :</td>

338

<td>. [<acronym title="Free data after the code is done.">transfer full</acronym>]

339

</td>

338

<td>

339

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if write succeeded</td>

340

</tr>

341

</tbody>

342

</table></div>

345

</div>

346

347

<hr>

348

Generated by GTK-Doc V1.18.1</div>

348

Generated by GTK-Doc V1.19</div>

349

</body>

350

</html>

b'\\ No newline at end of file'

Older »