diff options
| author | Not Zed <NotZed@Ximian.com> | 2004-10-12 15:38:55 +0800 |
|---|---|---|
| committer | Michael Zucci <zucchi@src.gnome.org> | 2004-10-12 15:38:55 +0800 |
| commit | acbeb6cddd469e969b95cd4df7f9750bab39d0c0 (patch) | |
| tree | bb013f9a664e60a51270a8e2221024734beb0fc9 /doc/devel/evolution-plugin-manual.xml | |
| parent | b084903dddf3d529781b5acd29f6623fef64f50f (diff) | |
| download | gsoc2013-evolution-acbeb6cddd469e969b95cd4df7f9750bab39d0c0.tar.gz gsoc2013-evolution-acbeb6cddd469e969b95cd4df7f9750bab39d0c0.tar.zst gsoc2013-evolution-acbeb6cddd469e969b95cd4df7f9750bab39d0c0.zip | |
doc updates for new 'check' callback.
2004-10-12 Not Zed <NotZed@Ximian.com>
* evolution-plugin-manual.xml: doc updates for new 'check' callback.
svn path=/trunk/; revision=27552
Diffstat (limited to 'doc/devel/evolution-plugin-manual.xml')
| -rw-r--r-- | doc/devel/evolution-plugin-manual.xml | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/devel/evolution-plugin-manual.xml b/doc/devel/evolution-plugin-manual.xml index 9ca1d5b535..a8f01ac954 100644 --- a/doc/devel/evolution-plugin-manual.xml +++ b/doc/devel/evolution-plugin-manual.xml @@ -1194,6 +1194,7 @@ <group id="window id" target="targettype" + check="function spec"? commit="function spec"? abort="function spec"?> <item @@ -1228,6 +1229,30 @@ </listitem> </varlistentry> <varlistentry> + <term><parameter>check</parameter></term> + <listitem> + <simpara> + A callback which will be invoked to validate the + configuration or a specific page of the configuration. It + will be invoked with a + <link + linkend="API-struct--EConfigHookPageCheckData">EConfigHookPageCheckData</link> + structure, and is expected to return a non-NULL value if + the page validates. + </simpara> + <simpara> + The callback will be expected to handle all + <parameter>pageid</parameter>'s present in the + configuration window, and should return + <constant>TRUE</constant> for pages it does not recognise. + If <parameter>pageid=""</parameter> (an empty + string), then the <parameter>check</parameter> function + should validate all settings. See also <xref + linkend="API-e-config-add-page-check" />. + </simpara> + </listitem> + </varlistentry> + <varlistentry> <term><parameter>commit</parameter></term> <listitem> <simpara> |