ibus/interface/iengine.py

   1 # vim:set noet ts=4:
   2 #
   3 # ibus - The Input Bus
   4 #
   5 # Copyright (c) 2007-2008 Huang Peng <shawn.p.huang@gmail.com>
   6 #
   7 # This library is free software; you can redistribute it and/or
   8 # modify it under the terms of the GNU Lesser General Public
   9 # License as published by the Free Software Foundation; either
  10 # version 2 of the License, or (at your option) any later version.
  11 #
  12 # This library is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU Lesser General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU Lesser General Public
  18 # License along with this program; if not, write to the
  19 # Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  20 # Boston, MA  02111-1307  USA
  21
  22 __all__ = ("IEngine", )
  23
  24 import dbus.service
  25 from ibus.common import \
  26         IBUS_ENGINE_IFACE
  27
  28 class IEngine (dbus.service.Object):
  29         # define method decorator.
  30         method = lambda **args: \
  31                 dbus.service.method (dbus_interface = IBUS_ENGINE_IFACE, \
  32                                                         **args)
  33
  34         # define signal decorator.
  35         signal = lambda **args: \
  36                 dbus.service.signal (dbus_interface = IBUS_ENGINE_IFACE, \
  37                                                         **args)
  38
  39         # define async method decorator.
  40         async_method = lambda **args: \
  41                 dbus.service.method (dbus_interface = IBUS_ENGINE_IFACE, \
  42                                                         async_callbacks = ("reply_cb", "error_cb"), \
  43                                                         **args)
  44
  45         @method (in_signature = "ubu", out_signature = "b")
  46         def ProcessKeyEvent (self, keyval, is_press, state):
  47                 pass
  48
  49         @method (in_signature = "iiii")
  50         def SetCursorLocation (self, x, y, w, h): pass
  51
  52         @method ()
  53         def FocusIn (self): pass
  54
  55         @method ()
  56         def FocusOut (self): pass
  57
  58         @method ()
  59         def Reset (self): pass
  60
  61         # signals for lookup table
  62         @method ()
  63         def PageUp (self): pass
  64
  65         @method ()
  66         def PageDown (self): pass
  67
  68         @method ()
  69         def CursorUp (self): pass
  70
  71         @method ()
  72         def CursorDown (self): pass
  73
  74         @method (in_signature = "b")
  75         def SetEnable (self, enable): pass
  76
  77         @method (in_signature = "si")
  78         def PropertyActivate (self, prop_name, prop_state): pass
  79
  80         @method (in_signature = "s")
  81         def PropertyShow (self, prop_name): pass
  82
  83         @method (in_signature = "s")
  84         def PropertyHide (self, prop_name): pass
  85
  86         @method ()
  87         def Destroy (self): pass
  88
  89         @signal (signature="s")
  90         def CommitString (self, text): pass
  91
  92         @signal (signature="ubu")
  93         def ForwardKeyEvent (self, keyval, is_press, state): pass
  94
  95         @signal (signature="saauib")
  96         def UpdatePreedit (self, text, attrs, cursor_pos, visible): pass
  97
  98         @signal (signature="svb")
  99         def UpdateAuxString (self, text, attrs, visible): pass
 100
 101         @signal (signature="vb")
 102         def UpdateLookupTable (self, lookup_table, visible): pass
 103
 104         @signal (signature="v")
 105         def RegisterProperties (self, props): pass
 106
 107         @signal (signature="v")
 108         def UpdateProperty (self, prop): pass
 109