Portability | portable (depends on GHC) |
---|---|
Stability | provisional |
Maintainer | gtk2hs-users@lists.sourceforge.net |
Safe Haskell | None |
Graphics.UI.Gtk.Entry.EntryBuffer
Description
Text buffer for Entry
- Module available since Gtk+ version 2.18
- data EntryBuffer
- class GObjectClass o => EntryBufferClass o
- castToEntryBuffer :: GObjectClass obj => obj -> EntryBuffer
- toEntryBuffer :: EntryBufferClass o => o -> EntryBuffer
- entryBufferNew :: Maybe String -> IO EntryBuffer
- entryBufferGetBytes :: EntryBufferClass self => self -> IO Int
- entryBufferInsertText :: EntryBufferClass self => self -> Int -> String -> IO Int
- entryBufferDeleteText :: EntryBufferClass self => self -> Int -> Int -> IO Int
- entryBufferEmitDeletedText :: EntryBufferClass self => self -> Int -> Int -> IO ()
- entryBufferEmitInsertedText :: EntryBufferClass self => self -> Int -> String -> Int -> IO ()
- entryBufferText :: EntryBufferClass self => Attr self String
- entryBufferLength :: EntryBufferClass self => ReadAttr self Int
- entryBufferMaxLength :: EntryBufferClass self => Attr self Int
- entryBufferInsertedText :: EntryBufferClass self => Signal self (Int -> String -> Int -> IO ())
- entryBufferDeletedText :: EntryBufferClass self => Signal self (Int -> Int -> IO ())
Detail
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.
Class Hierarchy
| GObject
| +----EntryBuffer
Types
data EntryBuffer Source
class GObjectClass o => EntryBufferClass o Source
Instances
castToEntryBuffer :: GObjectClass obj => obj -> EntryBufferSource
toEntryBuffer :: EntryBufferClass o => o -> EntryBufferSource
Constructors
Arguments
:: Maybe String |
|
-> IO EntryBuffer |
Create a new EntryBuffer
object.
Optionally, specify initial text to set in the buffer.
- Available since Gtk+ version 2.18
Methods
Arguments
:: EntryBufferClass self | |
=> self | |
-> IO Int | returns The byte length of the buffer. |
Retrieves the length in bytes of the buffer. See entryBufferGetLength
.
- Available since Gtk+ version 2.18
Arguments
:: EntryBufferClass self | |
=> self | |
-> Int |
|
-> String |
|
-> IO Int | returns The number of characters actually inserted. |
Inserts chars
into the contents of the buffer,
at position position
.
- Available since Gtk+ version 2.18
Arguments
:: EntryBufferClass self | |
=> self | |
-> Int |
|
-> Int |
|
-> IO Int | 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.
- Available since Gtk+ version 2.18
entryBufferEmitDeletedTextSource
Arguments
:: EntryBufferClass self | |
=> self | |
-> Int |
|
-> Int |
|
-> IO () |
Used when subclassing EntryBuffer
- Available since Gtk+ version 2.18
entryBufferEmitInsertedTextSource
Arguments
:: EntryBufferClass self | |
=> self | |
-> Int |
|
-> String |
|
-> Int |
|
-> IO () |
Used when subclassing EntryBuffer
- Available since Gtk+ version 2.18
Attributes
entryBufferText :: EntryBufferClass self => Attr self StringSource
The contents of the buffer.
Default value: ""
- Available since Gtk+ version 2.18
entryBufferLength :: EntryBufferClass self => ReadAttr self IntSource
The length of the text in buffer.
Allowed values: <= 65535
Default value: 0
- Available since Gtk+ version 2.18
entryBufferMaxLength :: EntryBufferClass self => Attr self IntSource
The maximum length of the text in the buffer.
Allowed values: [0,65535]
Default value: 0
- Available since Gtk+ version 2.18
Signals
entryBufferInsertedText :: EntryBufferClass self => Signal self (Int -> String -> Int -> IO ())Source
- Available since Gtk+ version 2.18
entryBufferDeletedText :: EntryBufferClass self => Signal self (Int -> Int -> IO ())Source
- Available since Gtk+ version 2.18