Pileus Git - ~andy/gtk/blob - modules/input/gtkimcontextmultipress.h

   1 /* Copyright (C) 2006 Openismus GmbH
   2  *
   3  * This library is free software; you can redistribute it and/or
   4  * modify it under the terms of the GNU Lesser General Public
   5  * License as published by the Free Software Foundation; either
   6  * version 2 of the License, or (at your option) any later version.
   7  *
   8  * This library is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * Lesser General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public
  14  * License along with this library; if not, write to the
  15  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  16  * Boston, MA 02111-1307, USA.
  17  */
  18
  19 #ifndef __GTK_IM_CONTEXT_MULTIPRESS_H__
  20 #define __GTK_IM_CONTEXT_MULTIPRESS_H__
  21
  22 #include <gtk/gtk.h>
  23
  24 G_BEGIN_DECLS
  25
  26 #define GTK_TYPE_IM_CONTEXT_MULTIPRESS            (gtk_im_context_multipress_get_type ())
  27 #define GTK_IM_CONTEXT_MULTIPRESS(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_IM_CONTEXT_MULTIPRESS, GtkImContextMultipress))
  28 #define GTK_IM_CONTEXT_MULTIPRESS_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_IM_CONTEXT_MULTIPRESS, GtkImContextMultipressClass))
  29 #define GTK_IS_IM_CONTEXT_MULTIPRESS(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_IM_CONTEXT_MULTIPRESS))
  30 #define GTK_IS_IM_CONTEXT_MULTIPRESS_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_IM_CONTEXT_MULTIPRESS))
  31 #define GTK_IM_CONTEXT_MULTIPRESS_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_IM_CONTEXT_MULTIPRESS, GtkImContextMultipressClass))
  32
  33 typedef struct _GtkImContextMultipress GtkImContextMultipress;
  34
  35 /* This input method allows multi-press character input, like that found on
  36  * mobile phones.
  37  *
  38  * This is based on GtkImContextSimple, which allows "compose" based on
  39  * sequences of characters.  But instead the character sequences are defined
  40  * by lists of characters for a key, so that repeated pressing of the same key
  41  * can cycle through the possible output characters, with automatic choosing
  42  * of the character after a time delay.
  43  */
  44 struct _GtkImContextMultipress
  45 {
  46   /*< private >*/
  47   GtkIMContext parent;
  48
  49   /* Sequence information, loaded from the configuration file: */
  50   GHashTable* key_sequences;
  51   gsize dummy; /* ABI-preserving placeholder */
  52
  53   /* The last character entered so far during a compose.
  54    * If this is NULL then we are not composing yet.
  55    */
  56   guint key_last_entered;
  57
  58   /* The position of the compose in the possible sequence.
  59    *  For instance, this is 2 if aa has been pressed to show b (from abc0).
  60    */
  61   guint compose_count;
  62   guint timeout_id;
  63
  64   /* The character(s) that will be used if it the current character(s) is accepted: */
  65   const gchar *tentative_match;
  66 };
  67
  68
  69 typedef struct _GtkImContextMultipressClass  GtkImContextMultipressClass;
  70
  71 struct _GtkImContextMultipressClass
  72 {
  73   GtkIMContextClass parent_class;
  74 };
  75
  76 void gtk_im_context_multipress_register_type (GTypeModule* type_module);
  77 GType gtk_im_context_multipress_get_type (void);
  78 GtkIMContext *gtk_im_context_multipress_new (void);
  79
  80 G_END_DECLS
  81
  82 #endif /* __GTK_IM_CONTEXT_MULTIPRESS_H__ */