ibus/interface/ienginefactory.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__ = ("IEngineFactory", )
  23
  24 import dbus.service
  25 from ibus.common import \
  26         IBUS_ENGINE_FACTORY_IFACE
  27
  28 class IEngineFactory (dbus.service.Object):
  29         # define method decorator.
  30         method = lambda **args: \
  31                 dbus.service.method (dbus_interface = IBUS_ENGINE_FACTORY_IFACE, \
  32                                                         **args)
  33
  34         # define async method decorator.
  35         async_method = lambda **args: \
  36                 dbus.service.method (dbus_interface = IBUS_ENGINE_FACTORY_IFACE, \
  37                                                         async_callbacks = ("reply_cb", "error_cb"), \
  38                                                         **args)
  39         # Return a array. [name, default_language, icon_path, authors, credits]
  40         @method (out_signature = "as")
  41         def GetInfo (self): pass
  42
  43         # Factory should allocate all resources in this method
  44         @method ()
  45         def Initialize (self): pass
  46
  47         # Factory should free all allocated resources in this method
  48         @method ()
  49         def Uninitialize (self): pass
  50
  51         # Create an input context and return the id of the context.
  52         # If failed, it will return "" or None.
  53         @method (out_signature = "o")
  54         def CreateEngine (self): pass
  55