[evolution-data-server/openismus-work-master: 63/134] Adding D-Bus interface to interact with cursors
- From: Tristan Van Berkom <tvb src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [evolution-data-server/openismus-work-master: 63/134] Adding D-Bus interface to interact with cursors
- Date: Sat, 19 Oct 2013 19:02:19 +0000 (UTC)
commit 5c240e4f2db79be38b8d613f9b14d5992942a5b2
Author: Tristan Van Berkom <tristanvb openismus com>
Date: Tue Jul 2 17:16:33 2013 +0900
Adding D-Bus interface to interact with cursors
New D-Bus interface: org.gnome.evolution.dataserver.AddressBookCursor.xml
private/Makefile.am | 17 ++++
...nome.evolution.dataserver.AddressBookCursor.xml | 98 ++++++++++++++++++++
2 files changed, 115 insertions(+), 0 deletions(-)
---
diff --git a/private/Makefile.am b/private/Makefile.am
index 77fba7a..f8c2ccf 100644
--- a/private/Makefile.am
+++ b/private/Makefile.am
@@ -45,6 +45,15 @@ $(GENERATED_DBUS_ADDRESS_BOOK) : Makefile.am org.gnome.evolution.dataserver.Addr
$(top_srcdir)/private/org.gnome.evolution.dataserver.AddressBook.xml \
$(NULL)
+$(GENERATED_DBUS_ADDRESS_BOOK_CURSOR) : Makefile.am org.gnome.evolution.dataserver.AddressBookCursor.xml
+ $(AM_V_GEN) gdbus-codegen \
+ --interface-prefix org.gnome.evolution.dataserver \
+ --c-namespace E_DBus \
+ --generate-c-code e-dbus-address-book-cursor \
+ --generate-docbook e-dbus-address-book-cursor \
+ $(top_srcdir)/private/org.gnome.evolution.dataserver.AddressBookCursor.xml \
+ $(NULL)
+
$(GENERATED_DBUS_DIRECT_BOOK) : Makefile.am org.gnome.evolution.dataserver.DirectBook.xml
$(AM_V_GEN) gdbus-codegen \
--interface-prefix org.gnome.evolution.dataserver \
@@ -130,6 +139,12 @@ GENERATED_DBUS_ADDRESS_BOOK = \
e-dbus-address-book-org.gnome.evolution.dataserver.AddressBook.xml \
$(NULL)
+GENERATED_DBUS_ADDRESS_BOOK_CURSOR = \
+ e-dbus-address-book-cursor.c \
+ e-dbus-address-book-cursor.h \
+ e-dbus-address-book-cursor-org.gnome.evolution.dataserver.AddressBookCursor.xml \
+ $(NULL)
+
GENERATED_DBUS_DIRECT_BOOK = \
e-dbus-direct-book.c \
e-dbus-direct-book.h \
@@ -160,6 +175,7 @@ BUILT_SOURCES = \
$(GENERATED_DBUS_SOURCE_MANAGER) \
$(GENERATED_DBUS_AUTHENTICATOR) \
$(GENERATED_DBUS_ADDRESS_BOOK) \
+ $(GENERATED_DBUS_ADDRESS_BOOK_CURSOR) \
$(GENERATED_DBUS_DIRECT_BOOK) \
$(GENERATED_DBUS_ADDRESS_BOOK_FACTORY) \
$(GENERATED_DBUS_CALENDAR) \
@@ -202,6 +218,7 @@ EXTRA_DIST = \
org.gnome.evolution.dataserver.SourceManager.xml \
org.gnome.evolution.dataserver.Authenticator.xml \
org.gnome.evolution.dataserver.AddressBook.xml \
+ org.gnome.evolution.dataserver.AddressBookCursor.xml \
org.gnome.evolution.dataserver.DirectBook.xml \
org.gnome.evolution.dataserver.AddressBookFactory.xml \
org.gnome.evolution.dataserver.Calendar.xml \
diff --git a/private/org.gnome.evolution.dataserver.AddressBookCursor.xml
b/private/org.gnome.evolution.dataserver.AddressBookCursor.xml
new file mode 100644
index 0000000..423ecc8
--- /dev/null
+++ b/private/org.gnome.evolution.dataserver.AddressBookCursor.xml
@@ -0,0 +1,98 @@
+<!DOCTYPE node PUBLIC
+"-//freedesktop//DTD D-Bus Object Introspection 1.0//EN"
+"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
+<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
+
+<!--
+ org.gnome.evolution.dataserver.AddressBookCursor:
+ @short_description: Address book cursor objects
+ @since: 3.10
+
+ This interface allows for interaction with an address book cursor backend.
+-->
+<interface name="org.gnome.evolution.dataserver.AddressBookCursor">
+
+ <!--
+ Total:
+
+ The total number of contacts for this cursor query
+ -->
+ <property name="Total" type="u" access="read"/>
+
+ <!--
+ Position:
+
+ The current cursor position in the cursor query
+ -->
+ <property name="Position" type="u" access="read"/>
+
+ <!--
+ MoveBy:
+ @revision_guard: The expected revision of the addressbook
+ @origin: The #EBookCursorOrigin
+ @count: The number of contacts to try and fetch, negative values move the cursor in reverse
+ @fetch_results: Whether this call should actually fetch results, or if it should only move the cursor
position
+ @vcards: The returned contact list
+ @new_total: The total amount of contacts after moving the cursor
+ @new_position: The cursor position after moving
+
+ Move the cursor by @count contacts from @origin
+
+ This will also result in changes of the Position and Total properties
+
+ The @revision_guard will be checked against the current addressbook
+ revision, if the revisions differ then %E_CLIENT_ERROR_OUT_OF_SYNC
+ will be reported.
+ -->
+ <method name="MoveBy">
+ <arg name="revision_guard" direction="in" type="s"/>
+ <arg name="origin" direction="in" type="i"/>
+ <arg name="count" direction="in" type="i"/>
+ <arg name="fetch_results" direction="in" type="b"/>
+ <arg name="vcards" direction="out" type="as"/>
+ <arg name="new_total" direction="out" type="u"/>
+ <arg name="new_position" direction="out" type="u"/>
+ </method>
+
+ <!--
+ SetAlphabeticIndex:
+ @index: The alphabetic index to set
+ @locale: The locale for which @index is known to be valid
+
+ Sets the cursor's alphabetic index, the index must be valid for @locale
+ and @locale is expected to be the current locale of the addressbook.
+
+ If the addressbook's locale has changed and doesnt match the @locale
+ argument then an error will be returned and the call should be retried.
+
+ This will also result in changes of the Position and Total properties
+ -->
+ <method name="SetAlphabeticIndex">
+ <arg name="index" direction="in" type="u"/>
+ <arg name="locale" direction="in" type="s"/>
+ <arg name="new_total" direction="out" type="u"/>
+ <arg name="new_position" direction="out" type="u"/>
+ </method>
+
+ <!--
+ SetQuery:
+ @query: The new query for this cursor
+
+ Changes the query for the given cursor
+
+ This will also result in changes of the Position and Total properties
+ -->
+ <method name="SetQuery">
+ <arg name="query" direction="in" type="s"/>
+ <arg name="new_total" direction="out" type="u"/>
+ <arg name="new_position" direction="out" type="u"/>
+ </method>
+
+ <!--
+ Dispose
+
+ Delete the server side resources for this cursor
+ -->
+ <method name="Dispose"/>
+
+</interface>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]