ICalGLib.Object¶

Subclasses:: ICalGLib.Array, ICalGLib.Attach, ICalGLib.CompIter, ICalGLib.Component, ICalGLib.Datetimeperiod, ICalGLib.Duration, ICalGLib.Geo, ICalGLib.Parameter, ICalGLib.Parser, ICalGLib.Period, ICalGLib.Property, ICalGLib.RecurIterator, ICalGLib.Recurrence, ICalGLib.Reqstat, ICalGLib.Time, ICalGLib.TimeSpan, ICalGLib.Timezone, ICalGLib.Trigger, ICalGLib.Value

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`free_global_objects` ()
	`add_depender` (depender)
	`get_always_destroy` ()
	`get_is_global_memory` ()
	`ref_owner` ()
	`remove_depender` (depender)
	`remove_owner` ()
	`set_always_destroy` (value)
	`set_native_destroy_func` (native_destroy_func)
	`set_owner` (owner)
	`steal_native` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`always-destroy`	`bool`	r/w	Whether the native libical structure is freed even when the owner is set
`is-global-memory`	`bool`	r/w/co	Whether the native libical structure is from a global shared memory
`native`	`int`	r/w/co	Native libical structure
`native-destroy-func`	`int`	r/w	`GLib.DestroyNotify` function to use to destroy the native libical structure
`owner`	`GObject.Object`	r/w	The native libical structure owner

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class ICalGLib.Object(**kwargs)¶

Bases:: GObject.Object
Abstract:: Yes
Structure:: ICalGLib.ObjectClass

This is an ICalGLib.Object instance struct.

classmethod free_global_objects()¶: Frees all global objects. Any references to them are invalidated by this call, unless they had been GObject.Object.ref()-ed manually.

New in version 3.0.5.

add_depender(depender)¶

Parameters:: depender (GObject.Object) – a GObject.Object depender

Adds a depender into the list of objects which should not be destroyed before this self. It’s usually used for cases where the self uses native libical structure from the depender. The depender is referenced. It’s illegal to try to add one depender multiple times.

New in version 1.0.

get_always_destroy()¶

Returns:: Whether the native libical structure is freed even when an owner is set.
Return type:: bool

Obtain the ICalObject::always-destroy property value.

New in version 3.0.11.

get_is_global_memory()¶

Returns:: Whether the native libical structure is a global shared memory.
Return type:: bool

Obtains whether the native libical structure is a global shared memory, thus should not be destroyed. This can be set only during construction time.

New in version 1.0.

ref_owner()¶

Returns:: Current owner of the libical native structure. Returns None when there is no owner.
Return type:: GObject.Object or None

Obtain current owner of the native libical structure. The returned pointer, if not None, is referenced for thread safety. Unref it with GObject.Object.unref when done with it.

New in version 1.0.

remove_depender(depender)¶

Parameters:: depender (GObject.Object) – a GObject.Object depender

Removes a depender from the list of objects which should not be destroyed before this self, previously added with ICalGLib.Object.add_depender(). It’s illegal to try to remove the depender which is not in the internal list.

New in version 1.0.

remove_owner()¶: Unref and remove the owner.

New in version 1.0.

set_always_destroy(value)¶

Parameters:: value (bool) – value to set

Sets the ICalObject::always-destroy property value. When True, the native libical structure is always freed, even when an owner of the self is set.

New in version 3.0.11.

set_native_destroy_func(native_destroy_func)¶

Parameters:: native_destroy_func (GLib.DestroyNotify) – Function to be used to destroy the native libical structure

Sets a function to be used to destroy the native libical structure.

New in version 1.0.

set_owner(owner)¶

Parameters:: owner (GObject.Object) – Owner of the native libical structure

Sets an owner of the native libical structure, that is an object responsible for a destroy of the native libical structure.

New in version 1.0.

steal_native()¶

Returns:: Native libical structure pointer associated with this self.
Return type:: object or None

Obtain native libical structure pointer associated with this self and sets the one at self to None, thus it’s invalid since now on.

New in version 1.0.

Property Details¶

ICalGLib.Object.props.always_destroy¶

Name:: always-destroy
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Whether free the native libical structure on ICalGLib.Object's finalize even if the object has set an owner.

New in version 3.0.11.

ICalGLib.Object.props.is_global_memory¶

Name:: is-global-memory
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Whether the native libical structure is from a global shared memory. If True, then it is not freed on ICalGLib.Object's finalize.

ICalGLib.Object.props.native¶

Name:: native
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The native libical structure for this ICalGLib.Object.

ICalGLib.Object.props.native_destroy_func¶

Name:: native-destroy-func
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE

GLib.DestroyNotify function to use to destroy the native libical pointer.

ICalGLib.Object.props.owner¶

Name:: owner
Type:: GObject.Object
Default Value:: None
Flags:: READABLE, WRITABLE

Owner of the native libical structure. If set, then it is responsible for a free of the native libical structure.