1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
|
<?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-gtkcolorselectiondialog">
<refnamediv>
<refname>gtk.ColorSelectionDialog</refname>
<refpurpose>a standard dialog for selecting a color.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.ColorSelectionDialog</classname></ooclass>
<ooclass><classname><link linkend="class-gtkdialog">gtk.Dialog</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-gtkcolorselectiondialog">gtk.ColorSelectionDialog</link></methodname>
<methodparam><parameter role="keyword">title</parameter></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcolorselectiondialog--get-color-selection">get_color_selection</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
</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-gtkbin">gtk.Bin</link>
+-- <link linkend="class-gtkwindow">gtk.Window</link>
+-- <link linkend="class-gtkdialog">gtk.Dialog</link>
+-- <link linkend="class-gtkcolorselectiondialog">gtk.ColorSelectionDialog</link>
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
<link linkend="class-gtkcolorselectiondialog"><classname>gtk.ColorSelectionDialog</classname></link>
implements
<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
</para>
</refsect1>
<refsect1 id="properties-gtkcolorselectiondialog">
<title>gtk.ColorSelectionDialog 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-gtkwindow">gtk.Window Properties</link></para>
<para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="3.5in"/>
<tbody>
<row valign="top">
<entry>"cancel-button"</entry>
<entry>Read</entry>
<entry>The cancel button of the dialog.</entry>
</row>
<row valign="top">
<entry>"color-selection"</entry>
<entry>Read</entry>
<entry>The color selection embedded in the dialog.</entry>
</row>
<row valign="top">
<entry>"help-button"</entry>
<entry>Read</entry>
<entry>The help button of the dialog.</entry>
</row>
<row valign="top">
<entry>"ok-button"</entry>
<entry>Read</entry>
<entry>The OK button of the dialog.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="style-properties-gtkcolorselectiondialog">
<title>gtk.ColorSelectionDialog Style Properties</title>
<para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
<para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para>
</refsect1>
<refsect1>
<title>Attributes</title>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="3.5in"/>
<tbody>
<row valign="top">
<entry>"colorsel"</entry>
<entry>Read</entry>
<entry>The <link linkend="class-gtkcolorselection"><classname>gtk.ColorSelection</classname></link> widget contained in the dialog.</entry>
</row>
<row valign="top">
<entry>"ok_button"</entry>
<entry>Read</entry>
<entry>The "OK" button contained in the dialog.</entry>
</row>
<row valign="top">
<entry>"cancel_button"</entry>
<entry>Read</entry>
<entry>The "Cancel" button contained in the dialog.</entry>
</row>
<row valign="top">
<entry>"help_button"</entry>
<entry>Read</entry>
<entry>The "Help" button contained in the dialog.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="signal-prototypes-gtkcolorselectiondialog">
<title>gtk.ColorSelectionDialog 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>
<para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para>
</refsect1>
<refsect1>
<title>Description</title>
<para>The <link
linkend="class-gtkcolorselectiondialog"><classname>gtk.ColorSelectionDialog</classname></link>
provides a standard dialog that allows a user to select a color. The <link
linkend="class-gtkcolorselectiondialog"><classname>gtk.ColorSelectionDialog</classname></link>
uses an embedded <link
linkend="class-gtkcolorselection"><classname>gtk.ColorSelection</classname></link>
to provide color selection capability.</para>
<para>Use the attributes (ok_button, cancel_button and help_button) of
the colorselectiondialog to connect handlers to the "OK", "Cancel" and
"Help" button "clicked" signals. The colorsel attribute provides access to
the colorselection widget. Connect a handler to its "color-changed" signal
to be notified when the color is changed. The current color can be retrieved
using the <link
linkend="method-gtkcolorselection--get-current-color"><methodname>gtk.ColorSelection.get_current_color</methodname>()</link>
method.</para>
</refsect1>
<refsect1 id="constructor-gtkcolorselectiondialog">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtk.ColorSelectionDialog</methodname>
<methodparam><parameter role="keyword">title</parameter></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">title</parameter> :</term>
<listitem><simpara>a string to be used as the dialog title.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new colorselectiondialog</simpara></listitem>
</varlistentry>
</variablelist>
<para>Creates a new <classname>gtk.ColorSelectionDialog</classname>
using the string contained in <parameter>title</parameter> as the text for
the dialog title.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtkcolorselectiondialog--get-color-selection">
<title>gtk.ColorSelectionDialog.get_color_selection</title>
<programlisting><methodsynopsis language="python">
<methodname>get_color_selection</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the embedded <link linkend="class-gtkcolorselection"> <classname>gtk.ColorSelection</classname></link>.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.14 and above.</para>
</note>
<para>The <methodname>get_color_selection</methodname>() method retrieves the
<link linkend="class-gtkcolorselection"><classname>gtk.ColorSelection</classname></link>
widget embedded in the dialog.</para>
</refsect2>
</refsect1>
</refentry>
|