ICalGLib.Period¶

Subclasses:: None

Methods¶

Inherited:: ICalGLib.Object (11), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new_from_string` (str)
class	`new_null_period` ()
	`as_ical_string` ()
	`get_duration` ()
	`get_end` ()
	`get_start` ()
	`is_null_period` ()
	`is_valid_period` ()
	`set_duration` (duration)
	`set_end` (end)
	`set_start` (start)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: ICalGLib.Object (5)

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class ICalGLib.Period(**kwargs)¶

Bases:: ICalGLib.Object
Abstract:: No
Structure:: ICalGLib.PeriodClass

This is the ICalGLib.Period instance.

classmethod new_from_string(str)¶

Parameters:: str (str) – The string used to create the ICalGLib.Period
Returns:: The newly created ICalGLib.Period
Return type:: ICalGLib.Period

Creates a ICalGLib.Period from a string.

New in version 1.0.

classmethod new_null_period()¶

Returns:: The newly created default ICalGLib.Period
Return type:: ICalGLib.Period

Creates a default ICalGLib.Period.

New in version 1.0.

as_ical_string()¶

Returns:: The string representation of ICalGLib.Period.
Return type:: str

Translates ICalGLib.Period to string.

New in version 1.0.

get_duration()¶

Returns:: The duration of self.
Return type:: ICalGLib.Duration

Gets the duration from an ICalGLib.Period.

New in version 1.0.

get_end()¶

Returns:: The end of self.
Return type:: ICalGLib.Time

Gets the end time from an ICalGLib.Period.

New in version 1.0.

get_start()¶

Returns:: The start of self.
Return type:: ICalGLib.Time

Gets the start time from an ICalGLib.Period.

New in version 1.0.

is_null_period()¶

Returns:: 1 if yes, 0 if not.
Return type:: bool

Checks the ICalGLib.Period is null_period.

New in version 1.0.

is_valid_period()¶

Returns:: 1 if yes, 0 if not.
Return type:: bool

Checks the ICalGLib.Period is valid_period.

New in version 1.0.

set_duration(duration)¶

Parameters:: duration (ICalGLib.Duration) – The duration of self

Sets the duration of an ICalGLib.Period.

New in version 1.0.

set_end(end)¶

Parameters:: end (ICalGLib.Time) – The end of self

Sets the end time of an ICalGLib.Period.

New in version 1.0.

set_start(start)¶

Parameters:: start (ICalGLib.Time) – The start of self

Sets the start time of an ICalGLib.Period.

New in version 1.0.