From: handa <handa>
Date: Mon, 26 Mar 2007 12:23:36 +0000 (+0000)
Subject: *** empty log message ***
X-Git-Tag: REL-0-9-0~33
X-Git-Url: http://git.chise.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4f5ee8c0c081c13a88e38989ddd660767d040246;p=m17n%2Fm17n-im-config.git

*** empty log message ***
---

diff --git a/README b/README
index 4ddab4f..66508c3 100644
--- a/README
+++ b/README
@@ -9,7 +9,7 @@ See the end for copying conditions.
 This package provides:
 
 (1-1) C library to create a GTK+ widget for per-user configuration of
-input methods provided by the m17n.
+input methods provided by the m17n library.
 
 (1-2) Standalone GTK+ program that uses the above widget.
 
@@ -46,6 +46,56 @@ Run the following commands:
 
 (3) Documentaion
 
+(3-1) Library API
+
+The library libm17n-im-config has these public functions.
+
+GtkWidget *mim_config_new (GCallback func, gpointer data)
+
+	The mim_config_new () function returns a newly created Gtk+
+	widget for for per-user configuration of input methods
+	provided by the m17n library.  If the argument FUNC is not
+	NULL, it is called when the configuration status is changed
+	(because some value is changed or reverted by a user).  The
+	function must have two arguments; the widget created by this
+	function, and DATA.
+
+gboolean mim_config_modified (GtkWidget *config)
+
+	The mim_config_modified () function checks if there are any
+	unsaved configurations.  If any, TRUE is returned.  Othewise,
+	FALSE is returned.  The argument CONFIG must be what created
+	by mim_config_new ().
+
+gboolean mim_config_revert (GtkWidget *config)
+
+	The mim_config_revert () function reverts all configurations
+	done by a user to the original state.  If there are any
+	configurations actually reverted, TRUE is returned.  Othewise
+	FALSE is returned.  The argument CONFIG must be what created
+	by mim_config_new ().
+
+gboolean mim_config_save (GtkWidget *config)
+
+       The mim_config_save () function saves all configurations done
+       by a user into a per-user customization file.  If the file is
+       actually written, TRUE is returned.  If there's no configuraion
+       to save, FALSE is returned.  The argument CONFIG must be what
+       created by mim_config_new ().
+
+(3-2) Compiling and Linking
+
+As this package provides pkgconfig data, you can see compiler and
+linker options by the following commands:
+
+% pkg-config --cflags m17n-im-config
+% pkg-config --libs m17n-im-config
+
+(3-3) Usage of the standalone program
+
+The program "m17n-im-config" provides a GUI for per-user configuration
+of input methods provided by the m17n library.  As the GUI is quite
+straight forward, there's nothing we should explain here.
 
 
 ----------------------------------------------------------------------