README

   1 This directory tree holds version 0.9.0 of the m17n-im-config package.
   2 Copyright (C) 2007
   3   National Institute of Advanced Industrial Science and Technology (AIST)
   4   Registration Number H15PRO112
   5 See the end for copying conditions.
   6
   7 (1) What is this package.
   8
   9 This package provides:
  10
  11 (1-1) C library to create a GTK+ widget for per-user configuration of
  12 input methods provided by the m17n library.
  13
  14 (1-2) Standalone GTK+ program that uses the above widget.
  15
  16
  17 (2) How to install.
  18
  19 (2-1) Prerequisite
  20
  21 This package requires these libralies:
  22
  23         * the m17n library of version 1.3.4 or the later.
  24
  25         * GTK+ version 2.4.0 or the later
  26
  27 (2-2) From CVS working directory
  28
  29 Run the script "bootstrap.sh" in this directory.  It is tested that
  30 the script run successfully with these versions of autotools.
  31
  32         libtool-1.5.6
  33         automake-1.4-p6
  34         autoconf-2.59
  35
  36 Then, proceed to the next step.
  37
  38 (2-3) From the tarball.
  39
  40 Run the following commands:
  41
  42         % ./configure
  43         % make
  44         % make install
  45
  46
  47 (3) Documentaion
  48
  49 (3-1) Library API
  50
  51 The library libm17n-im-config has these public functions.
  52
  53 GtkWidget *mim_config_new (GCallback func, gpointer data)
  54
  55         The mim_config_new () function returns a newly created Gtk+
  56         widget for for per-user configuration of input methods
  57         provided by the m17n library.  If the argument FUNC is not
  58         NULL, it is called when the configuration status is changed
  59         (because some value is changed or reverted by a user).  The
  60         function must have two arguments; the widget created by this
  61         function, and DATA.
  62
  63 gboolean mim_config_modified (GtkWidget *config)
  64
  65         The mim_config_modified () function checks if there are any
  66         unsaved configurations.  If any, TRUE is returned.  Othewise,
  67         FALSE is returned.  The argument CONFIG must be what created
  68         by mim_config_new ().
  69
  70 gboolean mim_config_revert (GtkWidget *config)
  71
  72         The mim_config_revert () function reverts all configurations
  73         done by a user to the original state.  If there are any
  74         configurations actually reverted, TRUE is returned.  Othewise
  75         FALSE is returned.  The argument CONFIG must be what created
  76         by mim_config_new ().
  77
  78 gboolean mim_config_save (GtkWidget *config)
  79
  80        The mim_config_save () function saves all configurations done
  81        by a user into a per-user customization file.  If the file is
  82        actually written, TRUE is returned.  If there's no configuraion
  83        to save, FALSE is returned.  The argument CONFIG must be what
  84        created by mim_config_new ().
  85
  86 (3-2) Compiling and Linking
  87
  88 As this package provides pkgconfig data, you can see compiler and
  89 linker options by the following commands:
  90
  91 % pkg-config --cflags m17n-im-config
  92 % pkg-config --libs m17n-im-config
  93
  94 (3-3) Usage of the standalone program
  95
  96 The program "m17n-im-config" provides a GUI for per-user configuration
  97 of input methods provided by the m17n library.  As the GUI is quite
  98 straight forward, there's nothing we should explain here.
  99
 100
 101 ----------------------------------------------------------------------
 102 Copyright information
 103
 104 Copyright (C) 2007
 105   National Institute of Advanced Industrial Science and Technology (AIST)
 106   Registration Number H15PRO112
 107
 108 This file is part of the m17n-im-config package; a sub-part of the
 109 m17n library..
 110
 111 The m17n library is free software; you can redistribute it and/or
 112 modify it under the terms of the GNU Lesser General Public License
 113 as published by the Free Software Foundation; either version 2.1 of
 114 the License, or (at your option) any later version.
 115
 116 The m17n library is distributed in the hope that it will be useful,
 117 but WITHOUT ANY WARRANTY; without even the implied warranty of
 118 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 119 Lesser General Public License for more details.
 120
 121 You should have received a copy of the GNU Lesser General Public
 122 License along with the m17n library; if not, write to the Free
 123 Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 124 Boston, MA 02110-1301, USA.