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