Adds a new key
to data,
with no value. If key already exists, it does
nothing.
key to add
Adds a new author to media
.
an author for media
Appends a new binary value for key
in data
.
key to append
the buffer containing the new value
size of buffer
Adds a new external player to media
.
an external player for media
Adds a new external url to media
.
an external url for media
Appends a new float value for key
in data
.
key to append
the new value
Appends a new int value for key
in data
.
key to append
the new value
Adds a new set of values into data
.
All keys in prop
must be related among them.
data
will take the ownership of relkeys,
so do not modify it.
a set of related properties with their values
Appends a new string value for key
in data
.
key to append
the new value
Adds a new thumbnail to media
.
a thumbnail for media
Adds a new thumbnail to media
.
a buffer containing the thumbnail for media
size of buffer
Adds a new media's URL with its mime-type.
a media's URL
th url
mime type
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
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.
Get the first value from data
associated with key
.
freed by user.
key to look up.
Returns all non-%NULL values for key
from data
. This ignores related keys.
values. Do not change or free the values. Free the list with #g_list_free.
a metadata key
Returns all non-%NULL values for key
from data
. key
must have been
registered as a string-type key. This ignores related keys.
not change or free the strings. Free the list with #g_list_free.
a metadata key
Returns the first binary value associated with key
from data
. If key
has
no first value, or value is not a gfloat, or key
is not in data, then %NULL
is returned.
successful size
will be set the to the buffer size.
key to use
Number of children of this box.
unknown.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
where the user play the media.
Returns the first float value associated with key
from data
. If key
has no
first value, or value is not a gfloat, or key
is not in data, then 0 is
returned.
key to use
Returns the first int value associated with key
from data
. If key
has no
first value, or value is not a gint, or key
is not in data, then 0 is
returned.
key to use
Returns a list with keys contained in data
.
keys. The content of the list should not be modified or freed. Use g_list_free() when done using the list.
Checks if old values are replaced when calling #grl_data_set.
object for this media
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
Returns a set containing the values for key
and related keys at position
index
from data
.
If user changes any of the values in the related keys, the changes will become permanent.
a metadata key
element to retrieve, starting at 0
Returns all non-%NULL values for key
from data
. This ignores related keys.
values. Do not change or free the values. Free the list with #g_list_free.
a metadata key
Returns all non-%NULL values for key
from data
. key
must have been
registered as a string-type key. This ignores related keys.
not change or free the strings. Free the list with #g_list_free.
a metadata key
Returns the first string value associated with key
from data
. If key
has
no first value, or value is not string, or key
is not in data,
then %NULL
is returned.
not change nor free the value.
key to use
buffer size.
pointer to store the thumbnail buffer size
element to retrieve
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 if key
is in data
.
key to search
Checks whether object
has a [floating][floating-ref] reference.
Checks if the key
has a first value in data
.
key to search
Returns how many values key
or related keys have in data:
if key
has no
value, but a related key has, then it is counted as positive.
As example, let's think in three related keys, K1, K2 and K3, and then thinks we have added several values for those keys, as:
(V10, V20, V30),, (V11, NULL, V31), (V12, NULL, V32)
Therefore, when invoking grl_data_length (data, K2) it will return 3: considering K2 and the related keys (K1 and K3), there are 3 values.
a metadata key
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().
Removes the first value for key
from data
. If there are other keys related
to key
their values will also be removed from data
.
key to remove
Removes the value at position index
for key
from data
. If there are other
keys related to key,
their values at position index
will also be removed
from data
.
a metadata key
index of key to be removed, starting at 0
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Serializes a GrlMedia into a string. It does a basic serialization.
See grl_media_serialize_extended() to get more serialization approaches.
Sets the first value associated with key
in data
. If key already has a
value old value is freed and the new one is set.
Also, checks that value
is compliant with key
specification, modifying it
accordingly. For instance, if key
requires a number between 0 and 10, but
value
is outside this range, it will be adapted accordingly.
key to change or add
the new value
Set the media's author
the media's author
Sets the first binary value associated with key
in data
. If key
already
has a first value old value is replaced by the new one.
key to change or add
buffer holding the data
size of the buffer
Set the media certificate
The rating certificate of the media
Sets the number of children of this box. Use #GRL_METADATA_KEY_CHILDCOUNT_UNKNOWN if it is unknown.
number of children
Set the creation_date of the media
date when media was created
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
Set the media's date (TBD)
the date
Set the media's description
the description
Set the media's duration
the duration
Set the location of a player for the media (usually a flash player)
location of an external player for this media
Set an external location where users can play the media
external location where this media can be played.
Sets the first float value associated with key
in data
. If key
already has
a first value old value is replaced by the new one.
key to change or add
the new value
Set the media identifier
the identifier of the media
Sets the first int value associated with key
in data
. If key
already has a
first value old value is replaced by the new one.
key to change or add
the new value
Set the media last played date
date when the media was last played
Set the media last played position
second at which the media playback was interrupted
Set the media license
The license of the media
Set the media's mime-type
the mime type
This controls if #grl_data_set will overwrite the current value of a property with the new one.
Set it to %TRUE so old values are overwritten, or %FALSE in other case (default is %FALSE).
if data can be overwritten
Set the media play count
the play count
Sets a property on an object.
the name of the property to set
the value
This method receives a rating and its scale and normalizes it
a rating value
maximum rating value
Updates the values at position index
in data
with values in relkeys
.
data
will take ownership of relkeys,
so do not free it after invoking this
function.
a set of related keys
position to be updated, starting at 0
Set the media's site
the site
Set the media's source
the source
Sets the first string value associated with key
in data
. If key
already
has a value old value is freed and the new one is set.
key to change or add
the new value
Set the media studio
The studio the media is from
Set the media's thumbnail URL
the thumbnail URL
Set the media's binary thumbnail
thumbnail buffer
thumbnail buffer size
Set the media's title
the title
Set the media's URL
the media's URL
Set the media's URL and its mime-type.
the media's URL
the url
mime type
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.
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.
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
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
Creates a new data box object.