~ubuntu-branches/ubuntu/vivid/glib2.0/vivid-proposed : revision 203

92

</tr>

93

<tr>

94

95

<a href="../glib/glib-GVariant.html#GVariant">GVariant</a> *

95

<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a> *

96

</td>

97

98

<a class="link" href="GSettings.html#g-settings-get-value" title="g_settings_get_value ()">g_settings_get_value</a> ()

100

</tr>

101

<tr>

102

103

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

103

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

104

</td>

105

106

<a class="link" href="GSettings.html#g-settings-set-value" title="g_settings_set_value ()">g_settings_set_value</a> ()

108

</tr>

109

<tr>

110

111

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

111

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

112

</td>

113

114

<a class="link" href="GSettings.html#g-settings-is-writable" title="g_settings_is_writable ()">g_settings_is_writable</a> ()

140

</tr>

141

<tr>

142

143

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

143

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

144

</td>

145

146

<a class="link" href="GSettings.html#g-settings-get-has-unapplied" title="g_settings_get_has_unapplied ()">g_settings_get_has_unapplied</a> ()

164

</tr>

165

<tr>

166

167

<a href="../glib/glib-GVariant.html#GVariant">GVariant</a> *

167

<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a> *

168

</td>

169

170

<a class="link" href="GSettings.html#g-settings-get-user-value" title="g_settings_get_user_value ()">g_settings_get_user_value</a> ()

172

</tr>

173

<tr>

174

175

<a href="../glib/glib-GVariant.html#GVariant">GVariant</a> *

175

<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a> *

176

</td>

177

178

<a class="link" href="GSettings.html#g-settings-get-default-value" title="g_settings_get_default_value ()">g_settings_get_default_value</a> ()

179

</td>

180

</tr>

181

<tr>

182

<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> * const *

182

<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> * const *

183

</td>

184

185

<a class="link" href="GSettings.html#g-settings-list-schemas" title="g_settings_list_schemas ()">g_settings_list_schemas</a> ()

186

</td>

187

</tr>

188

<tr>

189

<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> * const *

189

<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> * const *

190

</td>

191

192

<a class="link" href="GSettings.html#g-settings-list-relocatable-schemas" title="g_settings_list_relocatable_schemas ()">g_settings_list_relocatable_schemas</a> ()

194

</tr>

195

<tr>

196

197

<a href="../glib/glib-Basic-Types.html#gchar">gchar</a> **

197

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> **

198

</td>

199

200

<a class="link" href="GSettings.html#g-settings-list-keys" title="g_settings_list_keys ()">g_settings_list_keys</a> ()

202

</tr>

203

<tr>

204

205

<a href="../glib/glib-Basic-Types.html#gchar">gchar</a> **

205

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> **

206

</td>

207

208

<a class="link" href="GSettings.html#g-settings-list-children" title="g_settings_list_children ()">g_settings_list_children</a> ()

210

</tr>

211

<tr>

212

213

<a href="../glib/glib-GVariant.html#GVariant">GVariant</a> *

213

<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a> *

214

</td>

215

216

<a class="link" href="GSettings.html#g-settings-get-range" title="g_settings_get_range ()">g_settings_get_range</a> ()

218

</tr>

219

<tr>

220

221

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

221

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

222

</td>

223

224

<a class="link" href="GSettings.html#g-settings-range-check" title="g_settings_range_check ()">g_settings_range_check</a> ()

234

</tr>

235

<tr>

236

237

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

237

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

238

</td>

239

240

<a class="link" href="GSettings.html#g-settings-set" title="g_settings_set ()">g_settings_set</a> ()

242

</tr>

243

<tr>

244

245

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

245

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

246

</td>

247

248

<a class="link" href="GSettings.html#g-settings-get-boolean" title="g_settings_get_boolean ()">g_settings_get_boolean</a> ()

250

</tr>

251

<tr>

252

253

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

253

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

254

</td>

255

256

<a class="link" href="GSettings.html#g-settings-set-boolean" title="g_settings_set_boolean ()">g_settings_set_boolean</a> ()

258

</tr>

259

<tr>

260

261

261

262

</td>

263

264

<a class="link" href="GSettings.html#g-settings-get-int" title="g_settings_get_int ()">g_settings_get_int</a> ()

266

</tr>

267

<tr>

268

269

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

269

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

270

</td>

271

272

<a class="link" href="GSettings.html#g-settings-set-int" title="g_settings_set_int ()">g_settings_set_int</a> ()

274

</tr>

275

<tr>

276

277

<a href="../glib/glib-Basic-Types.html#guint">guint</a>

277

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

278

</td>

279

280

<a class="link" href="GSettings.html#g-settings-get-uint" title="g_settings_get_uint ()">g_settings_get_uint</a> ()

282

</tr>

283

<tr>

284

285

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

285

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

286

</td>

287

288

<a class="link" href="GSettings.html#g-settings-set-uint" title="g_settings_set_uint ()">g_settings_set_uint</a> ()

290

</tr>

291

<tr>

292

293

<a href="../glib/glib-Basic-Types.html#gdouble">gdouble</a>

293

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

294

</td>

295

296

<a class="link" href="GSettings.html#g-settings-get-double" title="g_settings_get_double ()">g_settings_get_double</a> ()

298

</tr>

299

<tr>

300

301

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

301

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

302

</td>

303

304

<a class="link" href="GSettings.html#g-settings-set-double" title="g_settings_set_double ()">g_settings_set_double</a> ()

306

</tr>

307

<tr>

308

309

<a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *

309

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *

310

</td>

311

312

<a class="link" href="GSettings.html#g-settings-get-string" title="g_settings_get_string ()">g_settings_get_string</a> ()

314

</tr>

315

<tr>

316

317

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

317

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

318

</td>

319

320

<a class="link" href="GSettings.html#g-settings-set-string" title="g_settings_set_string ()">g_settings_set_string</a> ()

322

</tr>

323

<tr>

324

325

<a href="../glib/glib-Basic-Types.html#gchar">gchar</a> **

325

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> **

326

</td>

327

328

<a class="link" href="GSettings.html#g-settings-get-strv" title="g_settings_get_strv ()">g_settings_get_strv</a> ()

330

</tr>

331

<tr>

332

333

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

333

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

334

</td>

335

336

<a class="link" href="GSettings.html#g-settings-set-strv" title="g_settings_set_strv ()">g_settings_set_strv</a> ()

338

</tr>

339

<tr>

340

341

341

342

</td>

343

344

<a class="link" href="GSettings.html#g-settings-get-enum" title="g_settings_get_enum ()">g_settings_get_enum</a> ()

346

</tr>

347

<tr>

348

349

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

349

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

350

</td>

351

352

<a class="link" href="GSettings.html#g-settings-set-enum" title="g_settings_set_enum ()">g_settings_set_enum</a> ()

354

</tr>

355

<tr>

356

357

<a href="../glib/glib-Basic-Types.html#guint">guint</a>

357

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

358

</td>

359

360

<a class="link" href="GSettings.html#g-settings-get-flags" title="g_settings_get_flags ()">g_settings_get_flags</a> ()

362

</tr>

363

<tr>

364

365

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

365

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

366

</td>

367

368

<a class="link" href="GSettings.html#g-settings-set-flags" title="g_settings_set_flags ()">g_settings_set_flags</a> ()

370

</tr>

371

<tr>

372

373

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

373

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

374

</td>

375

376

(<a class="link" href="GSettings.html#GSettingsGetMapping" title="GSettingsGetMapping ()">*GSettingsGetMapping</a>) ()

378

</tr>

379

<tr>

380

381

<a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a>

381

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

382

</td>

383

384

<a class="link" href="GSettings.html#g-settings-get-mapped" title="g_settings_get_mapped ()">g_settings_get_mapped</a> ()

418

</tr>

419

<tr>

420

421

<a href="../glib/glib-GVariant.html#GVariant">GVariant</a> *

421

<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a> *

422

</td>

423

424

(<a class="link" href="GSettings.html#GSettingsBindSetMapping" title="GSettingsBindSetMapping ()">*GSettingsBindSetMapping</a>) ()

426

</tr>

427

<tr>

428

429

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

429

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

430

</td>

431

432

(<a class="link" href="GSettings.html#GSettingsBindGetMapping" title="GSettingsBindGetMapping ()">*GSettingsBindGetMapping</a>) ()

459

<td class="property_flags">Read / Write / Construct Only</td>

460

</tr>

461

<tr>

462

<td class="property_type"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a></td>

462

<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a></td>

463

<td class="property_name"><a class="link" href="GSettings.html#GSettings--delay-apply" title="The “delay-apply” property">delay-apply</a></td>

464

465

</tr>

466

<tr>

467

<td class="property_type"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a></td>

467

<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a></td>

468

<td class="property_name"><a class="link" href="GSettings.html#GSettings--has-unapplied" title="The “has-unapplied” property">has-unapplied</a></td>

469

470

</tr>

471

<tr>

472

473

<a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *</td>

473

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *</td>

474

475

<td class="property_flags">Read / Write / Construct Only</td>

476

</tr>

477

<tr>

478

479

<a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *</td>

479

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *</td>

480

<td class="property_name"><a class="link" href="GSettings.html#GSettings--schema" title="The “schema” property">schema</a></td>

481

<td class="property_flags">Read / Write / Construct Only</td>

482

</tr>

483

<tr>

484

485

<a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *</td>

485

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *</td>

486

<td class="property_name"><a class="link" href="GSettings.html#GSettings--schema-id" title="The “schema-id” property">schema-id</a></td>

487

<td class="property_flags">Read / Write / Construct Only</td>

488

</tr>

505

</colgroup>

506

<tbody>

507

<tr>

508

<td class="signal_type"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a></td>

508

<td class="signal_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a></td>

509

<td class="signal_name"><a class="link" href="GSettings.html#GSettings-change-event" title="The “change-event” signal">change-event</a></td>

510

510

511

</tr>

512

<tr>

513

514

<td class="signal_name"><a class="link" href="GSettings.html#GSettings-changed" title="The “changed” signal">changed</a></td>

515

<td class="signal_flags">Has Details</td>

515

<td class="signal_flags"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS">Has Details</a></td>

516

</tr>

517

<tr>

518

<td class="signal_type"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a></td>

518

<td class="signal_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a></td>

519

<td class="signal_name"><a class="link" href="GSettings.html#GSettings-writable-change-event" title="The “writable-change-event” signal">writable-change-event</a></td>

520

520

521

</tr>

522

<tr>

523

524

<td class="signal_name"><a class="link" href="GSettings.html#GSettings-writable-changed" title="The “writable-changed” signal">writable-changed</a></td>

525

<td class="signal_flags">Has Details</td>

525

<td class="signal_flags"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS">Has Details</a></td>

526

</tr>

527

</tbody>

528

</table></div>

548

</div>

549

550

<a name="GSettings.object-hierarchy"></a><h2>Object Hierarchy</h2>

551

<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>

551

<pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>

552

╰── GSettings

553

</pre>

554

</div>

564

Reads and writes can be considered to be non-blocking. Reading

565

settings with <a class="link" href="GSettings.html" title="GSettings">GSettings</a> is typically extremely fast: on

566

approximately the same order of magnitude (but slower than) a

567

<a href="../glib/glib-Hash-Tables.html#GHashTable">GHashTable</a> lookup. Writing settings is also extremely fast in terms

567

<a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable">GHashTable</a> lookup. Writing settings is also extremely fast in terms

568

of time to return to your application, but can be extremely expensive

569

for other threads and other processes. Many settings backends

570

(including dconf) have lazy initialisation which means in the common

594

they often did in GConf.

595

Unlike other configuration systems (like GConf), GSettings does not

596

restrict keys to basic types like strings and numbers. GSettings stores

597

values as <a href="../glib/glib-GVariant.html#GVariant">GVariant</a>, and allows any <a href="../glib/glib-GVariantType.html#GVariantType">GVariantType</a> for keys. Key names

597

values as <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a>, and allows any <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariantType.html#GVariantType">GVariantType</a> for keys. Key names

598

are restricted to lowercase characters, numbers and '-'. Furthermore,

599

the names must begin with a lowercase character, must not end

600

with a '-', and must not contain consecutive dashes.

619

and schema id should match. For schemas which deal with settings not

620

associated with one named application, the id should not use

621

StudlyCaps, e.g. "org.gnome.font-rendering".

622

In addition to <a href="../glib/glib-GVariant.html#GVariant">GVariant</a> types, keys can have types that have

622

In addition to <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a> types, keys can have types that have

623

enumerated types. These can be described by a <choice>,

624

<enum> or <flags> element, as seen in the

625

example. The underlying type of such a key

798

</div>

799

800

<a name="id-1.4.19.2.9.21"></a><h4>Binding</h4>

801

A very convenient feature of GSettings lets you bind <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> properties

801

A very convenient feature of GSettings lets you bind <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> properties

802

directly to settings, using <a class="link" href="GSettings.html#g-settings-bind" title="g_settings_bind ()"><code class="function">g_settings_bind()</code></a>. Once a GObject property

803

has been bound to a setting, changes on either side are automatically

804

propagated to the other side. GSettings handles details like mapping

816

817

<a name="g-settings-new"></a><h3>g_settings_new ()</h3>

818

<pre class="programlisting"><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *

819

g_settings_new (<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *schema_id</code>);</pre>

819

g_settings_new (<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *schema_id</code>);</pre>

820

Creates a new <a class="link" href="GSettings.html" title="GSettings">GSettings</a> object with the schema specified by

821

<code>schema_id</code>

822

.

823

Signals on the newly created <a class="link" href="GSettings.html" title="GSettings">GSettings</a> object will be dispatched

824

via the thread-default <a href="../glib/glib-The-Main-Event-Loop.html#GMainContext">GMainContext</a> in effect at the time of the

824

via the thread-default <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext">GMainContext</a> in effect at the time of the

825

call to <a class="link" href="GSettings.html#g-settings-new" title="g_settings_new ()"><code class="function">g_settings_new()</code></a>. The new <a class="link" href="GSettings.html" title="GSettings">GSettings</a> will hold a reference

826

on the context. See <a href="../glib/glib-The-Main-Event-Loop.html#g-main-context-push-thread-default"><code class="function">g_main_context_push_thread_default()</code></a>.

826

on the context. See <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-main-context-push-thread-default"><code class="function">g_main_context_push_thread_default()</code></a>.

827

828

<a name="id-1.4.19.2.10.2.6"></a><h4>Parameters</h4>

829

850

851

<a name="g-settings-new-with-path"></a><h3>g_settings_new_with_path ()</h3>

852

<pre class="programlisting"><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *

853

g_settings_new_with_path (<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *schema_id</code>,

854

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *path</code>);</pre>

853

g_settings_new_with_path (<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *schema_id</code>,

854

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

855

Creates a new <a class="link" href="GSettings.html" title="GSettings">GSettings</a> object with the relocatable schema specified

856

by <code>schema_id</code>

857

and a given path.

897

898

<a name="g-settings-new-with-backend"></a><h3>g_settings_new_with_backend ()</h3>

899

<pre class="programlisting"><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *

900

g_settings_new_with_backend (<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *schema_id</code>,

900

g_settings_new_with_backend (<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *schema_id</code>,

901

<code><a class="link" href="GSettingsBackend.html" title="GSettingsBackend">GSettingsBackend</a> *backend</code>);</pre>

902

Creates a new <a class="link" href="GSettings.html" title="GSettings">GSettings</a> object with the schema specified by

903

<code>schema_id</code>

940

941

<a name="g-settings-new-with-backend-and-path"></a><h3>g_settings_new_with_backend_and_path ()</h3>

942

<pre class="programlisting"><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *

943

g_settings_new_with_backend_and_path (<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *schema_id</code>,

943

g_settings_new_with_backend_and_path (<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *schema_id</code>,

944

<code><a class="link" href="GSettingsBackend.html" title="GSettingsBackend">GSettingsBackend</a> *backend</code>,

945

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *path</code>);</pre>

945

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

946

Creates a new <a class="link" href="GSettings.html" title="GSettings">GSettings</a> object with the schema specified by

947

<code>schema_id</code>

948

and a given <a class="link" href="GSettingsBackend.html" title="GSettingsBackend">GSettingsBackend</a> and path.

988

<pre class="programlisting"><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *

989

g_settings_new_full (<code><a class="link" href="gio-GSettingsSchema-GSettingsSchemaSource.html#GSettingsSchema">GSettingsSchema</a> *schema</code>,

990

<code><a class="link" href="GSettingsBackend.html" title="GSettingsBackend">GSettingsBackend</a> *backend</code>,

991

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *path</code>);</pre>

991

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

992

Creates a new <a class="link" href="GSettings.html" title="GSettings">GSettings</a> object with a given schema, backend and

993

path.

994

It should be extremely rare that you ever want to use this function.

997

etc).

998

At the most basic level, a <a class="link" href="GSettings.html" title="GSettings">GSettings</a> object is a pure composition of

999

4 things: a <a class="link" href="gio-GSettingsSchema-GSettingsSchemaSource.html#GSettingsSchema">GSettingsSchema</a>, a <a class="link" href="GSettingsBackend.html" title="GSettingsBackend">GSettingsBackend</a>, a path within that

1000

backend, and a <a href="../glib/glib-The-Main-Event-Loop.html#GMainContext">GMainContext</a> to which signals are dispatched.

1000

backend, and a <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext">GMainContext</a> to which signals are dispatched.

1001

This constructor therefore gives you full control over constructing

1002

<a class="link" href="GSettings.html" title="GSettings">GSettings</a> instances. The first 4 parameters are given directly as

1003

<code>schema</code>

1006

, and the main context is taken from the

1007

thread-default (as per <a class="link" href="GSettings.html#g-settings-new" title="g_settings_new ()"><code class="function">g_settings_new()</code></a>).

1008

If <code>backend</code>

1009

is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then the default backend is used.

1009

is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then the default backend is used.

1010

If <code>path</code>

1011

is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then the path from the schema is used. It is an

1011

is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then the path from the schema is used. It is an

1012

error f <code>path</code>

1013

is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> and the schema has no path of its own or if

1013

is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> and the schema has no path of its own or if

1014

1015

is non-<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> and not equal to the path that the schema does

1015

is non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> and not equal to the path that the schema does

1016

have.

1017

1018

<a name="id-1.4.19.2.10.6.10"></a><h4>Parameters</h4>

1066

<hr>

1067

1068

<a name="g-settings-get-value"></a><h3>g_settings_get_value ()</h3>

1069

<pre class="programlisting"><a href="../glib/glib-GVariant.html#GVariant">GVariant</a> *

1069

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a> *

1070

g_settings_get_value (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

1071

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>);</pre>

1071

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

1072

Gets the value that is stored in <code>settings</code>

1073

for <code>key</code>

1074

.

1100

</div>

1101

1102

<a name="id-1.4.19.2.10.8.7"></a><h4>Returns</h4>

1103

a new <a href="../glib/glib-GVariant.html#GVariant">GVariant</a>

1103

a new <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a>

1104

1105

</div>

1106

Since 2.26

1108

<hr>

1109

1110

<a name="g-settings-set-value"></a><h3>g_settings_set_value ()</h3>

1111

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

1111

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

1112

g_settings_set_value (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

1113

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

1114

<code><a href="../glib/glib-GVariant.html#GVariant">GVariant</a> *value</code>);</pre>

1113

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

1114

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

1115

Sets <code>key</code>

1116

in <code>settings</code>

1117

to <code>value</code>

1145

</tr>

1146

<tr>

1147

<td class="parameter_name">value</td>

1148

<td class="parameter_description">a <a href="../glib/glib-GVariant.html#GVariant">GVariant</a> of the correct type</td>

1148

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a> of the correct type</td>

1149

1150

</tr>

1151

</tbody>

1153

</div>

1154

1155

<a name="id-1.4.19.2.10.9.8"></a><h4>Returns</h4>

1156

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if setting the key succeeded,

1157

<a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable

1156

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

1157

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable

1158

1159

</div>

1160

Since 2.26

1162

<hr>

1163

1164

<a name="g-settings-is-writable"></a><h3>g_settings_is_writable ()</h3>

1165

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

1165

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

1166

g_settings_is_writable (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

1167

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *name</code>);</pre>

1167

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

1168

Finds out if a key can be written or not

1169

1170

<a name="id-1.4.19.2.10.10.5"></a><h4>Parameters</h4>

1190

</div>

1191

1192

<a name="id-1.4.19.2.10.10.6"></a><h4>Returns</h4>

1193

1193

1194

is writable

1195

1196

</div>

1278

<hr>

1279

1280

<a name="g-settings-get-has-unapplied"></a><h3>g_settings_get_has_unapplied ()</h3>

1281

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

1281

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

1282

g_settings_get_has_unapplied (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>);</pre>

1283

Returns whether the <a class="link" href="GSettings.html" title="GSettings">GSettings</a> object has any unapplied

1284

changes. This can only be the case if it is in 'delayed-apply' mode.

1299

</div>

1300

1301

<a name="id-1.4.19.2.10.14.6"></a><h4>Returns</h4>

1302

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <code>settings</code>

1302

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

1303

has unapplied changes

1304

1305

</div>

1310

<a name="g-settings-get-child"></a><h3>g_settings_get_child ()</h3>

1311

<pre class="programlisting"><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *

1312

g_settings_get_child (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

1313

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *name</code>);</pre>

1313

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

1314

Creates a child settings object which has a base path of

1315

<code class="literal">base-path/@name</code>, where <code class="literal">base-path</code> is the base path of

1316

<code>settings</code>

1352

<a name="g-settings-reset"></a><h3>g_settings_reset ()</h3>

1353

<pre class="programlisting">void

1354

g_settings_reset (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

1355

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>);</pre>

1355

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

1356

Resets <code>key</code>

1357

to its default value.

1358

This call resets the key, as much as possible, to its default value.

1384

<hr>

1385

1386

<a name="g-settings-get-user-value"></a><h3>g_settings_get_user_value ()</h3>

1387

<pre class="programlisting"><a href="../glib/glib-GVariant.html#GVariant">GVariant</a> *

1387

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a> *

1388

g_settings_get_user_value (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

1389

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>);</pre>

1389

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

1390

Checks the "user value" of a key, if there is one.

1391

The user value of a key is the last value that was set by the user.

1392

After calling <a class="link" href="GSettings.html#g-settings-reset" title="g_settings_reset ()"><code class="function">g_settings_reset()</code></a> this function should always return

1393

<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> (assuming something is not wrong with the system

1393

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> (assuming something is not wrong with the system

1394

configuration).

1395

It is possible that <a class="link" href="GSettings.html#g-settings-get-value" title="g_settings_get_value ()"><code class="function">g_settings_get_value()</code></a> will return a different

1396

value than this function. This can happen in the case that the user

1434

<hr>

1435

1436

<a name="g-settings-get-default-value"></a><h3>g_settings_get_default_value ()</h3>

1437

<pre class="programlisting"><a href="../glib/glib-GVariant.html#GVariant">GVariant</a> *

1437

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a> *

1438

g_settings_get_default_value (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

1439

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>);</pre>

1439

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

1440

Gets the "default value" of a key.

1441

This is the value that would be read if <a class="link" href="GSettings.html#g-settings-reset" title="g_settings_reset ()"><code class="function">g_settings_reset()</code></a> were to be

1442

called on the key.

1487

<hr>

1488

1489

<a name="g-settings-list-schemas"></a><h3>g_settings_list_schemas ()</h3>

1490

<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> * const *

1490

<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> * const *

1491

g_settings_list_schemas (<code>void</code>);</pre>

1492

1493

<code class="literal">g_settings_list_schemas</code> has been deprecated since version 2.40 and should not be used in newly-written code.

1508

<hr>

1509

1510

<a name="g-settings-list-relocatable-schemas"></a><h3>g_settings_list_relocatable_schemas ()</h3>

1511

<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> * const *

1511

<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> * const *

1512

g_settings_list_relocatable_schemas (<code>void</code>);</pre>

1513

1514

<code class="literal">g_settings_list_relocatable_schemas</code> has been deprecated since version 2.40 and should not be used in newly-written code.

1526

<hr>

1527

1528

<a name="g-settings-list-keys"></a><h3>g_settings_list_keys ()</h3>

1529

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar">gchar</a> **

1529

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> **

1530

g_settings_list_keys (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>);</pre>

1531

Introspects the list of keys on <code>settings</code>

1532

.

1533

You should probably not be calling this function from "normal" code

1534

(since you should already know what keys are in your schema). This

1535

function is intended for introspection reasons.

1536

You should free the return value with <a href="../glib/glib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a> when you are done

1536

You should free the return value with <a href="http://library.gnome.org/devel/glib/unstable/glib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a> when you are done

1537

with it.

1538

1539

<a name="id-1.4.19.2.10.21.7"></a><h4>Parameters</h4>

1560

<hr>

1561

1562

<a name="g-settings-list-children"></a><h3>g_settings_list_children ()</h3>

1563

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar">gchar</a> **

1563

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> **

1564

g_settings_list_children (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>);</pre>

1565

Gets the list of children on <code>settings</code>

1566

.

1571

for those changes. Note that there is a race condition here: you may

1572

request a child after listing it only for it to have been destroyed

1573

in the meantime. For this reason, <a class="link" href="GSettings.html#g-settings-get-child" title="g_settings_get_child ()"><code class="function">g_settings_get_child()</code></a> may return

1574

<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> even for a child that was listed by this function.

1574

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> even for a child that was listed by this function.

1575

For GSettings objects that are not lists, you should probably not be

1576

calling this function from "normal" code (since you should already

1577

know what children are in your schema). This function may still be

1578

useful there for introspection reasons, however.

1579

You should free the return value with <a href="../glib/glib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a> when you are done

1579

You should free the return value with <a href="http://library.gnome.org/devel/glib/unstable/glib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a> when you are done

1580

with it.

1581

1582

<a name="id-1.4.19.2.10.22.9"></a><h4>Parameters</h4>

1603

<hr>

1604

1605

<a name="g-settings-get-range"></a><h3>g_settings_get_range ()</h3>

1606

<pre class="programlisting"><a href="../glib/glib-GVariant.html#GVariant">GVariant</a> *

1606

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a> *

1607

g_settings_get_range (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

1608

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>);</pre>

1608

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

1609

1610

<code class="literal">g_settings_get_range</code> has been deprecated since version 2.40 and should not be used in newly-written code.

1611

Use <a class="link" href="gio-GSettingsSchema-GSettingsSchemaSource.html#g-settings-schema-key-get-range" title="g_settings_schema_key_get_range ()"><code class="function">g_settings_schema_key_get_range()</code></a> instead.

1638

<hr>

1639

1640

<a name="g-settings-range-check"></a><h3>g_settings_range_check ()</h3>

1641

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

1641

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

1642

g_settings_range_check (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

1643

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

1644

<code><a href="../glib/glib-GVariant.html#GVariant">GVariant</a> *value</code>);</pre>

1643

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

1644

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

1645

1646

<code class="literal">g_settings_range_check</code> has been deprecated since version 2.40 and should not be used in newly-written code.

1647

Use <a class="link" href="gio-GSettingsSchema-GSettingsSchemaSource.html#g-settings-schema-key-range-check" title="g_settings_schema_key_range_check ()"><code class="function">g_settings_schema_key_range_check()</code></a> instead.

1679

</div>

1680

1681

<a name="id-1.4.19.2.10.24.8"></a><h4>Returns</h4>

1682

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <code>value</code>

1682

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

1683

is valid for <code>key</code>

1684

1685

1691

<a name="g-settings-get"></a><h3>g_settings_get ()</h3>

1692

<pre class="programlisting">void

1693

g_settings_get (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

1694

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

1695

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *format</code>,

1694

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

1695

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *format</code>,

1696

1697

Gets the value that is stored at <code>key</code>

1698

in <code>settings</code>

1699

.

1700

A convenience function that combines <a class="link" href="GSettings.html#g-settings-get-value" title="g_settings_get_value ()"><code class="function">g_settings_get_value()</code></a> with

1701

<a href="../glib/glib-GVariant.html#g-variant-get"><code class="function">g_variant_get()</code></a>.

1701

<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#g-variant-get"><code class="function">g_variant_get()</code></a>.

1702

It is a programmer error to give a <code>key</code>

1703

that isn't contained in the

1704

schema for <code>settings</code>

1705

or for the <a href="../glib/glib-GVariantType.html#GVariantType">GVariantType</a> of <code>format</code>

1705

or for the <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariantType.html#GVariantType">GVariantType</a> of <code>format</code>

1706

to mismatch

1707

the type given in the schema.

1708

1726

</tr>

1727

<tr>

1728

<td class="parameter_name">format</td>

1729

<td class="parameter_description">a <a href="../glib/glib-GVariant.html#GVariant">GVariant</a> format string</td>

1729

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a> format string</td>

1730

1731

</tr>

1732

<tr>

1743

<hr>

1744

1745

<a name="g-settings-set"></a><h3>g_settings_set ()</h3>

1746

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

1746

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

1747

g_settings_set (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

1748

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

1749

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *format</code>,

1748

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

1749

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *format</code>,

1750

1751

Sets <code>key</code>

1752

in <code>settings</code>

1753

to <code>value</code>

1754

.

1755

A convenience function that combines <a class="link" href="GSettings.html#g-settings-set-value" title="g_settings_set_value ()"><code class="function">g_settings_set_value()</code></a> with

1756

<a href="../glib/glib-GVariant.html#g-variant-new"><code class="function">g_variant_new()</code></a>.

1756

<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#g-variant-new"><code class="function">g_variant_new()</code></a>.

1757

It is a programmer error to give a <code>key</code>

1758

that isn't contained in the

1759

schema for <code>settings</code>

1760

or for the <a href="../glib/glib-GVariantType.html#GVariantType">GVariantType</a> of <code>format</code>

1760

or for the <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariantType.html#GVariantType">GVariantType</a> of <code>format</code>

1761

to mismatch

1762

the type given in the schema.

1763

1781

</tr>

1782

<tr>

1783

<td class="parameter_name">format</td>

1784

<td class="parameter_description">a <a href="../glib/glib-GVariant.html#GVariant">GVariant</a> format string</td>

1784

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a> format string</td>

1785

1786

</tr>

1787

<tr>

1795

</div>

1796

1797

<a name="id-1.4.19.2.10.26.8"></a><h4>Returns</h4>

1798

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if setting the key succeeded,

1799

<a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable

1798

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

1799

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable

1800

1801

</div>

1802

Since 2.26

1804

<hr>

1805

1806

<a name="g-settings-get-boolean"></a><h3>g_settings_get_boolean ()</h3>

1807

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

1807

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

1808

g_settings_get_boolean (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

1809

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>);</pre>

1809

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

1810

Gets the value that is stored at <code>key</code>

1811

in <code>settings</code>

1812

.

1847

<hr>

1848

1849

<a name="g-settings-set-boolean"></a><h3>g_settings_set_boolean ()</h3>

1850

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

1850

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

1851

g_settings_set_boolean (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

1852

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

1853

<code><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> value</code>);</pre>

1852

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

1853

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

1854

Sets <code>key</code>

1855

in <code>settings</code>

1856

to <code>value</code>

1889

</div>

1890

1891

<a name="id-1.4.19.2.10.28.8"></a><h4>Returns</h4>

1892

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if setting the key succeeded,

1893

<a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable

1892

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

1893

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable

1894

1895

</div>

1896

Since 2.26

1898

<hr>

1899

1900

<a name="g-settings-get-int"></a><h3>g_settings_get_int ()</h3>

1901

1901

1902

g_settings_get_int (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

1903

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>);</pre>

1903

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

1904

Gets the value that is stored at <code>key</code>

1905

in <code>settings</code>

1906

.

1941

<hr>

1942

1943

<a name="g-settings-set-int"></a><h3>g_settings_set_int ()</h3>

1944

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

1944

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

1945

g_settings_set_int (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

1946

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

1947

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> value</code>);</pre>

1946

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

1947

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

1948

Sets <code>key</code>

1949

in <code>settings</code>

1950

to <code>value</code>

1983

</div>

1984

1985

<a name="id-1.4.19.2.10.30.8"></a><h4>Returns</h4>

1986

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if setting the key succeeded,

1987

<a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable

1986

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

1987

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable

1988

1989

</div>

1990

Since 2.26

1992

<hr>

1993

1994

<a name="g-settings-get-uint"></a><h3>g_settings_get_uint ()</h3>

1995

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint">guint</a>

1995

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a>

1996

g_settings_get_uint (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

1997

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>);</pre>

1997

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

1998

Gets the value that is stored at <code>key</code>

1999

in <code>settings</code>

2000

.

2036

<hr>

2037

2038

<a name="g-settings-set-uint"></a><h3>g_settings_set_uint ()</h3>

2039

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

2039

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

2040

g_settings_set_uint (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

2041

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

2042

<code><a href="../glib/glib-Basic-Types.html#guint">guint</a> value</code>);</pre>

2041

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

2042

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

2043

Sets <code>key</code>

2044

in <code>settings</code>

2045

to <code>value</code>

2079

</div>

2080

2081

<a name="id-1.4.19.2.10.32.8"></a><h4>Returns</h4>

2082

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if setting the key succeeded,

2083

<a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable

2082

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

2083

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable

2084

2085

</div>

2086

Since 2.30

2088

<hr>

2089

2090

<a name="g-settings-get-double"></a><h3>g_settings_get_double ()</h3>

2091

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gdouble">gdouble</a>

2091

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble">gdouble</a>

2092

g_settings_get_double (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

2093

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>);</pre>

2093

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

2094

Gets the value that is stored at <code>key</code>

2095

in <code>settings</code>

2096

.

2131

<hr>

2132

2133

<a name="g-settings-set-double"></a><h3>g_settings_set_double ()</h3>

2134

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

2134

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

2135

g_settings_set_double (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

2136

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

2137

<code><a href="../glib/glib-Basic-Types.html#gdouble">gdouble</a> value</code>);</pre>

2136

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

2137

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

2138

Sets <code>key</code>

2139

in <code>settings</code>

2140

to <code>value</code>

2173

</div>

2174

2175

<a name="id-1.4.19.2.10.34.8"></a><h4>Returns</h4>

2176

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if setting the key succeeded,

2177

<a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable

2176

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

2177

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable

2178

2179

</div>

2180

Since 2.26

2182

<hr>

2183

2184

<a name="g-settings-get-string"></a><h3>g_settings_get_string ()</h3>

2185

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *

2185

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *

2186

g_settings_get_string (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

2187

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>);</pre>

2187

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

2188

Gets the value that is stored at <code>key</code>

2189

in <code>settings</code>

2190

.

2225

<hr>

2226

2227

<a name="g-settings-set-string"></a><h3>g_settings_set_string ()</h3>

2228

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

2228

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

2229

g_settings_set_string (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

2230

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

2231

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *value</code>);</pre>

2230

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

2231

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

2232

Sets <code>key</code>

2233

in <code>settings</code>

2234

to <code>value</code>

2267

</div>

2268

2269

<a name="id-1.4.19.2.10.36.8"></a><h4>Returns</h4>

2270

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if setting the key succeeded,

2271

<a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable

2270

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

2271

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable

2272

2273

</div>

2274

Since 2.26

2276

<hr>

2277

2278

<a name="g-settings-get-strv"></a><h3>g_settings_get_strv ()</h3>

2279

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar">gchar</a> **

2279

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> **

2280

g_settings_get_strv (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

2281

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>);</pre>

2281

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

2282

A convenience variant of <a class="link" href="GSettings.html#g-settings-get" title="g_settings_get ()"><code class="function">g_settings_get()</code></a> for string arrays.

2283

It is a programmer error to give a <code>key</code>

2284

that isn't specified as

2309

2310

<a name="id-1.4.19.2.10.37.7"></a><h4>Returns</h4>

2311

a

2312

newly-allocated, <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array of strings, the value that

2312

newly-allocated, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array of strings, the value that

2313

is stored at <code>key</code>

2314

in <code>settings</code>

2315

.

2320

<hr>

2321

2322

<a name="g-settings-set-strv"></a><h3>g_settings_set_strv ()</h3>

2323

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

2323

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

2324

g_settings_set_strv (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

2325

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

2326

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *const *value</code>);</pre>

2325

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

2326

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

2327

Sets <code>key</code>

2328

in <code>settings</code>

2329

to <code>value</code>

2330

.

2331

A convenience variant of <a class="link" href="GSettings.html#g-settings-set" title="g_settings_set ()"><code class="function">g_settings_set()</code></a> for string arrays. If

2332

<code>value</code>

2333

is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then <code>key</code>

2333

is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then <code>key</code>

2334

is set to be the empty array.

2335

It is a programmer error to give a <code>key</code>

2336

that isn't specified as

2357

</tr>

2358

<tr>

2359

<td class="parameter_name">value</td>

2360

<td class="parameter_description"> the value to set it to, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

2360

<td class="parameter_description"> the value to set it to, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

2361

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>][<acronym title="Parameter points to an array of items.">array</acronym> zero-terminated=1]</td>

2362

</tr>

2363

</tbody>

2365

</div>

2366

2367

<a name="id-1.4.19.2.10.38.8"></a><h4>Returns</h4>

2368

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if setting the key succeeded,

2369

<a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable

2368

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

2369

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable

2370

2371

</div>

2372

Since 2.26

2374

<hr>

2375

2376

<a name="g-settings-get-enum"></a><h3>g_settings_get_enum ()</h3>

2377

2377

2378

g_settings_get_enum (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

2379

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>);</pre>

2379

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

2380

Gets the value that is stored in <code>settings</code>

2381

for <code>key</code>

2382

and converts it

2422

<hr>

2423

2424

<a name="g-settings-set-enum"></a><h3>g_settings_set_enum ()</h3>

2425

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

2425

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

2426

g_settings_set_enum (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

2427

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

2428

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> value</code>);</pre>

2427

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

2428

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

2429

Looks up the enumerated type nick for <code>value</code>

2430

and writes it to <code>key</code>

2431

,

2472

</div>

2473

2474

<a name="id-1.4.19.2.10.40.8"></a><h4>Returns</h4>

2475

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, if the set succeeds

2475

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, if the set succeeds

2476

2477

</div>

2478

</div>

2479

<hr>

2480

2481

<a name="g-settings-get-flags"></a><h3>g_settings_get_flags ()</h3>

2482

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint">guint</a>

2482

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a>

2483

g_settings_get_flags (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

2484

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>);</pre>

2484

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

2485

Gets the value that is stored in <code>settings</code>

2486

for <code>key</code>

2487

and converts it

2527

<hr>

2528

2529

<a name="g-settings-set-flags"></a><h3>g_settings_set_flags ()</h3>

2530

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

2530

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

2531

g_settings_set_flags (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

2532

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

2533

<code><a href="../glib/glib-Basic-Types.html#guint">guint</a> value</code>);</pre>

2532

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

2533

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

2534

Looks up the flags type nicks for the bits specified by <code>value</code>

2535

, puts

2536

them in an array of strings and writes the array to <code>key</code>

2578

</div>

2579

2580

<a name="id-1.4.19.2.10.42.8"></a><h4>Returns</h4>

2581

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, if the set succeeds

2581

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, if the set succeeds

2582

2583

</div>

2584

</div>

2585

<hr>

2586

2587

<a name="GSettingsGetMapping"></a><h3>GSettingsGetMapping ()</h3>

2588

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

2589

(*GSettingsGetMapping) (<code><a href="../glib/glib-GVariant.html#GVariant">GVariant</a> *value</code>,

2590

<code><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> *result</code>,

2591

<code><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

2588

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

2589

(*GSettingsGetMapping) (<code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a> *value</code>,

2590

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

2591

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

2592

The type of the function that is used to convert from a value stored

2593

in a <a class="link" href="GSettings.html" title="GSettings">GSettings</a> to a value that is useful to the application.

2594

If the value is successfully mapped, the result should be stored at

2595

<code>result</code>

2596

and <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> returned. If mapping fails (for example, if <code>value</code>

2596

and <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> returned. If mapping fails (for example, if <code>value</code>

2597

2598

is not in the right format) then <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> should be returned.

2598

is not in the right format) then <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> should be returned.

2599

If <code>value</code>

2600

is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then it means that the mapping function is being

2601

given a "last chance" to successfully return a valid value. <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>

2600

is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then it means that the mapping function is being

2601

given a "last chance" to successfully return a valid value. <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>

2602

must be returned in this case.

2603

2604

<a name="id-1.4.19.2.10.43.7"></a><h4>Parameters</h4>

2611

<tbody>

2612

<tr>

2613

<td class="parameter_name">value</td>

2614

<td class="parameter_description">the <a href="../glib/glib-GVariant.html#GVariant">GVariant</a> to map, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></td>

2614

<td class="parameter_description">the <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a> to map, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></td>

2615

2616

</tr>

2617

<tr>

2630

</div>

2631

2632

<a name="id-1.4.19.2.10.43.8"></a><h4>Returns</h4>

2633

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the conversion succeeded, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> in case of an error

2633

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the conversion succeeded, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> in case of an error

2634

2635

</div>

2636

</div>

2637

<hr>

2638

2639

<a name="g-settings-get-mapped"></a><h3>g_settings_get_mapped ()</h3>

2640

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a>

2640

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a>

2641

g_settings_get_mapped (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

2642

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

2642

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

2643

<code><a class="link" href="GSettings.html#GSettingsGetMapping" title="GSettingsGetMapping ()">GSettingsGetMapping</a> mapping</code>,

2644

<code><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

2644

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

2645

Gets the value that is stored at <code>key</code>

2646

in <code>settings</code>

2647

, subject to

2659

tried in an unspecified order (system or site defaults, translated

2660

schema default values, untranslated schema default values, etc).

2661

If the mapping function fails for all possible values, one additional

2662

attempt is made: the mapping function is called with a <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> value.

2662

attempt is made: the mapping function is called with a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> value.

2663

If the mapping function still indicates failure at this point then

2664

the application will be aborted.

2665

The result parameter for the <code>mapping</code>

2666

function is pointed to a

2667

<a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> which is initially set to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. The same pointer is given

2667

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> which is initially set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. The same pointer is given

2668

to each invocation of <code>mapping</code>

2669

. The final value of that <a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> is

2670

what is returned by this function. <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is valid; it is returned

2669

. The final value of that <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> is

2670

what is returned by this function. <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is valid; it is returned

2671

just as any other value would be.

2672

2673

<a name="id-1.4.19.2.10.44.10"></a><h4>Parameters</h4>

2705

</div>

2706

2707

<a name="id-1.4.19.2.10.44.11"></a><h4>Returns</h4>

2708

the result, which may be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

2708

the result, which may be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

2709

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

2710

</div>

2711

</div>

2714

<a name="g-settings-bind"></a><h3>g_settings_bind ()</h3>

2715

<pre class="programlisting">void

2716

g_settings_bind (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

2717

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

2718

<code><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> object</code>,

2719

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *property</code>,

2717

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

2718

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

2719

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *property</code>,

2720

<code><a class="link" href="GSettings.html#GSettingsBindFlags" title="enum GSettingsBindFlags">GSettingsBindFlags</a> flags</code>);</pre>

2721

Create a binding between the <code>key</code>

2722

in the <code>settings</code>

2764

</tr>

2765

<tr>

2766

<td class="parameter_name">object</td>

2767

<td class="parameter_description"> a <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>. </td>

2767

<td class="parameter_description"> a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>. </td>

2768

<td class="parameter_annotations">[<acronym title="Override the parsed C type with given type.">type</acronym> GObject.Object]</td>

2769

</tr>

2770

<tr>

2787

<a name="g-settings-bind-with-mapping"></a><h3>g_settings_bind_with_mapping ()</h3>

2788

<pre class="programlisting">void

2789

g_settings_bind_with_mapping (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

2790

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

2791

<code><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> object</code>,

2792

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *property</code>,

2790

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

2791

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

2792

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *property</code>,

2793

<code><a class="link" href="GSettings.html#GSettingsBindFlags" title="enum GSettingsBindFlags">GSettingsBindFlags</a> flags</code>,

2794

<code><a class="link" href="GSettings.html#GSettingsBindGetMapping" title="GSettingsBindGetMapping ()">GSettingsBindGetMapping</a> get_mapping</code>,

2795

<code><a class="link" href="GSettings.html#GSettingsBindSetMapping" title="GSettingsBindSetMapping ()">GSettingsBindSetMapping</a> set_mapping</code>,

2796

<code><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>,

2797

<code><a href="../glib/glib-Datasets.html#GDestroyNotify">GDestroyNotify</a> destroy</code>);</pre>

2796

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

2797

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify">GDestroyNotify</a> destroy</code>);</pre>

2798

Create a binding between the <code>key</code>

2799

in the <code>settings</code>

2800

object

2828

</tr>

2829

<tr>

2830

<td class="parameter_name">object</td>

2831

<td class="parameter_description"> a <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>. </td>

2831

<td class="parameter_description"> a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>. </td>

2832

<td class="parameter_annotations">[<acronym title="Override the parsed C type with given type.">type</acronym> GObject.Object]</td>

2833

</tr>

2834

<tr>

2846

<td class="parameter_description">a function that gets called to convert values

2847

from <code>settings</code>

2848

to <code>object</code>

2849

, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default GIO mapping</td>

2849

, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default GIO mapping</td>

2850

2851

</tr>

2852

<tr>

2854

<td class="parameter_description">a function that gets called to convert values

2855

from <code>object</code>

2856

to <code>settings</code>

2857

, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default GIO mapping</td>

2857

, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default GIO mapping</td>

2858

2859

</tr>

2860

<tr>

2866

</tr>

2867

<tr>

2868

<td class="parameter_name">destroy</td>

2869

<td class="parameter_description"><a href="../glib/glib-Datasets.html#GDestroyNotify">GDestroyNotify</a> function for <code>user_data</code>

2869

<td class="parameter_description"><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify">GDestroyNotify</a> function for <code>user_data</code>

2870

</td>

2871

2872

</tr>

2880

<a name="g-settings-bind-writable"></a><h3>g_settings_bind_writable ()</h3>

2881

<pre class="programlisting">void

2882

g_settings_bind_writable (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

2883

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

2884

<code><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> object</code>,

2885

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *property</code>,

2886

<code><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> inverted</code>);</pre>

2883

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key</code>,

2884

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

2885

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *property</code>,

2886

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

2887

Create a binding between the writability of <code>key</code>

2888

in the

2889

<code>settings</code>

2896

writability of the setting will be propagated to the object

2897

property, not the other way.

2898

When the <code>inverted</code>

2899

argument is <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the binding inverts the

2899

argument is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the binding inverts the

2900

value as it passes from the setting to the object, i.e. <code>property</code>

2901

2902

will be set to <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the key is not writable.

2902

will be set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the key is not writable.

2903

Note that the lifecycle of the binding is tied to the object,

2904

and that you can have only one binding per object property.

2905

If you bind the same property twice on the same object, the second

2925

</tr>

2926

<tr>

2927

<td class="parameter_name">object</td>

2928

<td class="parameter_description">a <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>. </td>

2928

<td class="parameter_description">a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>. </td>

2929

<td class="parameter_annotations">[<acronym title="Override the parsed C type with given type.">type</acronym> GObject.Object]</td>

2930

</tr>

2931

<tr>

2947

2948

<a name="g-settings-unbind"></a><h3>g_settings_unbind ()</h3>

2949

<pre class="programlisting">void

2950

g_settings_unbind (<code><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> object</code>,

2951

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *property</code>);</pre>

2950

g_settings_unbind (<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> object</code>,

2951

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

2952

Removes an existing binding for <code>property</code>

2953

on <code>object</code>

2954

.

2982

<hr>

2983

2984

<a name="GSettingsBindSetMapping"></a><h3>GSettingsBindSetMapping ()</h3>

2985

<pre class="programlisting"><a href="../glib/glib-GVariant.html#GVariant">GVariant</a> *

2986

(*GSettingsBindSetMapping) (<code>const <a href="../gobject/gobject-Generic-values.html#GValue">GValue</a> *value</code>,

2987

<code>const <a href="../glib/glib-GVariantType.html#GVariantType">GVariantType</a> *expected_type</code>,

2988

<code><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

2985

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a> *

2986

(*GSettingsBindSetMapping) (<code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue">GValue</a> *value</code>,

2987

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariantType.html#GVariantType">GVariantType</a> *expected_type</code>,

2988

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

2989

The type for the function that is used to convert an object property

2990

value to a <a href="../glib/glib-GVariant.html#GVariant">GVariant</a> for storing it in <a class="link" href="GSettings.html" title="GSettings">GSettings</a>.

2990

value to a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a> for storing it in <a class="link" href="GSettings.html" title="GSettings">GSettings</a>.

2991

2992

<a name="id-1.4.19.2.10.49.5"></a><h4>Parameters</h4>

2993

2999

<tbody>

3000

<tr>

3001

<td class="parameter_name">value</td>

3002

<td class="parameter_description">a <a href="../gobject/gobject-Generic-values.html#GValue">GValue</a> containing the property value to map</td>

3002

<td class="parameter_description">a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue">GValue</a> containing the property value to map</td>

3003

3004

</tr>

3005

<tr>

3006

<td class="parameter_name">expected_type</td>

3007

<td class="parameter_description">the <a href="../glib/glib-GVariantType.html#GVariantType">GVariantType</a> to create</td>

3007

<td class="parameter_description">the <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariantType.html#GVariantType">GVariantType</a> to create</td>

3008

3009

</tr>

3010

<tr>

3017

</div>

3018

3019

<a name="id-1.4.19.2.10.49.6"></a><h4>Returns</h4>

3020

a new <a href="../glib/glib-GVariant.html#GVariant">GVariant</a> holding the data from <code>value</code>

3020

a new <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a> holding the data from <code>value</code>

3021

,

3022

or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> in case of an error

3022

or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> in case of an error

3023

3024

</div>

3025

</div>

3026

<hr>

3027

3028

<a name="GSettingsBindGetMapping"></a><h3>GSettingsBindGetMapping ()</h3>

3029

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

3030

(*GSettingsBindGetMapping) (<code><a href="../gobject/gobject-Generic-values.html#GValue">GValue</a> *value</code>,

3031

<code><a href="../glib/glib-GVariant.html#GVariant">GVariant</a> *variant</code>,

3032

<code><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

3029

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

3030

(*GSettingsBindGetMapping) (<code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue">GValue</a> *value</code>,

3031

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a> *variant</code>,

3032

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

3033

The type for the function that is used to convert from <a class="link" href="GSettings.html" title="GSettings">GSettings</a> to

3034

an object property. The <code>value</code>

3035

is already initialized to hold values

3050

</tr>

3051

<tr>

3052

<td class="parameter_name">variant</td>

3053

<td class="parameter_description">the <a href="../glib/glib-GVariant.html#GVariant">GVariant</a></td>

3053

<td class="parameter_description">the <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a></td>

3054

3055

</tr>

3056

<tr>

3063

</div>

3064

3065

<a name="id-1.4.19.2.10.50.6"></a><h4>Returns</h4>

3066

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the conversion succeeded, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> in case of an error

3066

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the conversion succeeded, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> in case of an error

3067

3068

</div>

3069

</div>

3072

<a name="g-settings-create-action"></a><h3>g_settings_create_action ()</h3>

3073

<pre class="programlisting"><a class="link" href="GAction.html" title="GAction">GAction</a> *

3074

g_settings_create_action (<code><a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings</code>,

3075

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key</code>);</pre>

3075

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

3076

Creates a <a class="link" href="GAction.html" title="GAction">GAction</a> corresponding to a given <a class="link" href="GSettings.html" title="GSettings">GSettings</a> key.

3077

The action has the same name as the key.

3078

The value of the key becomes the state of the action and the action

3146

<tr>

3147

<td class="enum_member_name"><a name="G-SETTINGS-BIND-GET:CAPS"></a>G_SETTINGS_BIND_GET</td>

3148

3149

Update the <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> property when the setting changes.

3149

Update the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> property when the setting changes.

3150

It is an error to use this flag if the property is not writable.

3151

</td>

3152

3154

<tr>

3155

<td class="enum_member_name"><a name="G-SETTINGS-BIND-SET:CAPS"></a>G_SETTINGS_BIND_SET</td>

3156

3157

Update the setting when the <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> property changes.

3157

Update the setting when the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> property changes.

3158

It is an error to use this flag if the property is not readable.

3159

</td>

3160

3169

<tr>

3170

<td class="enum_member_name"><a name="G-SETTINGS-BIND-GET-NO-CHANGES:CAPS"></a>G_SETTINGS_BIND_GET_NO_CHANGES</td>

3171

3172

When set in addition to <a class="link" href="GSettings.html#G-SETTINGS-BIND-GET:CAPS">G_SETTINGS_BIND_GET</a>, set the <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> property

3172

When set in addition to <a class="link" href="GSettings.html#G-SETTINGS-BIND-GET:CAPS">G_SETTINGS_BIND_GET</a>, set the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> property

3173

value initially from the setting, but do not listen for changes of the setting

3174

</td>

3175

3199

<hr>

3200

3201

<a name="GSettings--delay-apply"></a><h3>The <code class="literal">“delay-apply”</code> property</h3>

3202

<pre class="programlisting"> “delay-apply” <a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a></pre>

3202

<pre class="programlisting"> “delay-apply” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a></pre>

3203

Whether the <a class="link" href="GSettings.html" title="GSettings">GSettings</a> object is in 'delay-apply' mode. See

3204

<a class="link" href="GSettings.html#g-settings-delay" title="g_settings_delay ()"><code class="function">g_settings_delay()</code></a> for details.

3205

Flags: Read

3209

<hr>

3210

3211

<a name="GSettings--has-unapplied"></a><h3>The <code class="literal">“has-unapplied”</code> property</h3>

3212

<pre class="programlisting"> “has-unapplied” <a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a></pre>

3213

If this property is <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the <a class="link" href="GSettings.html" title="GSettings">GSettings</a> object has outstanding

3212

<pre class="programlisting"> “has-unapplied” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a></pre>

3213

If this property is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the <a class="link" href="GSettings.html" title="GSettings">GSettings</a> object has outstanding

3214

changes that will be applied when <a class="link" href="GSettings.html#g-settings-apply" title="g_settings_apply ()"><code class="function">g_settings_apply()</code></a> is called.

3215

Flags: Read

3216

Default value: FALSE

3218

<hr>

3219

3220

<a name="GSettings--path"></a><h3>The <code class="literal">“path”</code> property</h3>

3221

<pre class="programlisting"> “path” <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *</pre>

3221

<pre class="programlisting"> “path” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *</pre>

3222

The path within the backend where the settings are stored.

3223

Flags: Read / Write / Construct Only

3224

Default value: NULL

3226

<hr>

3227

3228

<a name="GSettings--schema"></a><h3>The <code class="literal">“schema”</code> property</h3>

3229

<pre class="programlisting"> “schema” <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *</pre>

3229

<pre class="programlisting"> “schema” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *</pre>

3230

The name of the schema that describes the types of keys

3231

for this <a class="link" href="GSettings.html" title="GSettings">GSettings</a> object.

3232

The type of this property is *not* <a class="link" href="gio-GSettingsSchema-GSettingsSchemaSource.html#GSettingsSchema">GSettingsSchema</a>.

3246

<hr>

3247

3248

<a name="GSettings--schema-id"></a><h3>The <code class="literal">“schema-id”</code> property</h3>

3249

<pre class="programlisting"> “schema-id” <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *</pre>

3249

<pre class="programlisting"> “schema-id” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *</pre>

3250

The name of the schema that describes the types of keys

3251

for this <a class="link" href="GSettings.html" title="GSettings">GSettings</a> object.

3252

Flags: Read / Write / Construct Only

3269

<a name="GSettings.signal-details"></a><h2>Signal Details</h2>

3270

3271

<a name="GSettings-change-event"></a><h3>The <code class="literal">“change-event”</code> signal</h3>

3272

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

3272

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

3273

user_function (<a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings,

3274

<a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> keys,

3275

<a href="../glib/glib-Basic-Types.html#gint">gint</a> n_keys,

3276

<a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data)</pre>

3274

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

3275

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

3276

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data)</pre>

3277

The "change-event" signal is emitted once per change event that

3278

affects this settings object. You should connect to this signal

3279

only if you are interested in viewing groups of changes before they

3281

For most use cases it is more appropriate to use the "changed" signal.

3282

In the event that the change event applies to one or more specified

3283

keys, <code>keys</code>

3284

will be an array of <a href="../glib/glib-Quarks.html#GQuark">GQuark</a> of length <code>n_keys</code>

3284

will be an array of <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuark</a> of length <code>n_keys</code>

3285

. In the

3286

event that the change event applies to the <a class="link" href="GSettings.html" title="GSettings">GSettings</a> object as a

3287

whole (ie: potentially every key has been changed) then <code>keys</code>

3288

will

3289

be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> and <code>n_keys</code>

3289

be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> and <code>n_keys</code>

3290

will be 0.

3291

The default handler for this signal invokes the "changed" signal

3292

for each affected key. If any other connected handler returns

3293

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> then this default functionality will be suppressed.

3293

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> then this default functionality will be suppressed.

3294

3295

<a name="id-1.4.19.2.13.2.7"></a><h4>Parameters</h4>

3296

3307

</tr>

3308

<tr>

3309

3310

<td class="parameter_description"> an array of <a href="../glib/glib-Quarks.html#GQuark">GQuarks</a> for the changed keys, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

3310

<td class="parameter_description"> an array of <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuarks</a> for the changed keys, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

3311

<td class="parameter_annotations">[<acronym title="Parameter points to an array of items.">array</acronym> length=n_keys][<acronym title="Generics and defining elements of containers and arrays.">element-type</acronym> GQuark][<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

3312

</tr>

3313

<tr>

3326

</div>

3327

3328

<a name="id-1.4.19.2.13.2.8"></a><h4>Returns</h4>

3329

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to stop other handlers from being invoked for the

3329

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to stop other handlers from being invoked for the

3330

event. FALSE to propagate the event further.

3331

3332

</div>

3333

Flags: Run Last

3333

Flags: <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a>

3334

</div>

3335

<hr>

3336

3337

<a name="GSettings-changed"></a><h3>The <code class="literal">“changed”</code> signal</h3>

3338

<pre class="programlisting">void

3339

user_function (<a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings,

3340

<a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key,

3341

<a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data)</pre>

3340

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key,

3341

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data)</pre>

3342

The "changed" signal is emitted when a key has potentially changed.

3343

You should call one of the <a class="link" href="GSettings.html#g-settings-get" title="g_settings_get ()"><code class="function">g_settings_get()</code></a> calls to check the new

3344

value.

3372

</tbody>

3373

</table></div>

3374

</div>

3375

Flags: Has Details

3375

Flags: <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS">Has Details</a>

3376

</div>

3377

<hr>

3378

3379

<a name="GSettings-writable-change-event"></a><h3>The <code class="literal">“writable-change-event”</code> signal</h3>

3380

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

3380

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

3381

user_function (<a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings,

3382

<a href="../glib/glib-Basic-Types.html#guint">guint</a> key,

3383

<a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data)</pre>

3382

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

3383

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data)</pre>

3384

The "writable-change-event" signal is emitted once per writability

3385

change event that affects this settings object. You should connect

3386

to this signal if you are interested in viewing groups of changes

3389

appropriate to use the "writable-changed" signal.

3390

In the event that the writability change applies only to a single

3391

key, <code>key</code>

3392

will be set to the <a href="../glib/glib-Quarks.html#GQuark">GQuark</a> for that key. In the event

3392

will be set to the <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuark</a> for that key. In the event

3393

that the writability change affects the entire settings object,

3394

3395

will be 0.

3397

and "changed" signals for each affected key. This is done because

3398

changes in writability might also imply changes in value (if for

3399

example, a new mandatory setting is introduced). If any other

3400

connected handler returns <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> then this default functionality

3400

connected handler returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> then this default functionality

3401

will be suppressed.

3402

3403

<a name="id-1.4.19.2.13.4.7"></a><h4>Parameters</h4>

3428

</div>

3429

3430

<a name="id-1.4.19.2.13.4.8"></a><h4>Returns</h4>

3431

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to stop other handlers from being invoked for the

3431

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to stop other handlers from being invoked for the

3432

event. FALSE to propagate the event further.

3433

3434

</div>

3435

Flags: Run Last

3435

Flags: <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a>

3436

</div>

3437

<hr>

3438

3439

<a name="GSettings-writable-changed"></a><h3>The <code class="literal">“writable-changed”</code> signal</h3>

3440

<pre class="programlisting">void

3441

user_function (<a class="link" href="GSettings.html" title="GSettings">GSettings</a> *settings,

3442

<a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *key,

3443

<a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data)</pre>

3442

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *key,

3443

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data)</pre>

3444

The "writable-changed" signal is emitted when the writability of a

3445

key has potentially changed. You should call

3446

<a class="link" href="GSettings.html#g-settings-is-writable" title="g_settings_is_writable ()"><code class="function">g_settings_is_writable()</code></a> in order to determine the new status.

3474

</tbody>

3475

</table></div>

3476

</div>

3477

Flags: Has Details

3477

Flags: <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS">Has Details</a>

3478

</div>

3479

</div>

3480

</div>