Pileus Git - ~andy/gtk/blob - gtk/gtkimcontext.h

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 2000 Red Hat Software
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  21 #error "Only <gtk/gtk.h> can be included directly."
  22 #endif
  23
  24 #ifndef __GTK_IM_CONTEXT_H__
  25 #define __GTK_IM_CONTEXT_H__
  26
  27 #include <gdk/gdk.h>
  28 #include <gtk/gtkobject.h>
  29 #include <pango/pango.h>
  30
  31 G_BEGIN_DECLS
  32
  33 #define GTK_TYPE_IM_CONTEXT              (gtk_im_context_get_type ())
  34 #define GTK_IM_CONTEXT(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_IM_CONTEXT, GtkIMContext))
  35 #define GTK_IM_CONTEXT_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_IM_CONTEXT, GtkIMContextClass))
  36 #define GTK_IS_IM_CONTEXT(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_IM_CONTEXT))
  37 #define GTK_IS_IM_CONTEXT_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_IM_CONTEXT))
  38 #define GTK_IM_CONTEXT_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_IM_CONTEXT, GtkIMContextClass))
  39
  40
  41 typedef struct _GtkIMContext       GtkIMContext;
  42 typedef struct _GtkIMContextClass  GtkIMContextClass;
  43
  44 struct _GtkIMContext
  45 {
  46   GObject parent_instance;
  47 };
  48
  49 struct _GtkIMContextClass
  50 {
  51   /* Yes, this should be GObjectClass, be we can't fix it without breaking
  52    * binary compatibility - see bug #90935
  53    */
  54   GtkObjectClass parent_class;
  55
  56   /* Signals */
  57   void     (*preedit_start)        (GtkIMContext *context);
  58   void     (*preedit_end)          (GtkIMContext *context);
  59   void     (*preedit_changed)      (GtkIMContext *context);
  60   void     (*commit)               (GtkIMContext *context, const gchar *str);
  61   gboolean (*retrieve_surrounding) (GtkIMContext *context);
  62   gboolean (*delete_surrounding)   (GtkIMContext *context,
  63                                     gint          offset,
  64                                     gint          n_chars);
  65
  66   /* Virtual functions */
  67   void     (*set_client_window)   (GtkIMContext   *context,
  68                                    GdkWindow      *window);
  69   void     (*get_preedit_string)  (GtkIMContext   *context,
  70                                    gchar         **str,
  71                                    PangoAttrList **attrs,
  72                                    gint           *cursor_pos);
  73   gboolean (*filter_keypress)     (GtkIMContext   *context,
  74                                    GdkEventKey    *event);
  75   void     (*focus_in)            (GtkIMContext   *context);
  76   void     (*focus_out)           (GtkIMContext   *context);
  77   void     (*reset)               (GtkIMContext   *context);
  78   void     (*set_cursor_location) (GtkIMContext   *context,
  79                                    GdkRectangle   *area);
  80   void     (*set_use_preedit)     (GtkIMContext   *context,
  81                                    gboolean        use_preedit);
  82   void     (*set_surrounding)     (GtkIMContext   *context,
  83                                    const gchar    *text,
  84                                    gint            len,
  85                                    gint            cursor_index);
  86   gboolean (*get_surrounding)     (GtkIMContext   *context,
  87                                    gchar         **text,
  88                                    gint           *cursor_index);
  89
  90   /* Padding for future expansion */
  91   void (*_gtk_reserved1) (void);
  92   void (*_gtk_reserved2) (void);
  93   void (*_gtk_reserved3) (void);
  94   void (*_gtk_reserved4) (void);
  95   void (*_gtk_reserved5) (void);
  96   void (*_gtk_reserved6) (void);
  97 };
  98
  99 GType    gtk_im_context_get_type            (void) G_GNUC_CONST;
 100
 101 void     gtk_im_context_set_client_window   (GtkIMContext       *context,
 102                                              GdkWindow          *window);
 103 void     gtk_im_context_get_preedit_string  (GtkIMContext       *context,
 104                                              gchar             **str,
 105                                              PangoAttrList     **attrs,
 106                                              gint               *cursor_pos);
 107 gboolean gtk_im_context_filter_keypress     (GtkIMContext       *context,
 108                                              GdkEventKey        *event);
 109 void     gtk_im_context_focus_in            (GtkIMContext       *context);
 110 void     gtk_im_context_focus_out           (GtkIMContext       *context);
 111 void     gtk_im_context_reset               (GtkIMContext       *context);
 112 void     gtk_im_context_set_cursor_location (GtkIMContext       *context,
 113                                              const GdkRectangle *area);
 114 void     gtk_im_context_set_use_preedit     (GtkIMContext       *context,
 115                                              gboolean            use_preedit);
 116 void     gtk_im_context_set_surrounding     (GtkIMContext       *context,
 117                                              const gchar        *text,
 118                                              gint                len,
 119                                              gint                cursor_index);
 120 gboolean gtk_im_context_get_surrounding     (GtkIMContext       *context,
 121                                              gchar             **text,
 122                                              gint               *cursor_index);
 123 gboolean gtk_im_context_delete_surrounding  (GtkIMContext       *context,
 124                                              gint                offset,
 125                                              gint                n_chars);
 126
 127 G_END_DECLS
 128
 129 #endif /* __GTK_IM_CONTEXT_H__ */