GI.Gtk.Interfaces.Editable

The Editable interface is an interface which should be implemented by text editing widgets, such as Entry and SpinButton. It contains functions for generically manipulating an editable widget, a large number of action signals used for key bindings, and several signals that an application can connect to to modify the behavior of a widget.

As an example of the latter usage, by connecting the following handler to Editable::insert-text, an application can convert all entry into a widget into uppercase.

Forcing entry to uppercase.

C code

#include <ctype.h>;

void
insert_text_handler (GtkEditable *editable,
                     const gchar *text,
                     gint         length,
                     gint        *position,
                     gpointer     data)
{
  gchar *result = g_utf8_strup (text, length);

  g_signal_handlers_block_by_func (editable,
                               (gpointer) insert_text_handler, data);
  gtk_editable_insert_text (editable, result, length, position);
  g_signal_handlers_unblock_by_func (editable,
                                     (gpointer) insert_text_handler, data);

  g_signal_stop_emission_by_name (editable, "insert_text");

  g_free (result);
}

Exported types

newtype Editable

Constructors

Editable (ManagedPtr Editable)

Instances

WrappedPtr Editable

Methods

wrappedPtrCalloc :: IO (Ptr Editable)

wrappedPtrCopy :: Editable -> IO Editable

wrappedPtrFree :: Maybe (FunPtr (Ptr Editable -> IO ()))

IsEditable Editable

((~) * info (ResolveEditableMethod t Editable), MethodInfo * info Editable p) => IsLabel t (Editable -> p)

Methods

fromLabel :: Proxy# Symbol t -> Editable -> p

((~) * info (ResolveEditableMethod t Editable), MethodInfo * info Editable p) => IsLabelProxy t (Editable -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Editable -> p

HasAttributeList * Editable

type AttributeList Editable

type AttributeList Editable

type SignalList Editable

type SignalList Editable

noEditable :: Maybe Editable

class ManagedPtrNewtype a => IsEditable a

Instances

IsEditable SpinButton

IsEditable Entry

IsEditable Editable

IsEditable SearchEntry

Methods

copyClipboard

data EditableCopyClipboardMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsEditable a) => MethodInfo * EditableCopyClipboardMethodInfo a signature

Methods

overloadedMethod :: MethodProxy EditableCopyClipboardMethodInfo a -> signature -> s

editableCopyClipboard

Arguments

:: (HasCallStack, MonadIO m, IsEditable a)

=> a

editable: a Editable

-> m ()

Copies the contents of the currently selected content in the editable and puts it on the clipboard.

cutClipboard

data EditableCutClipboardMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsEditable a) => MethodInfo * EditableCutClipboardMethodInfo a signature

Methods

overloadedMethod :: MethodProxy EditableCutClipboardMethodInfo a -> signature -> s

editableCutClipboard

Arguments

:: (HasCallStack, MonadIO m, IsEditable a)

=> a

editable: a Editable

-> m ()

Removes the contents of the currently selected content in the editable and puts it on the clipboard.

deleteSelection

data EditableDeleteSelectionMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsEditable a) => MethodInfo * EditableDeleteSelectionMethodInfo a signature

Methods

overloadedMethod :: MethodProxy EditableDeleteSelectionMethodInfo a -> signature -> s

editableDeleteSelection

Arguments

:: (HasCallStack, MonadIO m, IsEditable a)

=> a

editable: a Editable

-> m ()

Deletes the currently selected text of the editable. This call doesn’t do anything if there is no selected text.

deleteText

data EditableDeleteTextMethodInfo

Instances

((~) * signature (Int32 -> Int32 -> m ()), MonadIO m, IsEditable a) => MethodInfo * EditableDeleteTextMethodInfo a signature

Methods

overloadedMethod :: MethodProxy EditableDeleteTextMethodInfo a -> signature -> s

editableDeleteText

Arguments

:: (HasCallStack, MonadIO m, IsEditable a)

=> a

editable: a Editable

-> Int32

startPos: start position

-> Int32

endPos: end position

-> m ()

Deletes a sequence of characters. The characters that are deleted are those characters at positions from startPos up to, but not including endPos. If endPos is negative, then the characters deleted are those from startPos to the end of the text.

Note that the positions are specified in characters, not bytes.

getChars

data EditableGetCharsMethodInfo

Instances

((~) * signature (Int32 -> Int32 -> m Text), MonadIO m, IsEditable a) => MethodInfo * EditableGetCharsMethodInfo a signature

Methods

overloadedMethod :: MethodProxy EditableGetCharsMethodInfo a -> signature -> s

editableGetChars

Arguments

:: (HasCallStack, MonadIO m, IsEditable a)

=> a

editable: a Editable

-> Int32

startPos: start of text

-> Int32

endPos: end of text

-> m Text

Returns: a pointer to the contents of the widget as a string. This string is allocated by the Editable implementation and should be freed by the caller.

Retrieves a sequence of characters. The characters that are retrieved are those characters at positions from startPos up to, but not including endPos. If endPos is negative, then the characters retrieved are those characters from startPos to the end of the text.

Note that positions are specified in characters, not bytes.

getEditable

data EditableGetEditableMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsEditable a) => MethodInfo * EditableGetEditableMethodInfo a signature

Methods

overloadedMethod :: MethodProxy EditableGetEditableMethodInfo a -> signature -> s

editableGetEditable

Arguments

:: (HasCallStack, MonadIO m, IsEditable a)

=> a

editable: a Editable

-> m Bool

Returns: True if editable is editable.

Retrieves whether editable is editable. See editableSetEditable.

getPosition

data EditableGetPositionMethodInfo

Instances

((~) * signature (m Int32), MonadIO m, IsEditable a) => MethodInfo * EditableGetPositionMethodInfo a signature

Methods

overloadedMethod :: MethodProxy EditableGetPositionMethodInfo a -> signature -> s

editableGetPosition

Arguments

:: (HasCallStack, MonadIO m, IsEditable a)

=> a

editable: a Editable

-> m Int32

Returns: the cursor position

Retrieves the current position of the cursor relative to the start of the content of the editable.

Note that this position is in characters, not in bytes.

getSelectionBounds

data EditableGetSelectionBoundsMethodInfo

Instances

((~) * signature (m (Bool, Int32, Int32)), MonadIO m, IsEditable a) => MethodInfo * EditableGetSelectionBoundsMethodInfo a signature

Methods

overloadedMethod :: MethodProxy EditableGetSelectionBoundsMethodInfo a -> signature -> s

editableGetSelectionBounds

Arguments

:: (HasCallStack, MonadIO m, IsEditable a)

=> a

editable: a Editable

-> m (Bool, Int32, Int32)

Returns: True if an area is selected, False otherwise

Retrieves the selection bound of the editable. start_pos will be filled with the start of the selection and endPos with end. If no text was selected both will be identical and False will be returned.

Note that positions are specified in characters, not bytes.

insertText

data EditableInsertTextMethodInfo

Instances

((~) * signature (Text -> Int32 -> Int32 -> m Int32), MonadIO m, IsEditable a) => MethodInfo * EditableInsertTextMethodInfo a signature

Methods

overloadedMethod :: MethodProxy EditableInsertTextMethodInfo a -> signature -> s

editableInsertText

Arguments

:: (HasCallStack, MonadIO m, IsEditable a)

=> a

editable: a Editable

-> Text

newText: the text to append

-> Int32

newTextLength: the length of the text in bytes, or -1

-> Int32

position: location of the position text will be inserted at

-> m Int32

Inserts newTextLength bytes of newText into the contents of the widget, at position position.

Note that the position is in characters, not in bytes. The function updates position to point after the newly inserted text.

pasteClipboard

data EditablePasteClipboardMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsEditable a) => MethodInfo * EditablePasteClipboardMethodInfo a signature

Methods

overloadedMethod :: MethodProxy EditablePasteClipboardMethodInfo a -> signature -> s

editablePasteClipboard

Arguments

:: (HasCallStack, MonadIO m, IsEditable a)

=> a

editable: a Editable

-> m ()

Pastes the content of the clipboard to the current position of the cursor in the editable.

selectRegion

data EditableSelectRegionMethodInfo

Instances

((~) * signature (Int32 -> Int32 -> m ()), MonadIO m, IsEditable a) => MethodInfo * EditableSelectRegionMethodInfo a signature

Methods

overloadedMethod :: MethodProxy EditableSelectRegionMethodInfo a -> signature -> s

editableSelectRegion

Arguments

:: (HasCallStack, MonadIO m, IsEditable a)

=> a

editable: a Editable

-> Int32

startPos: start of region

-> Int32

endPos: end of region

-> m ()

Selects a region of text. The characters that are selected are those characters at positions from startPos up to, but not including endPos. If endPos is negative, then the characters selected are those characters from startPos to the end of the text.

Note that positions are specified in characters, not bytes.

setEditable

data EditableSetEditableMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsEditable a) => MethodInfo * EditableSetEditableMethodInfo a signature

Methods

overloadedMethod :: MethodProxy EditableSetEditableMethodInfo a -> signature -> s

editableSetEditable

Arguments

:: (HasCallStack, MonadIO m, IsEditable a)

=> a

editable: a Editable

-> Bool

isEditable: True if the user is allowed to edit the text in the widget

-> m ()

Determines if the user can edit the text in the editable widget or not.

setPosition

data EditableSetPositionMethodInfo

Instances

((~) * signature (Int32 -> m ()), MonadIO m, IsEditable a) => MethodInfo * EditableSetPositionMethodInfo a signature

Methods

overloadedMethod :: MethodProxy EditableSetPositionMethodInfo a -> signature -> s

editableSetPosition

Arguments

:: (HasCallStack, MonadIO m, IsEditable a)

=> a

editable: a Editable

-> Int32

position: the position of the cursor

-> m ()

Sets the cursor position in the editable to the given value.

The cursor is displayed before the character with the given (base 0) index in the contents of the editable. The value must be less than or equal to the number of characters in the editable. A value of -1 indicates that the position should be set after the last character of the editable. Note that position is in characters, not in bytes.

Signals

changed

type C_EditableChangedCallback = Ptr () -> Ptr () -> IO ()

type EditableChangedCallback = IO ()

data EditableChangedSignalInfo

Instances

SignalInfo EditableChangedSignalInfo

Associated Types

type HaskellCallbackType EditableChangedSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o EditableChangedSignalInfo -> o -> HaskellCallbackType EditableChangedSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType EditableChangedSignalInfo

type HaskellCallbackType EditableChangedSignalInfo = EditableChangedCallback

afterEditableChanged :: (GObject a, MonadIO m) => a -> EditableChangedCallback -> m SignalHandlerId

genClosure_EditableChanged :: EditableChangedCallback -> IO Closure

mk_EditableChangedCallback :: C_EditableChangedCallback -> IO (FunPtr C_EditableChangedCallback)

noEditableChangedCallback :: Maybe EditableChangedCallback

onEditableChanged :: (GObject a, MonadIO m) => a -> EditableChangedCallback -> m SignalHandlerId

wrap_EditableChangedCallback :: EditableChangedCallback -> Ptr () -> Ptr () -> IO ()

deleteText

type C_EditableDeleteTextCallback = Ptr () -> Int32 -> Int32 -> Ptr () -> IO ()

type EditableDeleteTextCallback = Int32 -> Int32 -> IO ()

data EditableDeleteTextSignalInfo

Instances

SignalInfo EditableDeleteTextSignalInfo

Associated Types

type HaskellCallbackType EditableDeleteTextSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o EditableDeleteTextSignalInfo -> o -> HaskellCallbackType EditableDeleteTextSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType EditableDeleteTextSignalInfo

type HaskellCallbackType EditableDeleteTextSignalInfo = EditableDeleteTextCallback

afterEditableDeleteText :: (GObject a, MonadIO m) => a -> EditableDeleteTextCallback -> m SignalHandlerId

genClosure_EditableDeleteText :: EditableDeleteTextCallback -> IO Closure

mk_EditableDeleteTextCallback :: C_EditableDeleteTextCallback -> IO (FunPtr C_EditableDeleteTextCallback)

noEditableDeleteTextCallback :: Maybe EditableDeleteTextCallback

onEditableDeleteText :: (GObject a, MonadIO m) => a -> EditableDeleteTextCallback -> m SignalHandlerId

wrap_EditableDeleteTextCallback :: EditableDeleteTextCallback -> Ptr () -> Int32 -> Int32 -> Ptr () -> IO ()

insertText

type C_EditableInsertTextCallback = Ptr () -> CString -> Int32 -> Ptr Int32 -> Ptr () -> IO ()

type EditableInsertTextCallback = Text -> Int32 -> Int32 -> IO Int32

data EditableInsertTextSignalInfo

Instances

SignalInfo EditableInsertTextSignalInfo

Associated Types

type HaskellCallbackType EditableInsertTextSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o EditableInsertTextSignalInfo -> o -> HaskellCallbackType EditableInsertTextSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType EditableInsertTextSignalInfo

type HaskellCallbackType EditableInsertTextSignalInfo = EditableInsertTextCallback

afterEditableInsertText :: (GObject a, MonadIO m) => a -> EditableInsertTextCallback -> m SignalHandlerId

genClosure_EditableInsertText :: EditableInsertTextCallback -> IO Closure

mk_EditableInsertTextCallback :: C_EditableInsertTextCallback -> IO (FunPtr C_EditableInsertTextCallback)

noEditableInsertTextCallback :: Maybe EditableInsertTextCallback

onEditableInsertText :: (GObject a, MonadIO m) => a -> EditableInsertTextCallback -> m SignalHandlerId

wrap_EditableInsertTextCallback :: EditableInsertTextCallback -> Ptr () -> CString -> Int32 -> Ptr Int32 -> Ptr () -> IO ()