From acbeb6cddd469e969b95cd4df7f9750bab39d0c0 Mon Sep 17 00:00:00 2001
From: Not Zed <NotZed@Ximian.com>
Date: Tue, 12 Oct 2004 07:38:55 +0000
Subject: 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
---
 doc/devel/ChangeLog                   |  4 ++++
 doc/devel/evolution-plugin-manual.xml | 25 +++++++++++++++++++++++++
 2 files changed, 29 insertions(+)

(limited to 'doc/devel')

diff --git a/doc/devel/ChangeLog b/doc/devel/ChangeLog
index 18d59f736c..9de1bb25a1 100644
--- a/doc/devel/ChangeLog
+++ b/doc/devel/ChangeLog
@@ -1,3 +1,7 @@
+2004-10-12  Not Zed  <NotZed@Ximian.com>
+
+	* evolution-plugin-manual.xml: doc updates for new 'check' callback.
+
 2004-10-07  Not Zed  <NotZed@Ximian.com>
 
 	* evolution-plugin-manual.xml: some updates.
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
@@ -1227,6 +1228,30 @@
 		  </simpara>
 		</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=&quot;&quot;</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>
-- 
cgit