Sophie

Sophie

distrib > Mandriva > 2010.1 > x86_64 > media > main-release > by-pkgid > 22e237efd6851989a23adf3360bb53d0 > files > 261

gtkmm2.4-doc-2.20.3-1mdv2010.1.x86_64.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>gtkmm: Gtk::ColorButton Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceGtk.html">Gtk</a>::<a class="el" href="classGtk_1_1ColorButton.html">ColorButton</a>
  </div>
</div>
<div class="contents">
<h1>Gtk::ColorButton Class Reference<br/>
<small>
[<a class="el" href="group__Widgets.html">Widgets</a>]</small>
</h1><!-- doxytag: class="Gtk::ColorButton" --><!-- doxytag: inherits="Gtk::Button" -->
<p>A button to launch a color selection dialog. <a href="#_details">More...</a></p>

<p>Inherits <a class="el" href="classGtk_1_1Button.html">Gtk::Button</a>.</p>
<div class="dynheader">
Collaboration diagram for Gtk::ColorButton:</div>
<div class="dynsection">
<div class="center"><img src="classGtk_1_1ColorButton__coll__graph.png" border="0" usemap="#Gtk_1_1ColorButton_coll__map" alt="Collaboration graph"/></div>
<map name="Gtk_1_1ColorButton_coll__map" id="Gtk_1_1ColorButton_coll__map">
<area shape="rect" href="classGtk_1_1Button.html" title="A widget that creates a signal when clicked on." alt="" coords="69,547,157,576"/><area shape="rect" href="classGtk_1_1Bin.html" title="A container with just one child." alt="" coords="79,469,148,499"/><area shape="rect" href="classGtk_1_1Container.html" title="Abstract container class." alt="" coords="61,392,165,421"/><area shape="rect" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)." alt="" coords="68,315,159,344"/><area shape="rect" href="classGtk_1_1Object.html" title="Gtk::Object is the base class for all widgets, and for a few non&#45;widget objects such..." alt="" coords="5,237,93,267"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="5,160,96,189"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="51,83,171,112"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="123,160,227,189"/><area shape="rect" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="57,5,164,35"/><area shape="rect" href="classAtk_1_1Implementor.html" title="Atk::Implementor" alt="" coords="117,237,237,267"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classGtk_1_1ColorButton-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#a14625cde4af3f272591dae2f9298eedd">~ColorButton</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GtkColorButton*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#a1faf17015e5af54cfaa60c263e3b487e">gobj</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#a1faf17015e5af54cfaa60c263e3b487e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GtkColorButton*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#ae852b3e46116fdf4e87e1660ca8bf84e">gobj</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#ae852b3e46116fdf4e87e1660ca8bf84e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#ac12239750b35f3cd2594563d479eda6f">ColorButton</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new color button. <a href="#ac12239750b35f3cd2594563d479eda6f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#a76b6f88db3cdab453e0782a33fc9e94e">ColorButton</a> (const <a class="el" href="classGdk_1_1Color.html">Gdk::Color</a>&amp; color)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new color button with a predefined color. <a href="#a76b6f88db3cdab453e0782a33fc9e94e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#abdebef43488848096b3beb48437a253b">set_color</a> (const <a class="el" href="classGdk_1_1Color.html">Gdk::Color</a>&amp; color)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the current color to be <em>color</em>. <a href="#abdebef43488848096b3beb48437a253b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#aed363cb1e704dd6b364b03b55e6f49c7">set_alpha</a> (guint16 alpha)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the current opacity to be <em>alpha</em>. <a href="#aed363cb1e704dd6b364b03b55e6f49c7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGdk_1_1Color.html">Gdk::Color</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#a99998d8ff0bcaecf7839328eadba1c06">get_color</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a copy of the the current color. <a href="#a99998d8ff0bcaecf7839328eadba1c06"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">guint16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#ada6bbec9fc824c14b62021222f79ce31">get_alpha</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current alpha value. <a href="#ada6bbec9fc824c14b62021222f79ce31"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#a817d20b6c2ca8ab10ec06177eebedebb">set_use_alpha</a> (bool use_alpha=true)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets whether or not the color button should use the alpha channel. <a href="#a817d20b6c2ca8ab10ec06177eebedebb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#a774b389f2284706cee98cacb597acfba">get_use_alpha</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Does the color selection dialog use the alpha channel? <a href="#a774b389f2284706cee98cacb597acfba"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#a6fb0f55e86936a07c6c062113b0e323d">set_title</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>&amp; title)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the title for the color selection dialog. <a href="#a6fb0f55e86936a07c6c062113b0e323d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#a0d6c56c9dd9210ac8f40ebb6ff5b3fa4">get_title</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the title of the color selection dialog. <a href="#a0d6c56c9dd9210ac8f40ebb6ff5b3fa4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#a14af4e100c68b27c563983a6552f42cd">property_use_alpha</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether or not to give the color an alpha value. <a href="#a14af4e100c68b27c563983a6552f42cd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#a071a40e8bd6d505ce741f2da0e99107d">property_use_alpha</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether or not to give the color an alpha value. <a href="#a071a40e8bd6d505ce741f2da0e99107d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><br class="typebreak"/>
&lt; <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#ad6b9606b7da58f64a5d42ed7757f3a30">property_title</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The title of the color selection dialog. <a href="#ad6b9606b7da58f64a5d42ed7757f3a30"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
&lt; <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#a9a5e85d638857b9b583873066e139983">property_title</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The title of the color selection dialog. <a href="#a9a5e85d638857b9b583873066e139983"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>&lt; <a class="el" href="classGdk_1_1Color.html">Gdk::Color</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#af3cb699ee266f6d423d963254945a708">property_color</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The selected color. <a href="#af3cb699ee266f6d423d963254945a708"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
&lt; <a class="el" href="classGdk_1_1Color.html">Gdk::Color</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#a1408096a78c6e50e490f3bca673b96dc">property_color</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The selected color. <a href="#a1408096a78c6e50e490f3bca673b96dc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>&lt; guint16 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#a4eaec016cd21ded946036129bac42515">property_alpha</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The selected opacity value (0 fully transparent, 65535 fully opaque). <a href="#a4eaec016cd21ded946036129bac42515"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
&lt; guint16 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#add368c191d4e6980632c3adb907ee98c">property_alpha</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The selected opacity value (0 fully transparent, 65535 fully opaque). <a href="#add368c191d4e6980632c3adb907ee98c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>&lt; void &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#aba946d3c0d7cb90ff05617409c55216f">signal_color_set</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The color_set signal is emitted when the user selects a color. <a href="#aba946d3c0d7cb90ff05617409c55216f"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#af189df069ef862bc355f52b94732973d">on_color_set</a> ()</td></tr>
<tr><td colspan="2"><h2>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1ColorButton.html">Gtk::ColorButton</a>*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1ColorButton.html#a14285f6a8086a0fe5296df841f34e5ea">wrap</a> (GtkColorButton* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a14285f6a8086a0fe5296df841f34e5ea"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A button to launch a color selection dialog. </p>
<p>The GtkColorButton is a button which displays the currently selected color an allows to open a color selection dialog to change the color. It is suitable widget for selecting a color in a preference dialog.</p>
<p>The <a class="el" href="classGtk_1_1ColorButton.html" title="A button to launch a color selection dialog.">ColorButton</a> widget looks like this: </p>
<div align="center">
<img src="colorbutton1.png" alt="colorbutton1.png"/>
</div>
 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a14625cde4af3f272591dae2f9298eedd"></a><!-- doxytag: member="Gtk::ColorButton::~ColorButton" ref="a14625cde4af3f272591dae2f9298eedd" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual Gtk::ColorButton::~ColorButton </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="ac12239750b35f3cd2594563d479eda6f"></a><!-- doxytag: member="Gtk::ColorButton::ColorButton" ref="ac12239750b35f3cd2594563d479eda6f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Gtk::ColorButton::ColorButton </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Creates a new color button. </p>
<p>This creates a widget in the form of a small button containing a swatch representing the current selected color. When the button is clicked, a color-selection dialog will open, allowing the user to select a color. The swatch will be updated to reflect the new color when the user finishes.</p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000063">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>

</div>
</div>
<a class="anchor" id="a76b6f88db3cdab453e0782a33fc9e94e"></a><!-- doxytag: member="Gtk::ColorButton::ColorButton" ref="a76b6f88db3cdab453e0782a33fc9e94e" args="(const Gdk::Color &amp;color)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Gtk::ColorButton::ColorButton </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classGdk_1_1Color.html">Gdk::Color</a>&amp;&#160;</td>
          <td class="paramname"> <em>color</em></td>
          <td>&#160;)&#160;</td>
          <td><code> [explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Creates a new color button with a predefined color. </p>
<p>Same as <a class="el" href="classGtk_1_1ColorButton.html#ac12239750b35f3cd2594563d479eda6f" title="Creates a new color button.">Gtk::ColorButton::ColorButton()</a>. Additionally takes a <a class="el" href="classGdk_1_1Color.html" title="Gdk::Color is used to describe an allocated or unallocated color.">Gdk::Color</a> and initializes the button with this color. Equivalent to calling set_color(<em>color</em>) after the default constructor.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>color</em>&#160;</td><td>A <a class="el" href="classGdk_1_1Color.html" title="Gdk::Color is used to describe an allocated or unallocated color.">Gdk::Color</a> to set the current color with.</td></tr>
  </table>
  </dd>
</dl>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000064">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ada6bbec9fc824c14b62021222f79ce31"></a><!-- doxytag: member="Gtk::ColorButton::get_alpha" ref="ada6bbec9fc824c14b62021222f79ce31" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">guint16 Gtk::ColorButton::get_alpha </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the current alpha value. </p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000068">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>An integer between 0 and 65535. </dd></dl>

</div>
</div>
<a class="anchor" id="a99998d8ff0bcaecf7839328eadba1c06"></a><!-- doxytag: member="Gtk::ColorButton::get_color" ref="a99998d8ff0bcaecf7839328eadba1c06" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classGdk_1_1Color.html">Gdk::Color</a> Gtk::ColorButton::get_color </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns a copy of the the current color. </p>
<p>Changes to the return value will have no effect on the <a class="el" href="classGtk_1_1ColorButton.html" title="A button to launch a color selection dialog.">Gtk::ColorButton</a>.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classGdk_1_1Color.html" title="Gdk::Color is used to describe an allocated or unallocated color.">Gdk::Color</a> representing the current internal color of the <a class="el" href="classGtk_1_1ColorButton.html" title="A button to launch a color selection dialog.">Gtk::ColorButton</a>.</dd></dl>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000067">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>

</div>
</div>
<a class="anchor" id="a0d6c56c9dd9210ac8f40ebb6ff5b3fa4"></a><!-- doxytag: member="Gtk::ColorButton::get_title" ref="a0d6c56c9dd9210ac8f40ebb6ff5b3fa4" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Gtk::ColorButton::get_title </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Gets the title of the color selection dialog. </p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000072">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The title. </dd></dl>

</div>
</div>
<a class="anchor" id="a774b389f2284706cee98cacb597acfba"></a><!-- doxytag: member="Gtk::ColorButton::get_use_alpha" ref="a774b389f2284706cee98cacb597acfba" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Gtk::ColorButton::get_use_alpha </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Does the color selection dialog use the alpha channel? </p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000070">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the color sample uses alpha channel, <code>false</code> if not. </dd></dl>

</div>
</div>
<a class="anchor" id="ae852b3e46116fdf4e87e1660ca8bf84e"></a><!-- doxytag: member="Gtk::ColorButton::gobj" ref="ae852b3e46116fdf4e87e1660ca8bf84e" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const GtkColorButton* Gtk::ColorButton::gobj </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Provides access to the underlying C GtkObject. </p>

<p>Reimplemented from <a class="el" href="classGtk_1_1Button.html#a9ea06156c54545902608286d1a0d0e42">Gtk::Button</a>.</p>

</div>
</div>
<a class="anchor" id="a1faf17015e5af54cfaa60c263e3b487e"></a><!-- doxytag: member="Gtk::ColorButton::gobj" ref="a1faf17015e5af54cfaa60c263e3b487e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GtkColorButton* Gtk::ColorButton::gobj </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Provides access to the underlying C GtkObject. </p>

<p>Reimplemented from <a class="el" href="classGtk_1_1Button.html#aac9db3896fa8b7576c6f3720846faa1c">Gtk::Button</a>.</p>

</div>
</div>
<a class="anchor" id="af189df069ef862bc355f52b94732973d"></a><!-- doxytag: member="Gtk::ColorButton::on_color_set" ref="af189df069ef862bc355f52b94732973d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void Gtk::ColorButton::on_color_set </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="add368c191d4e6980632c3adb907ee98c"></a><!-- doxytag: member="Gtk::ColorButton::property_alpha" ref="add368c191d4e6980632c3adb907ee98c" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a>&lt;guint16&gt; Gtk::ColorButton::property_alpha </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The selected opacity value (0 fully transparent, 65535 fully opaque). </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>

</div>
</div>
<a class="anchor" id="a4eaec016cd21ded946036129bac42515"></a><!-- doxytag: member="Gtk::ColorButton::property_alpha" ref="a4eaec016cd21ded946036129bac42515" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>&lt;guint16&gt; Gtk::ColorButton::property_alpha </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The selected opacity value (0 fully transparent, 65535 fully opaque). </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>

</div>
</div>
<a class="anchor" id="a1408096a78c6e50e490f3bca673b96dc"></a><!-- doxytag: member="Gtk::ColorButton::property_color" ref="a1408096a78c6e50e490f3bca673b96dc" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a>&lt;<a class="el" href="classGdk_1_1Color.html">Gdk::Color</a>&gt; Gtk::ColorButton::property_color </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The selected color. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>

</div>
</div>
<a class="anchor" id="af3cb699ee266f6d423d963254945a708"></a><!-- doxytag: member="Gtk::ColorButton::property_color" ref="af3cb699ee266f6d423d963254945a708" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>&lt;<a class="el" href="classGdk_1_1Color.html">Gdk::Color</a>&gt; Gtk::ColorButton::property_color </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The selected color. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>

</div>
</div>
<a class="anchor" id="a9a5e85d638857b9b583873066e139983"></a><!-- doxytag: member="Gtk::ColorButton::property_title" ref="a9a5e85d638857b9b583873066e139983" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a>&lt;<a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>&gt; Gtk::ColorButton::property_title </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The title of the color selection dialog. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>

</div>
</div>
<a class="anchor" id="ad6b9606b7da58f64a5d42ed7757f3a30"></a><!-- doxytag: member="Gtk::ColorButton::property_title" ref="ad6b9606b7da58f64a5d42ed7757f3a30" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>&lt;<a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>&gt; Gtk::ColorButton::property_title </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The title of the color selection dialog. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>

</div>
</div>
<a class="anchor" id="a071a40e8bd6d505ce741f2da0e99107d"></a><!-- doxytag: member="Gtk::ColorButton::property_use_alpha" ref="a071a40e8bd6d505ce741f2da0e99107d" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a>&lt;bool&gt; Gtk::ColorButton::property_use_alpha </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Whether or not to give the color an alpha value. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>

</div>
</div>
<a class="anchor" id="a14af4e100c68b27c563983a6552f42cd"></a><!-- doxytag: member="Gtk::ColorButton::property_use_alpha" ref="a14af4e100c68b27c563983a6552f42cd" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>&lt;bool&gt; Gtk::ColorButton::property_use_alpha </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Whether or not to give the color an alpha value. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>

</div>
</div>
<a class="anchor" id="aed363cb1e704dd6b364b03b55e6f49c7"></a><!-- doxytag: member="Gtk::ColorButton::set_alpha" ref="aed363cb1e704dd6b364b03b55e6f49c7" args="(guint16 alpha)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Gtk::ColorButton::set_alpha </td>
          <td>(</td>
          <td class="paramtype">guint16&#160;</td>
          <td class="paramname"> <em>alpha</em></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the current opacity to be <em>alpha</em>. </p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000066">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>alpha</em>&#160;</td><td>An integer between 0 and 65535. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="abdebef43488848096b3beb48437a253b"></a><!-- doxytag: member="Gtk::ColorButton::set_color" ref="abdebef43488848096b3beb48437a253b" args="(const Gdk::Color &amp;color)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Gtk::ColorButton::set_color </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classGdk_1_1Color.html">Gdk::Color</a>&amp;&#160;</td>
          <td class="paramname"> <em>color</em></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the current color to be <em>color</em>. </p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000065">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>color</em>&#160;</td><td>A <a class="el" href="classGdk_1_1Color.html" title="Gdk::Color is used to describe an allocated or unallocated color.">Gdk::Color</a> to set the current color with. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a6fb0f55e86936a07c6c062113b0e323d"></a><!-- doxytag: member="Gtk::ColorButton::set_title" ref="a6fb0f55e86936a07c6c062113b0e323d" args="(const Glib::ustring &amp;title)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Gtk::ColorButton::set_title </td>
          <td>(</td>
          <td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> &amp;&#160;</td>
          <td class="paramname"> <em>title</em></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the title for the color selection dialog. </p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000071">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>title</em>&#160;</td><td>String containing new window title. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a817d20b6c2ca8ab10ec06177eebedebb"></a><!-- doxytag: member="Gtk::ColorButton::set_use_alpha" ref="a817d20b6c2ca8ab10ec06177eebedebb" args="(bool use_alpha=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Gtk::ColorButton::set_use_alpha </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"> <em>use_alpha</em> = <code>true</code></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets whether or not the color button should use the alpha channel. </p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000069">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>use_alpha</em>&#160;</td><td><code>true</code> if color button should use alpha channel, <code>false</code> if not. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="aba946d3c0d7cb90ff05617409c55216f"></a><!-- doxytag: member="Gtk::ColorButton::signal_color_set" ref="aba946d3c0d7cb90ff05617409c55216f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>&lt; void &gt; Gtk::ColorButton::signal_color_set </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&#160;)&#160;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The color_set signal is emitted when the user selects a color. </p>
<p>When handling this signal, use <a class="el" href="classGtk_1_1ColorButton.html#a99998d8ff0bcaecf7839328eadba1c06" title="Returns a copy of the the current color.">get_color()</a> and <a class="el" href="classGtk_1_1ColorButton.html#ada6bbec9fc824c14b62021222f79ce31" title="Returns the current alpha value.">get_alpha()</a> to find out which color was just selected.</p>
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_color_set()</code> </dd></dl>

</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a14285f6a8086a0fe5296df841f34e5ea"></a><!-- doxytag: member="Gtk::ColorButton::wrap" ref="a14285f6a8086a0fe5296df841f34e5ea" args="(GtkColorButton *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classGtk_1_1ColorButton.html">Gtk::ColorButton</a>* wrap </td>
          <td>(</td>
          <td class="paramtype">GtkColorButton *&#160;</td>
          <td class="paramname"> <em>object</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"> <em>take_copy</em> = <code>false</code></td><td>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [related]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>object</em>&#160;</td><td>The C instance. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>take_copy</em>&#160;</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>gtkmm/colorbutton.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue May 4 13:21:49 2010 for gtkmm by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>