<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="class-gtkgammacurve">
  <refnamediv>
    <refname>gtk.GammaCurve</refname>
    <refpurpose> subclass of <link
linkend="class-gtkcurve"><classname>gtk.Curve</classname></link> for editing
gamma curves.</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.GammaCurve</classname></ooclass>
      <ooclass><classname><link
linkend="class-gtkvbox">gtk.VBox</link></classname></ooclass>
      <constructorsynopsis language="python">
	<methodname><link
linkend="constructor-gtkgammacurve">gtk.GammaCurve</link></methodname>
	<methodparam></methodparam>  </constructorsynopsis>
    </classsynopsis>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-gtkobject">gtk.Object</link>
    +-- <link linkend="class-gtkwidget">gtk.Widget</link>
      +-- <link linkend="class-gtkcontainer">gtk.Container</link>
        +-- <link linkend="class-gtkbox">gtk.Box</link>
          +-- <link linkend="class-gtkvbox">gtk.VBox</link>
            +-- <link linkend="class-gtkgammacurve">gtk.GammaCurve</link>
</synopsis>

  </refsect1>
  
  <refsect1>
		<title>Implemented Interfaces</title>
		<para>
			<link linkend="class-gtkgammacurve"><classname>gtk.GammaCurve</classname></link>
			implements 
			<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
		</para>
	</refsect1>

  <refsect1 id="properties-gtkgammacurve">
    <title>gtk.GammaCurve Properties</title>

    <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
    <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
    <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
    <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para>

  </refsect1>

  <refsect1 id="style-properties-gtkgammacurve">
    <title>gtk.GammaCurve Style Properties</title>

    <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>

  </refsect1>

  <refsect1 id="child-properties-gtkgammacurve">
    <title>gtk.GammaCurve Child Properties</title>

    <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para>

  </refsect1>

  <refsect1>
    <title>Attributes</title>

    <blockquote role="properties">
      <informaltable pgwide="1" frame="none">
	<tgroup cols="3">
	<?dbhtml cellpadding="5"?>
	  <colspec column="1" colwidth="1in"/>
	  <colspec column="2" colwidth="1in"/>
	  <colspec column="3" colwidth="4in"/>
	  <tbody>

	    <row valign="top">
	      <entry>"table"</entry>
	      <entry>Read</entry>
	      <entry>The <link
linkend="class-gtktable"><classname>gtk.Table</classname></link>
containing the <link
linkend="class-gtkgammacurve"><classname>gtk.GammaCurve</classname></link>
widgets.</entry>
	    </row>

	    <row valign="top">
	      <entry>"curve"</entry>
	      <entry>Read</entry>
	      <entry>The <link
linkend="class-gtkcurve"><classname>gtk.Curve</classname></link>
widget.</entry>
	    </row>

	    <row valign="top">
	      <entry>"gamma"</entry>
	      <entry>Read</entry>
	      <entry>The gamma value (float)</entry>
	    </row>

	    <row valign="top">
	      <entry>"gamma_dialog"</entry>
	      <entry>Read</entry>
	      <entry>The <link
linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link>
that prompts for the gamma value.</entry>
	    </row>

	    <row valign="top">
	      <entry>"gamma_text"</entry>
	      <entry>Read</entry>
	      <entry>The <link
linkend="class-gtkentry"><classname>gtk.Entry</classname></link>
containing the gamma value in the gamma dialog</entry>
	    </row>

	</tbody>
      </tgroup>
      </informaltable>
    </blockquote>

  </refsect1>

  <refsect1 id="signal-prototypes-gtkgammacurve">
    <title>gtk.GammaCurve Signal Prototypes</title>

    <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
  </refsect1>

  <refsect1>
    <title>Description</title>

    <note>
      <para>This widget is considered too specialized or little-used for
PyGTK, and will in the future be moved to some other package. If your
application needs this widget, feel free to use it, as the widget does work
and is useful in some applications; it's just not of general interest.
However, it will eventually move out of the PyGTK distribution.</para>
    </note>

    <para>The <link
linkend="class-gtkgammacurve"><classname>gtk.GammaCurve</classname></link>
widget is a variant of <link
linkend="class-gtkcurve"><classname>gtk.Curve</classname></link>
specifically for editing gamma curves, which are used in graphics
applications such as the <application>Gimp</application>. The <link
linkend="class-gtkgammacurve"><classname>gtk.GammaCurve</classname></link>
widget shows a curve which the user can edit with the mouse just like a
<link linkend="class-gtkcurve"><classname>gtk.Curve</classname></link>
widget. On the right of the curve it also displays 5 buttons, 3 of which
change between the 3 curve modes (spline, linear and free), and the other 2
set the curve to a particular gamma value, or reset it to a straight
line.</para>

  </refsect1>

  <refsect1 id="constructor-gtkgammacurve">
    <title>Constructor</title>

    <programlisting><constructorsynopsis language="python">
	<methodname>gtk.GammaCurve</methodname>
	<methodparam></methodparam>  </constructorsynopsis></programlisting>
    <variablelist>
      <varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	<listitem><simpara>a new gammacurve widget</simpara></listitem>
      </varlistentry>
    </variablelist>

    <para>Creates a new <link
linkend="class-gtkgammacurve"><classname>gtk.GammaCurve</classname></link>
widget.</para>

  </refsect1>

</refentry>
