gtkimcontextmultipress.h 3.09 KB
Newer Older
1
/* Copyright (C) 2006 Openismus GmbH
2
 *
3 4 5 6 7 8 9 10 11 12 13
 * This 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 of the License, or (at your option) any later version.
 *
 * This 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
Javier Jardón's avatar
Javier Jardón committed
14
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
15 16
 */

17 18
#ifndef __GTK_IM_CONTEXT_MULTIPRESS_H__
#define __GTK_IM_CONTEXT_MULTIPRESS_H__
19

20
#include <gtk/gtk.h>
21 22 23

G_BEGIN_DECLS

24
#define GTK_TYPE_IM_CONTEXT_MULTIPRESS            (gtk_im_context_multipress_get_type ())
25 26
#define GTK_IM_CONTEXT_MULTIPRESS(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_IM_CONTEXT_MULTIPRESS, GtkImContextMultipress))
#define GTK_IM_CONTEXT_MULTIPRESS_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_IM_CONTEXT_MULTIPRESS, GtkImContextMultipressClass))
27 28
#define GTK_IS_IM_CONTEXT_MULTIPRESS(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_IM_CONTEXT_MULTIPRESS))
#define GTK_IS_IM_CONTEXT_MULTIPRESS_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_IM_CONTEXT_MULTIPRESS))
29
#define GTK_IM_CONTEXT_MULTIPRESS_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_IM_CONTEXT_MULTIPRESS, GtkImContextMultipressClass))
30 31 32

typedef struct _GtkImContextMultipress GtkImContextMultipress;

33 34
/* This input method allows multi-press character input, like that found on
 * mobile phones.
35
 *
36 37 38 39 40 41
 * This is based on GtkImContextSimple, which allows "compose" based on
 * sequences of characters.  But instead the character sequences are defined
 * by lists of characters for a key, so that repeated pressing of the same key
 * can cycle through the possible output characters, with automatic choosing
 * of the character after a time delay.
 */
42 43
struct _GtkImContextMultipress
{
44
  /*< private >*/
45 46
  GtkIMContext parent;

47 48 49
  /* Sequence information, loaded from the configuration file: */
  GHashTable* key_sequences;
  gsize dummy; /* ABI-preserving placeholder */
50 51 52 53 54 55 56 57 58 59 60 61 62

  /* The last character entered so far during a compose.
   * If this is NULL then we are not composing yet.
   */
  guint key_last_entered;
  
  /* The position of the compose in the possible sequence.
   *  For instance, this is 2 if aa has been pressed to show b (from abc0).
   */
  guint compose_count; 
  guint timeout_id;

  /* The character(s) that will be used if it the current character(s) is accepted: */
63
  const gchar *tentative_match;
64 65 66 67 68 69 70 71 72 73 74
};


typedef struct _GtkImContextMultipressClass  GtkImContextMultipressClass;

struct _GtkImContextMultipressClass
{
  GtkIMContextClass parent_class;
};

void gtk_im_context_multipress_register_type (GTypeModule* type_module);
75
GType gtk_im_context_multipress_get_type (void);
76 77 78 79
GtkIMContext *gtk_im_context_multipress_new (void);

G_END_DECLS

80
#endif /* __GTK_IM_CONTEXT_MULTIPRESS_H__ */