the unique identifier
The unique identifier for the entity The format of identifiers is undefined, but the recommended practice is to use a URI. This parameter must be set at time of construction as no default value is provided.
Adds a new parameter against the entity. A key can have multiple values associated. Thus repeated calls with the same key will build up a list of possible values.
the name of the key
the data to associated with that key
Creates a binding between source_property
on source
and target_property
on target
.
Whenever the source_property
is changed the target_property
is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.
If flags
contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
if target_property
on target
changes then the source_property
on source
will be updated as well.
The binding will automatically be removed when either the source
or the
target
instances are finalized. To remove the binding without affecting the
source
and the target
you can just call g_object_unref() on the returned
#GBinding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source
and target
are only used from a single thread and it
is clear that both source
and target
outlive the binding. Especially it
is not safe to rely on this if the binding, source
or target
can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A #GObject can have multiple bindings.
the property on source
to bind
the target #GObject
the property on target
to bind
flags to pass to #GBinding
Creates a binding between source_property
on source
and target_property
on target,
allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.
the property on source
to bind
the target #GObject
the property on target
to bind
flags to pass to #GBinding
a #GClosure wrapping the transformation function from the source
to the target,
or %NULL to use the default
a #GClosure wrapping the transformation function from the target
to the source,
or %NULL to use the default
Remove all values associated with a key
the name of the key
This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object
. If the freeze count is
non-zero, the emission of "notify" signals on object
is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
#GObject::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Retrieves the unique key for the entity. The format of identifiers is undefined, but the recommended practice is to use a URI.
Returns the URL the script will use to perform the installation.
Retrieve all the known parameter keys associated with the entity
Retrieve the parameter value associated with a named key. If multiple values are stored against the key, only the first value is returned. If no value is associated, NULL is returned
the name of the key
Retrieve the parameter value associated with a named key as a boolean. If multiple values are stored against the key, only the first value is returned. If no value is associated, FALSE is returned
the name of the key
Retrieve the parameter value associated with a named key as a
boolean. If multiple values are stored against the key, only the
first value is returned. If no value is associated, default_value
is returned.
the name of the key
the value to be returned in case there's no value associated with the key
Retrieve the parameter value associated with a named key as an
enum value. If multiple values are stored against the key, only
the first value is returned. If no value is associated, the
default_value
is returned.
the name of the key
the enum type
the default value to be used, in case there's no value associated with the key
Retrieve the parameter value associated with a named key as an int64. If multiple values are stored against the key, only the first value is returned. If no value is associated, -1 is returned.
the name of the key
Retrieve the parameter value associated with a named key as an
int64. If multiple values are stored against the key, only the
first value is returned. If no value is associated, default_value
is returned.
the name of the key
the value to be returned in case there's no value associated with the key
Retrieve all the parameter values associated with a named key. If no values are associated, NULL is returned
the name of the key
Gets a property of an object.
The value
can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().
Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.
the name of the property to get
return location for the property value
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Gets n_properties
properties for an object
.
Obtained properties will be set to values
. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Checks whether object
has a [floating][floating-ref] reference.
Emits a "notify" signal for the property property_name
on object
.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
the name of a property installed on the class of object
.
Emits a "notify" signal for the property specified by pspec
on object
.
This function omits the property name lookup, hence it is faster than g_object_notify().
One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:
enum
{
PROP_0,
PROP_FOO,
PROP_LAST
};
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
0, 100,
50,
G_PARAM_READWRITE);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the #GParamSpec of a property installed on the class of object
.
Increase the reference count of object,
and possibly remove the
[floating][floating-ref] reference, if object
has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object
will be propagated to the return type
under the same conditions as for g_object_ref().
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Sets the #OSINFO_INSTALL_CONFIG_PROP_ADMIN_PASSWORD parameter
the administrator password to be set
Sets the #OSINFO_INSTALL_CONFIG_PROP_AVATAR_DISK parameter.
Please read documentation on #osinfo_install_config_set_target_disk() for
explanation on the format of disk
string.
the avatar disk
Sets the #OSINFO_INSTALL_CONFIG_PROP_AVATAR_LOCATION parameter.
Note that the format of this string is dependent on the installer script
config
is going to be used with. You can use
#osinfo_install_script_get_path_format() to find out which format
does the script expects this string to be in.
Also note that in case of #OSINFO_PATH_FORMAT_DOS, the drive/disk letter and the leading ':' must not be included in the path.
new location
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key
is converted to a #GQuark using g_quark_from_string().
This means a copy of key
is kept permanently (even after object
has been
finalized) — so it is recommended to only use a small, bounded set of values
for key
in your program, to avoid the #GQuark storage growing unbounded.
name of the key
data to associate with that key
If a script requires drivers to be signed, this function can be used to disable that security feature. WARNING: Disabling driver signing may very well mean disabling it permanently.
boolean value
Sets the #OSINFO_INSTALL_CONFIG_PROP_HARDWARE_ARCH parameter.
The list of valid architectures are part of osinfo.rng schema
the hardware architecture
Sets the #OSINFO_INSTALL_CONFIG_PROP_HOSTNAME parameter.
Note that some operating systems have restrictions on maximum number of, and allowed characters in hostname (or its equivalent) so it is highly recommended that you keep the actual hostname less than or equal to 15 characters long and make sure that it does not contain any characters other than ASCII alphanumeric and '-'. Otherwise unattended installation might fail.
the desired hostname
When performing a tree based installation the script will need the installation URL to be set, whenever the installation is performed from a non canonical place.
the URL used to perform the installation
Sets the #OSINFO_INSTALL_CONFIG_PROP_L10N_KEYBOARD parameter.
The expected format of this string is the same as #osinfo_install_config_set_l10n_language function's 'language' parameter.
the keyboard
Sets the #OSINFO_INSTALL_CONFIG_PROP_L10N_LANGUAGE parameter.
The expected format of this string is the gettext locale names standard:
https://www.gnu.org/savannah-checkouts/gnu/gettext/manual/html_node/Locale-Names.html
Encoding and variant are (at least for now) not supported. For example, 'pt_BR' is accepted is accepted as the language codes for Brazilian Portuguese but 'pt_BR.utf8' is not.
the language
Set the #OSINFO_INSTALL_CONFIG_PROP_L10N_TIMEZONE parameter.
The expected format of this string is the tzdata names standard.
the timezone
Sets a new parameter against the entity. If the key already has a value associated with it, the existing value will be cleared.
the name of the key
the data to associated with that key
Sets a new parameter against the entity. If the key already has a value associated with it, the existing value will be cleared.
the name of the key
the boolean value to be associated with that key
Sets a new parameter against the entity. If the key already has a value associated with it, the existing value will be cleared.
the name of the key
the enum value to be associated with that key
the enum type
Sets a new parameter against the entity. If the key already has a value associated with it, the existing value will be cleared.
the name of the key
the int64 value to be associated with that key
Specify the disk on which drivers to be installed at the end of installation, are available.
Please read documentation on #osinfo_install_config_set_target_disk() for
explanation on the format of disk
string.
NOTE: Not every install script supports post-installation of drivers. Use #osinfo_install_script_get_can_post_install_drivers() to find out if an install script supports it.
the target disk
Specify the disk on which drivers to be installed at the end of installation, are available.
Please read documentation on #osinfo_install_config_set_avatar_location() for
explanation on the format of location
string.
NOTE: Not every install script supports post-installation of drivers. Use #osinfo_install_script_get_can_post_install_drivers() to find out if an install script supports it.
the location of avatar
Specify the disk on which drivers to be installed at the very beginning of installation, are available. This is usually needed for devices for which the OS in question does not have out of the box support for and devices are required/preferred to be available during actual installation.
Please read documentation on #osinfo_install_config_set_target_disk() for
explanation on the format of disk
string.
NOTE: Not every install script supports pre-installation of drivers. Use #osinfo_install_script_get_can_pre_install_drivers() to find out if an installer script supports it.
NOTE: Microsoft Windows XP requires pre-installation driver files to be present in the script disk under the toplevel directory.
the disk
Specify the location on which drivers to be installed at the very beginning of installation, are available. Please read documentation on #osinfo_install_config_set_pre_install_drivers_disk() for more information about pre-installation of drivers.
Please read documentation on #osinfo_install_config_set_avatar_location() for
explanation on the format of location
string.
the location
Sets a property on an object.
the name of the property to set
the value
Sets the value of #OSINFO_INSTALL_CONFIG_PROP_REG_LOGIN parameter.
the registration login
Sets the value of #OSINFO_INSTALL_CONFIG_PROP_REG_PASSWORD parameter.
the registration password
Sets the #OSINFO_INSTALL_CONFIG_PROP_SCRIPT_DISK parameter.
Please read documentation on #osinfo_install_config_set_target_disk() for
explanation on the format of disk
string.
the disk
Sets the #OSINFO_INSTALL_CONFIG_PROP_TARGET_DISK parameter.
Note that the format of this string is dependent on the installer script
config
is going to be used with. You can use
#osinfo_install_script_get_path_format() to find out which format
does the script expects this string to be in. In case of
#OSINFO_PATH_FORMAT_UNIX unix device node names are expected, e.g "/dev/fd0".
In case of #OSINFO_PATH_FORMAT_DOS drive letters are expected, e.g "A".
the target disk
Sets the value of #OSINFO_INSTALL_CONFIG_PROP_USER_ADMIN parameter.
whether the user should be set as administrator or not
Sets the value of #OSINFO_INSTALL_CONFIG_PROP_USER_AUTOLOGIN parameter.
whether autologin should be set for the user or not
Sets the value of #OSINFO_INSTALL_CONFIG_PROP_USER_LOGIN parameter.
the chosen username for the user log into the system
Sets the #OSINFO_INSTALL_CONFIG_PROP_USER_PASSWORD parameter
the user password to be set
Sets the value of #OSINFO_INSTALL_CONFIG_PROP_USER_REALNAME parameter.
the user real name to be displayed
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data
from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().
A #GQuark, naming the user data pointer
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Decreases the reference count of object
. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.
This function essentially limits the life time of the closure
to
the life time of the object. That is, when the object is finalized,
the closure
is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure,
to ensure that an extra
reference count is held on object
during invocation of the
closure
. Usually, this function will be called on closures that
use this object
as closure data.
#GClosure to watch
Find the #GParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init
member of
#GTypeInfo.) It must not be called after after class_init
has
been called for any object types implementing this interface.
If pspec
is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the #GParamSpec for the new property
Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface
will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Construct a new install configuration with default values for language, keyboard, timezone and admin password. The default values are to use an 'en_US' language and keyboard, and an 'America/New_York' timezone. The admin password is set to a random 8 character password.
the unique identifier
Creates a new instance of a #GObject subtype and sets its properties.
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.
the type id of the #GObject subtype to instantiate
an array of #GParameter
Construct a new install configuration with default values for language, keyboard, timezone and admin password. The default values are to use an 'en_US' language and keyboard, and an 'America/New_York' timezone. The admin password is set to a random 8 character password.