Files
gimp/devel-docs/libgimpwidgets/html/GimpButton.html
2010-08-11 01:23:35 -04:00

236 lines
9.8 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GimpButton</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual">
<link rel="up" href="libgimpwidgets-widgets.html" title="Part&#160;I.&#160;GIMP Widgets">
<link rel="prev" href="GimpBrowser.html" title="GimpBrowser">
<link rel="next" href="GimpChainButton.html" title="GimpChainButton">
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpwidgets-widgets.html" title="Part&#160;I.&#160;GIMP Widgets">
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
<link rel="chapter" href="libgimpwidgets-gallery.html" title="Widget Gallery">
<link rel="chapter" href="libgimpwidgets-cell-renderers.html" title="Cell Renderers for GtkTreeView">
<link rel="part" href="libgimpwidgets-colordisplay.html" title="Part&#160;II.&#160;GIMP Display Filters">
<link rel="part" href="libgimpwidgets-colorselector.html" title="Part&#160;III.&#160;GIMP Color Selectors">
<link rel="part" href="libgimpwidgets-controller.html" title="Part&#160;IV.&#160;GIMP Controllers">
<link rel="part" href="libgimpwidgets-utils.html" title="Part&#160;V.&#160;GIMP Widgets Utilities">
<link rel="part" href="libgimpwidgets-deprecated.html" title="Part&#160;VI.&#160;Deprecated API">
<link rel="index" href="libgimpwidgets-index.html" title="Index">
<link rel="index" href="libgimpwidgets-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="libgimpwidgets-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="libgimpwidgets-index-deprecated.html" title="Index of deprecated symbols">
</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="2">
<tr valign="middle">
<td><a accesskey="p" href="GimpBrowser.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpwidgets-widgets.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Widgets Library Reference Manual</th>
<td><a accesskey="n" href="GimpChainButton.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2584526" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2613821" class="shortcut">Description</a>
&#160;|&#160;
<a href="#id2574962" class="shortcut">Object Hierarchy</a>
&#160;|&#160;
<a href="#id2575030" class="shortcut">Implemented Interfaces</a>
&#160;|&#160;
<a href="#id2575058" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GimpButton"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2584526"></a><span class="refentrytitle">GimpButton</span>
</h2>
<p>GimpButton &#8212; A <a
href="../gtk/GtkButton.html"
><span class="type">GtkButton</span></a> with a little extra functionality.</p>
</td>
<td valign="top" align="right"><img src="gimp-button.png"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="GimpButton.html#GimpButton-struct">GimpButton</a>;
<a
href="../gtk/GtkWidget.html"
>GtkWidget</a>* <a class="link" href="GimpButton.html#gimp-button-new">gimp_button_new</a> (void);
void <a class="link" href="GimpButton.html#gimp-button-extended-clicked">gimp_button_extended_clicked</a> (<a class="link" href="GimpButton.html" title="GimpButton">GimpButton</a> *button,
<a
href="../gdk/gdk-Windows.html#GdkModifierType"
>GdkModifierType</a> state);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2574962"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a
href="../gtk/GtkObject.html"
>GtkObject</a>
+----<a
href="../gtk/GtkWidget.html"
>GtkWidget</a>
+----<a
href="../gtk/GtkContainer.html"
>GtkContainer</a>
+----<a
href="../gtk/GtkBin.html"
>GtkBin</a>
+----<a
href="../gtk/GtkButton.html"
>GtkButton</a>
+----GimpButton
+----<a class="link" href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2575030"></a><h2>Implemented Interfaces</h2>
<p>
GimpButton implements
AtkImplementorIface and GtkBuildable.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2575058"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GimpButton.html#GimpButton-extended-clicked">extended-clicked</a>" : Run First
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2613821"></a><h2>Description</h2>
<p>
<a class="link" href="GimpButton.html" title="GimpButton"><span class="type">GimpButton</span></a> adds an extra signal to the <a
href="../gtk/GtkButton.html"
><span class="type">GtkButton</span></a> widget that allows
to distinguish a normal click from a click that was performed with
modifier keys pressed.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2613853"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2613863"></a><h3>
<a name="GimpButton-struct"></a>GimpButton</h3>
<a class="indexterm" name="id2613876"></a><pre class="programlisting">typedef struct _GimpButton GimpButton;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2613891"></a><h3>
<a name="gimp-button-new"></a>gimp_button_new ()</h3>
<a class="indexterm" name="id2613903"></a><pre class="programlisting"><a
href="../gtk/GtkWidget.html"
>GtkWidget</a>* gimp_button_new (void);</pre>
<p>
Creates a new <a class="link" href="GimpButton.html" title="GimpButton"><span class="type">GimpButton</span></a> widget.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> A pointer to the new <a class="link" href="GimpButton.html" title="GimpButton"><span class="type">GimpButton</span></a> widget.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2613958"></a><h3>
<a name="gimp-button-extended-clicked"></a>gimp_button_extended_clicked ()</h3>
<a class="indexterm" name="id2613969"></a><pre class="programlisting">void gimp_button_extended_clicked (<a class="link" href="GimpButton.html" title="GimpButton">GimpButton</a> *button,
<a
href="../gdk/gdk-Windows.html#GdkModifierType"
>GdkModifierType</a> state);</pre>
<p>
Emits the button's "extended_clicked" signal.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>button</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GimpButton.html" title="GimpButton"><span class="type">GimpButton</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>state</code></em>&#160;:</span></p></td>
<td> a state as found in <span class="type">GdkEventButton-</span>&gt;state, e.g. <a
href="../gdk/gdk-Windows.html#GDK-SHIFT-MASK:CAPS"
><span class="type">GDK_SHIFT_MASK</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2592595"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2592606"></a><h3>
<a name="GimpButton-extended-clicked"></a>The <code class="literal">"extended-clicked"</code> signal</h3>
<a class="indexterm" name="id2592620"></a><pre class="programlisting">void user_function (<a class="link" href="GimpButton.html" title="GimpButton">GimpButton</a> *gimpbutton,
<a
href="../gdk/gdk-Windows.html#GdkModifierType"
>GdkModifierType</a> arg1,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run First</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gimpbutton</code></em>&#160;:</span></p></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg1</code></em>&#160;:</span></p></td>
<td>the state of modifier keys when the button was clicked
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2592712"></a><div class="refsect2" lang="en"><a name="id2592713"></a></div>
<hr>
<div class="refsect2" lang="en"><a name="id2592714"></a></div>
</div>
</div>
</body>
</html>