Package io.github.jwharm.javagi.gtk.util

Class BuilderJavaScope

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.BuilderCScope

io.github.jwharm.javagi.gtk.util.BuilderJavaScope

All Implemented Interfaces:

Proxy, BuilderScope

public final class BuilderJavaScope
extends BuilderCScope
implements BuilderScope

The BuilderJavaScope class can be used with a GtkBuilder to refer to Java instance methods from a ui file.

When a ui file contains, for example, the following element:

<signal name="clicked" handler="okButtonClicked"/>

the Java instance method okButtonClicked() will be called on the widget that is being built with the GtkBuilder.

Nested Class Summary

Nested classes/interfaces inherited from class org.gnome.gtk.BuilderCScope

BuilderCScope.Builder<B extends BuilderCScope.Builder<B>>, BuilderCScope.BuilderCScopeClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gtk.BuilderScope

BuilderScope.BuilderScopeImpl, BuilderScope.BuilderScopeInterface

Constructor Summary

Constructors

Constructor	Description
BuilderJavaScope(MemorySegment address)	Memory address constructor for instantiating a Java proxy object

Method Summary

Modifier and Type	Method	Description
Closure	createClosure(GtkBuilder builder, String function, Set<BuilderClosureFlags> flags, GObject object)	Called by a GtkBuilder to create a Closure from the name that was specified in an attribute of a UI file.
static Type	getType()	Return the GType of BuilderJavaScope
Type	getTypeFromFunction(GtkBuilder builder, String functionName)	See BuilderScope.getTypeFromFunction(GtkBuilder, String)
Type	getTypeFromName(GtkBuilder builder, String typeName)	See BuilderScope.getTypeFromName(GtkBuilder, String)
static BuilderJavaScope	newInstance()	Instantiates a new BuilderScope

Methods inherited from class org.gnome.gtk.BuilderCScope

addCallbackSymbol, addCallbackSymbols, asParent, builder, getMemoryLayout, lookupCallbackSymbol

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.github.jwharm.javagi.base.Proxy

handle

Constructor Details

BuilderJavaScope

public BuilderJavaScope(MemorySegment address)

Memory address constructor for instantiating a Java proxy object

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Return the GType of BuilderJavaScope

Returns:

the GType

newInstance

public static BuilderJavaScope newInstance()

Instantiates a new BuilderScope

createClosure

public Closure createClosure(GtkBuilder builder,
 String function,
 Set<BuilderClosureFlags> flags,
 GObject object)
                      throws GErrorException

Called by a GtkBuilder to create a Closure from the name that was specified in an attribute of a UI file. The function should refer to a method in the Java class (a Buildable instance). If that fails, as a fallback mechanism the BuilderScope.createClosure(GtkBuilder, String, Set, GObject) is called and the result of that function is returned.

Specified by:

createClosure in interface BuilderScope

Parameters:

builder - the GtkBuilder instance

function - the function name for which a Closure will be returned

flags - options for creating the closure

object - unused

Returns:

a new JavaClosure instance for the requested function

Throws:

GErrorException - when an error occurs

getTypeFromFunction

public Type getTypeFromFunction(GtkBuilder builder,
 String functionName)

See BuilderScope.getTypeFromFunction(GtkBuilder, String)

Specified by:

getTypeFromFunction in interface BuilderScope

Parameters:

builder - the GtkBuilder instance

functionName - the name of the function that will return a GType

Returns:

the GType returned by functionName

getTypeFromName

public Type getTypeFromName(GtkBuilder builder,
 String typeName)

See BuilderScope.getTypeFromName(GtkBuilder, String)

Specified by:

getTypeFromName in interface BuilderScope

Parameters:

builder - the GtkBuilder instance

typeName - the name of the GType

Returns:

the requested GType