Method

EDataBookBookCachecursor_set_target_alphabetic_index

since: 3.26

Declaration [src]

void
e_book_cache_cursor_set_target_alphabetic_index (
  EBookCache* book_cache,
  EBookCacheCursor* cursor,
  gint idx
)

Description [src]

Sets the cursor position to an Alphabetic Index into the alphabet active in book_caches locale.

After setting the target to an alphabetic index, for example the index for letter ‘E’, then further calls to e_book_cache_cursor_step() will return results starting with the letter ‘E’ (or results starting with the last result in ‘D’, if moving in a negative direction).

The passed index must be a valid index in the active locale, knowledge on the currently active alphabet index must be obtained using ECollator APIs.

Use e_book_cache_ref_collator() to obtain the active collator for book_cache.

Available since: 3.26

Parameters

cursor

Type: EBookCacheCursor

The EBookCacheCursor to modify.

The data is owned by the caller of the method.
idx

Type: gint

The alphabetic index.