Xfconf.Channel¶

Subclasses:: None

Methods¶

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

class	`get` (channel_name)
class	`new` (channel_name)
class	`new_with_property_base` (channel_name, property_base)
	`get_arrayv` (property)
	`get_bool` (property, default_value)
	`get_double` (property, default_value)
	`get_int` (property, default_value)
	`get_named_struct` (property, struct_name, value_struct)
	`get_properties` (property_base)
	`get_property` (property, value)
	`get_string` (property, default_value)
	`get_string_list` (property)
	`get_structv` (property, value_struct, n_members, member_types)
	`get_uint` (property, default_value)
	`get_uint64` (property, default_value)
	`has_property` (property)
	`is_property_locked` (property)
	`reset_property` (property_base, recursive)
	`set_arrayv` (property, values)
	`set_bool` (property, value)
	`set_double` (property, value)
	`set_int` (property, value)
	`set_named_struct` (property, struct_name, value_struct)
	`set_property` (property, value)
	`set_string` (property, value)
	`set_string_list` (property, values)
	`set_structv` (property, value_struct, n_members, member_types)
	`set_uint` (property, value)
	`set_uint64` (property, value)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`channel-name`	`str`	r/w/co	The name of the channel
`is-singleton`	`bool`	r/w/co	Whether or not this instance is a singleton
`property-base`	`str`	r/w/co	Base property path

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`property-changed`	Emitted whenever a property on channel has changed.

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Xfconf.Channel(**kwargs)¶

Bases:: GObject.Object
Abstract:: No

An opaque structure that holds state about a channel.

classmethod get(channel_name)¶

Parameters:: channel_name (str) – A channel name.
Returns:: An Xfconf.Channel singleton.
Return type:: Xfconf.Channel

Either creates a new channel, or fetches a singleton object for channel_name. This function always returns a valid object; no checking is done to see if the channel exists or has a valid name.

The reference count of the returned channel is owned by libxfconf.

New in version 4.5.91.

classmethod new(channel_name)¶

Parameters:: channel_name (str) – A channel name.
Returns:: A new Xfconf.Channel. Release with GObject.Object.unref() when no longer needed.
Return type:: Xfconf.Channel

Creates a new channel using name as the channel’s identifier. This function always returns a valid object; no checking is done to see if the channel exists or has a valid name.

Note: use of this function is not recommended, in favor of Xfconf.Channel.get(), which returns a singleton object and saves a little memory. However, Xfconf.Channel.new() can be useful in some cases where you want to tie an Xfconf.Channel's lifetime (and thus the lifetime of connected signals and bound GObject.Object properties) to the lifetime of another object.

Also note that each channel has its own cache, so if you create 2 new channels with the same name, it will double the dbus traffic, so in this cases it is highly recommended to use Xfconf.Channel.get().

classmethod new_with_property_base(channel_name, property_base)¶

Parameters:

channel_name (str) – A channel name.
property_base (str) – A property root name.

Returns:

A new Xfconf.Channel. Release with GObject.Object.unref() when no longer needed.

Return type:

Xfconf.Channel

Creates a new channel using name as the channel’s identifier, restricting the accessible properties to be rooted at property_base. This function always returns a valid object; no checking is done to see if the channel exists or has a valid name.

New in version 4.5.92.

get_arrayv(property)¶

Parameters:: property (str) – A property string.
Returns:: A newly-allocated GLib.PtrArray on success, or None on failure.
Return type:: [GObject.Value] or None

Gets an array property on self and returns it as a GLib.PtrArray, which can be freed with Xfconf.array_free() when no longer needed.

get_bool(property, default_value)¶