GI.Atk.Structs.TextRange

A structure used to describe a text range.

Exported types

newtype TextRange

Memory-managed wrapper type.

Constructors

TextRange (ManagedPtr TextRange)

Instances

BoxedObject TextRange

Defined in GI.Atk.Structs.TextRange

Methods

boxedType :: TextRange -> IO GType

tag ~ AttrSet => Constructible TextRange tag

Defined in GI.Atk.Structs.TextRange

Methods

new :: MonadIO m => (ManagedPtr TextRange -> TextRange) -> [AttrOp TextRange tag] -> m TextRange

newZeroTextRange :: MonadIO m => m TextRange

Construct a TextRange struct initialized to zero.

noTextRange :: Maybe TextRange

A convenience alias for Nothing :: Maybe TextRange.

Properties

bounds

A rectangle giving the bounds of the text range

getTextRangeBounds :: MonadIO m => TextRange -> m TextRectangle

Get the value of the “bounds” field. When overloading is enabled, this is equivalent to

get textRange #bounds

content

The text in the text range

clearTextRangeContent :: MonadIO m => TextRange -> m ()

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

clear #content

getTextRangeContent :: MonadIO m => TextRange -> m (Maybe Text)

Get the value of the “content” field. When overloading is enabled, this is equivalent to

get textRange #content

setTextRangeContent :: MonadIO m => TextRange -> CString -> m ()

Set the value of the “content” field. When overloading is enabled, this is equivalent to

set textRange [ #content := value ]

endOffset

The end offset of a AtkTextRange

getTextRangeEndOffset :: MonadIO m => TextRange -> m Int32

Get the value of the “end_offset” field. When overloading is enabled, this is equivalent to

get textRange #endOffset

setTextRangeEndOffset :: MonadIO m => TextRange -> Int32 -> m ()

Set the value of the “end_offset” field. When overloading is enabled, this is equivalent to

set textRange [ #endOffset := value ]

startOffset

The start offset of a AtkTextRange

getTextRangeStartOffset :: MonadIO m => TextRange -> m Int32

Get the value of the “start_offset” field. When overloading is enabled, this is equivalent to

get textRange #startOffset

setTextRangeStartOffset :: MonadIO m => TextRange -> Int32 -> m ()

Set the value of the “start_offset” field. When overloading is enabled, this is equivalent to

set textRange [ #startOffset := value ]