GI.Clutter.Objects.TextBuffer

The TextBuffer structure contains private data and it should only be accessed using the provided API.

Since: 1.10

Exported types

newtype TextBuffer

Memory-managed wrapper type.

Constructors

TextBuffer (ManagedPtr TextBuffer)

Instances

Eq TextBuffer

Defined in GI.Clutter.Objects.TextBuffer

Methods

(==) :: TextBuffer -> TextBuffer -> Bool

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

GObject TextBuffer

Defined in GI.Clutter.Objects.TextBuffer

ManagedPtrNewtype TextBuffer

Defined in GI.Clutter.Objects.TextBuffer

Methods

toManagedPtr :: TextBuffer -> ManagedPtr TextBuffer

TypedObject TextBuffer

Defined in GI.Clutter.Objects.TextBuffer

Methods

glibType :: IO GType

HasParentTypes TextBuffer

Defined in GI.Clutter.Objects.TextBuffer

IsGValue (Maybe TextBuffer)

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

Defined in GI.Clutter.Objects.TextBuffer

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes TextBuffer

Defined in GI.Clutter.Objects.TextBuffer

type ParentTypes TextBuffer = '[Object]

class (GObject o, IsDescendantOf TextBuffer o) => IsTextBuffer o

Type class for types which can be safely cast to TextBuffer, for instance with toTextBuffer.

Instances

(GObject o, IsDescendantOf TextBuffer o) => IsTextBuffer o

Defined in GI.Clutter.Objects.TextBuffer

toTextBuffer :: (MonadIO m, IsTextBuffer o) => o -> m TextBuffer

Cast to TextBuffer, 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, deleteText, emitDeletedText, emitInsertedText, forceFloating, freezeNotify, getv, insertText, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getBytes, getData, getLength, getMaxLength, getProperty, getQdata, getText.

Setters

setData, setDataFull, setMaxLength, setProperty, setText.

deleteText

textBufferDeleteText

Arguments

:: (HasCallStack, MonadIO m, IsTextBuffer a)

=> a

buffer: a TextBuffer

-> 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: 1.10

emitDeletedText

textBufferEmitDeletedText

Arguments

:: (HasCallStack, MonadIO m, IsTextBuffer a)

=> a

buffer: a TextBuffer

-> Word32

position: position at which text was deleted

-> Word32

nChars: number of characters deleted

-> m ()

Emits the TextBuffer::deletedText signal on buffer.

Used when subclassing TextBuffer

Since: 1.10

emitInsertedText

textBufferEmitInsertedText

Arguments

:: (HasCallStack, MonadIO m, IsTextBuffer a)

=> a

buffer: a TextBuffer

-> Word32

position: position at which text was inserted

-> Text

chars: text that was inserted

-> Word32

nChars: number of characters inserted

-> m ()

Emits the TextBuffer::insertedText signal on buffer.

Used when subclassing TextBuffer

Since: 1.10

getBytes

textBufferGetBytes

Arguments

:: (HasCallStack, MonadIO m, IsTextBuffer a)

=> a

buffer: a TextBuffer

-> m Word64

Returns: The byte length of the buffer.

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

Since: 1.10

getLength

textBufferGetLength

Arguments

:: (HasCallStack, MonadIO m, IsTextBuffer a)

=> a

buffer: a TextBuffer

-> m Word32

Returns: The number of characters in the buffer.

Retrieves the length in characters of the buffer.

Since: 1.10

getMaxLength

textBufferGetMaxLength

Arguments

:: (HasCallStack, MonadIO m, IsTextBuffer a)

=> a

buffer: a TextBuffer

-> m Int32

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

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

Since: 1.10

getText

textBufferGetText

Arguments

:: (HasCallStack, MonadIO m, IsTextBuffer a)

=> a

buffer: a TextBuffer

-> 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: 1.10

insertText

textBufferInsertText

Arguments

:: (HasCallStack, MonadIO m, IsTextBuffer a)

=> a

buffer: a TextBuffer

-> 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: 1.10

new

textBufferNew

Arguments

:: (HasCallStack, MonadIO m)

=> m TextBuffer

Returns: A new ClutterTextBuffer object.

Create a new ClutterTextBuffer object.

Since: 1.10

newWithText

textBufferNewWithText

Arguments

:: (HasCallStack, MonadIO m)

=> Maybe Text

text: initial buffer text

-> Int64

textLen: initial buffer text length, or -1 for null-terminated.

-> m TextBuffer

Returns: A new ClutterTextBuffer object.

Create a new ClutterTextBuffer object with some text.

Since: 1.10

setMaxLength

textBufferSetMaxLength

Arguments

:: (HasCallStack, MonadIO m, IsTextBuffer a)

=> a

buffer: a TextBuffer

-> 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, CLUTTER_TEXT_BUFFER_MAX_SIZE ].

-> 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: 1.10

setText

textBufferSetText

Arguments

:: (HasCallStack, MonadIO m, IsTextBuffer a)

=> a

buffer: a TextBuffer

-> 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 textBufferDeleteText and textBufferInsertText.

Note that nChars is in characters, not in bytes.

Since: 1.10

Properties

length

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

Since: 1.10

getTextBufferLength :: (MonadIO m, IsTextBuffer o) => o -> m Word32

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

get textBuffer #length

maxLength

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

Since: 1.10

constructTextBufferMaxLength :: (IsTextBuffer o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getTextBufferMaxLength :: (MonadIO m, IsTextBuffer o) => o -> m Int32

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

get textBuffer #maxLength

setTextBufferMaxLength :: (MonadIO m, IsTextBuffer o) => o -> Int32 -> m ()

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

set textBuffer [ #maxLength := value ]

text

The contents of the buffer.

Since: 1.10

getTextBufferText :: (MonadIO m, IsTextBuffer o) => o -> m Text

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

get textBuffer #text

Signals

deletedText

type TextBufferDeletedTextCallback

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: 1.10

afterTextBufferDeletedText :: (IsTextBuffer a, MonadIO m) => a -> ((?self :: a) => TextBufferDeletedTextCallback) -> 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 textBuffer #deletedText 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.

onTextBufferDeletedText :: (IsTextBuffer a, MonadIO m) => a -> ((?self :: a) => TextBufferDeletedTextCallback) -> 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 textBuffer #deletedText callback

insertedText

type TextBufferInsertedTextCallback

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: 1.10

afterTextBufferInsertedText :: (IsTextBuffer a, MonadIO m) => a -> ((?self :: a) => TextBufferInsertedTextCallback) -> 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 textBuffer #insertedText 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.

onTextBufferInsertedText :: (IsTextBuffer a, MonadIO m) => a -> ((?self :: a) => TextBufferInsertedTextCallback) -> 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 textBuffer #insertedText callback