Added new cursor related APIs to the documentation build.cursor-staging

14 files changed, 138 insertions, 0 deletions

diff --git a/docs/reference/addressbook/libebook-contacts/libebook-contacts-sections.txt b/docs/reference/addressbook/libebook-contacts/libebook-contacts-sections.txt
index 6412ffbbe..889cf1a94 100644
--- a/docs/reference/addressbook/libebook-contacts/libebook-contacts-sections.txt
+++ b/docs/reference/addressbook/libebook-contacts/libebook-contacts-sections.txt
@@ -16,6 +16,9 @@ EBookViewStatus
 EBookChangeType
 EBookChange
 EBookIndexType
+EBookCursorSortType
+EBookCursorOrigin
+EBookCursorStepFlags
 e_book_client_error_quark
 e_book_client_error_to_string
 e_book_client_error_create
diff --git a/docs/reference/addressbook/libebook/Makefile.am b/docs/reference/addressbook/libebook/Makefile.am
index c0eb9ca41..f413c1cec 100644
--- a/docs/reference/addressbook/libebook/Makefile.am
+++ b/docs/reference/addressbook/libebook/Makefile.am
@@ -41,6 +41,12 @@ GTKDOC_LIBS = \
 	$(EVOLUTION_ADDRESSBOOK_LIBS)				\
 	$(CAMEL_LIBS)
 
+HTML_IMAGES = \
+	cursor-positions.png		\
+	cursor-positions-filtered.png	\
+	cursor-positions-step.png	\
+	cursor-alphabetic-indexes.png
+
 # This includes the standard gtk-doc make rules, copied by gtkdocize.
 include $(top_srcdir)/gtk-doc.make
 
diff --git a/docs/reference/addressbook/libebook/cursor-alphabetic-indexes.png b/docs/reference/addressbook/libebook/cursor-alphabetic-indexes.png
new file mode 100644
index 000000000..e58671427
--- /dev/null
+++ b/docs/reference/addressbook/libebook/cursor-alphabetic-indexes.png
diff --git a/docs/reference/addressbook/libebook/cursor-positions-filtered.png b/docs/reference/addressbook/libebook/cursor-positions-filtered.png
new file mode 100644
index 000000000..028dfed09
--- /dev/null
+++ b/docs/reference/addressbook/libebook/cursor-positions-filtered.png
diff --git a/docs/reference/addressbook/libebook/cursor-positions-step.png b/docs/reference/addressbook/libebook/cursor-positions-step.png
new file mode 100644
index 000000000..29f8718c1
--- /dev/null
+++ b/docs/reference/addressbook/libebook/cursor-positions-step.png
diff --git a/docs/reference/addressbook/libebook/cursor-positions.png b/docs/reference/addressbook/libebook/cursor-positions.png
new file mode 100644
index 000000000..eff780c27
--- /dev/null
+++ b/docs/reference/addressbook/libebook/cursor-positions.png
diff --git a/docs/reference/addressbook/libebook/libebook-docs.sgml b/docs/reference/addressbook/libebook/libebook-docs.sgml
index bfb749ee1..276fe9ff6 100644
--- a/docs/reference/addressbook/libebook/libebook-docs.sgml
+++ b/docs/reference/addressbook/libebook/libebook-docs.sgml
@@ -12,6 +12,7 @@
     <title>Evolution-Data-Server Manual: Address Book Client (libebook)</title>
     <xi:include href="xml/e-book-client.xml"/>
     <xi:include href="xml/e-book-client-view.xml"/>
+    <xi:include href="xml/e-book-client-cursor.xml"/>
     <xi:include href="xml/e-book-types.xml"/>
     <xi:include href="xml/e-destination.xml"/>
   </chapter>
diff --git a/docs/reference/addressbook/libebook/libebook-sections.txt b/docs/reference/addressbook/libebook/libebook-sections.txt
index 9075713f3..2a586ca4e 100644
--- a/docs/reference/addressbook/libebook/libebook-sections.txt
+++ b/docs/reference/addressbook/libebook/libebook-sections.txt
@@ -117,9 +117,12 @@ e_book_client_connect_sync
 e_book_client_connect
 e_book_client_connect_finish
 e_book_client_connect_direct_sync
+e_book_client_connect_direct
+e_book_client_connect_direct_finish
 e_book_client_get_self
 e_book_client_set_self
 e_book_client_is_self
+e_book_client_get_locale
 e_book_client_add_contact
 e_book_client_add_contact_finish
 e_book_client_add_contact_sync
@@ -153,6 +156,9 @@ e_book_client_get_contacts_uids_sync
 e_book_client_get_view
 e_book_client_get_view_finish
 e_book_client_get_view_sync
+e_book_client_get_cursor
+e_book_client_get_cursor_finish
+e_book_client_get_cursor_sync
 <SUBSECTION Deprecated>
 BOOK_BACKEND_PROPERTY_SUPPORTED_AUTH_METHODS
 e_book_client_new
@@ -171,6 +177,36 @@ e_book_client_error_quark
 </SECTION>
 
 <SECTION>
+<FILE>e-book-client-cursor</FILE>
+<TITLE>EBookClientCursor</TITLE>
+EBookClientCursor
+EBookClientCursorClass
+e_book_client_cursor_ref_client
+e_book_client_cursor_get_total
+e_book_client_cursor_get_position
+e_book_client_cursor_get_alphabet
+e_book_client_cursor_set_sexp
+e_book_client_cursor_set_sexp_finish
+e_book_client_cursor_set_sexp_sync
+e_book_client_cursor_step
+e_book_client_cursor_step_finish
+e_book_client_cursor_step_sync
+e_book_client_cursor_set_alphabetic_index
+e_book_client_cursor_set_alphabetic_index_finish
+e_book_client_cursor_set_alphabetic_index_sync
+e_book_client_cursor_get_contact_alphabetic_index
+<SUBSECTION Standard>
+EBookClientCursorPrivate
+E_BOOK_CLIENT_CURSOR
+E_BOOK_CLIENT_CURSOR_CLASS
+E_BOOK_CLIENT_CURSOR_GET_CLASS
+E_IS_BOOK_CLIENT_CURSOR
+E_IS_BOOK_CLIENT_CURSOR_CLASS
+E_TYPE_BOOK_CLIENT_CURSOR
+e_book_client_cursor_get_type
+</SECTION>
+
+<SECTION>
 <FILE>e-book-client-view</FILE>
 <TITLE>EBookClientView</TITLE>
 EBookClientView
diff --git a/docs/reference/addressbook/libebook/libebook.types b/docs/reference/addressbook/libebook/libebook.types
index 8af72dd08..891effec1 100644
--- a/docs/reference/addressbook/libebook/libebook.types
+++ b/docs/reference/addressbook/libebook/libebook.types
@@ -2,6 +2,7 @@
 
 e_book_get_type
 e_book_client_get_type
+e_book_client_cursor_get_type
 e_book_client_view_get_type
 e_book_view_get_type
 e_destination_get_type
diff --git a/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml b/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml
index 62e4ec253..f2571c93a 100644
--- a/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml
+++ b/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml
@@ -19,6 +19,8 @@
     <xi:include href="xml/e-book-backend-summary.xml"/>
     <xi:include href="xml/e-data-book.xml"/>
     <xi:include href="xml/e-data-book-direct.xml"/>
+    <xi:include href="xml/e-data-book-cursor.xml"/>
+    <xi:include href="xml/e-data-book-cursor-sqlite.xml"/>
     <xi:include href="xml/e-data-book-factory.xml"/>
     <xi:include href="xml/e-data-book-view.xml"/>
     <xi:include href="xml/ximian-vcard.xml"/>
diff --git a/docs/reference/addressbook/libedata-book/libedata-book-sections.txt b/docs/reference/addressbook/libedata-book/libedata-book-sections.txt
index 0bf2a10b1..badd021fe 100644
--- a/docs/reference/addressbook/libedata-book/libedata-book-sections.txt
+++ b/docs/reference/addressbook/libedata-book/libedata-book-sections.txt
@@ -54,6 +54,10 @@ e_book_backend_notify_property_changed
 e_book_backend_sync
 e_book_backend_get_direct_book
 e_book_backend_configure_direct
+e_book_backend_set_locale
+e_book_backend_get_locale
+e_book_backend_create_cursor
+e_book_backend_delete_cursor
 <SUBSECTION Standard>
 E_BOOK_BACKEND
 E_IS_BOOK_BACKEND
@@ -176,6 +180,9 @@ e_book_backend_sqlitedb_get_is_populated
 e_book_backend_sqlitedb_set_is_populated
 e_book_backend_sqlitedb_get_revision
 e_book_backend_sqlitedb_set_revision
+e_book_backend_sqlitedb_get_locale
+e_book_backend_sqlitedb_set_locale
+e_book_backend_sqlitedb_ref_collator
 e_book_backend_sqlitedb_get_sync_data
 e_book_backend_sqlitedb_set_sync_data
 e_book_backend_sqlitedb_get_key_value
@@ -190,6 +197,15 @@ e_book_backend_sqlitedb_remove
 e_book_backend_sqlitedb_search_data_free
 e_book_backend_sqlitedb_check_summary_query
 e_book_backend_sqlitedb_check_summary_fields
+EbSdbCursor
+e_book_backend_sqlitedb_cursor_new
+e_book_backend_sqlitedb_cursor_free
+EbSdbCurorOrigin
+e_book_backend_sqlitedb_cursor_move_by
+e_book_backend_sqlitedb_cursor_set_target_alphabetic_index
+e_book_backend_sqlitedb_cursor_set_sexp
+e_book_backend_sqlitedb_cursor_calculate
+e_book_backend_sqlitedb_cursor_compare
 <SUBSECTION Deprecated>
 e_book_backend_sqlitedb_is_summary_query
 e_book_backend_sqlitedb_is_summary_fields
@@ -281,6 +297,56 @@ e_data_book_error_quark
 </SECTION>
 
 <SECTION>
+<FILE>e-data-book-cursor</FILE>
+<TITLE>EDataBookCursor</TITLE>
+EDataBookCursor
+EDataBookCursorClass
+EDataBookCursorSetSexpFunc
+EDataBookCursorMoveByFunc
+EDataBookCursorSetAlphabetIndexFunc
+EDataBookCursorGetPositionFunc
+EDataBookCursorCompareFunc
+EDataBookCursorLoadLocaleFunc
+e_data_book_cursor_get_backend
+e_data_book_cursor_get_total
+e_data_book_cursor_get_position
+e_data_book_cursor_set_sexp
+e_data_book_cursor_move_by
+e_data_book_cursor_set_alphabetic_index
+e_data_book_cursor_recalculate
+e_data_book_cursor_load_locale
+e_data_book_cursor_contact_added
+e_data_book_cursor_contact_removed
+e_data_book_cursor_register_gdbus_object
+<SUBSECTION Standard>
+EDataBookCursorPrivate
+E_DATA_BOOK_CURSOR
+E_DATA_BOOK_CURSOR_CLASS
+E_DATA_BOOK_CURSOR_GET_CLASS
+E_IS_DATA_BOOK_CURSOR
+E_IS_DATA_BOOK_CURSOR_CLASS
+E_TYPE_DATA_BOOK_CURSOR
+e_data_book_cursor_get_type
+</SECTION>
+
+<SECTION>
+<FILE>e-data-book-cursor-sqlite</FILE>
+<TITLE>EDataBookCursorSqlite</TITLE>
+EDataBookCursorSqlite
+EDataBookCursorSqliteClass
+e_data_book_cursor_sqlite_new
+<SUBSECTION Standard>
+EDataBookCursorSqlitePrivate
+E_DATA_BOOK_CURSOR_SQLITE
+E_DATA_BOOK_CURSOR_SQLITE_CLASS
+E_DATA_BOOK_CURSOR_SQLITE_GET_CLASS
+E_IS_DATA_BOOK_CURSOR_SQLITE
+E_IS_DATA_BOOK_CURSOR_SQLITE_CLASS
+E_TYPE_DATA_BOOK_CURSOR_SQLITE
+e_data_book_cursor_sqlite_get_type
+</SECTION>
+
+<SECTION>
 <FILE>e-data-book-direct</FILE>
 <TITLE>EDataBookDirect</TITLE>
 EDataBookDirect
diff --git a/docs/reference/addressbook/libedata-book/libedata-book.types b/docs/reference/addressbook/libedata-book/libedata-book.types
index 58d35eebb..a50228431 100644
--- a/docs/reference/addressbook/libedata-book/libedata-book.types
+++ b/docs/reference/addressbook/libedata-book/libedata-book.types
@@ -6,5 +6,7 @@ e_book_backend_factory_get_type
 e_book_backend_sexp_get_type
 e_book_backend_summary_get_type
 e_data_book_get_type
+e_data_book_cursor_get_type
+e_data_book_cursor_sqlite_get_type
 e_data_book_direct_get_type
 e_data_book_view_get_type
diff --git a/docs/reference/libedataserver/libedataserver-docs.sgml b/docs/reference/libedataserver/libedataserver-docs.sgml
index ffc45996c..ac01c8120 100644
--- a/docs/reference/libedataserver/libedataserver-docs.sgml
+++ b/docs/reference/libedataserver/libedataserver-docs.sgml
@@ -52,6 +52,7 @@
     <title>Miscellaneous Utilities</title>
     <xi:include href="xml/e-categories.xml"/>
     <xi:include href="xml/e-client.xml"/>
+    <xi:include href="xml/e-collator.xml"/>
     <xi:include href="xml/e-debug-log.xml"/>
     <xi:include href="xml/e-flag.xml"/>
     <xi:include href="xml/e-memory.xml"/>
diff --git a/docs/reference/libedataserver/libedataserver-sections.txt b/docs/reference/libedataserver/libedataserver-sections.txt
index 4cfb131d8..19251a7fc 100644
--- a/docs/reference/libedataserver/libedataserver-sections.txt
+++ b/docs/reference/libedataserver/libedataserver-sections.txt
@@ -103,6 +103,26 @@ e_client_error_quark
 </SECTION>
 
 <SECTION>
+<FILE>e-collator</FILE>
+<TITLE>ECollator</TITLE>
+E_COLLATOR_ERROR
+ECollatorError
+e_collator_error_quark
+ECollator
+e_collator_new
+e_collator_ref
+e_collator_unref
+e_collator_generate_key
+e_collator_generate_key_for_index
+e_collator_collate
+e_collator_get_index_labels
+e_collator_get_index
+<SUBSECTION Standard>
+E_TYPE_COLLATOR
+e_collator_get_type
+</SECTION>
+
+<SECTION>
 <FILE>e-credentials</FILE>
 <TITLE>ECredentials</TITLE>
 ECredentials