![]() |
![]() |
![]() |
libskk Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#define SKK_TYPE_RULE SkkRule * skk_rule_new (const gchar *name
,GError **error
); void skk_rule_get_metadata (SkkRule *self
,SkkRuleMetadata *result
); SkkRuleMetadata * skk_rule_find_rule (const gchar *name
); SkkRuleMetadata * skk_rule_list (int *result_length1
); struct SkkRule; struct SkkRuleClass; enum SkkRuleParseError; gchar * skk_rule_metadata_locate_map_file (SkkRuleMetadata *self
,const gchar *type
,const gchar *name
); struct SkkRuleMetadata; SkkRuleMetadata * skk_rule_metadata_dup (const SkkRuleMetadata *self
); void skk_rule_metadata_free (SkkRuleMetadata *self
);
SkkRule * skk_rule_new (const gchar *name
,GError **error
);
Create a rule.
|
name of the rule to load. [in] |
|
location to store the error occuring, or NULL to ignore. [error-domains SkkRuleParseError]
|
Returns : |
a new Rule |
void skk_rule_get_metadata (SkkRule *self
,SkkRuleMetadata *result
);
Get and return the current value of the "metadata" property.
|
the SkkRule instance to query |
Returns : |
the value of the "metadata" property |
SkkRuleMetadata * skk_rule_find_rule (const gchar *name
);
Locate a rule by name.
|
name of the rule. [in] |
Returns : |
a RuleMetadata or `null` |
SkkRuleMetadata * skk_rule_list (int *result_length1
);
List rules.
Returns : |
an array of RuleMetadata. [array length=result_length1] |
struct SkkRuleClass { GObjectClass parent_class; };
The class structure for SKK_TYPE_RULE
. All the fields in this structure are private and should never be accessed directly.
gchar * skk_rule_metadata_locate_map_file (SkkRuleMetadata *self
,const gchar *type
,const gchar *name
);
Return the path of the map file.
|
the SkkRuleMetadata instance |
|
type of the map file. [in] |
|
name of the map file. [in] |
Returns : |
the absolute path of the map file |
struct SkkRuleMetadata { gchar* base_dir; gchar* name; gchar* label; gchar* description; gchar* filter; };
Object describing a rule.