Holder

class Holder : ObjectWrap , Lockable {}

Constructors

this
this(void* ptr, Flag!"Take" take)
this
this(gobject.types.GType type)

Creates a new holder of type type

Members

Functions

connectAttributeChanged
ulong connectAttributeChanged(T callback, Flag!"After" after)

Connect to AttributeChanged signal.

connectChanged
ulong connectChanged(T callback, Flag!"After" after)

Connect to Changed signal.

connectSourceChanged
ulong connectSourceChanged(T callback, Flag!"After" after)

Connect to SourceChanged signal.

connectValidateChange
ulong connectValidateChange(T callback, Flag!"After" after)

Connect to ValidateChange signal.

copy
gda.holder.Holder copy()

Copy constructor.

forceInvalid
void forceInvalid()

Forces a holder to be invalid; to set it valid again, a new value must be assigned to it using gda.holder.Holder.setValue or gda.holder.Holder.takeValue.

forceInvalidE
void forceInvalidE(glib.error.ErrorWrap error)

Forces a holder to be invalid; to set it valid again, a new value must be assigned to it using gda.holder.Holder.setValue or gda.holder.Holder.takeValue.

getAlphanumId
string getAlphanumId()

Get an "encoded" version of holder's name. The "encoding" consists in replacing non alphanumeric character with the string "__gdaXX" where XX is the hex. representation of the non alphanumeric char.

getAttribute
gobject.value.Value getAttribute(string attribute)

Get the value associated to a named attribute.

getBind
gda.holder.Holder getBind()

Get the holder which makes holder change its value when the holder's value is changed.

getDefaultValue
gobject.value.Value getDefaultValue()

Get the default value held into the holder. WARNING: the default value does not need to be of the same type as the one required by holder.

getGType
gobject.types.GType getGType()
getId
string getId()

Get the ID of holder. The ID can be set using holder's "id" property

getNotNull
bool getNotNull()

Get wether the holder can be NULL or not

getValue
gobject.value.Value getValue()

Get the value held into the holder. If holder is set to use its default value and that default value is not of the same type as holder, then null is returned.

getValueStr
string getValueStr(gda.data_handler.DataHandler dh)

Same functionality as gda.holder.Holder.getValue except that it returns the value as a string (the conversion is done using dh if not null, or the default data handler otherwise).

isValid
bool isValid()

Get the validity of holder (that is, of the value held by holder)

isValidE
bool isValidE()

Get the validity of holder (that is, of the value held by holder)

self
Holder self()

Returns this, for use in with statements.

setAttribute
void setAttribute(string attribute, gobject.value.Value value, glib.types.DestroyNotify destroy)

Set the value associated to a named attribute. The attribute string is 'stolen' by this method, and the memory it uses will be freed using the destroy function when no longer needed (if destroy is null, then the string will not be freed at all).

setBind
bool setBind(gda.holder.Holder bindTo)

Sets holder to change when bind_to changes (and does not make bind_to change when holder changes). For the operation to succeed, the GType of holder and bind_to must be the same, with the exception that any of them can have a GDA_TYPE_NULL type (in this situation, the GType of the two #GdaHolder objects involved is set to match the other when any of them sets its type to something different than GDA_TYPE_NULL).

setDefaultValue
void setDefaultValue(gobject.value.Value value)

Sets the default value within the holder. If value is null then holder won't have a default value anymore. To set a default value to null, then pass a #GValue created using gda.global.valueNewNull.

setNotNull
void setNotNull(bool notNull)

Sets if the holder can have a NULL value. If not_null is TRUE, then that won't be allowed

setSourceModel
bool setSourceModel(gda.data_model.DataModel model, int col)

Sets an hint that holder's values should be restricted among the values contained in the col column of the model data model. Note that this is just a hint, meaning this policy is not enforced by holder's implementation.

setValue
bool setValue(gobject.value.Value value)

Sets the value within the holder. If holder is an alias for another holder, then the value is also set for that other holder.

setValueStr
bool setValueStr(gda.data_handler.DataHandler dh, string value)

Same functionality as gda.holder.Holder.setValue except that it uses a string representation of the value to set, which will be converted into a GValue first (using default data handler if dh is null).

setValueToDefault
bool setValueToDefault()

Set holder's value to its default value.

takeValue
bool takeValue(gobject.value.Value value)

Sets the value within the holder. If holder is an alias for another holder, then the value is also set for that other holder.

valueIsDefault
bool valueIsDefault()

Tells if holder's current value is the default one.

Properties

_gType
GType _gType [@property getter]
description
string description [@property getter]
description
string description [@property setter]
fullBind
gda.holder.Holder fullBind [@property getter]
fullBind
gda.holder.Holder fullBind [@property setter]
gType
gobject.types.GType gType [@property getter]
gType
gobject.types.GType gType [@property setter]
id
string id [@property getter]
id
string id [@property setter]
name
string name [@property getter]
name
string name [@property setter]
notNull
bool notNull [@property getter]
notNull
bool notNull [@property setter]
simpleBind
gda.holder.Holder simpleBind [@property getter]
simpleBind
gda.holder.Holder simpleBind [@property setter]
sourceColumn
int sourceColumn [@property getter]
sourceColumn
int sourceColumn [@property setter]
sourceModel
gda.data_model.DataModel sourceModel [@property getter]
sourceModel
gda.data_model.DataModel sourceModel [@property setter]
validateChanges
bool validateChanges [@property getter]

Get validateChanges property.

validateChanges
bool validateChanges [@property setter]

Set validateChanges property.

Static functions

_getGType
GType _getGType()
errorQuark
glib.types.Quark errorQuark()

Mixed In Members

From mixin LockableT!()

lock
void lock()

Locks lockable. If it is already locked by another thread, the current thread will block until it is unlocked by the other thread.

trylock
bool trylock()

Tries to lock lockable. If it is already locked by another thread, then it immediately returns FALSE, otherwise it locks lockable.

unlock
void unlock()

Unlocks lockable. This method should not be called if the current does not already holds a lock on lockable (having used gda.lockable.Lockable.lock or gda.lockable.Lockable.trylock).

Inherited Members

From ObjectWrap

_setGObject
void _setGObject(void* cObj, Flag!"Take" take)

Set the GObject of a D ObjectWrap wrapper.

_cPtr
void* _cPtr(Flag!"Dup" dup)

Get a pointer to the underlying C object.

_ref
void* _ref(void* gObj)

Calls g_object_ref() on a GObject.

_unref
_unref(void* gObj)

Calls g_object_unref() on a GObject.

_getGType
GType _getGType()

Get the GType of an object.

_gType
GType _gType [@property getter]

GObject GType property.

self
ObjectWrap self()

Convenience method to return this cast to a type. For use in D with statements.

_getDObject
T _getDObject(void* cptr, Flag!"Take" take)

Template to get the D object from a C GObject and cast it to the given D object type.

connectSignalClosure
ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after)

Connect a D closure to an object signal.

setProperty
void setProperty(string propertyName, T val)

Template for setting a GObject property.

getProperty
T getProperty(string propertyName)

Template for getting a GObject property.

compatControl
size_t compatControl(size_t what, void* data)
bindProperty
gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectWrap target, string targetProperty, gobject.types.BindingFlags flags)

Creates a binding between source_property on source and target_property on target.

bindPropertyFull
gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectWrap target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom)

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.

forceFloating
void forceFloating()

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 gobject.object.ObjectWrap.refSink.

freezeNotify
void freezeNotify()

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.

getData
void* getData(string key)

Gets a named field from the objects table of associations (see gobject.object.ObjectWrap.setData).

getProperty
void getProperty(string propertyName, gobject.value.Value value)

Gets a property of an object.

getQdata
void* getQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata.

getv
void getv(string[] names, gobject.value.Value[] values)

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.

isFloating
bool isFloating()

Checks whether object has a floating[floating-ref] reference.

notify
void notify(string propertyName)

Emits a "notify" signal for the property property_name on object.

notifyByPspec
void notifyByPspec(gobject.param_spec.ParamSpec pspec)

Emits a "notify" signal for the property specified by pspec on object.

refSink
gobject.object.ObjectWrap refSink()

Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.

runDispose
void runDispose()

Releases all references to other objects. This can be used to break reference cycles.

setData
void setData(string key, void* data)

Each object carries around a table of associations from strings to pointers. This function lets you set an association.

setProperty
void setProperty(string propertyName, gobject.value.Value value)

Sets a property on an object.

stealData
void* stealData(string key)

Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

stealQdata
void* stealQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata 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:

thawNotify
void thawNotify()

Reverts the effect of a previous call to gobject.object.ObjectWrap.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

watchClosure
void watchClosure(gobject.closure.Closure closure)

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 gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectWrap.ref_ and gobject.object.ObjectWrap.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.

connectNotify
ulong connectNotify(string detail, T callback, Flag!"After" after)

Connect to Notify signal.

From Lockable

_getGType
GType _getGType()
lock
void lock()

Locks lockable. If it is already locked by another thread, the current thread will block until it is unlocked by the other thread.

trylock
bool trylock()

Tries to lock lockable. If it is already locked by another thread, then it immediately returns FALSE, otherwise it locks lockable.

unlock
void unlock()

Unlocks lockable. This method should not be called if the current does not already holds a lock on lockable (having used gda.lockable.Lockable.lock or gda.lockable.Lockable.trylock).