GI.GtkSource.Objects.Mark

No description available in the introspection data.

Exported types

newtype Mark

Memory-managed wrapper type.

Constructors

Mark (ManagedPtr Mark)

Instances

GObject Mark

Defined in GI.GtkSource.Objects.Mark

Methods

gobjectType :: IO GType

HasParentTypes Mark

Defined in GI.GtkSource.Objects.Mark

type ParentTypes Mark

Defined in GI.GtkSource.Objects.Mark

type ParentTypes Mark = TextMark ': (Object ': ([] :: [Type]))

class (GObject o, IsDescendantOf Mark o) => IsMark o

Type class for types which can be safely cast to Mark, for instance with toMark.

Instances

(GObject o, IsDescendantOf Mark o) => IsMark o

Defined in GI.GtkSource.Objects.Mark

toMark :: (MonadIO m, IsMark o) => o -> m Mark

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

noMark :: Maybe Mark

A convenience alias for Nothing :: Maybe Mark.

Methods

getCategory

markGetCategory

Arguments

:: (HasCallStack, MonadIO m, IsMark a)

=> a

mark: a Mark.

-> m Text

Returns: the category of the Mark.

Returns the mark category.

Since: 2.2

new

markNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

name: Name of the Mark, can be NULL when not using a name

-> Text

category: is used to classify marks according to common characteristics (e.g. all the marks representing a bookmark could belong to the "bookmark" category, or all the marks representing a compilation error could belong to "error" category).

-> m Mark

Returns: a new Mark that can be added using textBufferAddMark.

Creates a text mark. Add it to a buffer using textBufferAddMark. If name is NULL, the mark is anonymous; otherwise, the mark can be retrieved by name using textBufferGetMark. Normally marks are created using the utility function bufferCreateSourceMark.

Since: 2.2

next

markNext

Arguments

:: (HasCallStack, MonadIO m, IsMark a)

=> a

mark: a Mark.

-> Maybe Text

category: a string specifying the mark category, or Nothing.

-> m (Maybe Mark)

Returns: the next Mark, or Nothing.

Returns the next Mark in the buffer or Nothing if the mark was not added to a buffer. If there is no next mark, Nothing will be returned.

If category is Nothing, looks for marks of any category.

Since: 2.2

prev

markPrev

Arguments

:: (HasCallStack, MonadIO m, IsMark a)

=> a

mark: a Mark.

-> Text

category: a string specifying the mark category, or Nothing.

-> m (Maybe Mark)

Returns: the previous Mark, or Nothing.

Returns the previous Mark in the buffer or Nothing if the mark was not added to a buffer. If there is no previous mark, Nothing is returned.

If category is Nothing, looks for marks of any category

Since: 2.2

Properties

category

The category of the Mark, classifies the mark and controls which pixbuf is used and with which priority it is drawn.

constructMarkCategory :: IsMark o => Text -> IO (GValueConstruct o)

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

getMarkCategory :: (MonadIO m, IsMark o) => o -> m Text

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

get mark #category