*** empty log message ***

[m17n/m17n-im-config.git] / README

diff --git a/README b/README
index 90ff8f4..b4a52bb 100644 (file)
--- a/README
+++ b/README
@@ -60,39 +60,46 @@ GtkWidget *mim_config_new (GCallback func, gpointer data)
        function must have two arguments; the widget created by this
        function, and DATA.
 
-       The widget returned is actually a GtkScrolledWindow widget
-       that contains a GtkTreeView widget.  You can get this
-       GtkTreeView widget by mim_config_get_tree_view () function.
+       The widget returned must be the argument to the following
+       functions.
+
+       This widget is actually a GtkScrolledWindow widget that
+       contains a GtkTreeView widget.  You can get this GtkTreeView
+       widget by mim_config_get_tree_view () function.
 
 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 ().
+       FALSE is returned.
+
+gboolean mim_config_default (GtkWidget *config)
+
+       The mim_config_default () function reset all configurations
+       done by a user at the current session, and all customization
+       saved in a per-user customization file to the default state.
+       If there are any configurations actually reverted, TRUE is
+       returned.  Othewise FALSE is returned.
 
 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 ().
+       FALSE is returned.
 
 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 ().
+       to save, FALSE is returned.
 
 GtkTreeView *mim_config_get_tree_view (GtkWidget *config)
 
        The mim_config_get_tree_view () function returns the
        GtkTreeView widget used in the widget created by
-       mim_config_new ().  The argument CONFIG must be what created
-       by mim_config_new ().
+       mim_config_new ().
 
 (3-2) Compiling and Linking