_UnihanProperty Struct Reference

Struct to hold an input method property. More...

#include <unihan_property.h>

Data Fields
const char *	key
const char *	label
const char *	icon
const char *	tip
int	state

---

Detailed Description

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.

---

Field Documentation

const char* _UnihanProperty::key

const char* _UnihanProperty::label

const char* _UnihanProperty::icon

const char* _UnihanProperty::tip

int _UnihanProperty::state

---

The documentation for this struct was generated from the following file:

• include/unihan_property.h

---