diff options
author | Dieter Verfaillie <dieterv@optionexplicit.be> | 2011-02-17 07:59:56 +0100 |
---|---|---|
committer | Dieter Verfaillie <dieterv@optionexplicit.be> | 2011-02-21 21:44:02 +0100 |
commit | a3be76ed8203fea5ee5695059a6d58582849c1a5 (patch) | |
tree | f8f2d64f767a637813dc3b8fc63c8ea20456383c /docs | |
parent | c00167cb8fdd5325c18f595dc7e9cdea89f49b44 (diff) | |
download | pygtk-a3be76ed8203fea5ee5695059a6d58582849c1a5.tar.gz |
reference: pygtk-gtkcolorselectiondialog.xml: add missing properties
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/ChangeLog | 1 | ||||
-rw-r--r-- | docs/reference/pygtk-gtkcolorselectiondialog.xml | 203 |
2 files changed, 115 insertions, 89 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 98b34468..b349f1ed 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -3,6 +3,7 @@ * pygtk-gtkcelleditable.xml: add missing "editing-canceled" property * pygtk-gtkcellrenderer.xml: add missing property and methods * pygtk-gtkcellrenderertoggle.xml: add missing methods + * pygtk-gtkcolorselectiondialog.xml: add missing properties 2011-01-13 Dieter Verfaillie <dieterv@optionexplicit.be> diff --git a/docs/reference/pygtk-gtkcolorselectiondialog.xml b/docs/reference/pygtk-gtkcolorselectiondialog.xml index bca343da..e7b06f64 100644 --- a/docs/reference/pygtk-gtkcolorselectiondialog.xml +++ b/docs/reference/pygtk-gtkcolorselectiondialog.xml @@ -13,17 +13,14 @@ <classsynopsis language="python"> <ooclass><classname>gtk.ColorSelectionDialog</classname></ooclass> - <ooclass><classname><link -linkend="class-gtkdialog">gtk.Dialog</link></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> + <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> + <methodname><link linkend="method-gtkcolorselectiondialog--get-color-selection">get_color_selection</link></methodname> + <methodparam></methodparam> </methodsynopsis> </classsynopsis> @@ -43,15 +40,15 @@ linkend="constructor-gtkcolorselectiondialog">gtk.ColorSelectionDialog</link></m </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> + <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> @@ -62,6 +59,41 @@ linkend="constructor-gtkcolorselectiondialog">gtk.ColorSelectionDialog</link></m <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"> @@ -77,40 +109,36 @@ linkend="constructor-gtkcolorselectiondialog">gtk.ColorSelectionDialog</link></m <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> + <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> @@ -131,21 +159,21 @@ widget contained in the dialog.</entry> <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> + 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> + 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> @@ -153,55 +181,52 @@ method.</para> <title>Constructor</title> <programlisting><constructorsynopsis language="python"> - <methodname>gtk.ColorSelectionDialog</methodname> - <methodparam><parameter - role="keyword">title</parameter></methodparam> - </constructorsynopsis></programlisting> + <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> + <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> + <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> + 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.Frame.get_color_selection</title> + <title>gtk.ColorSelectionDialog.get_color_selection</title> <programlisting><methodsynopsis language="python"> - <methodname>get_color_selection</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> + <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> + <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> + <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> |