callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
07c3f6bee3d1029e9f8eec498a68cbf098e66843
gimp/devel-docs/libgimpwidgets/html/GimpCellRendererToggle.html
Jeremy Bicha 566351d422 New upstream version 2.10.0~RC2
2018-04-19 11:58:35 -04:00

269 lines
15 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GimpCellRendererToggle: GIMP Widgets Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GIMP Widgets Library Reference Manual">
<link rel="up" href="libgimpwidgets-cell-renderers.html" title="Part II. Cell Renderers for GtkTreeView">
<link rel="prev" href="GimpCellRendererColor.html" title="GimpCellRendererColor">
<link rel="next" href="libgimpwidgets-colordisplay.html" title="Part III. GIMP Display Filters">
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
<a href="#GimpCellRendererToggle.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
<a href="#GimpCellRendererToggle.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
<a href="#GimpCellRendererToggle.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
<a href="#GimpCellRendererToggle.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimpwidgets-cell-renderers.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GimpCellRendererColor.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgimpwidgets-colordisplay.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GimpCellRendererToggle"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GimpCellRendererToggle.top_of_page"></a>GimpCellRendererToggle</span></h2>
<p>GimpCellRendererToggle — A <a href="../gtk2/GtkCellRendererToggle.html#GtkCellRendererToggle-struct"><span class="type">GtkCellRendererToggle</span></a> that displays icons instead
of a checkbox.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GimpCellRendererToggle.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="../gtk2/GtkCellRenderer.html#GtkCellRenderer-struct"><span class="returnvalue">GtkCellRenderer</span></a> *
</td>
<td class="function_name">
<a class="link" href="GimpCellRendererToggle.html#gimp-cell-renderer-toggle-new" title="gimp_cell_renderer_toggle_new ()">gimp_cell_renderer_toggle_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GimpCellRendererToggle.html#gimp-cell-renderer-toggle-clicked" title="gimp_cell_renderer_toggle_clicked ()">gimp_cell_renderer_toggle_clicked</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpCellRendererToggle.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GimpCellRendererToggle.html#GimpCellRendererToggle--icon-name" title="The “icon-name” property">icon-name</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GimpCellRendererToggle.html#GimpCellRendererToggle--override-background" title="The “override-background” property">override-background</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GimpCellRendererToggle.html#GimpCellRendererToggle--stock-id" title="The “stock-id” property">stock-id</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="GimpCellRendererToggle.html#GimpCellRendererToggle--stock-size" title="The “stock-size” property">stock-size</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpCellRendererToggle.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GimpCellRendererToggle.html#GimpCellRendererToggle-clicked" title="The “clicked” signal">clicked</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpCellRendererToggle.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GimpCellRendererToggle.html#GimpCellRendererToggle-struct" title="GimpCellRendererToggle">GimpCellRendererToggle</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpCellRendererToggle.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<span class="lineart">╰──</span> <a href="../gtk2/GtkObject.html#GtkObject-struct">GtkObject</a>
<span class="lineart">╰──</span> <a href="../gtk2/GtkCellRenderer.html#GtkCellRenderer-struct">GtkCellRenderer</a>
<span class="lineart">╰──</span> <a href="../gtk2/GtkCellRendererToggle.html#GtkCellRendererToggle-struct">GtkCellRendererToggle</a>
<span class="lineart">╰──</span> GimpCellRendererToggle
</pre>
</div>
<div class="refsect1">
<a name="GimpCellRendererToggle.description"></a><h2>Description</h2>
<p>A <a href="../gtk2/GtkCellRendererToggle.html#GtkCellRendererToggle-struct"><span class="type">GtkCellRendererToggle</span></a> that displays icons instead of a checkbox.</p>
</div>
<div class="refsect1">
<a name="GimpCellRendererToggle.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-cell-renderer-toggle-new"></a><h3>gimp_cell_renderer_toggle_new ()</h3>
<pre class="programlisting"><a href="../gtk2/GtkCellRenderer.html#GtkCellRenderer-struct"><span class="returnvalue">GtkCellRenderer</span></a> *
gimp_cell_renderer_toggle_new (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>);</pre>
<p>Creates a custom version of the <a href="../gtk2/GtkCellRendererToggle.html#GtkCellRendererToggle-struct"><span class="type">GtkCellRendererToggle</span></a>. Instead of
showing the standard toggle button, it shows a named icon if the
cell is active and no icon otherwise. This cell renderer is for
example used in the Layers treeview to indicate and control the
layer's visibility by showing <a class="link" href="libgimpwidgets-GimpIcons.html#GIMP-STOCK-VISIBLE:CAPS" title="GIMP_STOCK_VISIBLE"><code class="literal">GIMP_STOCK_VISIBLE</code></a>.</p>
<div class="refsect3">
<a name="gimp-cell-renderer-toggle-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>icon_name</p></td>
<td class="parameter_description"><p>the icon name of the icon to use for the active state</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-cell-renderer-toggle-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GimpCellRendererToggle.html" title="GimpCellRendererToggle"><span class="type">GimpCellRendererToggle</span></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-cell-renderer-toggle-clicked"></a><h3>gimp_cell_renderer_toggle_clicked ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_cell_renderer_toggle_clicked (<em class="parameter"><code><a class="link" href="GimpCellRendererToggle.html" title="GimpCellRendererToggle"><span class="type">GimpCellRendererToggle</span></a> *cell</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
<em class="parameter"><code><a href="../gdk2/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> state</code></em>);</pre>
<p>Emits the "clicked" signal from a <a class="link" href="GimpCellRendererToggle.html" title="GimpCellRendererToggle"><span class="type">GimpCellRendererToggle</span></a>.</p>
<div class="refsect3">
<a name="gimp-cell-renderer-toggle-clicked.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cell</p></td>
<td class="parameter_description"><p>a <a class="link" href="GimpCellRendererToggle.html" title="GimpCellRendererToggle"><span class="type">GimpCellRendererToggle</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>the path to the clicked row</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>state</p></td>
<td class="parameter_description"><p>the modifier state</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
</div>
<div class="refsect1">
<a name="GimpCellRendererToggle.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GimpCellRendererToggle-struct"></a><h3>GimpCellRendererToggle</h3>
<pre class="programlisting">typedef struct _GimpCellRendererToggle GimpCellRendererToggle;</pre>
</div>
</div>
<div class="refsect1">
<a name="GimpCellRendererToggle.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GimpCellRendererToggle--icon-name"></a><h3>The <code class="literal">“icon-name”</code> property</h3>
<pre class="programlisting"> “icon-name” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The icon to display.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GimpCellRendererToggle--override-background"></a><h3>The <code class="literal">“override-background”</code> property</h3>
<pre class="programlisting"> “override-background” <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Draw the background if the row is selected.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GimpCellRendererToggle--stock-id"></a><h3>The <code class="literal">“stock-id”</code> property</h3>
<pre class="programlisting"> “stock-id” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The icon to display, deprecated.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GimpCellRendererToggle--stock-size"></a><h3>The <code class="literal">“stock-size”</code> property</h3>
<pre class="programlisting"> “stock-size” <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The icon size to use.</p>
<p>Flags: Read / Write / Construct</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 4</p>
</div>
</div>
<div class="refsect1">
<a name="GimpCellRendererToggle.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GimpCellRendererToggle-clicked"></a><h3>The <code class="literal">“clicked”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GimpCellRendererToggle.html" title="GimpCellRendererToggle"><span class="type">GimpCellRendererToggle</span></a> *gimpcellrenderertoggle,
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *arg1,
<a href="../gdk2/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> arg2,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink