Camel.Index¶

Subclasses:	`Camel.TextIndex`

Methods¶

Inherited:	GObject.Object (37)
Structs:	GObject.ObjectClass (5)

	`add_name` (name)
	`compress` ()
	`construct` (path, flags)
	`delete` ()
	`delete_name` (name)
	`find` (word)
	`find_name` (name)
	`has_name` (name)
	`rename` (path)
	`set_normalize` (func, *user_data)
	`sync` ()
	`words` ()
	`write_name` (idn)

Virtual Methods¶

Inherited:	GObject.Object (7)

	`do_add_name` (name)
	`do_compress` ()
	`do_delete_` ()
	`do_delete_name` (name)
	`do_find` (word)
	`do_find_name` (name)
	`do_has_name` (name)
	`do_rename` (path)
	`do_sync` ()
	`do_words` ()
	`do_write_name` (idn)

Properties¶

None

Signals¶

Inherited:	GObject.Object (1)

Fields¶

Inherited:	GObject.Object (1)

Name	Type	Access
flags	`int`	r
normalize	`Camel.IndexNorm`	r
normalize_data	`object`	r
parent	`GObject.Object`	r
path	`str`	r
state	`int`	r
version	`int`	r

Class Details¶

class Camel.Index(**kwargs)¶

Bases:	`GObject.Object`
Abstract:	No
Structure:	`Camel.IndexClass`

add_name(name)¶

Parameters:	name (`str`) – a name to add
Returns:	a `Camel.IndexName` with added given name, or `None`, when the name could not be added.
Return type:	`Camel.IndexName` or `None`

compress()¶

Return type:	`int`

construct(path, flags)¶

Parameters:	path (`str`) – flags (`int`) –

delete()¶

Return type:	`int`

delete_name(name)¶

Parameters:	name (`str`) – a name to delete

Deletes the given name from self.

find(word)¶

Parameters:	word (`str`) – a word to find
Returns:	a `Camel.IndexCursor` object with the given word, or `None`, when not found
Return type:	`Camel.IndexCursor` or `None`

find_name(name)¶

Parameters:	name (`str`) – a name to find
Returns:	a `Camel.IndexCursor` with the given name, or `None`< when not found.
Return type:	`Camel.IndexCursor` or `None`

has_name(name)¶

Parameters:	name (`str`) –
Return type:	`int`

rename(path)¶

Parameters:	path (`str`) –
Return type:	`int`

set_normalize(func, *user_data)¶

Parameters:	func (`Camel.IndexNorm`) – normalization function user_data (`object` or `None`) – user data for func

New in version 2.32.

sync()¶

Return type:	`int`

words()¶

Returns:	a `Camel.IndexCursor` containing all words of the self, or `None`, when there are none
Return type:	`Camel.IndexCursor` or `None`

write_name(idn)¶

Parameters:	idn (`Camel.IndexName`) –
Return type:	`int`

do_add_name(name) virtual¶

Parameters:	name (`str`) – a name to add
Returns:	a `Camel.IndexName` with added given name, or `None`, when the name could not be added.
Return type:	`Camel.IndexName` or `None`

do_compress() virtual¶

Return type:	`int`

do_delete_() virtual¶

Return type:	`int`

do_delete_name(name) virtual¶

Parameters:	name (`str`) – a name to delete

Deletes the given name from index.

do_find(word) virtual¶

Parameters:	word (`str`) – a word to find
Returns:	a `Camel.IndexCursor` object with the given word, or `None`, when not found
Return type:	`Camel.IndexCursor` or `None`

do_find_name(name) virtual¶

Parameters:	name (`str`) – a name to find
Returns:	a `Camel.IndexCursor` with the given name, or `None`< when not found.
Return type:	`Camel.IndexCursor` or `None`

do_has_name(name) virtual¶

Parameters:	name (`str`) –
Return type:	`int`

do_rename(path) virtual¶

Parameters:	path (`str`) –
Return type:	`int`

do_sync() virtual¶

Return type:	`int`

do_words() virtual¶

Returns:	a `Camel.IndexCursor` containing all words of the index, or `None`, when there are none
Return type:	`Camel.IndexCursor` or `None`

do_write_name(idn) virtual¶

Parameters:	idn (`Camel.IndexName`) –
Return type:	`int`