README

   1 This directory tree holds version 0.9.2 the m17n-im-config package.
   2 Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012
   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         The widget returned must be the argument to the following
  64         functions.
  65
  66         This widget is actually a GtkScrolledWindow widget that
  67         contains a GtkTreeView widget.  You can get this GtkTreeView
  68         widget by mim_config_get_tree_view () function.
  69
  70 gboolean mim_config_modified (GtkWidget *config)
  71
  72         The mim_config_modified () function checks if there are any
  73         unsaved configurations.  If any, TRUE is returned.  Othewise,
  74         FALSE is returned.
  75
  76 gboolean mim_config_default (GtkWidget *config)
  77
  78         The mim_config_default () function reset all configurations
  79         done by a user at the current session, and all customization
  80         saved in a per-user customization file to the default state.
  81         If there are any configurations actually reverted, TRUE is
  82         returned.  Othewise FALSE is returned.
  83
  84 gboolean mim_config_revert (GtkWidget *config)
  85
  86         The mim_config_revert () function reverts all configurations
  87         done by a user to the original state.  If there are any
  88         configurations actually reverted, TRUE is returned.  Othewise
  89         FALSE is returned.
  90
  91 gboolean mim_config_save (GtkWidget *config)
  92
  93        The mim_config_save () function saves all configurations done
  94        by a user into a per-user customization file.  If the file is
  95        actually written, TRUE is returned.  If there's no configuraion
  96        to save, FALSE is returned.
  97
  98 GtkTreeView *mim_config_get_tree_view (GtkWidget *config)
  99
 100         The mim_config_get_tree_view () function returns the
 101         GtkTreeView widget used in the widget created by
 102         mim_config_new ().
 103
 104 (3-2) Compiling and Linking
 105
 106 As this package provides pkgconfig data, you can see compiler and
 107 linker options by the following commands:
 108
 109 % pkg-config --cflags m17n-im-config
 110 % pkg-config --libs m17n-im-config
 111
 112 (3-3) Usage of the standalone program
 113
 114 The program "m17n-im-config" provides a GUI for per-user configuration
 115 of input methods of the m17n library.  As the GUI is quite straight
 116 forward, there's nothing we should explain here.
 117
 118 (3-4) Usage of SCIM Setup module
 119
 120 The module "scim-m17n-setup" is installed in a proper directory where
 121 the program "scim-setup" searches loadable moduels.  When you run that
 122 program and click the tab "IMEngine->M17N Lib", you'll see the same
 123 GUI window as "m17n-im-config" provides.
 124
 125
 126 ----------------------------------------------------------------------
 127 Copyright information
 128
 129 Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012
 130   National Institute of Advanced Industrial Science and Technology (AIST)
 131   Registration Number H15PRO112
 132
 133 This file is part of the m17n-im-config package; a sub-part of the
 134 m17n library..
 135
 136 The m17n library is free software; you can redistribute it and/or
 137 modify it under the terms of the GNU Lesser General Public License
 138 as published by the Free Software Foundation; either version 2.1 of
 139 the License, or (at your option) any later version.
 140
 141 The m17n library is distributed in the hope that it will be useful,
 142 but WITHOUT ANY WARRANTY; without even the implied warranty of
 143 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 144 Lesser General Public License for more details.
 145
 146 You should have received a copy of the GNU Lesser General Public
 147 License along with the m17n library; if not, write to the Free
 148 Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 149 Boston, MA 02110-1301, USA.