SkkRomKanaConverter: Reference Manual

Functions

gboolean	skk_rom_kana_converter_is_valid ()
gboolean	skk_rom_kana_converter_output_nn_if_any ()
void	skk_rom_kana_converter_append_text ()
gboolean	skk_rom_kana_converter_append ()
gboolean	skk_rom_kana_converter_can_consume ()
void	skk_rom_kana_converter_reset ()
gboolean	skk_rom_kana_converter_delete ()
SkkRomKanaConverter *	skk_rom_kana_converter_new ()
SkkKanaMode	skk_rom_kana_converter_get_kana_mode ()
void	skk_rom_kana_converter_set_kana_mode ()
SkkPeriodStyle	skk_rom_kana_converter_get_period_style ()
void	skk_rom_kana_converter_set_period_style ()
const gchar *	skk_rom_kana_converter_get_output ()
const gchar *	skk_rom_kana_converter_get_preedit ()

Properties

SkkKanaMode	kana-mode	Read / Write
gchar *	output	Read / Write
SkkPeriodStyle	period-style	Read / Write
gchar *	preedit	Read
SkkRomKanaMapFile *	rule	Read / Write

Types and Values

#define	SKK_TYPE_ROM_KANA_CONVERTER
struct	SkkRomKanaConverter
struct	SkkRomKanaConverterClass
enum	SkkKanaMode
enum	SkkPeriodStyle

Object Hierarchy

    GEnum
    ├── SkkKanaMode
    ╰── SkkPeriodStyle
    GObject
    ╰── SkkRomKanaConverter

Description

Functions

skk_rom_kana_converter_is_valid ()

gboolean
skk_rom_kana_converter_is_valid (SkkRomKanaConverter *self,
                                 gunichar uc);

Parameters

self	the SkkRomKanaConverter instance
uc

skk_rom_kana_converter_output_nn_if_any ()

gboolean
skk_rom_kana_converter_output_nn_if_any
                               (SkkRomKanaConverter *self);

Output "nn" if preedit ends with "n".

Parameters

self

the SkkRomKanaConverter instance

skk_rom_kana_converter_append_text ()

void
skk_rom_kana_converter_append_text (SkkRomKanaConverter *self,
                                    const gchar *text);

Append text to the internal buffer.

Parameters

self

the SkkRomKanaConverter instance

text

.

a string

.

[in]

skk_rom_kana_converter_append ()

gboolean
skk_rom_kana_converter_append (SkkRomKanaConverter *self,
                               gunichar uc);

Append a character to the internal buffer.

Parameters

self

the SkkRomKanaConverter instance

uc

.

an ASCII character

.

[in]

Returns

`true` if the character is handled, `false` otherwise

skk_rom_kana_converter_can_consume ()

gboolean
skk_rom_kana_converter_can_consume (SkkRomKanaConverter *self,
                                    gunichar uc,
                                    gboolean preedit_only,
                                    gboolean no_carryover);

Check if a character will be consumed by the current conversion.

Parameters

self	the SkkRomKanaConverter instance
uc	. an ASCII character .	[in]
preedit_only	. only checks if preedit is active .	[in]
no_carryover	. return false if there will be carryover .	[in]

Returns

`true` if the character can be consumed

skk_rom_kana_converter_reset ()

void
skk_rom_kana_converter_reset (SkkRomKanaConverter *self);

Reset the internal state of the converter.

Parameters

self

the SkkRomKanaConverter instance

skk_rom_kana_converter_delete ()

gboolean
skk_rom_kana_converter_delete (SkkRomKanaConverter *self);

Delete the trailing character from the internal buffer.

Parameters

self

the SkkRomKanaConverter instance

Returns

`true` if any character is removed, `false` otherwise

skk_rom_kana_converter_new ()

SkkRomKanaConverter *
skk_rom_kana_converter_new (void);

skk_rom_kana_converter_get_kana_mode ()

SkkKanaMode
skk_rom_kana_converter_get_kana_mode (SkkRomKanaConverter *self);

Get and return the current value of the "kana-mode" property.

Parameters

self

the SkkRomKanaConverter instance to query

Returns

the value of the "kana-mode" property

skk_rom_kana_converter_set_kana_mode ()

void
skk_rom_kana_converter_set_kana_mode (SkkRomKanaConverter *self,
                                      SkkKanaMode value);

Set the value of the "kana-mode" property to value .

Parameters

self	the SkkRomKanaConverter instance to modify
value	the new value of the "kana-mode" property

skk_rom_kana_converter_get_period_style ()

SkkPeriodStyle
skk_rom_kana_converter_get_period_style
                               (SkkRomKanaConverter *self);

Get and return the current value of the "period-style" property.

Parameters

self

the SkkRomKanaConverter instance to query

Returns

the value of the "period-style" property

skk_rom_kana_converter_set_period_style ()

void
skk_rom_kana_converter_set_period_style
                               (SkkRomKanaConverter *self,
                                SkkPeriodStyle value);

Set the value of the "period-style" property to value .

Parameters

self	the SkkRomKanaConverter instance to modify
value	the new value of the "period-style" property

skk_rom_kana_converter_get_output ()

const gchar *
skk_rom_kana_converter_get_output (SkkRomKanaConverter *self);

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

Parameters

self

the SkkRomKanaConverter instance to query

Returns

the value of the "output" property

skk_rom_kana_converter_get_preedit ()

const gchar *
skk_rom_kana_converter_get_preedit (SkkRomKanaConverter *self);

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

Parameters

self

the SkkRomKanaConverter instance to query

Returns

the value of the "preedit" property

Types and Values

SKK_TYPE_ROM_KANA_CONVERTER

#define SKK_TYPE_ROM_KANA_CONVERTER (skk_rom_kana_converter_get_type ())

The type for SkkRomKanaConverter.

struct SkkRomKanaConverter

struct SkkRomKanaConverter;

Romaji-to-kana converter.

struct SkkRomKanaConverterClass

struct SkkRomKanaConverterClass {
	GObjectClass parent_class;
};

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

Members

enum SkkKanaMode

Type representing kana scripts.

Members

SKK_KANA_MODE_HIRAGANA	Hiragana like "あいう...".
SKK_KANA_MODE_KATAKANA	Katakana like "アイウ...".
SKK_KANA_MODE_HANKAKU_KATAKANA	Half-width katakana like "ｱｲｳ...".

enum SkkPeriodStyle

Type to specify how "." and "," are converted.

Members

SKK_PERIOD_STYLE_JA_JA	Use "。" and "、" for "." and ",".
SKK_PERIOD_STYLE_EN_EN	Use "．" and "，" for "." and ",".
SKK_PERIOD_STYLE_JA_EN	Use "。" and "，" for "." and ",".
SKK_PERIOD_STYLE_EN_JA	Use "．" and "、" for "." and ",".

Property Details

The `“kana-mode”` property

  “kana-mode”                SkkKanaMode

kana-mode.

Owner: SkkRomKanaConverter

Flags: Read / Write

Default value: SKK_KANA_MODE_HIRAGANA

The `“output”` property

  “output”                   gchar *

output.

Owner: SkkRomKanaConverter

Flags: Read / Write

Default value: NULL

The `“period-style”` property

  “period-style”             SkkPeriodStyle

period-style.

Owner: SkkRomKanaConverter

Flags: Read / Write

Default value: SKK_PERIOD_STYLE_JA_JA

The `“preedit”` property

  “preedit”                  gchar *

preedit.

Owner: SkkRomKanaConverter

Flags: Read

Default value: NULL

The `“rule”` property

  “rule”                     SkkRomKanaMapFile *

rule.

Owner: SkkRomKanaConverter

Flags: Read / Write