EDataCal.DataCalView¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37), Gio.Initable (2)
Structs:: GObject.ObjectClass (5)

class	`new` (backend, sexp, connection, object_path)
	`component_matches` (component)
	`get_component_string` (component)
	`get_connection` ()
	`get_fields_of_interest` ()
	`get_flags` ()
	`get_object_path` ()
	`get_sexp` ()
	`is_completed` ()
	`is_started` ()
	`is_stopped` ()
	`notify_complete` (error)
	`notify_components_added` (ecalcomponents)
	`notify_components_added_1` (component)
	`notify_components_modified` (ecalcomponents)
	`notify_components_modified_1` (component)
	`notify_objects_removed` (ids)
	`notify_objects_removed_1` (id)
	`notify_progress` (percent, message)
	`object_matches` (object)
	`ref_backend` ()

Virtual Methods¶

Inherited:: GObject.Object (7), Gio.Initable (1)

Properties¶

Name	Type	Flags	Short Description
`backend`	`EDataCal.CalBackend`	r/w/co	The backend being monitored
`connection`	`Gio.DBusConnection`	r/w/co	The `Gio.DBusConnection` on which to export the view interface
`object-path`	`str`	r/w/co	The object path at which to export the view interface
`sexp`	`EDataCal.CalBackendSExp`	r/w/co	The query expression for this view

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class EDataCal.DataCalView(**kwargs)¶

Bases:: GObject.Object, Gio.Initable
Abstract:: No
Structure:: EDataCal.DataCalViewClass

classmethod new(backend, sexp, connection, object_path)¶

Parameters:

backend (object or None) – an EDataCal.CalBackend
sexp (object or None) – an EDataCal.CalBackendSExp
connection (Gio.DBusConnection) – a Gio.DBusConnection
object_path (str) – an object path for the view

Raises:

GLib.Error

Returns:

a new EDataCal.DataCalView, or None on error

Return type:

EDataCal.DataCalView or None

Creates a new EDataCal.DataCalView and exports its D-Bus interface on connection at object_path. If an error occurs while exporting, the function sets error and returns None.

component_matches(component)¶

Parameters:: component (ECal.Component) – the ECal.Component object to match.
Returns:: True if the object matches the expression, False if not.
Return type:: bool

Compares the given component to the regular expression used for the given view.

New in version 3.4.

get_component_string(component)¶

Parameters:: component (ECal.Component) – The ECal.Component to get the string for.
Returns:: A newly allocated string representation of component suitable for self.
Return type:: str

This function is similar to ECal.Component.get_as_string() except that it takes into account the fields-of-interest that self is configured with and filters out any unneeded fields.

New in version 3.4.

get_connection()¶

Returns:: the Gio.DBusConnection
Return type:: Gio.DBusConnection

Returns the Gio.DBusConnection on which the CalendarView D-Bus interface is exported.

New in version 3.8.

get_fields_of_interest()¶

Returns:

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 None 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.

Return type:

{object: object} or None

New in version 3.2.

get_flags()¶

Returns:: the flags for self.
Return type:: ECal.ClientViewFlags

Gets the ECal.ClientViewFlags that control the behaviour of self.

New in version 3.6.

get_object_path()¶

Returns:: the object path
Return type:: str

Return the object path at which the CalendarView D-Bus inteface is exported.

New in version 3.8.

get_sexp()¶

Returns:: The expression object used to search.
Return type:: object or None

Get the EDataCal.CalBackendSExp object used for the given view.

New in version 3.8.

is_completed()¶

Returns:: True if the view is completed, False if still in progress.
Return type:: bool

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.

New in version 3.2.

is_started()¶

Returns:: True if the view has already been started, False otherwise.
Return type:: bool

Checks whether the given view has already been started.

is_stopped()¶

Returns:: True if the view has been stopped, False otherwise.
Return type:: bool

Checks whether the given view has been stopped.

New in version 2.32.

notify_complete(error)¶

Parameters:: error (GLib.Error) – View completion error, if any.

Notifies all view listeners of the completion of the view, including a status code.

New in version 3.2.

notify_components_added(ecalcomponents)¶

Parameters:: ecalcomponents ([ECal.Component]) – List of ECal.Component-s that have been added.

Notifies all view listeners of the addition of a list of components.

Uses the EDataCal.DataCalView's fields-of-interest to filter out unwanted information from iCalendar strings sent over the bus.

New in version 3.4.

notify_components_added_1(component)¶

Parameters:: component (ECal.Component) – The ECal.Component that has been added.

Notifies all the view listeners of the addition of a single object.

Uses the EDataCal.DataCalView's fields-of-interest to filter out unwanted information from iCalendar strings sent over the bus.

New in version 3.4.

notify_components_modified(ecalcomponents)¶

Parameters:: ecalcomponents ([ECal.Component]) – List of modified ECal.Component-s.

Notifies all view listeners of the modification of a list of components.

Uses the EDataCal.DataCalView's fields-of-interest to filter out unwanted information from iCalendar strings sent over the bus.

New in version 3.4.

notify_components_modified_1(component)¶

Parameters:: component (ECal.Component) – The modified ECal.Component.

Notifies all view listeners of the modification of component.

Uses the EDataCal.DataCalView's fields-of-interest to filter out unwanted information from iCalendar strings sent over the bus.

New in version 3.4.

notify_objects_removed(ids)¶

Parameters:: ids ([ECal.ComponentId]) – List of IDs for the objects that have been removed.

Notifies all view listener of the removal of a list of objects.

notify_objects_removed_1(id)¶

Parameters:: id (ECal.ComponentId) – ID of the removed object.

Notifies all view listener of the removal of a single object.

notify_progress(percent, message)¶

Parameters:

percent (int) – Percentage completed.
message (str) – Progress message to send to listeners.

Notifies all view listeners of progress messages.

object_matches(object)¶

Parameters:: object (str) – Object to match.
Returns:: True if the object matches the expression, False if not.
Return type:: bool

Compares the given object to the regular expression used for the given view.

ref_backend()¶

Returns:: The associated EDataCal.CalBackend.
Return type:: EDataCal.CalBackend or None

Refs the backend that self is querying. Unref the returned backend, if not None, with GObject.Object.unref(), when no longer needed.

New in version 3.34.

Property Details¶

EDataCal.DataCalView.props.backend¶

Name:: backend
Type:: EDataCal.CalBackend
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The backend being monitored

EDataCal.DataCalView.props.connection¶

Name:: connection
Type:: Gio.DBusConnection
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The Gio.DBusConnection on which to export the view interface

EDataCal.DataCalView.props.object_path¶

Name:: object-path
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The object path at which to export the view interface

EDataCal.DataCalView.props.sexp¶

Name:: sexp
Type:: EDataCal.CalBackendSExp
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The query expression for this view