<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" >
<head><meta content="text/html;charset=&quot;utf-8&quot;" http-equiv="Content-type"/><link href="faldoc.css" rel="stylesheet" type="text/css"/><title> - Class GtkActivatable</title></head><body class="faldoc"><ul class="navi_top"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="gtk.html">Up: The Falcon GTK Binding module</a></li>
<li class="prev"><a href="gtk_GtkAction.html">Previous: Class GtkAction</a></li>
<li class="next"><a href="gtk_GtkAdjustment.html">Next: Class GtkAdjustment</a></li>
<li class="clear"></li>
</ul><div id="page_body"><h1><span class="toc_number">10.25</span>Class GtkActivatable</h1><p class="brief">An interface for activatable widgets </p>
<pre class="prototype">Class GtkActivatable</pre>
<p>GtkActivatable is implemented by GtkTearoffMenuItem, GtkOptionMenu, GtkLinkButton, GtkRadioButton, GtkRadioToolButton, GtkToggleButton, GtkSeparatorMenuItem, GtkImageMenuItem, GtkCheckButton, GtkRadioMenuItem, GtkButton, GtkMenuToolButton, GtkMenuItem, GtkRecentChooserMenu, GtkToolItem, GtkSeparatorToolItem, GtkCheckMenuItem, GtkToolButton, GtkFontButton, GtkScaleButton, GtkToggleToolButton, GtkVolumeButton and GtkColorButton. </p>
<p>Activatable widgets can be connected to a GtkAction and reflects the state of its action. A GtkActivatable can also provide feedback through its action, as they are responsible for activating their related actions. </p>
<table class="members">
<tbody><tr class="member_type"><td class="member_type" colspan="2">Methods</td></tr>
<tr><td><a href="#do_set_related_action">do_set_related_action</a></td><td>This is a utility function for GtkActivatable implementors. </td></tr>
<tr><td><a href="#get_related_action">get_related_action</a></td><td>Gets the related GtkAction for activatable. </td></tr>
<tr><td><a href="#get_use_action_appearance">get_use_action_appearance</a></td><td>Gets whether this activatable should reset its layout and appearance when setting the related action or when the action changes appearance. </td></tr>
<tr><td><a href="#set_related_action">set_related_action</a></td><td>Sets the related action on the activatable object. </td></tr>
<tr><td><a href="#set_use_action_appearance">set_use_action_appearance</a></td><td>Sets whether this activatable should reset its layout and appearance when setting the related action or when the action changes appearance </td></tr>
<tr><td><a href="#sync_action_properties">sync_action_properties</a></td><td>This is called to update the activatable completely, this is called internally when the "related-action" property is set or unset and by the implementing class when "use-action-appearance" changes. </td></tr>
</tbody>
</table>
<h2>Methods</h2><h3><a name="do_set_related_action">do_set_related_action</a></h3><p class="brief">This is a utility function for GtkActivatable implementors. </p>
<pre class="prototype">GtkActivatable.do_set_related_action( action )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">action</td><td class="content"> the GtkAction to set </td></tr>
</tbody>
</table>
<p>When implementing GtkActivatable you must call this when handling changes of the "related-action", and you must also use this to break references in GObject->dispose(). </p>
<p>This function adds a reference to the currently set related action for you, it also makes sure the GtkActivatable->update() method is called when the related GtkAction properties change and registers to the action's proxy list. </p>
<p>Note: Be careful to call this before setting the local copy of the GtkAction property, since this function uses gtk_activatable_get_action() to retrieve the previous action. </p>
<h3><a name="get_related_action">get_related_action</a></h3><p class="brief">Gets the related GtkAction for activatable. </p>
<pre class="prototype">GtkActivatable.get_related_action()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">the related GtkAction if one is set. </td></tr>
</tbody>
</table>
<h3><a name="get_use_action_appearance">get_use_action_appearance</a></h3><p class="brief">Gets whether this activatable should reset its layout and appearance when setting the related action or when the action changes appearance. </p>
<pre class="prototype">GtkActivatable.get_use_action_appearance()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">whether activatable uses its actions appearance. </td></tr>
</tbody>
</table>
<h3><a name="set_related_action">set_related_action</a></h3><p class="brief">Sets the related action on the activatable object. </p>
<pre class="prototype">GtkActivatable.set_related_action( action )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">action</td><td class="content"> the GtkAction to set </td></tr>
</tbody>
</table>
<h3><a name="set_use_action_appearance">set_use_action_appearance</a></h3><p class="brief">Sets whether this activatable should reset its layout and appearance when setting the related action or when the action changes appearance </p>
<pre class="prototype">GtkActivatable.set_use_action_appearance( use_appearance )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">use_appearance</td><td class="content"> whether to use the actions appearance </td></tr>
</tbody>
</table>
<h3><a name="sync_action_properties">sync_action_properties</a></h3><p class="brief">This is called to update the activatable completely, this is called internally when the "related-action" property is set or unset and by the implementing class when "use-action-appearance" changes. </p>
<pre class="prototype">GtkActivatable.sync_action_properties( action )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">action</td><td class="content"> the related GtkAction or NULL. </td></tr>
</tbody>
</table>
</div><ul class="navi_bottom"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="gtk.html">Up: The Falcon GTK Binding module</a></li>
<li class="prev"><a href="gtk_GtkAction.html">Previous: Class GtkAction</a></li>
<li class="next"><a href="gtk_GtkAdjustment.html">Next: Class GtkAdjustment</a></li>
<li class="clear"></li>
</ul><div class="signature">Made with <a href="faldoc 3.0">http://www.falconpl.org</a></div></body></html>
