diff options
| author | Dieter Verfaillie <dieterv@optionexplicit.be> | 2011-02-17 07:18:22 +0100 |
|---|---|---|
| committer | Dieter Verfaillie <dieterv@optionexplicit.be> | 2011-02-21 21:43:57 +0100 |
| commit | 3fc5e316051e1cb5c1c6a4575b6ea4da5c993eb7 (patch) | |
| tree | ea2d9b5c653881af48ebc61a98e5c7332e8fd926 | |
| parent | 8d1ffdfbd40e54a8c8f4c717aaaff1b3cdeb66ca (diff) | |
| download | pygtk-3fc5e316051e1cb5c1c6a4575b6ea4da5c993eb7.tar.gz | |
reference: pygtk-gtkassistant.xml: add new commit method
| -rw-r--r-- | docs/reference/ChangeLog | 1 | ||||
| -rw-r--r-- | docs/reference/pygtk-gtkassistant.xml | 27 |
2 files changed, 28 insertions, 0 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index d8e9a3b9..6fb9268f 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -3,6 +3,7 @@ * pygtk-gtkaboutdialog.xml: fix (s|g)et_name and (s|g)et_program_name. * pygtk-gtkaccessible.xml: add new methods * pygtk-gtkaction.xml: add new methods + * pygtk-gtkassistant.xml: add new commit method 2011-01-12 Dieter Verfaillie <dieterv@optionexplicit.be> diff --git a/docs/reference/pygtk-gtkassistant.xml b/docs/reference/pygtk-gtkassistant.xml index d317f1c0..99424a19 100644 --- a/docs/reference/pygtk-gtkassistant.xml +++ b/docs/reference/pygtk-gtkassistant.xml @@ -110,6 +110,10 @@ <methodname><link linkend="method-gtkassistant--update-buttons-state">update_buttons_state</link></methodname> <methodparam></methodparam> </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkassistant--commit">commit</link></methodname> + <methodparam></methodparam> + </methodsynopsis> </classsynopsis> </refsect1> @@ -1015,6 +1019,29 @@ role="keyword"></parameter> :</term> </refsect2> + <refsect2 id="method-gtkassistant--commit"> + <title>gtk.Assistant.commit</title> + + <programlisting><methodsynopsis language="python"> + <methodname>commit</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <note> + <para>This method is available in PyGTK 2.22 and above.</para> + </note> + + <para>The <methodname>commit</methodname>() method erases the visited + page history so the back button is not shown on the current page, and + removes the cancel button from subsequent pages.</para> + + <para>Use this when the information provided up to the current page is + hereafter deemed permanent and cannot be modified or undone. For example, + showing a progress page to track a long-running, unreversible operation + after the user has clicked apply on a confirmation page.</para> + + </refsect2> + </refsect1> <refsect1> |