Class IMContextSimple

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.IMContext

org.gnome.gtk.IMContextSimple

All Implemented Interfaces:

Proxy

@Generated("org.javagi.JavaGI")
public class IMContextSimple
extends IMContext

Supports compose sequences, dead keys and numeric Unicode input.

Compose sequences

GtkIMContextSimple reads compose sequences from the first of the following files that is found: ~/.config/gtk-4.0/Compose, ~/.XCompose, /usr/share/X11/locale/$locale/Compose (for locales that have a nontrivial Compose file). A subset of the file syntax described in the Compose(5) manual page is supported. Additionally, include "%L" loads GTK’s built-in table of compose sequences rather than the locale-specific one from X11.

If none of these files is found, GtkIMContextSimple uses a built-in table of compose sequences that is derived from the X11 Compose files.

Note that compose sequences typically start with the Compose_key, which is often not available as a dedicated key on keyboards. Keyboard layouts may map this keysym to other keys, such as the right Control key.

Unicode characters

GtkIMContextSimple also supports numeric entry of Unicode characters by typing Ctrl-Shift-u, followed by a hexadecimal Unicode codepoint.

For example,

Ctrl-Shift-u 1 2 3 Enter

yields U+0123 LATIN SMALL LETTER G WITH CEDILLA, i.e. ģ.

Dead keys

GtkIMContextSimple supports dead keys. For example, typing

dead_acute a

yields U+00E! LATIN SMALL LETTER_A WITH ACUTE, i.e. á. Note that this depends on the keyboard layout including dead keys.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IMContextSimple.Builder<B extends IMContextSimple.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	IMContextSimple.IMContextSimpleClass

Nested classes/interfaces inherited from class IMContext

IMContext.CommitCallback, IMContext.DeleteSurroundingCallback, IMContext.IMContext$Impl, IMContext.IMContextClass, IMContext.InvalidCompositionCallback, IMContext.PreeditChangedCallback, IMContext.PreeditEndCallback, IMContext.PreeditStartCallback, IMContext.RetrieveSurroundingCallback

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
IMContextSimple()	Create a new IMContextSimple.
IMContextSimple(MemorySegment address)	Create a IMContextSimple instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
void	addComposeFile(String composeFile)	Adds an additional table from the X11 compose file.
void	addTable(@Nullable short @Nullable [] data, int maxSeqLen, int nSeqs)	Deprecated. Use gtk_im_context_simple_add_compose_file()
protected IMContextSimple	asParent()	Return this instance as if it were its parent type.
static IMContextSimple.Builder<? extends IMContextSimple.Builder>	builder()	A IMContextSimple.Builder object constructs a IMContextSimple with the specified properties.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the IMContextSimple class.

Methods inherited from class IMContext

activateOsk, activateOsk, activateOskWithEvent, commit, deleteSurrounding, emitCommit, emitDeleteSurrounding, emitInvalidComposition, emitPreeditChanged, emitPreeditEnd, emitPreeditStart, emitRetrieveSurrounding, filterKey, filterKey, filterKeypress, focusIn, focusOut, getPreeditString, getSurrounding, getSurroundingWithSelection, invalidComposition, onCommit, onDeleteSurrounding, onInvalidComposition, onPreeditChanged, onPreeditEnd, onPreeditStart, onRetrieveSurrounding, preeditChanged, preeditEnd, preeditStart, reset, retrieveSurrounding, setClientWidget, setCursorLocation, setSurrounding, setSurroundingWithSelection, setUsePreedit

Methods inherited from class 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 TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class ProxyInstance

equals, handle, hashCode

Methods inherited from class Object

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

Constructor Details

IMContextSimple

public IMContextSimple(MemorySegment address)

Create a IMContextSimple instance for the provided memory address.

Parameters:

address - the memory address of the native object

IMContextSimple

public IMContextSimple()

Create a new IMContextSimple.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the IMContextSimple class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected IMContextSimple asParent()

Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.

Overrides:

asParent in class IMContext

Returns:

the instance as if it were its parent type

addComposeFile

public void addComposeFile(String composeFile)

Adds an additional table from the X11 compose file.

Parameters:

composeFile - The path of compose file

addTable

@Deprecated
public void addTable(@Nullable short @Nullable [] data,
 int maxSeqLen,
 int nSeqs)

Deprecated.

Use gtk_im_context_simple_add_compose_file()

Adds an additional table to search to the input context. Each row of the table consists of maxSeqLen key symbols followed by two guint16 interpreted as the high and low words of a gunicode value. Tables are searched starting from the last added.

The table must be sorted in dictionary order on the numeric value of the key symbol fields. (Values beyond the length of the sequence should be zero.)

Parameters:

data - the table

maxSeqLen - Maximum length of a sequence in the table

nSeqs - number of sequences in the table

builder

public static IMContextSimple.Builder<? extends IMContextSimple.Builder> builder()

A IMContextSimple.Builder object constructs a IMContextSimple with the specified properties. Use the various set...() methods to set properties, and finish construction with IMContextSimple.Builder.build().

Returns:

the builder object