GI.Gtk.Objects.TextMark

You may wish to begin by reading the [text widget conceptual overview][TextWidget] which gives an overview of all the objects and data types related to the text widget and how they work together.

A TextMark is like a bookmark in a text buffer; it preserves a position in the text. You can convert the mark to an iterator using textBufferGetIterAtMark. Unlike iterators, marks remain valid across buffer mutations, because their behavior is defined when text is inserted or deleted. When text containing a mark is deleted, the mark remains in the position originally occupied by the deleted text. When text is inserted at a mark, a mark with “left gravity” will be moved to the beginning of the newly-inserted text, and a mark with “right gravity” will be moved to the end.

Note that “left” and “right” here refer to logical direction (left is the toward the start of the buffer); in some languages such as Hebrew the logically-leftmost text is not actually on the left when displayed.

Marks are reference counted, but the reference count only controls the validity of the memory; marks can be deleted from the buffer at any time with textBufferDeleteMark. Once deleted from the buffer, a mark is essentially useless.

Marks optionally have names; these can be convenient to avoid passing the TextMark object around.

Marks are typically created using the textBufferCreateMark function.

Exported types

newtype TextMark

Constructors

TextMark (ManagedPtr TextMark)

Instances

GObject TextMark

Methods

gobjectType :: TextMark -> IO GType

IsObject TextMark

IsTextMark TextMark

((~) * info (ResolveTextMarkMethod t TextMark), MethodInfo * info TextMark p) => IsLabel t (TextMark -> p)

Methods

fromLabel :: Proxy# Symbol t -> TextMark -> p

((~) * info (ResolveTextMarkMethod t TextMark), MethodInfo * info TextMark p) => IsLabelProxy t (TextMark -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> TextMark -> p

HasAttributeList * TextMark

type AttributeList TextMark

type AttributeList TextMark

type SignalList TextMark

type SignalList TextMark

class GObject o => IsTextMark o

Instances

(GObject a, UnknownAncestorError Constraint TextMark a) => IsTextMark a

IsTextMark TextMark

toTextMark :: IsTextMark o => o -> IO TextMark

noTextMark :: Maybe TextMark

Methods

getBuffer

data TextMarkGetBufferMethodInfo

Instances

((~) * signature (m TextBuffer), MonadIO m, IsTextMark a) => MethodInfo * TextMarkGetBufferMethodInfo a signature

Methods

overloadedMethod :: MethodProxy TextMarkGetBufferMethodInfo a -> signature -> s

textMarkGetBuffer

Arguments

:: (HasCallStack, MonadIO m, IsTextMark a)

=> a

mark: a TextMark

-> m TextBuffer

Returns: the mark’s TextBuffer

Gets the buffer this mark is located inside, or Nothing if the mark is deleted.

getDeleted

data TextMarkGetDeletedMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsTextMark a) => MethodInfo * TextMarkGetDeletedMethodInfo a signature

Methods

overloadedMethod :: MethodProxy TextMarkGetDeletedMethodInfo a -> signature -> s

textMarkGetDeleted

Arguments

:: (HasCallStack, MonadIO m, IsTextMark a)

=> a

mark: a TextMark

-> m Bool

Returns: whether the mark is deleted

Returns True if the mark has been removed from its buffer with textBufferDeleteMark. See textBufferAddMark for a way to add it to a buffer again.

getLeftGravity

data TextMarkGetLeftGravityMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsTextMark a) => MethodInfo * TextMarkGetLeftGravityMethodInfo a signature

Methods

overloadedMethod :: MethodProxy TextMarkGetLeftGravityMethodInfo a -> signature -> s

textMarkGetLeftGravity

Arguments

:: (HasCallStack, MonadIO m, IsTextMark a)

=> a

mark: a TextMark

-> m Bool

Returns: True if the mark has left gravity, False otherwise

Determines whether the mark has left gravity.

getName

data TextMarkGetNameMethodInfo

Instances

((~) * signature (m Text), MonadIO m, IsTextMark a) => MethodInfo * TextMarkGetNameMethodInfo a signature

Methods

overloadedMethod :: MethodProxy TextMarkGetNameMethodInfo a -> signature -> s

textMarkGetName

Arguments

:: (HasCallStack, MonadIO m, IsTextMark a)

=> a

mark: a TextMark

-> m Text

Returns: mark name

Returns the mark name; returns NULL for anonymous marks.

getVisible

data TextMarkGetVisibleMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsTextMark a) => MethodInfo * TextMarkGetVisibleMethodInfo a signature

Methods

overloadedMethod :: MethodProxy TextMarkGetVisibleMethodInfo a -> signature -> s

textMarkGetVisible

Arguments

:: (HasCallStack, MonadIO m, IsTextMark a)

=> a

mark: a TextMark

-> m Bool

Returns: True if visible

Returns True if the mark is visible (i.e. a cursor is displayed for it).

new

textMarkNew

Arguments

:: (HasCallStack, MonadIO m)

=> Maybe Text

name: mark name or Nothing

-> Bool

leftGravity: whether the mark should have left gravity

-> m TextMark

Returns: new TextMark

Creates a text mark. Add it to a buffer using textBufferAddMark. If name is Nothing, the mark is anonymous; otherwise, the mark can be retrieved by name using textBufferGetMark. If a mark has left gravity, and text is inserted at the mark’s current location, the mark will be moved to the left of the newly-inserted text. If the mark has right gravity (leftGravity = False), the mark will end up on the right of newly-inserted text. The standard left-to-right cursor is a mark with right gravity (when you type, the cursor stays on the right side of the text you’re typing).

Since: 2.12

setVisible

data TextMarkSetVisibleMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsTextMark a) => MethodInfo * TextMarkSetVisibleMethodInfo a signature

Methods

overloadedMethod :: MethodProxy TextMarkSetVisibleMethodInfo a -> signature -> s

textMarkSetVisible

Arguments

:: (HasCallStack, MonadIO m, IsTextMark a)

=> a

mark: a TextMark

-> Bool

setting: visibility of mark

-> m ()

Sets the visibility of mark; the insertion point is normally visible, i.e. you can see it as a vertical bar. Also, the text widget uses a visible mark to indicate where a drop will occur when dragging-and-dropping text. Most other marks are not visible. Marks are not visible by default.

Properties

leftGravity

data TextMarkLeftGravityPropertyInfo

Instances

AttrInfo TextMarkLeftGravityPropertyInfo

Associated Types

type AttrAllowedOps TextMarkLeftGravityPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint TextMarkLeftGravityPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint TextMarkLeftGravityPropertyInfo :: * -> Constraint

type AttrGetType TextMarkLeftGravityPropertyInfo :: *

type AttrLabel TextMarkLeftGravityPropertyInfo :: Symbol

type AttrOrigin TextMarkLeftGravityPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint TextMarkLeftGravityPropertyInfo o => Proxy * TextMarkLeftGravityPropertyInfo -> o -> IO (AttrGetType TextMarkLeftGravityPropertyInfo)

attrSet :: (AttrBaseTypeConstraint TextMarkLeftGravityPropertyInfo o, AttrSetTypeConstraint TextMarkLeftGravityPropertyInfo b) => Proxy * TextMarkLeftGravityPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint TextMarkLeftGravityPropertyInfo o => Proxy * TextMarkLeftGravityPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint TextMarkLeftGravityPropertyInfo o, AttrSetTypeConstraint TextMarkLeftGravityPropertyInfo b) => Proxy * TextMarkLeftGravityPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin TextMarkLeftGravityPropertyInfo

type AttrOrigin TextMarkLeftGravityPropertyInfo = TextMark

type AttrLabel TextMarkLeftGravityPropertyInfo

type AttrLabel TextMarkLeftGravityPropertyInfo = "left-gravity"

type AttrGetType TextMarkLeftGravityPropertyInfo

type AttrGetType TextMarkLeftGravityPropertyInfo = Bool

type AttrBaseTypeConstraint TextMarkLeftGravityPropertyInfo

type AttrBaseTypeConstraint TextMarkLeftGravityPropertyInfo = IsTextMark

type AttrSetTypeConstraint TextMarkLeftGravityPropertyInfo

type AttrSetTypeConstraint TextMarkLeftGravityPropertyInfo = * ~ Bool

type AttrAllowedOps TextMarkLeftGravityPropertyInfo

type AttrAllowedOps TextMarkLeftGravityPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag))

constructTextMarkLeftGravity :: IsTextMark o => Bool -> IO (GValueConstruct o)

getTextMarkLeftGravity :: (MonadIO m, IsTextMark o) => o -> m Bool

textMarkLeftGravity :: AttrLabelProxy "leftGravity"

name

data TextMarkNamePropertyInfo

Instances

AttrInfo TextMarkNamePropertyInfo

Associated Types

type AttrAllowedOps TextMarkNamePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint TextMarkNamePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint TextMarkNamePropertyInfo :: * -> Constraint

type AttrGetType TextMarkNamePropertyInfo :: *

type AttrLabel TextMarkNamePropertyInfo :: Symbol

type AttrOrigin TextMarkNamePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint TextMarkNamePropertyInfo o => Proxy * TextMarkNamePropertyInfo -> o -> IO (AttrGetType TextMarkNamePropertyInfo)

attrSet :: (AttrBaseTypeConstraint TextMarkNamePropertyInfo o, AttrSetTypeConstraint TextMarkNamePropertyInfo b) => Proxy * TextMarkNamePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint TextMarkNamePropertyInfo o => Proxy * TextMarkNamePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint TextMarkNamePropertyInfo o, AttrSetTypeConstraint TextMarkNamePropertyInfo b) => Proxy * TextMarkNamePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin TextMarkNamePropertyInfo

type AttrOrigin TextMarkNamePropertyInfo = TextMark

type AttrLabel TextMarkNamePropertyInfo

type AttrLabel TextMarkNamePropertyInfo = "name"

type AttrGetType TextMarkNamePropertyInfo

type AttrGetType TextMarkNamePropertyInfo = Text

type AttrBaseTypeConstraint TextMarkNamePropertyInfo

type AttrBaseTypeConstraint TextMarkNamePropertyInfo = IsTextMark

type AttrSetTypeConstraint TextMarkNamePropertyInfo

type AttrSetTypeConstraint TextMarkNamePropertyInfo = * ~ Text

type AttrAllowedOps TextMarkNamePropertyInfo

type AttrAllowedOps TextMarkNamePropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructTextMarkName :: IsTextMark o => Text -> IO (GValueConstruct o)

getTextMarkName :: (MonadIO m, IsTextMark o) => o -> m Text

textMarkName :: AttrLabelProxy "name"