GI.WebKit.Objects.EditorState

Web editor state.

WebKitEditorState represents the state of a WebView editor. Use webViewGetEditorState to get the WebKitEditorState of a WebView.

Since: 2.10

Exported types

newtype EditorState

Memory-managed wrapper type.

Constructors

EditorState (ManagedPtr EditorState)

Instances

Eq EditorState

Defined in GI.WebKit.Objects.EditorState

Methods

(==) :: EditorState -> EditorState -> Bool

(/=) :: EditorState -> EditorState -> Bool

GObject EditorState

Defined in GI.WebKit.Objects.EditorState

ManagedPtrNewtype EditorState

Defined in GI.WebKit.Objects.EditorState

Methods

toManagedPtr :: EditorState -> ManagedPtr EditorState

TypedObject EditorState

Defined in GI.WebKit.Objects.EditorState

Methods

glibType :: IO GType

HasParentTypes EditorState

Defined in GI.WebKit.Objects.EditorState

IsGValue (Maybe EditorState)

Convert EditorState to and from GValue. See toGValue and fromGValue.

Defined in GI.WebKit.Objects.EditorState

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe EditorState -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe EditorState)

type ParentTypes EditorState

Defined in GI.WebKit.Objects.EditorState

type ParentTypes EditorState = '[Object]

class (GObject o, IsDescendantOf EditorState o) => IsEditorState o

Type class for types which can be safely cast to EditorState, for instance with toEditorState.

Instances

(GObject o, IsDescendantOf EditorState o) => IsEditorState o

Defined in GI.WebKit.Objects.EditorState

toEditorState :: (MonadIO m, IsEditorState o) => o -> m EditorState

Cast to EditorState, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isCopyAvailable, isCutAvailable, isFloating, isPasteAvailable, isRedoAvailable, isUndoAvailable, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getProperty, getQdata, getTypingAttributes.

Setters

setData, setDataFull, setProperty.

getTypingAttributes

editorStateGetTypingAttributes

Arguments

:: (HasCallStack, MonadIO m, IsEditorState a)

=> a

editorState: a EditorState

-> m Word32

Returns: a bitmask of EditorTypingAttributes flags

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.

Since: 2.10

isCopyAvailable

editorStateIsCopyAvailable

Arguments

:: (HasCallStack, MonadIO m, IsEditorState a)

=> a

editorState: a EditorState

-> m Bool

Returns: True if copy is currently available

Gets whether a copy command can be issued.

Since: 2.20

isCutAvailable

editorStateIsCutAvailable

Arguments

:: (HasCallStack, MonadIO m, IsEditorState a)

=> a

editorState: a EditorState

-> m Bool

Returns: True if cut is currently available

Gets whether a cut command can be issued.

Since: 2.20

isPasteAvailable

editorStateIsPasteAvailable

Arguments

:: (HasCallStack, MonadIO m, IsEditorState a)

=> a

editorState: a EditorState

-> m Bool

Returns: True if paste is currently available

Gets whether a paste command can be issued.

Since: 2.20

isRedoAvailable

editorStateIsRedoAvailable

Arguments

:: (HasCallStack, MonadIO m, IsEditorState a)

=> a

editorState: a EditorState

-> m Bool

Returns: True if redo is currently available

Gets whether a redo command can be issued.

Since: 2.20

isUndoAvailable

editorStateIsUndoAvailable

Arguments

:: (HasCallStack, MonadIO m, IsEditorState a)

=> a

editorState: a EditorState

-> m Bool

Returns: True if undo is currently available

Gets whether an undo command can be issued.

Since: 2.20

Properties

typingAttributes

Bitmask of EditorTypingAttributes flags. See editorStateGetTypingAttributes for more information.

Since: 2.10

getEditorStateTypingAttributes :: (MonadIO m, IsEditorState o) => o -> m Word32

Get the value of the “typing-attributes” property. When overloading is enabled, this is equivalent to

get editorState #typingAttributes

Signals

changed

type EditorStateChangedCallback = IO ()

Emitted when the WebKitEdtorState is changed.

Since: 2.44

afterEditorStateChanged :: (IsEditorState a, MonadIO m) => a -> ((?self :: a) => EditorStateChangedCallback) -> m SignalHandlerId

Connect a signal handler for the changed signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after editorState #changed callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onEditorStateChanged :: (IsEditorState a, MonadIO m) => a -> ((?self :: a) => EditorStateChangedCallback) -> m SignalHandlerId

Connect a signal handler for the changed signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on editorState #changed callback