GOffice.String

Fields

Name	Type	Access	Description
str	str	r/w	the embeded UTF-8 string

Methods

class	ERROR ()
class	append_c_n (target, c, n)
class	append_gstring (target, src)
class	cmp (gstr_a, gstr_b)
class	cmp_ignorecase (gstr_a, gstr_b)
class	equal (gstr_a, gstr_b)
class	equal_ignorecase (gstr_a, gstr_b)
class	equal_rich (gstr_a, gstr_b)
class	foreach_base (callback, *data)
class	hash (gstr)
class	new (str)
class	new_len (str, len)
class	new_nocopy (str)
class	new_nocopy_len (str, len)
class	new_rich (str, byte_len, markup, phonetic)
class	new_rich_nocopy (str, byte_len, markup, phonetic)
class	replace (target, pos, oldlen, txt, newlen)
	get_casefold ()
	get_casefolded_collate ()
	get_collation ()
	get_len ()
	get_markup ()
	get_ref_count ()
	ref ()
	trim (internal)
	unref ()

Details

class GOffice.String

GOffice.String is a structure containing a string.

classmethod ERROR()

Returns:

A string saying ‘ERROR’ but does not add a ref to it.

Return type:

GOffice.String

A convenience for g_return_val to share one error string without adding a reference to functions that do not add references to the result

classmethod append_c_n(target, c, n)

Parameters:

• target (GLib.String) –

• c (int) –

• n (int) –

classmethod append_gstring(target, src)

Parameters:

• target (GLib.String) –

• src (GLib.String) –

classmethod cmp(gstr_a, gstr_b)

Parameters:

• gstr_a (object or None) –

• gstr_b (object or None) –

Return type:

int

classmethod cmp_ignorecase(gstr_a, gstr_b)

Parameters:

• gstr_a (object or None) –

• gstr_b (object or None) –

Return type:

int

classmethod equal(gstr_a, gstr_b)

Parameters:

• gstr_a (object or None) –

• gstr_b (object or None) –

Return type:

bool

classmethod equal_ignorecase(gstr_a, gstr_b)

Parameters:

• gstr_a (object or None) – string.

• gstr_b (object or None) – string.

Returns:

True if the two strings are equal when ignoring letter case.

Return type:

bool

classmethod equal_rich(gstr_a, gstr_b)

Parameters:

• gstr_a (object or None) – string.

• gstr_b (object or None) – string.

Return type:

bool

classmethod foreach_base(callback, *data)

Parameters:

• callback (GLib.HFunc) – callback

• data (object or None) – user data

Iterates through the strings data base and apply callback to each.

classmethod hash(gstr)

Parameters:

gstr (object or None) –

Return type:

int

classmethod new(str)

Parameters:

str (str) – string (optionally None)

Returns:

a reference to a GOffice.String containing str, or None if str is None

Return type:

GOffice.String

GOffice.String duplicates str if no string already exists.

classmethod new_len(str, len)

Parameters:

• str (str) – string (optionally None)

• len (int) – guint32

Returns:

a reference to a GOffice.String containing str, or None if str is None

Return type:

GOffice.String

GOffice.String duplicates str if no string already exists.

classmethod new_nocopy(str)

Parameters:

str (str) – string

Returns:

a reference to a GOffice.String containing str

Return type:

GOffice.String

GOffice.String takes ownership of str

classmethod new_nocopy_len(str, len)

Parameters:

• str (str) – string (optionally None)

• len (int) – guint32

Returns:

a reference to a GOffice.String containing str

Return type:

GOffice.String

GOffice.String takes ownership of str

classmethod new_rich(str, byte_len, markup, phonetic)

Parameters:

• str (str) – string.

• byte_len (int) – < 0 will call strlen.

• markup (Pango.AttrList) – optionally None list, GOffice.String steals the ref.

• phonetic (GOffice.StringPhonetic) – optionally None list of phonetic extensions, GOffice.String steals the ref.

Returns:

a string.

Return type:

GOffice.String

classmethod new_rich_nocopy(str, byte_len, markup, phonetic)

Parameters:

• str (str) – string; GOffice.String takes ownership

• byte_len (int) – < 0 will call strlen.

• markup (Pango.AttrList) – optionally None list, GOffice.String steals the ref.

• phonetic (GOffice.StringPhonetic) – optionally None list of phonetic extensions, GOffice.String steals the ref.

Returns:

a string.

Return type:

GOffice.String

classmethod replace(target, pos, oldlen, txt, newlen)

Parameters:

• target (GLib.String) –

• pos (int) –

• oldlen (int) –

• txt (str) –

• newlen (int) –

get_casefold()

Return type:

str

get_casefolded_collate()

Return type:

str

get_collation()

Return type:

str

get_len()

Return type:

int

get_markup()

Return type:

Pango.AttrList

get_ref_count()

Return type:

int

ref()

Return type:

GOffice.String

trim(internal)

Parameters:

internal (bool) – Trim multiple consequtive internal spaces.

Returns:

self

Return type:

GOffice.String

unref()