This directory tree holds version 0.9.0 of the m17n-im-config package.
Copyright (C) 2007
  National Institute of Advanced Industrial Science and Technology (AIST)
  Registration Number H15PRO112
See the end for copying conditions.

(1) What is this package.

This package provides:

(1-1) C library to create a GTK+ widget for per-user configuration of
input methods provided by the m17n library.

(1-2) Standalone GTK+ program that uses the above widget.


(2) How to install.

(2-1) Prerequisite

This package requires these libralies:

	* the m17n library of version 1.3.4 or the later.

	* GTK+ version 2.4.0 or the later

(2-2) From CVS working directory

Run the script "bootstrap.sh" in this directory.  It is tested that
the script run successfully with these versions of autotools.

	libtool-1.5.6
	automake-1.4-p6
	autoconf-2.59

Then, proceed to the next step.

(2-3) From the tarball.

Run the following commands:

	% ./configure
	% make
	% make install


(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.

	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.

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.

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.

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 ().

(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 of the m17n library.  As the GUI is quite straight
forward, there's nothing we should explain here.


----------------------------------------------------------------------
Copyright information

Copyright (C) 2007
  National Institute of Advanced Industrial Science and Technology (AIST)
  Registration Number H15PRO112

This file is part of the m17n-im-config package; a sub-part of the
m17n library..

The m17n library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public License
as published by the Free Software Foundation; either version 2.1 of
the License, or (at your option) any later version.

The m17n library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with the m17n library; if not, write to the Free
Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
