![]() |
![]() |
![]() |
Evolution-Data-Server Manual: Calendar Client (libecal) | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties | Signals |
struct ECalClientView; struct _ECalClient * e_cal_client_view_get_client (ECalClientView *view
); gboolean e_cal_client_view_is_running (ECalClientView *view
); void e_cal_client_view_set_fields_of_interest (ECalClientView *view
,const GSList *fields_of_interest
,GError **error
); void e_cal_client_view_start (ECalClientView *view
,GError **error
); void e_cal_client_view_stop (ECalClientView *view
,GError **error
); enum ECalClientViewFlags; void e_cal_client_view_set_flags (ECalClientView *view
,ECalClientViewFlags flags
,GError **error
);
"client" ECalClient* : Read / Write / Construct Only "view" gpointer : Read / Write / Construct Only
"complete" :Run First
"objects-added" :Run First
"objects-modified" :Run First
"objects-removed" :Run First
"progress" :Run First
struct ECalClientView;
Contains only private data that should be read and manipulated using the functions below.
Since 3.2
struct _ECalClient * e_cal_client_view_get_client (ECalClientView *view
);
Get the ECalClient associated with this view.
|
A ECalClientView object. |
Returns : |
the associated client. |
Since 3.2
gboolean e_cal_client_view_is_running (ECalClientView *view
);
Retunrs: Whether view is running. Not running views are ignoring all events sent from the server.
|
an ECalClientView |
Since 3.2
void e_cal_client_view_set_fields_of_interest (ECalClientView *view
,const GSList *fields_of_interest
,GError **error
);
Client can instruct server to which fields it is interested in only, thus
the server can return less data over the wire. The server can still return
complete objects, this is just a hint to it that the listed fields will
be used only. The UID/RID fields are returned always. Initial views has no fields
of interest and using NULL
for fields_of_interest
will unset any previous
changes.
Some backends can use summary information of its cache to create artifical objects, which will omit stored object parsing. If this cannot be done then it will simply return object as is stored in the cache.
|
An ECalClientView object |
|
List of field names in which the client is interested |
|
A GError |
void e_cal_client_view_start (ECalClientView *view
,GError **error
);
Starts a live query to the calendar/tasks backend.
|
An ECalClientView object. |
|
A Gerror |
Since 3.2
void e_cal_client_view_stop (ECalClientView *view
,GError **error
);
Stops a live query to the calendar/tasks backend.
|
An ECalClientView object. |
|
A GError |
Since 3.2
typedef enum { E_CAL_CLIENT_VIEW_FLAGS_NONE = 0, E_CAL_CLIENT_VIEW_FLAGS_NOTIFY_INITIAL = (1 << 0) } ECalClientViewFlags;
Flags that control the behaviour of an ECalClientView.
Symbolic value for no flags | |
If this flag is set then all objects matching the view's query will
be sent as notifications when starting the view, otherwise only future
changes will be reported. The default for a ECalClientView is TRUE .
|
Since 3.6
void e_cal_client_view_set_flags (ECalClientView *view
,ECalClientViewFlags flags
,GError **error
);
Sets the flags
which control the behaviour of view
.
|
an ECalClientView |
|
the ECalClientViewFlags for view . |
|
a return location for a GError, or NULL . |
Since 3.6
"complete"
signalvoid user_function (ECalClientView *ecalclientview,
GError *arg1,
gpointer user_data) : Run First
"objects-added"
signalvoid user_function (ECalClientView *view:,
gpointer objects,
gpointer user_data) : Run First
|
self |
|
. [type GSList][transfer none][element-type long] |
|
user data set when the signal handler was connected. |
"objects-modified"
signalvoid user_function (ECalClientView *view:,
gpointer objects,
gpointer user_data) : Run First
|
self |
|
. [type GSList][transfer none][element-type long] |
|
user data set when the signal handler was connected. |
"objects-removed"
signalvoid user_function (ECalClientView *view:,
gpointer objects,
gpointer user_data) : Run First
|
self |
|
. [type GSList][transfer none][element-type ECalComponentId] |
|
user data set when the signal handler was connected. |
"progress"
signalvoid user_function (ECalClientView *ecalclientview,
guint arg1,
gchar *arg2,
gpointer user_data) : Run First