Package org.webkitgtk

Class EditorState

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.webkitgtk.EditorState

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public final class EditorState
extends GObject

Web editor state.

WebKitEditorState represents the state of a WebKitWebView editor. Use webkit_web_view_get_editor_state() to get the WebKitEditorState of a WebKitWebView.

Since:

2.10

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EditorState.Builder<B extends EditorState.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	EditorState.ChangedCallback	Functional interface declaration of the ChangedCallback callback.
static class	EditorState.EditorStateClass

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
EditorState()	Creates a new EditorState.
EditorState(MemorySegment address)	Create a EditorState proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected EditorState	asParent()	Returns this instance as if it were its parent type.
static EditorState.Builder<? extends EditorState.Builder>	builder()	A EditorState.Builder object constructs a EditorState with the specified properties.
void	emitChanged()	Emits the "changed" signal.
static @Nullable Type	getType()	Get the GType of the EditorState class
int	getTypingAttributes()	Gets the typing attributes at the current cursor position.
boolean	isCopyAvailable()	Gets whether a copy command can be issued.
boolean	isCutAvailable()	Gets whether a cut command can be issued.
boolean	isPasteAvailable()	Gets whether a paste command can be issued.
boolean	isRedoAvailable()	Gets whether a redo command can be issued.
boolean	isUndoAvailable()	Gets whether an undo command can be issued.
SignalConnection<EditorState.ChangedCallback>	onChanged(EditorState.ChangedCallback handler)	Emitted when the WebKitEdtorState is changed.

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, getMemoryLayout, 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, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

EditorState

public EditorState(MemorySegment address)

Create a EditorState proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

EditorState

public EditorState()

Creates a new EditorState.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the EditorState class

Returns:

the GType

asParent

protected EditorState asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

getTypingAttributes

public int getTypingAttributes()

Gets the typing attributes at the current cursor position.

If there is a selection, this returns the typing attributes of the selected text. Note that in case of a selection, typing attributes are considered active only when they are present throughout the selection.

Returns:

a bitmask of WebKitEditorTypingAttributes flags

Since:

2.10

isCopyAvailable

public boolean isCopyAvailable()

Gets whether a copy command can be issued.

Returns:

true if copy is currently available

Since:

2.20

isCutAvailable

public boolean isCutAvailable()

Gets whether a cut command can be issued.

Returns:

true if cut is currently available

Since:

2.20

isPasteAvailable

public boolean isPasteAvailable()

Gets whether a paste command can be issued.

Returns:

true if paste is currently available

Since:

2.20

isRedoAvailable

public boolean isRedoAvailable()

Gets whether a redo command can be issued.

Returns:

true if redo is currently available

Since:

2.20

isUndoAvailable

public boolean isUndoAvailable()

Gets whether an undo command can be issued.

Returns:

true if undo is currently available

Since:

2.20

onChanged

public SignalConnection<EditorState.ChangedCallback> onChanged(EditorState.ChangedCallback handler)

Emitted when the WebKitEdtorState is changed.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

2.44

See Also:

• EditorState.ChangedCallback.run()

emitChanged

public void emitChanged()

Emits the "changed" signal. See onChanged(org.webkitgtk.EditorState.ChangedCallback).

builder

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

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

Returns:

the builder object