KkcRuleMetadata

KkcRuleMetadata — Object describing a rule.

Functions

Properties

gchar * filter Read / Write / Construct
gint priority Read / Write / Construct
KkcKeyEventFilter * filter Read / Write / Construct
KkcRuleMetadata * metadata Read / Write / Construct

Types and Values

Object Hierarchy

    GObject
    ├── KkcMetadataFile
       ╰── KkcRuleMetadata
    ╰── KkcRule
        ╰── KkcUserRule

Implemented Interfaces

KkcRuleMetadata implements GInitable.

KkcRule implements GInitable.

Description

Functions

kkc_rule_metadata_create_key_event_filter ()

KkcKeyEventFilter *
kkc_rule_metadata_create_key_event_filter
                               (KkcRuleMetadata *self);

Parameters

self

the KkcRuleMetadata instance

 

kkc_rule_metadata_locate_map_file ()

gchar *
kkc_rule_metadata_locate_map_file (KkcRuleMetadata *self,
                                   const gchar *type,
                                   const gchar *name);

Return the path of the map file.

Parameters

self

the KkcRuleMetadata instance

 

type

 .

type of the map file

.

[in]

name

 .

name of the map file

.

[in]

Returns

the absolute path of the map file


kkc_rule_metadata_new ()

KkcRuleMetadata *
kkc_rule_metadata_new (const gchar *name,
                       const gchar *filename,
                       GError **error);

Parameters

name

 

 

filename

 

 

error

location to store the error occuring, or NULL to ignore

 

kkc_rule_metadata_get_filter ()

const gchar *
kkc_rule_metadata_get_filter (KkcRuleMetadata *self);

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

Name of key event filter.

Parameters

self

the KkcRuleMetadata instance to query

 

Returns

the value of the "filter" property


kkc_rule_metadata_set_filter ()

void
kkc_rule_metadata_set_filter (KkcRuleMetadata *self,
                              const gchar *value);

Set the value of the "filter" property to value .

Name of key event filter.

Parameters

self

the KkcRuleMetadata instance to modify

 

value

the new value of the "filter" property

 

kkc_rule_metadata_get_priority ()

gint
kkc_rule_metadata_get_priority (KkcRuleMetadata *self);

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

Priority of the rule.

Parameters

self

the KkcRuleMetadata instance to query

 

Returns

the value of the "priority" property


kkc_rule_metadata_set_priority ()

void
kkc_rule_metadata_set_priority (KkcRuleMetadata *self,
                                gint value);

Set the value of the "priority" property to value .

Priority of the rule.

Parameters

self

the KkcRuleMetadata instance to modify

 

value

the new value of the "priority" property

 

kkc_rule_metadata_find ()

KkcRuleMetadata *
kkc_rule_metadata_find (const gchar *name);

Locate a rule metadata by name.

Parameters

name

 .

name of the rule

.

[in]

Returns

a RuleMetadata or `null`


kkc_rule_get_keymap ()

KkcKeymap *
kkc_rule_get_keymap (KkcRule *self,
                     KkcInputMode mode);

Parameters

self

the KkcRule instance

 

mode

 

 

kkc_rule_new ()

KkcRule *
kkc_rule_new (KkcRuleMetadata *metadata,
              GError **error);

Create a rule.

Parameters

metadata

 .

metadata of the rule

.

[in]

error

location to store the error occuring, or NULL to ignore

 

Returns

a new Rule


kkc_rule_get_metadata ()

KkcRuleMetadata *
kkc_rule_get_metadata (KkcRule *self);

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

Metadata associated with the rule.

Parameters

self

the KkcRule instance to query

 

Returns

the value of the "metadata" property


kkc_rule_set_metadata ()

void
kkc_rule_set_metadata (KkcRule *self,
                       KkcRuleMetadata *value);

Set the value of the "metadata" property to value .

Metadata associated with the rule.

Parameters

self

the KkcRule instance to modify

 

value

the new value of the "metadata" property

 

kkc_rule_get_filter ()

KkcKeyEventFilter *
kkc_rule_get_filter (KkcRule *self);

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

Parameters

self

the KkcRule instance to query

 

Returns

the value of the "filter" property


kkc_rule_set_filter ()

void
kkc_rule_set_filter (KkcRule *self,
                     KkcKeyEventFilter *value);

Set the value of the "filter" property to value .

Parameters

self

the KkcRule instance to modify

 

value

the new value of the "filter" property

 

kkc_rule_list ()

KkcRuleMetadata **
kkc_rule_list (int *result_length1);

List rules.

Returns

an array of RuleMetadata

.

[array length=result_length1]

Types and Values

KKC_TYPE_RULE_METADATA

#define KKC_TYPE_RULE_METADATA (kkc_rule_metadata_get_type ())

The type for KkcRuleMetadata.


struct KkcRuleMetadata

struct KkcRuleMetadata;

Object describing a rule.


struct KkcRuleMetadataClass

struct KkcRuleMetadataClass {
	KkcMetadataFileClass parent_class;
};

The class structure for KKC_TYPE_RULE_METADATA. All the fields in this structure are private and should never be accessed directly.

Members


KKC_TYPE_RULE

#define KKC_TYPE_RULE (kkc_rule_get_type ())

The type for KkcRule.


struct KkcRule

struct KkcRule;

Object representing a typing rule.


struct KkcRuleClass

struct KkcRuleClass {
	GObjectClass parent_class;
};

The class structure for KKC_TYPE_RULE. All the fields in this structure are private and should never be accessed directly.

Members


enum KkcRuleParseError

Members

KKC_RULE_PARSE_ERROR_FAILED

   

Property Details

The “filter” property

  “filter”                   gchar *

Name of key event filter.

Flags: Read / Write / Construct

Default value: NULL


The “priority” property

  “priority”                 gint

Priority of the rule.

Flags: Read / Write / Construct

Default value: 0


The “filter” property

  “filter”                   KkcKeyEventFilter *

filter.

Flags: Read / Write / Construct


The “metadata” property

  “metadata”                 KkcRuleMetadata *

Metadata associated with the rule.

Flags: Read / Write / Construct