Create a new empty shared model without any column schema associated. The column schema will be set in one of two ways: firstly you may set it manually with dee_model_set_schema() or secondly it will be set once the first rows are exchanged with a peer model.
A #DeeSharedModel with a schema manually set has to be created before
creating more #DeeSharedModel with the same name.
A shared model created with this constructor will store row data in a suitably picked memory backed model.
A well known name to publish this model under. Models sharing this name will synchronize with each other
Enumeration defining behavior of this model when trying to write to it.
Setting this to #DEE_SHARED_MODEL_ACCESS_MODE_LEADER_WRITABLE is useful when one process is considered an "owner" of a model and all the other peers are supposed to only synchronize it for reading.
See also DeePeer:swarm-owner property to ensure ownership of a swarm.
The backend model used by this proxy model.
Enumeration defining the flushing behavior.
Setting this to #DEE_SHARED_MODEL_FLUSH_MODE_MANUAL will disable automatic flushing that usually happens when the application's main event loop is idle. Automatic flushing should be primarily disabled when a shared model is used from multiple threads, or when not using #GMainLoop. When disabled, dee_shared_model_flush_revision_queue() needs to be called explicitely.
Boolean property defining whether sequence numbers will be inherited from the back end model. You will most likely want to set this property to false if the implementation manipulates with the rows in the model and keep track of seqnums yourself.
The #DeePeer that this model uses to connect to the swarm
Boolean property defining whether or not to automatically forward signals from the back end model. This is especially useful for sub classes wishing to do their own more advanced signal forwarding.
Boolean property defining whether or not the model has synchronized with its peers (if any) yet.
You should not modify a #DeeSharedModel that is not synchronized. Before modifying the model in any way (except calling dee_model_set_schema()) you should wait for it to become synchronized.
Like dee_model_append() but intended for language bindings or situations where you work with models on a meta level and may not have a prior knowledge of the column schemas of the models. See also dee_model_build_row().
An array of #GVariants with type signature matching those of the column schemas of self. If any of the variants have floating references they will be consumed
Notify listeners that the model is about to be changed, which means that multiple row additions / changes / removals will follow. The default implementation of this method will emit the ::changeset-started signal.
It is not stricly necessary to enclose every change to a model in a dee_model_begin_changeset() and dee_model_end_changeset() calls, but doing so is highly recommended and allows implementing various optimizations.
The usual way to perform multiple changes to a model is as follows:
dee_model_begin_changeset (model);
dee_model_remove (model, dee_model_get_first_iter (model)); dee_model_append_row (model, added_row_data1); dee_model_append_row (model, added_row_data2);
dee_model_end_changeset (model); }
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
Removes all rows in the model. Signals are emitted for each row in the model
Notify listeners that all changes have been committed to the model. The default implementation of this method will emit the ::changeset-finished signal.
See also dee_model_begin_changeset().
Build an externalized form of self which can be used together with
dee_serializable_parse_external() to rebuild a copy of self.
It is important to note that the variant returned from this method does not have the same type signature as returned from a call to dee_serializable_serialize(). Externalization will wrap the serialized data in a container format with versioning information and headers with type information.
Finds a row in self according to the sorting specified by cmp_func.
This method will assume that self is already sorted by cmp_func.
If you use this method for searching you should only use dee_model_insert_row_sorted() to insert rows in the model.
An array of #GVariants with type signature matching those of the column schemas of self. No references will be taken on the variants.
Callback used for comparison or rows
Like dee_model_find_row_sorted(), but uses DeeCompareRowSizedFunc and therefore doesn't cause trouble when used from introspected languages.
Finds a row in self according to the sorting specified by cmp_func.
This method will assume that self is already sorted by cmp_func.
If you use this method for searching you should only use dee_model_insert_row_sorted() (or dee_model_insert_row_sorted_with_sizes()) to insert rows in the model.
An array of #GVariants with type signature matching those of the column schemas of self. No references will be taken on the variants.
Callback used for comparison or rows
Expert: All changes to self that has not yet been propagated to the peer
models are send. If you also want to block the mainloop until
all the underlying transport streams have been flushed use
dee_shared_model_flush_revision_queue_sync().
Normally #DeeSharedModel collects changes to self into batches and sends
them automatically to all peers. You can use this call to provide fine
grained control of exactly when changes to self are synchronized to its
peers. This may for example be useful to improve the interactivity of your
application if you have a model-process which intermix small and light
changes with big and expensive changes. Using this call you can make sure
the model-process dispatches small changes more aggresively to the
view-process, while holding on to the expensive changes a bit longer.
Similar to dee_shared_model_flush_revision_queue(), but also blocks the mainloop until all the underlying transport streams have been flushed.
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 column index of a column.
the column name to retrieve the index of
Get a %NULL-terminated array of column names for the columns of self.
These names can be used in calls to dee_model_build_named_row().
Get the #GVariant signature of a column
the column to get retrieve the #GVariant type string of
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Get the #GVariant signature of field previously registered with dee_model_register_vardict_schema().
name of vardict field to get schema of
Convenience function for accessing the #DeeSharedModel:flush-mode property.
Gets the number of columns in self
Gets the number of rows in self
Convenience function for accessing the #DeeSharedModel:peer property
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
Get a %NULL-terminated array of #GVariant type strings that defines the
required formats for the columns of self.
Convenience function for accessing the #DeePeer:swarm-name property of the #DeePeer defined in the #DeeSharedModel:peer property.
Get a schema for variant dictionary column previously registered using dee_model_register_vardict_schema().
the column index to get the schemas for
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
Increments sequence number of this #DeeSerializableModel.
As dee_model_insert(), but intended for language bindings or situations where you work with models on a meta level and may not have a priori knowledge of the column schemas of the models. See also dee_model_build_row().
The index to insert the row on. The existing row will be pushed down.
An array of #GVariants with type signature matching those of the column schemas of self. If any of the variants have floating references they will be consumed.
As dee_model_insert_before(), but intended for language bindings or situations where you work with models on a meta level and may not have a priori knowledge of the column schemas of the models. See also dee_model_build_row().
An iter pointing to the row before which to insert the new one
An array of #GVariants with type signature matching those of the column schemas of self. If any of the variants have floating references they will be consumed.
Inserts a row in self according to the sorting specified by cmp_func.
If you use this method for insertion you should not use other methods as this
method assumes the model to be already sorted by cmp_func.
An array of #GVariants with type signature matching those of the column schemas of self. If any of the variants have floating references they will be consumed.
Callback used for comparison or rows
Inserts a row in self according to the sorting specified by cmp_func.
If you use this method for insertion you should not use other methods as this
method assumes the model to be already sorted by cmp_func.
An array of #GVariants with type signature matching those of the column schemas of self. If any of the variants have floating references they will be consumed.
Callback used for comparison or rows
Checks whether object has a [floating][floating-ref] reference.
Check if the model is the swarm leader. This is a convenience function for accessing the #DeeSharedModel:peer property and checking if it's the swarm leader.
Check if the model is synchronized with its peers. Before modifying a shared model in any way (except dee_model_set_schema()) you should wait for it to become synchronized. This is normally done by waiting for the "notify::synchronized" signal.
This method is purely a convenience function for accessing the #DeeSharedModel:synchronized property.
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.
Like dee_model_prepend() but intended for language bindings or situations where you work with models on a meta level and may not have a priori knowledge of the column schemas of the models. See also dee_model_build_row().
An array of #GVariants with type signature matching those of the column schemas of self. If any of the variants have floating references they will be consumed.
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().
Register a new tag on a #DeeModel. A
Tags can be very useful in associating some extra data to a row in a model and have that automatically synced when the model changes. If you're writing a tiled view for a model you might want to tag each row with the tile widget for that row. That way you have very convenient access to the tile widget given any row in the model.
The private nature of tags and the fact that you can store arbitrary pointers and binary data in them also means that they are not serialized if you utilize a model implementation that exposes the #DeeSerializable interface.
Function called when a tagged row is removed from the model. This function will also be called on all tagged rows when the model is finalized.
Register schema for fields in a model containing column with variant dictionary schema ('a{sv}'). The keys registered with this function can be later used with dee_model_build_named_row() function, as well as dee_model_get_value_by_name(). Note that it is possible to register the same field name for multiple columns, in which case you need to use fully-qualified "column_name::field" name in the calls to dee_model_build_named_row() and dee_model_get_field_schema().
the column index to register the schemas with
hashtable with keys specifying names of the fields and values defining their schema
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Build a clean serialized representation of self. The signature of the
returned variant is entirely determined by the underlying implementation.
You can recreate a serialized instance by calling dee_serializable_parse()
provided that you know the correct #GType for the serialized instance.
Set column names used by self.
This method must be called exactly once, but only after setting
a schema of the model. Note that some constructors will do this for you.
A list of column names terminated by a %NULL
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
Convenience function for setting the #DeeSharedModel:flush-mode property.
Flush mode to use
Sets a property on an object.
the name of the property to set
the value
Sets all columns in the row iter points to, to those found in
row_members. The variants in row_members must match the types defined in
the model's schema.
a #DeeModelIter
And array of #GVariants with type signature matching those from the model schema. If any of the variants have floating references these will be consumed
Set the #GVariant types and the number of columns used by self.
This method must be called exactly once before using self. Note that
some constructors will do this for you.
A list of #GVariant type strings terminated by a %NULL
Sets sequence number of this #DeeSerializableModel.
Sequence number
Set a tag on a row in a model. This function is guaranteed to be O(1). See also dee_model_register_tag().
If tag is already set on this row the existing tag value will be destroyed
with the #GDestroyNotify passed to the dee_model_register_tag().
The row to set the tag on
The tag handle for the tag as obtained from dee_model_register_tag()
The value to set for tag. Note that %NULL represents an unset tag
Sets the data in column for the row iter points to, to value. The type
of value must be convertible to the type of the column.
When this method call completes the model will emit ::row-changed. You can edit the model in place without triggering the change signals by calling dee_model_set_value_silently().
a #DeeModelIter
column number to set the value
New value for cell. If value is a floating reference the model will assume ownership of the variant
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
Create a new empty shared model without any column schema associated. The column schema will be set in one of two ways: firstly you may set it manually with dee_model_set_schema() or secondly it will be set once the first rows are exchanged with a peer model.
A #DeeSharedModel with a schema manually set has to be created before
creating more #DeeSharedModel with the same name.
A shared model created with this constructor will store row data in a suitably picked memory backed model.
A well known name to publish this model under. Models sharing this name will synchronize with each other
Create a new empty shared model without any column schema associated. The column schema will be set in one of two ways: firstly you may set it manually with dee_model_set_schema() or secondly it will be set once the first rows are exchanged with a peer model.
A #DeeSharedModel with a schema manually set has to be created before
creating more #DeeSharedModel with the same name.
A shared model created with this constructor will store row data in a suitably picked memory backed model.
A #DeePeer instance.
Create a new shared model storing all data in back_end.
The model will start synchronizing with peer models as soon as possible and the #DeeSharedModel:synchronized property will be set once finished.
A well known name to publish this model under. Models sharing this name will synchronize with each other
The #DeeModel that will actually store the model data. Ownership of the ref to back_end is transfered to the shared model.
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
All fields in the DeeSharedModel structure are private and should never be accessed directly