Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
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); }
- newtype Editable = Editable (ManagedPtr Editable)
- noEditable :: Maybe Editable
- class GObject o => IsEditable o
- toEditable :: (MonadIO m, IsEditable o) => o -> m Editable
- editableCopyClipboard :: (HasCallStack, MonadIO m, IsEditable a) => a -> m ()
- editableCutClipboard :: (HasCallStack, MonadIO m, IsEditable a) => a -> m ()
- editableDeleteSelection :: (HasCallStack, MonadIO m, IsEditable a) => a -> m ()
- editableDeleteText :: (HasCallStack, MonadIO m, IsEditable a) => a -> Int32 -> Int32 -> m ()
- editableGetChars :: (HasCallStack, MonadIO m, IsEditable a) => a -> Int32 -> Int32 -> m Text
- editableGetEditable :: (HasCallStack, MonadIO m, IsEditable a) => a -> m Bool
- editableGetPosition :: (HasCallStack, MonadIO m, IsEditable a) => a -> m Int32
- editableGetSelectionBounds :: (HasCallStack, MonadIO m, IsEditable a) => a -> m (Bool, Int32, Int32)
- editableInsertText :: (HasCallStack, MonadIO m, IsEditable a) => a -> Text -> Int32 -> Int32 -> m Int32
- editablePasteClipboard :: (HasCallStack, MonadIO m, IsEditable a) => a -> m ()
- editableSelectRegion :: (HasCallStack, MonadIO m, IsEditable a) => a -> Int32 -> Int32 -> m ()
- editableSetEditable :: (HasCallStack, MonadIO m, IsEditable a) => a -> Bool -> m ()
- editableSetPosition :: (HasCallStack, MonadIO m, IsEditable a) => a -> Int32 -> m ()
- type C_EditableChangedCallback = Ptr () -> Ptr () -> IO ()
- type EditableChangedCallback = IO ()
- afterEditableChanged :: (IsEditable a, MonadIO m) => a -> EditableChangedCallback -> m SignalHandlerId
- genClosure_EditableChanged :: EditableChangedCallback -> IO Closure
- mk_EditableChangedCallback :: C_EditableChangedCallback -> IO (FunPtr C_EditableChangedCallback)
- noEditableChangedCallback :: Maybe EditableChangedCallback
- onEditableChanged :: (IsEditable a, MonadIO m) => a -> EditableChangedCallback -> m SignalHandlerId
- wrap_EditableChangedCallback :: EditableChangedCallback -> Ptr () -> Ptr () -> IO ()
- type C_EditableDeleteTextCallback = Ptr () -> Int32 -> Int32 -> Ptr () -> IO ()
- type EditableDeleteTextCallback = Int32 -> Int32 -> IO ()
- afterEditableDeleteText :: (IsEditable a, MonadIO m) => a -> EditableDeleteTextCallback -> m SignalHandlerId
- genClosure_EditableDeleteText :: EditableDeleteTextCallback -> IO Closure
- mk_EditableDeleteTextCallback :: C_EditableDeleteTextCallback -> IO (FunPtr C_EditableDeleteTextCallback)
- noEditableDeleteTextCallback :: Maybe EditableDeleteTextCallback
- onEditableDeleteText :: (IsEditable a, MonadIO m) => a -> EditableDeleteTextCallback -> m SignalHandlerId
- wrap_EditableDeleteTextCallback :: EditableDeleteTextCallback -> Ptr () -> Int32 -> Int32 -> Ptr () -> IO ()
- type C_EditableInsertTextCallback = Ptr () -> CString -> Int32 -> Ptr Int32 -> Ptr () -> IO ()
- type EditableInsertTextCallback = Text -> Int32 -> Int32 -> IO Int32
- afterEditableInsertText :: (IsEditable a, MonadIO m) => a -> EditableInsertTextCallback -> m SignalHandlerId
- genClosure_EditableInsertText :: EditableInsertTextCallback -> IO Closure
- mk_EditableInsertTextCallback :: C_EditableInsertTextCallback -> IO (FunPtr C_EditableInsertTextCallback)
- noEditableInsertTextCallback :: Maybe EditableInsertTextCallback
- onEditableInsertText :: (IsEditable a, MonadIO m) => a -> EditableInsertTextCallback -> m SignalHandlerId
- wrap_EditableInsertTextCallback :: EditableInsertTextCallback -> Ptr () -> CString -> Int32 -> Ptr Int32 -> Ptr () -> IO ()
Exported types
class GObject o => IsEditable o Source #
toEditable :: (MonadIO m, IsEditable o) => o -> m Editable Source #
Methods
copyClipboard
editableCopyClipboard Source #
:: (HasCallStack, MonadIO m, IsEditable a) | |
=> a |
|
-> m () |
Copies the contents of the currently selected content in the editable and puts it on the clipboard.
cutClipboard
:: (HasCallStack, MonadIO m, IsEditable a) | |
=> a |
|
-> m () |
Removes the contents of the currently selected content in the editable and puts it on the clipboard.
deleteSelection
editableDeleteSelection Source #
:: (HasCallStack, MonadIO m, IsEditable a) | |
=> a |
|
-> m () |
Deletes the currently selected text of the editable. This call doesn’t do anything if there is no selected text.
deleteText
:: (HasCallStack, MonadIO m, IsEditable a) | |
=> a |
|
-> Int32 |
|
-> Int32 |
|
-> 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
:: (HasCallStack, MonadIO m, IsEditable a) | |
=> a |
|
-> Int32 |
|
-> Int32 |
|
-> m Text | Returns: a pointer to the contents of the widget as a
string. This string is allocated by the |
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
:: (HasCallStack, MonadIO m, IsEditable a) | |
=> a |
|
-> m Bool | Returns: |
Retrieves whether editable
is editable. See
editableSetEditable
.
getPosition
:: (HasCallStack, MonadIO m, IsEditable a) | |
=> a |
|
-> 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
editableGetSelectionBounds Source #
:: (HasCallStack, MonadIO m, IsEditable a) | |
=> a |
|
-> m (Bool, Int32, Int32) |
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
:: (HasCallStack, MonadIO m, IsEditable a) | |
=> a |
|
-> Text |
|
-> Int32 |
|
-> Int32 |
|
-> 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
editablePasteClipboard Source #
:: (HasCallStack, MonadIO m, IsEditable a) | |
=> a |
|
-> m () |
Pastes the content of the clipboard to the current position of the cursor in the editable.
selectRegion
:: (HasCallStack, MonadIO m, IsEditable a) | |
=> a |
|
-> Int32 |
|
-> Int32 |
|
-> 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
:: (HasCallStack, MonadIO m, IsEditable a) | |
=> a |
|
-> Bool |
|
-> m () |
Determines if the user can edit the text in the editable widget or not.
setPosition
:: (HasCallStack, MonadIO m, IsEditable a) | |
=> a |
|
-> Int32 |
|
-> 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 EditableChangedCallback = IO () Source #
afterEditableChanged :: (IsEditable a, MonadIO m) => a -> EditableChangedCallback -> m SignalHandlerId Source #
mk_EditableChangedCallback :: C_EditableChangedCallback -> IO (FunPtr C_EditableChangedCallback) Source #
onEditableChanged :: (IsEditable a, MonadIO m) => a -> EditableChangedCallback -> m SignalHandlerId Source #
wrap_EditableChangedCallback :: EditableChangedCallback -> Ptr () -> Ptr () -> IO () Source #
deleteText
afterEditableDeleteText :: (IsEditable a, MonadIO m) => a -> EditableDeleteTextCallback -> m SignalHandlerId Source #
mk_EditableDeleteTextCallback :: C_EditableDeleteTextCallback -> IO (FunPtr C_EditableDeleteTextCallback) Source #
onEditableDeleteText :: (IsEditable a, MonadIO m) => a -> EditableDeleteTextCallback -> m SignalHandlerId Source #
wrap_EditableDeleteTextCallback :: EditableDeleteTextCallback -> Ptr () -> Int32 -> Int32 -> Ptr () -> IO () Source #
insertText
type C_EditableInsertTextCallback = Ptr () -> CString -> Int32 -> Ptr Int32 -> Ptr () -> IO () Source #
afterEditableInsertText :: (IsEditable a, MonadIO m) => a -> EditableInsertTextCallback -> m SignalHandlerId Source #
mk_EditableInsertTextCallback :: C_EditableInsertTextCallback -> IO (FunPtr C_EditableInsertTextCallback) Source #
onEditableInsertText :: (IsEditable a, MonadIO m) => a -> EditableInsertTextCallback -> m SignalHandlerId Source #