Collator

Object Hierarchy:

Description:

[ CCode ( ref_function = "e_collator_ref" , type_id = "e_collator_get_type ()" , unref_function = "e_collator_unref" ) ]
[ Compact ]
[ Version ( since = "3.12" ) ]
public class Collator

An opaque object used for locale specific string comparisons and sort ordering.

Namespace: E

Package: libedataserver-1.2

Content:

Static methods:

public static Quark error_quark ()

Creation methods:

public Collator (string locale) throws Error
Creates a new Collator for the given locale, the returned collator should be freed with unref.
public Collator.interpret_country (string locale, out string country_code) throws Error
Creates a new Collator for the given locale, the returned collator should be freed with unref.

Methods:

public Collator @ref ()
Increases the reference count of this.
public bool collate (string? str_a, string? str_b, out int result) throws Error
Compares str_a with str_b, the order of strings is determined by the parameters of this.
public string generate_key (string str) throws Error
Generates a collation key for str, the result of comparing two collation keys with strcmp will be the same result of calling collate on the same original strings.
public string generate_key_for_index (int index)
Generates a sort key for the given alphabetic index.
public int get_index (string str)
Checks which index, as determined by get_index_labels, that str should sort under.
public unowned string[] get_index_labels (out int n_labels, out int underflow, out int inflow, out int overflow)
Fetches the displayable labels and index positions for the active alphabet.
public void unref ()
Decreases the reference count of this.