include/unihan_property.h File Reference

Go to the source code of this file.

Data Structures
struct	_UnihanProperty
	Struct to hold an input method property. More...
struct	_UnihanPropertyList
	Struct to hold a set of properties. More...
Defines
#define	UNIHAN_PROPERTY_ACTIVE   1
#define	UNIHAN_PROPERTY_VISIBLE   2
Typedefs
typedef _UnihanProperty	UnihanProperty
	Struct to hold an input method property.
typedef _UnihanPropertyList	UnihanPropertyList
	Struct to hold a set of properties.

---

Define Documentation

#define UNIHAN_PROPERTY_ACTIVE   1

#define UNIHAN_PROPERTY_VISIBLE   2

---

Typedef Documentation

typedef struct _UnihanProperty UnihanProperty

Struct to hold an input method property.

For example, a Chinese input method may have properties to indicate the full/half input mode of punctuations and letters.

The members are:

• key An unique key string to identify this property. Multiple properties can be organized as a tree, by using file path like key string. For example: /PropertyRoot /PropertyRoot/PropOne /PropertyRoot/PropTwo /PropertyRoot/PropThree /PropertyRoot/PropThree/PropFour /PropertyRoot/PropThree/PropFive

In this example, there are six properties, which are organized into a two level tree. The root of this tree is the property "/PropertyRoot". The property "/PropertyRoot/PropThree" is a subroot which contains two sub properties.

This properties tree can be shown as a multilevel menu in GUI.

• label The label string of this property shown by GUI.

• icon The path of the icon file of this property.

• tip The tip (simple help) of this property.

• state The state mask of this property, can be combined by following mask: UNIHAN_PROPERTY_ACTIVE 1 UNIHAN_PROPERTY_VISIBLE 2 UNIHAN_PROPERTY_RADIO UNIHAN_PROPERTY_CHECK If UNIHAN_PROPERTY_ACTIVE is set then this property is active and can be toggled by user. If UNIHAN_PROPERTY_VISIBLE is set then this property is visible to user.

typedef struct _UnihanPropertyList UnihanPropertyList

Struct to hold a set of properties.

The members are:

• nr_properties The number of properties in this list.
• properties Array to hold the properties.

---