EDataServer.SourceLocal

g EDataServer.SourceExtension EDataServer.SourceExtension EDataServer.SourceLocal EDataServer.SourceLocal EDataServer.SourceExtension->EDataServer.SourceLocal GObject.Object GObject.Object GObject.Object->EDataServer.SourceExtension

Subclasses:

None

Methods

Inherited:

EDataServer.SourceExtension (4), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

dup_custom_file ()

dup_email_address ()

get_custom_file ()

get_email_address ()

get_writable ()

set_custom_file (custom_file)

set_email_address (email_address)

set_writable (writable)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Inherited:

EDataServer.SourceExtension (1)

Name

Type

Flags

Short Description

custom-file

Gio.File

r/w/c/en

Custom iCalendar file

email-address

str

r/w/c/en

Email address associated with the calendar

writable

bool

r/w/c/en

Whether the file can be opened in writable mode

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name

Type

Access

Description

parent

EDataServer.SourceExtension

r

Class Details

class EDataServer.SourceLocal(**kwargs)
Bases:

EDataServer.SourceExtension

Abstract:

No

Structure:

EDataServer.SourceLocalClass

dup_custom_file()
Returns:

the Gio.File instance, or None

Return type:

Gio.File or None

A thread safe variant to get a custom file being set on the self. Free the returned Gio.File, if not None, with GObject.Object.unref(), when no longer needed.

dup_email_address()
Returns:

a newly-allocated copy of EDataServer.SourceLocal :email-address

Return type:

str

Thread-safe variation of e_source_lcoal_get_email_address(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.40.

get_custom_file()
Returns:

the Gio.File instance, or None

Return type:

Gio.File or None

Get the custom file being set on the self. The returned Gio.File is owned by the self.

For thread safety use EDataServer.SourceLocal.dup_custom_file().

get_email_address()
Returns:

the email address for self

Return type:

str or None

New in version 3.40.

get_writable()
Returns:

whether prefer to pen the file in writable mode

Return type:

bool

Returns whether the backend should prefer to open the file in writable mode. The default is True. The file can be still opened for read-only, for example when the access to the file is read-only.

New in version 3.34.

set_custom_file(custom_file)
Parameters:

custom_file (Gio.File or None) – a Gio.File, or None

Set, or unset, when using None, the custom file for the self.

set_email_address(email_address)
Parameters:

email_address (str or None) – an email address, or None

Sets the email address for self.

The internal copy of email_address is automatically stripped of leading and trailing whitespace. If the resulting string is empty, None is set instead.

New in version 3.40.

set_writable(writable)
Parameters:

writable (bool) – value to set

Set whether the custom file should be opened in writable mode. The default is True. The file can be still opened for read-only, for example when the access to the file is read-only.

New in version 3.34.

Property Details

EDataServer.SourceLocal.props.custom_file
Name:

custom-file

Type:

Gio.File

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Custom iCalendar file

EDataServer.SourceLocal.props.email_address
Name:

email-address

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Email address associated with the calendar

EDataServer.SourceLocal.props.writable
Name:

writable

Type:

bool

Default Value:

True

Flags:

READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Whether the file can be opened in writable mode