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
Creates a new #GdaServerOperation object which can be modified in order to perform the type
type of
action. The options
can contain:
a #GdaConnection object which will be used to perform an action, or %NULL
the type of operation requested
a list of parameters or %NULL
Creates a new #GdaSqlParser object which is adapted to provider
(and possibly depending on
cnc
for the actual database version).
If prov
does not have its own parser, then %NULL is returned, and a general SQL parser can be obtained
using gda_sql_parser_new().
a #GdaConnection, or %NULL
Escapes str
for use within an SQL command (to avoid SQL injection attacks). Note that the returned value still needs
to be enclosed in single quotes before being used in an SQL statement.
a #GdaConnection object, or %NULL
a string to escape
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
Find a #GdaDataHandler object to manipulate data of type for_type
.
Note: this function is currently very poorly implemented by database providers.
a #GdaConnection object, or %NULL
a DBMS type definition
Find a #GdaDataHandler object to manipulate data of type for_type
. The returned object must not be modified.
a #GdaConnection object, or %NULL
a #GType
Get the name of the most common data type which has type
type.
The returned value may be %NULL either if the provider does not implement that method, or if
there is no DBMS data type which could contain data of the g_type
type (for example %NULL may be
returned if a DBMS has integers only up to 4 bytes and a #G_TYPE_INT64 is requested).
a #GdaConnection object or %NULL
a #GType value type
Get the name (identifier) of the provider
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 the version of the database to which the connection is opened.
a #GdaConnection object
Get the version of the provider.
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
Reserved to database provider's implementations: get the #GdaDataHandler associated to prov
for connection cnc
. You probably want to use gda_server_provider_get_data_handler_g_type().
a #GdaConnection
a #GType
a database type
Reserved to database provider's implementations. This method defines a default data handler for
provider,
and returns that #GdaDataHandler.
a #GType
Checks whether object
has a [floating][floating-ref] reference.
Locks lockable
. If it is already locked by another thread, the current thread will block until it is unlocked
by the other thread.
Note: unlike g_mutex_lock(), this method recursive, which means a thread can lock lockable
several times
(and has to unlock it as many times to actually unlock it).
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
.
Performs the operation described by op
. Note that op
is not destroyed by this method
and can be reused.
a #GdaConnection object which will be used to perform the action, or %NULL
a #GdaServerOperation object
Performs the operation described by op,
using the SQL from the rendering of the operation
a #GdaConnection object which will be used to perform an action, or %NULL
a #GdaServerOperation 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().
Creates an SQL statement (possibly using some specific extensions of the DBMS) corresponding to the
op
operation. Note that the returned string may actually contain more than one SQL statement.
This function's purpose is mainly informative to get the actual SQL code which would be executed to perform the operation; to actually perform the operation, use gda_server_provider_perform_operation().
a #GdaConnection object which will be used to render the action, or %NULL
a #GdaServerOperation object
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
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
Sets a property on an object.
the name of the property to set
the value
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
Use provider
to create a new #GValue from a single string representation.
The preferred_type
can optionally ask provider
to return a #GValue of the requested type
(but if such a value can't be created from string,
then %NULL is returned);
pass #G_TYPE_INVALID if any returned type is acceptable.
The returned value is either a new #GValue or %NULL in the following cases:
string
cannot be converted to preferred_type
typepreferred_type
string
If dbms_type
is not %NULL, then if will contain a constant string representing
the database type used for the conversion if the conversion was successfull, or %NULL
otherwise.
a #GdaConnection object, or %NULL
the SQL string to convert to a value
a #GType, or #G_TYPE_INVALID
place to get the actual database type used if the conversion succeeded, or %NULL
Tests if a feature is supported
a #GdaConnection object, or %NULL
#GdaConnectionFeature feature to test
Tells if provider
supports the type
of operation on the cnc
connection, using the
(optional) options
parameters.
a #GdaConnection object which would be used to perform an action, or %NULL
the type of operation requested
a list of named parameters, or %NULL
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.
Tries to lock lockable
. If it is already locked by another thread, then it immediately returns FALSE, otherwise
it locks lockable
.
Note: unlike g_mutex_lock(), this method recursive, which means a thread can lock lockable
several times
(and has to unlock it as many times to actually unlock it).
Unescapes str
for use within an SQL command. This is the exact opposite of gda_server_provider_escape_string().
a #GdaConnection object, or %NULL
a string to escape
Unlocks lockable
. This method should not be called if the current does not already holds a lock on lockable
(having
used gda_lockable_lock() or gda_lockable_trylock()).
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.
Produces a fully quoted and escaped string from a GValue
a #GdaConnection object, or %NULL
#GValue to convert from
Locks lockable
. If it is already locked by another thread, the current thread will block until it is unlocked
by the other thread.
Note: unlike g_mutex_lock(), this method recursive, which means a thread can lock lockable
several times
(and has to unlock it as many times to actually unlock it).
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.
Tries to lock lockable
. If it is already locked by another thread, then it immediately returns FALSE, otherwise
it locks lockable
.
Note: unlike g_mutex_lock(), this method recursive, which means a thread can lock lockable
several times
(and has to unlock it as many times to actually unlock it).
Unlocks lockable
. This method should not be called if the current does not already holds a lock on lockable
(having
used gda_lockable_lock() or gda_lockable_trylock()).
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
Obtain a #GMainContext on which to iterate. This function is reserved to database provider's implementations.
NB: if cnc
is NOT %NULL and has a #GdaWorker associated, and if we are in its worker thread, then this function
returns %NULL (to avoid generating contexts which are never used)
a #GdaConnection, or %NULL
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
Loads and returns the contents of the specified resource. This function should only be used by database provider's implementations
the provider's name
the name of the resource to load
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
Upon creation, used by provider's implementors to set the implementation functions. Passing %NULL
as the functions_set
has no effect.
If some pointers of functions_set
are %NULL, they are replaced by functions from the parent class of
provider
.
Warning: this function must only be called once for each different values of type
and for each klass
a #GdaServerProviderClass object
a #GdaServerProviderFunctionsType type
a pointer to the function set, or %NULL
Creates a binding between
source_property
onsource
andtarget_property
ontarget
.Whenever the
source_property
is changed thetarget_property
is updated using the same value. For instance: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: iftarget_property
ontarget
changes then thesource_property
onsource
will be updated as well.The binding will automatically be removed when either the
source
or thetarget
instances are finalized. To remove the binding without affecting thesource
and thetarget
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
andtarget
are only used from a single thread and it is clear that bothsource
andtarget
outlive the binding. Especially it is not safe to rely on this if the binding,source
ortarget
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.