IBusEngineDesc

IBusEngineDesc — Input method engine description data.

Stability Level

Stable, unless otherwise indicated

Synopsis

                    IBusEngineDesc;
                    IBusEngineDescClass;
IBusEngineDesc *    ibus_engine_desc_new                (const gchar *name,
                                                         const gchar *longname,
                                                         const gchar *description,
                                                         const gchar *language,
                                                         const gchar *license,
                                                         const gchar *author,
                                                         const gchar *icon,
                                                         const gchar *layout);
IBusEngineDesc *    ibus_engine_desc_new_from_xml_node  (XMLNode *node);
void                ibus_engine_desc_output             (IBusEngineDesc *info,
                                                         GString *output,
                                                         gint indent);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----IBusObject
               +----IBusSerializable
                     +----IBusEngineDesc

Properties

  "author"                   gchar*                : Read / Write / Construct Only
  "description"              gchar*                : Read / Write / Construct Only
  "hotkeys"                  gchar*                : Read / Write / Construct Only
  "icon"                     gchar*                : Read / Write / Construct Only
  "language"                 gchar*                : Read / Write / Construct Only
  "layout"                   gchar*                : Read / Write / Construct Only
  "license"                  gchar*                : Read / Write / Construct Only
  "longname"                 gchar*                : Read / Write / Construct Only
  "name"                     gchar*                : Read / Write / Construct Only
  "rank"                     guint                 : Read / Write / Construct Only

Description

An IBusEngineDesc stores description data of IBusEngine. The description data can either be passed to ibus_engine_desc_new(), or loaded from an XML node through ibus_engine_desc_new_from_xml_node() to construct IBusEngineDesc.

However, the recommended way to load engine description data is using ibus_component_new_from_file() to load a component file, which also includes engine description data.

see_also: IBusComponent, IBusEngine

Details

IBusEngineDesc

typedef struct _IBusEngineDesc IBusEngineDesc;

Input method engine description data. You can get extended values with g_object_get_properties. name: Name of the engine. longname: Long name of the input method engine. description: Input method engine description. language: Language (e.g. zh, jp) supported by this input method engine. license: License of the input method engine. author: Author of the input method engine. icon: Icon file of this engine. layout: Keyboard layout rank: Preference rank among engines, the highest ranked IME will put in the front. hotkeys: One or more hotkeys for switching to this engine, separated by semi-colon.


IBusEngineDescClass

typedef struct {
    IBusSerializableClass parent;
    /* class members */
} IBusEngineDescClass;


ibus_engine_desc_new ()

IBusEngineDesc *    ibus_engine_desc_new                (const gchar *name,
                                                         const gchar *longname,
                                                         const gchar *description,
                                                         const gchar *language,
                                                         const gchar *license,
                                                         const gchar *author,
                                                         const gchar *icon,
                                                         const gchar *layout);

New a IBusEngineDesc.

name :

Name of the engine.

longname :

Long name of the input method engine.

description :

Input method engine description.

language :

Language (e.g. zh, jp) supported by this input method engine.

license :

License of the input method engine.

author :

Author of the input method engine.

icon :

Icon file of this engine.

layout :

Keyboard layout

Returns :

A newly allocated IBusEngineDesc.

ibus_engine_desc_new_from_xml_node ()

IBusEngineDesc *    ibus_engine_desc_new_from_xml_node  (XMLNode *node);

New a IBusEngineDesc from an XML node.

Note

This function is called by ibus_component_new_from_file(), so developers normally do not need to call it directly.

node :

An XML node

Returns :

A newly allocated IBusEngineDesc that contains description from node.

ibus_engine_desc_output ()

void                ibus_engine_desc_output             (IBusEngineDesc *info,
                                                         GString *output,
                                                         gint indent);

Output XML-formatted input method engine description. The result will be append to GString specified in output.

info :

An IBusEngineDesc

output :

XML-formatted Input method engine description.

indent :

Number of indent (showed as 4 spaces).

Property Details

The "author" property

  "author"                   gchar*                : Read / Write / Construct Only

The author of engine description

Default value: ""


The "description" property

  "description"              gchar*                : Read / Write / Construct Only

The description of engine description

Default value: ""


The "hotkeys" property

  "hotkeys"                  gchar*                : Read / Write / Construct Only

The hotkeys of engine description

Default value: ""


The "icon" property

  "icon"                     gchar*                : Read / Write / Construct Only

The icon of engine description

Default value: "ibus-engine"


The "language" property

  "language"                 gchar*                : Read / Write / Construct Only

The language of engine description

Default value: ""


The "layout" property

  "layout"                   gchar*                : Read / Write / Construct Only

The layout of engine description

Default value: "us"


The "license" property

  "license"                  gchar*                : Read / Write / Construct Only

The license of engine description

Default value: ""


The "longname" property

  "longname"                 gchar*                : Read / Write / Construct Only

The longname of engine description

Default value: ""


The "name" property

  "name"                     gchar*                : Read / Write / Construct Only

The name of engine description

Default value: NULL


The "rank" property

  "rank"                     guint                 : Read / Write / Construct Only

The rank of engine description

Default value: 0