[evolution-data-server/october-code-drop-post-api-change: 9/39] e-book-contacts-types.h: New flags type for new cursor step API

[Tristan Van Berkom <tvb src gnome org>]

commit e7296a3ea43d8855ed7ae0bbce3ddafcda9701ed
Author: Tristan Van Berkom <tristanvb openismus com>
Date:   Fri Oct 18 22:38:36 2013 +0200

    e-book-contacts-types.h: New flags type for new cursor step API

 .../libebook-contacts/e-book-contacts-types.h      |   31 ++++++++++++++------
 1 files changed, 22 insertions(+), 9 deletions(-)
---
diff --git a/addressbook/libebook-contacts/e-book-contacts-types.h 
b/addressbook/libebook-contacts/e-book-contacts-types.h
index 4287156..01a6dfa 100644
--- a/addressbook/libebook-contacts/e-book-contacts-types.h
+++ b/addressbook/libebook-contacts/e-book-contacts-types.h
@@ -152,24 +152,37 @@ typedef enum {
 /**
  * EBookCursorOrigin:
  * @E_BOOK_CURSOR_ORIGIN_CURRENT:  The current cursor position
- * @E_BOOK_CURSOR_ORIGIN_PREVIOUS: The previously recorded cursor position, this can be used to repeat the 
previous query
- * @E_BOOK_CURSOR_ORIGIN_RESET:    The beginning of the cursor results (or end of the results, if navigating 
in reverse).
+ * @E_BOOK_CURSOR_ORIGIN_BEGIN:    The beginning of the cursor results.
+ * @E_BOOK_CURSOR_ORIGIN_END:      The ending of the cursor results.
  *
- * Defines the behaviour of e_book_client_cursor_move_by().
+ * Specifies the start position to in the list of traversed contacts
+ * in calls to e_book_client_cursor_step().
  *
- * The cursor always saves the previous cursor position as well as
- * the new cursor position after performing a move. This allows
- * cursor queries to be repeated in the case where content may have
- * changed but the same content window should be refreshed in a UI.
+ * When an #EBookClientCursor is created, the current position implied by %E_BOOK_CURSOR_ORIGIN_CURRENT
+ * is the same as %E_BOOK_CURSOR_ORIGIN_BEGIN.
  *
  * Since: 3.12
  */
 typedef enum {
        E_BOOK_CURSOR_ORIGIN_CURRENT,
-       E_BOOK_CURSOR_ORIGIN_PREVIOUS,
-       E_BOOK_CURSOR_ORIGIN_RESET
+       E_BOOK_CURSOR_ORIGIN_BEGIN,
+       E_BOOK_CURSOR_ORIGIN_END
 } EBookCursorOrigin;
 
+/**
+ * EBookCursorStepFlags:
+ * @E_BOOK_CURSOR_STEP_MOVE:  The cursor position should be modified while stepping
+ * @E_BOOK_CURSOR_STEP_FETCH: Traversed contacts should be listed and returned while stepping.
+ *
+ * Defines the behaviour of e_book_client_cursor_step().
+ *
+ * Since: 3.12
+ */
+typedef enum {
+       E_BOOK_CURSOR_STEP_MOVE  = (1 << 0),
+       E_BOOK_CURSOR_STEP_FETCH = (1 << 1)
+} EBookCursorStepFlags;
+
 GQuark         e_book_client_error_quark       (void) G_GNUC_CONST;
 const gchar *  e_book_client_error_to_string   (EBookClientError code);