~ubuntu-branches/ubuntu/vivid/glib2.0/vivid-proposed

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

105

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

106

</tr>

107

<tr>

108

109

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

109

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

110

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

111

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

112

</tr>

113

<tr>

114

115

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

115

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

116

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

117

118

</tr>

131

<tr>

132

133

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

134

134

135

</tr>

136

<tr>

137

138

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

139

139

140

</tr>

141

</tbody>

142

</table></div>

156

</div>

157

158

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

159

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

159

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

160

╰── GSimpleAction

161

</pre>

162

</div>

176

A <a class="link" href="GSimpleAction.html" title="GSimpleAction">GSimpleAction</a> is the obvious simple implementation of the <a class="link" href="GAction.html" title="GAction">GAction</a>

177

interface. This is the easiest way to create an action for purposes of

178

adding it to a <a class="link" href="GSimpleActionGroup.html" title="GSimpleActionGroup">GSimpleActionGroup</a>.

179

See also GtkAction.

179

See also <a href="http://developer.gnome.org/gtk2/GtkAction.html">GtkAction</a>.

180

</div>

181

182

<a name="GSimpleAction.functions_details"></a><h2>Functions</h2>

183

184

<a name="g-simple-action-new"></a><h3>g_simple_action_new ()</h3>

185

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

186

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

187

<code>const <a href="../glib/glib-GVariantType.html#GVariantType">GVariantType</a> *parameter_type</code>);</pre>

186

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

187

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

188

Creates a new action.

189

The created action is stateless. See <a class="link" href="GSimpleAction.html#g-simple-action-new-stateful" title="g_simple_action_new_stateful ()"><code class="function">g_simple_action_new_stateful()</code></a>.

190

220

221

<a name="g-simple-action-new-stateful"></a><h3>g_simple_action_new_stateful ()</h3>

222

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

223

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

224

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

225

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

223

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

224

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

225

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

226

Creates a new stateful action.

227

<code>state</code>

228

is the initial state of the action. All future state values

229

must have the same <a href="../glib/glib-GVariantType.html#GVariantType">GVariantType</a> as the initial state.

229

must have the same <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariantType.html#GVariantType">GVariantType</a> as the initial state.

230

If the <code>state</code>

231

GVariant is floating, it is consumed.

232

268

<a name="g-simple-action-set-enabled"></a><h3>g_simple_action_set_enabled ()</h3>

269

<pre class="programlisting">void

270

g_simple_action_set_enabled (<code><a class="link" href="GSimpleAction.html" title="GSimpleAction">GSimpleAction</a> *simple</code>,

271

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

271

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

272

Sets the action as enabled or not.

273

An action must be enabled in order to be activated or in order to

274

have its state changed from outside callers.

303

<a name="g-simple-action-set-state"></a><h3>g_simple_action_set_state ()</h3>

304

<pre class="programlisting">void

305

g_simple_action_set_state (<code><a class="link" href="GSimpleAction.html" title="GSimpleAction">GSimpleAction</a> *simple</code>,

306

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

306

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

307

Sets the state of the action.

308

This directly updates the 'state' property to the given value.

309

This should only be called by the implementor of the action. Users

328

</tr>

329

<tr>

330

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

331

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

331

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

332

333

</tr>

334

</tbody>

348

<a name="GSimpleAction.property-details"></a><h2>Property Details</h2>

349

350

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

351

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

351

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

352

If <code>action</code>

353

is currently enabled.

354

If the action is disabled then calls to <a class="link" href="GAction.html#g-action-activate" title="g_action_activate ()"><code class="function">g_action_activate()</code></a> and

360

<hr>

361

362

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

363

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

363

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

364

The name of the action. This is mostly meaningful for identifying

365

the action once it has been added to a <a class="link" href="GSimpleActionGroup.html" title="GSimpleActionGroup">GSimpleActionGroup</a>.

366

Flags: Read / Write / Construct Only

370

<hr>

371

372

<a name="GSimpleAction--parameter-type"></a><h3>The <code class="literal">“parameter-type”</code> property</h3>

373

<pre class="programlisting"> “parameter-type” <a href="../glib/glib-GVariantType.html#GVariantType">GVariantType</a> *</pre>

373

<pre class="programlisting"> “parameter-type” <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariantType.html#GVariantType">GVariantType</a> *</pre>

374

The type of the parameter that must be given when activating the

375

action.

376

Flags: Read / Write / Construct Only

379

<hr>

380

381

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

382

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

383

The state of the action, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the action is stateless.

382

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

383

The state of the action, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the action is stateless.

384

Flags: Read / Write / Construct

385

Allowed values: GVariant<*>

386

Default value: NULL

389

<hr>

390

391

<a name="GSimpleAction--state-type"></a><h3>The <code class="literal">“state-type”</code> property</h3>

392

<pre class="programlisting"> “state-type” <a href="../glib/glib-GVariantType.html#GVariantType">GVariantType</a> *</pre>

393

The <a href="../glib/glib-GVariantType.html#GVariantType">GVariantType</a> of the state that the action has, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the

392

<pre class="programlisting"> “state-type” <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariantType.html#GVariantType">GVariantType</a> *</pre>

393

The <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariantType.html#GVariantType">GVariantType</a> of the state that the action has, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the

394

action is stateless.

395

Flags: Read

396

Since 2.28

402

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

403

<pre class="programlisting">void

404

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

405

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

406

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

405

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

406

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

407

Indicates that the action was just activated.

408

<code>parameter</code>

409

will always be of the expected type. In the event that

410

an incorrect type was given, no signal will be emitted.

411

Since GLib 2.40, if no handler is connected to this signal then the

412

default behaviour for boolean-stated actions with a <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> parameter

412

default behaviour for boolean-stated actions with a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> parameter

413

type is to toggle them via the <a class="link" href="GSimpleAction.html#GSimpleAction-change-state" title="The “change-state” signal">“change-state”</a> signal.

414

For stateful actions where the state type is equal to the parameter

415

type, the default is to forward them directly to

442

</tbody>

443

</table></div>

444

</div>

445

Flags: Run Last

445

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

446

Since 2.28

447

</div>

448

<hr>

450

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

451

<pre class="programlisting">void

452

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

453

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

454

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

453

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

454

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

455

Indicates that the action just received a request to change its

456

state.

457

<code>value</code>

487

{

488

gint requested;

489

490

requested = <a href="../glib/glib-GVariant.html#g-variant-get-int32">g_variant_get_int32</a> (value);

490

requested = <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#g-variant-get-int32">g_variant_get_int32</a> (value);

491

492

// Volume only goes from 0 to 10

493

if (0 <= requested && requested <= 10)

528

</tbody>

529

</table></div>

530

</div>

531

Flags: Run Last

531

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

532

Since 2.30

533

</div>

534

</div>

Older »