Top | ![]() |
![]() |
![]() |
![]() |
This class communicates with ECalClientViews over the bus.
Calendar backends can automatically own a number of views requested by the client, this API can be used by the backend to issue notifications which will be delivered to the ECalClientView
EDataCalView * e_data_cal_view_new (struct _ECalBackend *backend
,struct _ECalBackendSExp *sexp
,GDBusConnection *connection
,const gchar *object_path
,GError **error
);
Creates a new EDataCalView and exports its D-Bus interface on
connection
at object_path
. If an error occurs while exporting,
the function sets error
and returns NULL
.
backend |
an ECalBackend |
|
sexp |
||
connection |
a GDBusConnection |
|
object_path |
an object path for the view |
|
error |
return location for a GError, or |
struct _ECalBackend *
e_data_cal_view_ref_backend (EDataCalView *view
);
Refs the backend that view
is querying. Unref the returned backend,
if not NULL
, with g_object_unref()
, when no longer needed.
Since: 3.34
struct _ECalBackend *
e_data_cal_view_get_backend (EDataCalView *view
);
e_data_cal_view_get_backend
has been deprecated since version 3.34 and should not be used in newly-written code.
Use e_data_cal_view_ref_backend()
instead.
Gets the backend that view
is querying.
Since: 3.8
GDBusConnection *
e_data_cal_view_get_connection (EDataCalView *view
);
Returns the GDBusConnection on which the CalendarView D-Bus interface is exported.
Since: 3.8
const gchar *
e_data_cal_view_get_object_path (EDataCalView *view
);
Return the object path at which the CalendarView D-Bus inteface is exported.
Since: 3.8
struct _ECalBackendSExp *
e_data_cal_view_get_sexp (EDataCalView *view
);
Get the ECalBackendSExp object used for the given view.
Since: 3.8
gboolean e_data_cal_view_object_matches (EDataCalView *view
,const gchar *object
);
Compares the given object
to the regular expression used for the
given view.
gboolean e_data_cal_view_component_matches (EDataCalView *view
,ECalComponent *component
);
Compares the given component
to the regular expression used for the
given view.
Since: 3.4
gboolean
e_data_cal_view_is_started (EDataCalView *view
);
Checks whether the given view has already been started.
gboolean
e_data_cal_view_is_completed (EDataCalView *view
);
Checks whether the given view is already completed. Being completed means the initial matching of objects have been finished, not that no more notifications about changes will be sent. In fact, even after completed, notifications will still be sent if there are changes in the objects matching the view search expression.
Since: 3.2
gboolean
e_data_cal_view_is_stopped (EDataCalView *view
);
Checks whether the given view has been stopped.
Since: 2.32
GHashTable *
e_data_cal_view_get_fields_of_interest
(EDataCalView *view
);
Hash table of field names which the listener is interested in.
Backends can return fully populated objects, but the listener advertised
that it will use only these. Returns NULL
for all available fields.
Note: The data pointer in the hash table has no special meaning, it's only GINT_TO_POINTER(1) for easier checking. Also, field names are compared case insensitively.
[transfer none]
Since: 3.2
ECalClientViewFlags
e_data_cal_view_get_flags (EDataCalView *view
);
Gets the ECalClientViewFlags that control the behaviour of view
.
Since: 3.6
gchar * e_data_cal_view_get_component_string (EDataCalView *view
,ECalComponent *component
);
This function is similar to e_cal_component_get_as_string()
except
that it takes into account the fields-of-interest that view
is
configured with and filters out any unneeded fields.
Since: 3.4
void e_data_cal_view_notify_components_added (EDataCalView *view
,const GSList *ecalcomponents
);
Notifies all view listeners of the addition of a list of components.
Uses the EDataCalView's fields-of-interest to filter out unwanted information from iCalendar strings sent over the bus.
view |
an EDataCalView |
|
ecalcomponents |
List of ECalComponent-s that have been added. |
[element-type ECalComponent] |
Since: 3.4
void e_data_cal_view_notify_components_added_1 (EDataCalView *view
,ECalComponent *component
);
Notifies all the view listeners of the addition of a single object.
Uses the EDataCalView's fields-of-interest to filter out unwanted information from iCalendar strings sent over the bus.
Since: 3.4
void e_data_cal_view_notify_components_modified (EDataCalView *view
,const GSList *ecalcomponents
);
Notifies all view listeners of the modification of a list of components.
Uses the EDataCalView's fields-of-interest to filter out unwanted information from iCalendar strings sent over the bus.
view |
an EDataCalView |
|
ecalcomponents |
List of modified ECalComponent-s. |
[element-type ECalComponent] |
Since: 3.4
void e_data_cal_view_notify_components_modified_1 (EDataCalView *view
,ECalComponent *component
);
Notifies all view listeners of the modification of component
.
Uses the EDataCalView's fields-of-interest to filter out unwanted information from iCalendar strings sent over the bus.
Since: 3.4
void e_data_cal_view_notify_objects_removed (EDataCalView *view
,const GSList *ids
);
Notifies all view listener of the removal of a list of objects.
view |
an EDataCalView |
|
ids |
List of IDs for the objects that have been removed. |
[element-type ECalComponentId] |
void e_data_cal_view_notify_objects_removed_1 (EDataCalView *view
,const ECalComponentId *id
);
Notifies all view listener of the removal of a single object.
void e_data_cal_view_notify_progress (EDataCalView *view
,gint percent
,const gchar *message
);
Notifies all view listeners of progress messages.
view |
an EDataCalView |
|
percent |
Percentage completed. |
|
message |
Progress message to send to listeners. |
void e_data_cal_view_notify_complete (EDataCalView *view
,const GError *error
);
Notifies all view listeners of the completion of the view, including a status code.
Since: 3.2