e_collator_error_quark ()

GQuark
e_collator_error_quark (void);

e_collator_new ()

ECollator *
e_collator_new (const gchar *locale,
                GError **error);

Creates a new ECollator for the given locale , the returned collator should be freed with e_collator_unref().

Since: 3.12

e_collator_new_interpret_country ()

ECollator *
e_collator_new_interpret_country (const gchar *locale,
                                  gchar **country_code,
                                  GError **error);

Creates a new ECollator for the given locale , the returned collator should be freed with e_collator_unref().

In addition, this also reliably interprets the country code from the locale string and stores it to country_code .

Since: 3.12

e_collator_ref ()

ECollator *
e_collator_ref (ECollator *collator);

Increases the reference count of collator .

Since: 3.12

e_collator_unref ()

void
e_collator_unref (ECollator *collator);

Decreases the reference count of collator . If the reference count reaches 0 then the collator is freed

Since: 3.12

e_collator_generate_key ()

gchar *
e_collator_generate_key (ECollator *collator,
                         const gchar *str,
                         GError **error);

Generates a collation key for str , the result of comparing two collation keys with strcmp() will be the same result of calling e_collator_collate() on the same original strings.

This function will first ensure that str is valid UTF-8 encoded.

Since: 3.12

e_collator_generate_key_for_index ()

gchar *
e_collator_generate_key_for_index (ECollator *collator,
                                   gint index);

Generates a sort key for the given alphabetic index .

The generated sort key is guaranteed to sort below any sort keys for words beginning with any variant of the given letter.

For instance, a sort key generated for the index 5 of a latin alphabet, where the fifth index is 'E' will sort below any sort keys generated for words starting with the characters 'e', 'E', 'é', 'É', 'è' or 'È'. It will also sort above any sort keys generated for words starting with the characters 'd' or 'D'.

Since: 3.12

e_collator_collate ()

gboolean
e_collator_collate (ECollator *collator,
                    const gchar *str_a,
                    const gchar *str_b,
                    gint *result,
                    GError **error);

Compares str_a with str_b , the order of strings is determined by the parameters of collator .

The result will be set to integer less than, equal to, or greater than zero if str_a is found, respectively, to be less than, to match, or be greater than str_b .

Either str_a or str_b can be NULL, NULL strings are considered to sort below other strings.

This function will first ensure that both strings are valid UTF-8.

Since: 3.12

e_collator_get_index_labels ()

const gchar *const  *
e_collator_get_index_labels (ECollator *collator,
                             gint *n_labels,
                             gint *underflow,
                             gint *inflow,
                             gint *overflow);

Fetches the displayable labels and index positions for the active alphabet.

Since: 3.12

e_collator_get_index ()

gint
e_collator_get_index (ECollator *collator,
                      const gchar *str);

Checks which index, as determined by e_collator_get_index_labels(), that str should sort under.

Since: 3.12

E_COLLATOR_ERROR

#define E_COLLATOR_ERROR (e_collator_error_quark ())

An error domain for collation errors

Since: 3.12

enum ECollatorError

Errors from the E_COLLATOR_ERROR domain.

ECollator

typedef struct _ECollator ECollator;

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

Since: 3.12