SkkRule

SkkRule — Object representing a typing rule.

Functions

Properties

Types and Values

Object Hierarchy

    GBoxed
    ╰── SkkRuleMetadata
    GObject
    ╰── SkkRule

Description

Functions

skk_rule_new ()

SkkRule *
skk_rule_new (const gchar *name,
              GError **error);

Create a rule.

Parameters

name

 .

name of the rule to load

.

[in]

error

location to store the error occurring, or NULL to ignore.

[error-domains SkkRuleParseError]

Returns

a new Rule


skk_rule_get_metadata ()

void
skk_rule_get_metadata (SkkRule *self,
                       SkkRuleMetadata *result);

Get and return the current value of the "metadata" property.

Metadata associated with the rule.

Parameters

self

the SkkRule instance to query

 

Returns

the value of the "metadata" property


skk_rule_find_rule ()

SkkRuleMetadata *
skk_rule_find_rule (const gchar *name);

Locate a rule by name.

Parameters

name

 .

name of the rule

.

[in]

Returns

a RuleMetadata or `null`


skk_rule_list ()

SkkRuleMetadata *
skk_rule_list (gint *result_length1);

List rules.

Returns

an array of RuleMetadata

.

[array length=result_length1]


skk_rule_metadata_locate_map_file ()

gchar *
skk_rule_metadata_locate_map_file (SkkRuleMetadata *self,
                                   const gchar *type,
                                   const gchar *name);

Return the path of the map file.

Parameters

self

the SkkRuleMetadata instance

 

type

 .

type of the map file

.

[in]

name

 .

name of the map file

.

[in]

Returns

the absolute path of the map file


skk_rule_metadata_dup ()

SkkRuleMetadata *
skk_rule_metadata_dup (const SkkRuleMetadata *self);

Creates a copy of self.

See also: skk_rule_metadata_copy(), skk_rule_metadata_destroy(), skk_rule_metadata_free()

Parameters

self

the instance to duplicate

 

Returns

a copy of self , free with skk_rule_metadata_free()


skk_rule_metadata_free ()

void
skk_rule_metadata_free (SkkRuleMetadata *self);

Frees the heap-allocated struct.

See also: skk_rule_metadata_dup(), skk_rule_metadata_copy(), skk_rule_metadata_destroy()

Parameters

self

the struct to free

 

skk_rule_metadata_copy ()

void
skk_rule_metadata_copy (const SkkRuleMetadata *self,
                        SkkRuleMetadata *dest);

Creates a copy of self.

See also: skk_rule_metadata_dup(), skk_rule_metadata_destroy(), skk_rule_metadata_free()

Parameters

self

the struct to copy

 

dest

a unused struct. Use skk_rule_metadata_destroy() to free the content.

 

skk_rule_metadata_destroy ()

void
skk_rule_metadata_destroy (SkkRuleMetadata *self);

Frees the content of the struct pointed by self .

See also: skk_rule_metadata_dup(), skk_rule_metadata_copy(), skk_rule_metadata_free()

Parameters

self

the struct to destroy

 

Types and Values

SKK_TYPE_RULE

#define SKK_TYPE_RULE (skk_rule_get_type ())

The type for SkkRule.


struct SkkRule

struct SkkRule;

Object representing a typing rule.


struct SkkRuleClass

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.

Members


enum SkkRuleParseError

Members

SKK_RULE_PARSE_ERROR_FAILED

   

struct SkkRuleMetadata

struct SkkRuleMetadata {
	gchar* base_dir;
	gchar* name;
	gchar* label;
	gchar* description;
	gchar* filter;
};

Object describing a rule.

Members

gchar *base_dir;

Base directory.

 

gchar *name;

Name of the rule.

 

gchar *label;

Label string of the rule.

 

gchar *description;

Description of the rule.

 

gchar *filter;

Name of key event filter.

 

Property Details

The “metadata” property

  “metadata”                 SkkRuleMetadata *

Metadata associated with the rule.

Owner: SkkRule

Flags: Read