ObjectG

The base object type.

gobject.object.ObjectG is the fundamental type providing the common attributes and methods for all object types in GTK, Pango and other libraries based on GObject. The gobject.object.ObjectG class provides methods for object construction and destruction, property access methods, and signal support. Signals are described in detail here[gobject-Signals].

For a tutorial on implementing a new gobject.object.ObjectG class, see [How to define and implement a new GObject](tutorial.html#how-to-define-and-implement-a-new-gobject). For a list of naming conventions for GObjects and their methods, see the GType conventions. For the high-level concepts behind GObject, read Instantiatable classed types: Objects.

Since GLib 2.72, all gobject.object.ObjectGs are guaranteed to be aligned to at least the alignment of the largest basic GLib type (typically this is vte.types.TEST_FLAGS_NONE or graphene.types.PI_2). If you need larger alignment for an element in a gobject.object.ObjectG, you should allocate it on the heap (aligned), or arrange for your gobject.object.ObjectG to be appropriately padded. This guarantee applies to the gobject.object.ObjectG (or derived) struct, the gstpbutils.types.ObjectClass (or derived) struct, and any private data allocated by G_ADD_PRIVATE().

class ObjectG {

protected

ObjectC* cInstancePtr;

this(GType type);

this(void* cObj, Flag!"Take" take);

void setGObject(void* cObj, Flag!"Take" take);

void* cPtr(Flag!"Dup" dup);

static void* ref_(void* gObj);

static unref(void* gObj);

static GType getType();

GType gType [@property getter];

ObjectG self();

static T getDObject(void* cptr, Flag!"Take" take);

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

void setProperty(string propertyName, T val);

T getProperty(string propertyName);

static size_t compatControl(size_t what, void* data);

gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags);

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

void forceFloating();

void freezeNotify();

void* getData(string key);

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

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

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

bool isFloating();

void notify(string propertyName);

void notifyByPspec(gobject.param_spec.ParamSpec pspec);

gobject.object.ObjectG refSink();

void runDispose();

void setData(string key, void* data);

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

void* stealData(string key);

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

void thawNotify();

void watchClosure(gobject.closure.Closure closure);

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

}

Constructors

this this(GType type): Create an ObjectG which is wrapping a C GObject with the given GType. Useful for creating custom D classes which are derived from ObjectG.
this this(void* cObj, Flag!"Take" take): Constructor to wrap a C GObject with a D proxy object.

Destructor

A destructor is present on this object, but not explicitly documented in the source.

Members

Functions

bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG 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.ObjectG 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.
cPtr void* cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
connectNotify ulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.
connectSignalClosure ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
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.ObjectG.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.ObjectG.setData).
getProperty T getProperty(string propertyName): Template for getting a GObject property.
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.ObjectG.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.ObjectG 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.
self ObjectG self(): Convenience method to return this cast to a type. For use in D with statements.
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.
setGObject void setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectG wrapper.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
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.ObjectG.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.ObjectG.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.ObjectG.ref_ and gobject.object.ObjectG.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.

Properties

gType GType gType [@property getter]: GObject GType property.

Static functions

compatControl size_t compatControl(size_t what, void* data)
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.
getType GType getType(): Get the GType of an object.
ref_ void* ref_(void* gObj): Calls g_object_ref() on a GObject.
unref unref(void* gObj): Calls g_object_unref() on a GObject.

gobject object classes

functions

objectGMixin