ECal.ClientView¶

Subclasses:: None

Methods¶

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

	`get_connection` ()
	`get_object_path` ()
	`is_running` ()
	`ref_client` ()
	`set_fields_of_interest` (fields_of_interest)
	`set_flags` (flags)
	`start` ()
	`stop` ()

Virtual Methods¶

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

	`do_complete` (error)
	`do_progress` (percent, message)

Properties¶

Name	Type	Flags	Short Description
`client`	`ECal.Client`	r/w/co	The `ECal.Client` for the view
`connection`	`Gio.DBusConnection`	r/w/co	The `Gio.DBusConnection` used to create the D-Bus proxy
`object-path`	`str`	r/w/co	The object path used to create the D-Bus proxy

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`complete`
`objects-added`
`objects-modified`
`objects-removed`
`progress`

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
object	`GObject.Object`	r

Class Details¶

class ECal.ClientView(**kwargs)¶

Bases:: GObject.Object, Gio.Initable
Abstract:: No
Structure:: ECal.ClientViewClass

Contains only private data that should be read and manipulated using the functions below.

New in version 3.2.

get_connection()¶

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

Returns the Gio.DBusConnection used to create the D-Bus proxy.

New in version 3.8.

get_object_path()¶

Returns:: the object path
Return type:: str

Returns the object path used to create the D-Bus proxy.

New in version 3.8.

is_running()¶

Return type:: bool

Retunrs: Whether view is running. Not running views are ignoring all events sent from the server.

New in version 3.2.

ref_client()¶

Returns:: an ECal.Client
Return type:: ECal.Client

Returns the ECal.ClientView :client associated with self.

The returned ECal.Client is referenced for thread-safety. Unreference the ECal.Client with GObject.Object.unref() when finished with it.

New in version 3.10.

set_fields_of_interest(fields_of_interest)¶

Parameters:: fields_of_interest ([str] or None) – List of field names in which the client is interested, or None to reset the fields of interest
Raises:: GLib.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 None 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.

set_flags(flags)¶

Parameters:: flags (ECal.ClientViewFlags) – the ECal.ClientViewFlags for self
Raises:: GLib.Error

Sets the flags which control the behaviour of self.

New in version 3.6.

start()¶

Raises:: GLib.Error

Tells self to start processing events.

New in version 3.2.

stop()¶

Raises:: GLib.Error

Tells self to stop processing events.

New in version 3.2.

do_complete(error) virtual¶

Parameters:: error (GLib.Error) –

A signal emitted when the backend finished initial view population

do_progress(percent, message) virtual¶

Parameters:

percent (int) –
message (str) –

A signal emitted when the backend notifies about the progress

Signal Details¶

ECal.ClientView.signals.complete(client_view, object)¶

Signal Name:

complete

Flags:

RUN_FIRST

Parameters:

client_view (ECal.ClientView) – The object which received the signal
object (GLib.Error) –

ECal.ClientView.signals.objects_added(client_view, objects)¶

Signal Name:

objects-added

Flags:

RUN_FIRST

Parameters:

client_view (ECal.ClientView) – The object which received the signal
objects ([ICalGLib.Component]) – a GLib.SList of added ICalGLib.Component objects into the client_view.

ECal.ClientView.signals.objects_modified(client_view, objects)¶

Signal Name:

objects-modified

Flags:

RUN_FIRST

Parameters:

client_view (ECal.ClientView) – The object which received the signal
objects ([ICalGLib.Component]) – a GLib.SList of modified ICalGLib.Component objects within the client_view

ECal.ClientView.signals.objects_removed(client_view, uids)¶

Signal Name:

objects-removed

Flags:

RUN_FIRST

Parameters:

client_view (ECal.ClientView) – The object which received the signal
uids ([ECal.ComponentId]) – a GLib.SList of removed objects, described by their UID and eventually RID, as an ECal.ComponentId structure.

ECal.ClientView.signals.progress(client_view, object, p0)¶

Signal Name:

progress

Flags:

RUN_FIRST

Parameters:

client_view (ECal.ClientView) – The object which received the signal
object (int) –
p0 (str) –

Property Details¶

ECal.ClientView.props.client¶

Name:: client
Type:: ECal.Client
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The ECal.Client for the view

ECal.ClientView.props.connection¶

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

The Gio.DBusConnection used to create the D-Bus proxy

ECal.ClientView.props.object_path¶

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

The object path used to create the D-Bus proxy