GI.Gtk.Objects.EntryBuffer

The EntryBuffer class contains the actual text displayed in a Entry widget.

A single EntryBuffer object can be shared by multiple Entry widgets which will then share the same text content, but not the cursor position, visibility attributes, icon etc.

EntryBuffer may be derived from. Such a derived class might allow text to be stored in an alternate location, such as non-pageable memory, useful in the case of important passwords. Or a derived class could integrate with an application’s concept of undo/redo.

Since: 2.18

Exported types

newtype EntryBuffer

Memory-managed wrapper type.

Constructors

EntryBuffer (ManagedPtr EntryBuffer)

Instances

Eq EntryBuffer

Defined in GI.Gtk.Objects.EntryBuffer

Methods

(==) :: EntryBuffer -> EntryBuffer -> Bool

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

IsGValue EntryBuffer

Convert EntryBuffer to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Objects.EntryBuffer

Methods

toGValue :: EntryBuffer -> IO GValue

fromGValue :: GValue -> IO EntryBuffer

GObject EntryBuffer

Defined in GI.Gtk.Objects.EntryBuffer

Methods

gobjectType :: IO GType

HasParentTypes EntryBuffer

Defined in GI.Gtk.Objects.EntryBuffer

type ParentTypes EntryBuffer

Defined in GI.Gtk.Objects.EntryBuffer

type ParentTypes EntryBuffer = '[Object]

class (GObject o, IsDescendantOf EntryBuffer o) => IsEntryBuffer o

Type class for types which can be safely cast to EntryBuffer, for instance with toEntryBuffer.

Instances

(GObject o, IsDescendantOf EntryBuffer o) => IsEntryBuffer o

Defined in GI.Gtk.Objects.EntryBuffer

toEntryBuffer :: (MonadIO m, IsEntryBuffer o) => o -> m EntryBuffer

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

noEntryBuffer :: Maybe EntryBuffer

A convenience alias for Nothing :: Maybe EntryBuffer.

Methods

Overloaded methods

deleteText

entryBufferDeleteText

Arguments

:: (HasCallStack, MonadIO m, IsEntryBuffer a)

=> a

buffer: a EntryBuffer

-> Word32

position: position at which to delete text

-> Int32

nChars: number of characters to delete

-> m Word32

Returns: The number of characters deleted.

Deletes a sequence of characters from the buffer. nChars characters are deleted starting at position. If nChars is negative, then all characters until the end of the text are deleted.

If position or nChars are out of bounds, then they are coerced to sane values.

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

Since: 2.18

emitDeletedText

entryBufferEmitDeletedText

Arguments

:: (HasCallStack, MonadIO m, IsEntryBuffer a)

=> a

buffer: a EntryBuffer

-> Word32

position: position at which text was deleted

-> Word32

nChars: number of characters deleted

-> m ()

Used when subclassing EntryBuffer

Since: 2.18

emitInsertedText

entryBufferEmitInsertedText

Arguments

:: (HasCallStack, MonadIO m, IsEntryBuffer a)

=> a

buffer: a EntryBuffer

-> Word32

position: position at which text was inserted

-> Text

chars: text that was inserted

-> Word32

nChars: number of characters inserted

-> m ()

Used when subclassing EntryBuffer

Since: 2.18

getBytes

entryBufferGetBytes

Arguments

:: (HasCallStack, MonadIO m, IsEntryBuffer a)

=> a

buffer: a EntryBuffer

-> m Word64

Returns: The byte length of the buffer.

Retrieves the length in bytes of the buffer. See entryBufferGetLength.

Since: 2.18

getLength

entryBufferGetLength

Arguments

:: (HasCallStack, MonadIO m, IsEntryBuffer a)

=> a

buffer: a EntryBuffer

-> m Word32

Returns: The number of characters in the buffer.

Retrieves the length in characters of the buffer.

Since: 2.18

getMaxLength

entryBufferGetMaxLength

Arguments

:: (HasCallStack, MonadIO m, IsEntryBuffer a)

=> a

buffer: a EntryBuffer

-> m Int32

Returns: the maximum allowed number of characters in EntryBuffer, or 0 if there is no maximum.

Retrieves the maximum allowed length of the text in buffer. See entryBufferSetMaxLength.

Since: 2.18

getText

entryBufferGetText

Arguments

:: (HasCallStack, MonadIO m, IsEntryBuffer a)

=> a

buffer: a EntryBuffer

-> m Text

Returns: a pointer to the contents of the widget as a string. This string points to internally allocated storage in the buffer and must not be freed, modified or stored.

Retrieves the contents of the buffer.

The memory pointer returned by this call will not change unless this object emits a signal, or is finalized.

Since: 2.18

insertText

entryBufferInsertText

Arguments

:: (HasCallStack, MonadIO m, IsEntryBuffer a)

=> a

buffer: a EntryBuffer

-> Word32

position: the position at which to insert text.

-> Text

chars: the text to insert into the buffer.

-> Int32

nChars: the length of the text in characters, or -1

-> m Word32

Returns: The number of characters actually inserted.

Inserts nChars characters of chars into the contents of the buffer, at position position.

If nChars is negative, then characters from chars will be inserted until a null-terminator is found. If position or nChars are out of bounds, or the maximum buffer text length is exceeded, then they are coerced to sane values.

Note that the position and length are in characters, not in bytes.

Since: 2.18

new

entryBufferNew

Arguments

:: (HasCallStack, MonadIO m)

=> Maybe Text

initialChars: initial buffer text, or Nothing

-> Int32

nInitialChars: number of characters in initialChars, or -1

-> m EntryBuffer

Returns: A new GtkEntryBuffer object.

Create a new GtkEntryBuffer object.

Optionally, specify initial text to set in the buffer.

Since: 2.18

setMaxLength

entryBufferSetMaxLength

Arguments

:: (HasCallStack, MonadIO m, IsEntryBuffer a)

=> a

buffer: a EntryBuffer

-> Int32

maxLength: the maximum length of the entry buffer, or 0 for no maximum. (other than the maximum length of entries.) The value passed in will be clamped to the range 0-65536.

-> m ()

Sets the maximum allowed length of the contents of the buffer. If the current contents are longer than the given length, then they will be truncated to fit.

Since: 2.18

setText

entryBufferSetText

Arguments

:: (HasCallStack, MonadIO m, IsEntryBuffer a)

=> a

buffer: a EntryBuffer

-> Text

chars: the new text

-> Int32

nChars: the number of characters in text, or -1

-> m ()

Sets the text in the buffer.

This is roughly equivalent to calling entryBufferDeleteText and entryBufferInsertText.

Note that nChars is in characters, not in bytes.

Since: 2.18

Properties

length

The length (in characters) of the text in buffer.

Since: 2.18

getEntryBufferLength :: (MonadIO m, IsEntryBuffer o) => o -> m Word32

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

get entryBuffer #length

maxLength

The maximum length (in characters) of the text in the buffer.

Since: 2.18

constructEntryBufferMaxLength :: IsEntryBuffer o => Int32 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “max-length” property. This is rarely needed directly, but it is used by new.

getEntryBufferMaxLength :: (MonadIO m, IsEntryBuffer o) => o -> m Int32

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

get entryBuffer #maxLength

setEntryBufferMaxLength :: (MonadIO m, IsEntryBuffer o) => o -> Int32 -> m ()

Set the value of the “max-length” property. When overloading is enabled, this is equivalent to

set entryBuffer [ #maxLength := value ]

text

The contents of the buffer.

Since: 2.18

clearEntryBufferText :: (MonadIO m, IsEntryBuffer o) => o -> m ()

Set the value of the “text” property to Nothing. When overloading is enabled, this is equivalent to

clear #text

constructEntryBufferText :: IsEntryBuffer o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “text” property. This is rarely needed directly, but it is used by new.

getEntryBufferText :: (MonadIO m, IsEntryBuffer o) => o -> m Text

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

get entryBuffer #text

setEntryBufferText :: (MonadIO m, IsEntryBuffer o) => o -> Text -> m ()

Set the value of the “text” property. When overloading is enabled, this is equivalent to

set entryBuffer [ #text := value ]

Signals

deletedText

type C_EntryBufferDeletedTextCallback = Ptr () -> Word32 -> Word32 -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type EntryBufferDeletedTextCallback

Arguments

 = Word32

position: the position the text was deleted at.

-> Word32

nChars: The number of characters that were deleted.

-> IO ()

This signal is emitted after text is deleted from the buffer.

Since: 2.18

afterEntryBufferDeletedText :: (IsEntryBuffer a, MonadIO m) => a -> EntryBufferDeletedTextCallback -> m SignalHandlerId

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

after entryBuffer #deletedText callback

genClosure_EntryBufferDeletedText :: MonadIO m => EntryBufferDeletedTextCallback -> m (GClosure C_EntryBufferDeletedTextCallback)

Wrap the callback into a GClosure.

mk_EntryBufferDeletedTextCallback :: C_EntryBufferDeletedTextCallback -> IO (FunPtr C_EntryBufferDeletedTextCallback)

Generate a function pointer callable from C code, from a C_EntryBufferDeletedTextCallback.

noEntryBufferDeletedTextCallback :: Maybe EntryBufferDeletedTextCallback

A convenience synonym for Nothing :: Maybe EntryBufferDeletedTextCallback.

onEntryBufferDeletedText :: (IsEntryBuffer a, MonadIO m) => a -> EntryBufferDeletedTextCallback -> m SignalHandlerId

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

on entryBuffer #deletedText callback

wrap_EntryBufferDeletedTextCallback :: EntryBufferDeletedTextCallback -> C_EntryBufferDeletedTextCallback

Wrap a EntryBufferDeletedTextCallback into a C_EntryBufferDeletedTextCallback.

insertedText

type C_EntryBufferInsertedTextCallback = Ptr () -> Word32 -> CString -> Word32 -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type EntryBufferInsertedTextCallback

Arguments

 = Word32

position: the position the text was inserted at.

-> Text

chars: The text that was inserted.

-> Word32

nChars: The number of characters that were inserted.

-> IO ()

This signal is emitted after text is inserted into the buffer.

Since: 2.18

afterEntryBufferInsertedText :: (IsEntryBuffer a, MonadIO m) => a -> EntryBufferInsertedTextCallback -> m SignalHandlerId

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

after entryBuffer #insertedText callback

genClosure_EntryBufferInsertedText :: MonadIO m => EntryBufferInsertedTextCallback -> m (GClosure C_EntryBufferInsertedTextCallback)

Wrap the callback into a GClosure.

mk_EntryBufferInsertedTextCallback :: C_EntryBufferInsertedTextCallback -> IO (FunPtr C_EntryBufferInsertedTextCallback)

Generate a function pointer callable from C code, from a C_EntryBufferInsertedTextCallback.

noEntryBufferInsertedTextCallback :: Maybe EntryBufferInsertedTextCallback

A convenience synonym for Nothing :: Maybe EntryBufferInsertedTextCallback.

onEntryBufferInsertedText :: (IsEntryBuffer a, MonadIO m) => a -> EntryBufferInsertedTextCallback -> m SignalHandlerId

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

on entryBuffer #insertedText callback

wrap_EntryBufferInsertedTextCallback :: EntryBufferInsertedTextCallback -> C_EntryBufferInsertedTextCallback

Wrap a EntryBufferInsertedTextCallback into a C_EntryBufferInsertedTextCallback.