gi-gtksource-3.0.24: GtkSource bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.GtkSource.Objects.Buffer

Description

No description available in the introspection data.

Synopsis

Exported types

newtype Buffer Source #

Memory-managed wrapper type.

Constructors

Buffer (ManagedPtr Buffer) 

Instances

Instances details
Eq Buffer Source # 
Instance details

Defined in GI.GtkSource.Objects.Buffer

Methods

(==) :: Buffer -> Buffer -> Bool #

(/=) :: Buffer -> Buffer -> Bool #

GObject Buffer Source # 
Instance details

Defined in GI.GtkSource.Objects.Buffer

ManagedPtrNewtype Buffer Source # 
Instance details

Defined in GI.GtkSource.Objects.Buffer

Methods

toManagedPtr :: Buffer -> ManagedPtr Buffer

TypedObject Buffer Source # 
Instance details

Defined in GI.GtkSource.Objects.Buffer

Methods

glibType :: IO GType

HasParentTypes Buffer Source # 
Instance details

Defined in GI.GtkSource.Objects.Buffer

IsGValue (Maybe Buffer) Source #

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

Instance details

Defined in GI.GtkSource.Objects.Buffer

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Buffer Source # 
Instance details

Defined in GI.GtkSource.Objects.Buffer

type ParentTypes Buffer = '[TextBuffer, Object]

class (GObject o, IsDescendantOf Buffer o) => IsBuffer o Source #

Type class for types which can be safely cast to Buffer, for instance with toBuffer.

Instances

Instances details
(GObject o, IsDescendantOf Buffer o) => IsBuffer o Source # 
Instance details

Defined in GI.GtkSource.Objects.Buffer

toBuffer :: (MonadIO m, IsBuffer o) => o -> m Buffer Source #

Cast to Buffer, 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

Expand

Methods

addMark, addSelectionClipboard, applyTag, applyTagByName, backspace, backwardIterToSourceMark, beginNotUndoableAction, beginUserAction, bindProperty, bindPropertyFull, canRedo, canUndo, changeCase, copyClipboard, createChildAnchor, createMark, createSourceMark, cutClipboard, delete, deleteInteractive, deleteMark, deleteMarkByName, deleteSelection, deserialize, deserializeGetCanCreateTags, deserializeSetCanCreateTags, endNotUndoableAction, endUserAction, ensureHighlight, forceFloating, forwardIterToSourceMark, freezeNotify, getv, insert, insertAtCursor, insertChildAnchor, insertInteractive, insertInteractiveAtCursor, insertMarkup, insertPixbuf, insertRange, insertRangeInteractive, isFloating, iterBackwardToContextClassToggle, iterForwardToContextClassToggle, iterHasContextClass, joinLines, moveMark, moveMarkByName, notify, notifyByPspec, pasteClipboard, placeCursor, redo, ref, refSink, registerDeserializeFormat, registerDeserializeTagset, registerSerializeFormat, registerSerializeTagset, removeAllTags, removeSelectionClipboard, removeSourceMarks, removeTag, removeTagByName, runDispose, selectRange, serialize, sortLines, stealData, stealQdata, thawNotify, undo, unref, unregisterDeserializeFormat, unregisterSerializeFormat, watchClosure.

Getters

getBounds, getCharCount, getContextClassesAtIter, getCopyTargetList, getData, getDeserializeFormats, getEndIter, getHasSelection, getHighlightMatchingBrackets, getHighlightSyntax, getImplicitTrailingNewline, getInsert, getIterAtChildAnchor, getIterAtLine, getIterAtLineIndex, getIterAtLineOffset, getIterAtMark, getIterAtOffset, getLanguage, getLineCount, getMark, getMaxUndoLevels, getModified, getPasteTargetList, getProperty, getQdata, getSelectionBound, getSelectionBounds, getSerializeFormats, getSlice, getSourceMarksAtIter, getSourceMarksAtLine, getStartIter, getStyleScheme, getTagTable, getText, getUndoManager.

Setters

setData, setDataFull, setHighlightMatchingBrackets, setHighlightSyntax, setImplicitTrailingNewline, setLanguage, setMaxUndoLevels, setModified, setProperty, setStyleScheme, setText, setUndoManager.

backwardIterToSourceMark

bufferBackwardIterToSourceMark Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> TextIter

iter: an iterator.

-> Maybe Text

category: category to search for, or Nothing

-> m Bool

Returns: whether iter was moved.

Moves iter to the position of the previous Mark of the given category. Returns True if iter was moved. If category is NULL, the previous source mark can be of any category.

Since: 2.2

beginNotUndoableAction

bufferBeginNotUndoableAction Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> m () 

Marks the beginning of a not undoable action on the buffer, disabling the undo manager. Typically you would call this function before initially setting the contents of the buffer (e.g. when loading a file in a text editor).

You may nest bufferBeginNotUndoableAction / bufferEndNotUndoableAction blocks.

canRedo

bufferCanRedo Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> m Bool

Returns: True if a redo is possible.

Determines whether a source buffer can redo the last action (i.e. if the last operation was an undo).

canUndo

bufferCanUndo Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> m Bool

Returns: True if it's possible to undo the last action.

Determines whether a source buffer can undo the last action.

changeCase

bufferChangeCase Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> ChangeCaseType

caseType: how to change the case.

-> TextIter

start: a TextIter.

-> TextIter

end: a TextIter.

-> m () 

Changes the case of the text between the specified iterators.

Since: 3.12

createSourceMark

bufferCreateSourceMark Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> Maybe Text

name: the name of the mark, or Nothing.

-> Text

category: a string defining the mark category.

-> TextIter

where: location to place the mark.

-> m Mark

Returns: a new Mark, owned by the buffer.

Creates a source mark in the buffer of category category. A source mark is a TextMark but organised into categories. Depending on the category a pixbuf can be specified that will be displayed along the line of the mark.

Like a TextMark, a Mark can be anonymous if the passed name is Nothing. Also, the buffer owns the marks so you shouldn't unreference it.

Marks always have left gravity and are moved to the beginning of the line when the user deletes the line they were in.

Typical uses for a source mark are bookmarks, breakpoints, current executing instruction indication in a source file, etc..

Since: 2.2

endNotUndoableAction

bufferEndNotUndoableAction Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> m () 

Marks the end of a not undoable action on the buffer. When the last not undoable block is closed through the call to this function, the list of undo actions is cleared and the undo manager is re-enabled.

ensureHighlight

bufferEnsureHighlight Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> TextIter

start: start of the area to highlight.

-> TextIter

end: end of the area to highlight.

-> m () 

Forces buffer to analyze and highlight the given area synchronously.

<note> <para> This is a potentially slow operation and should be used only when you need to make sure that some text not currently visible is highlighted, for instance before printing. </para> </note>

forwardIterToSourceMark

bufferForwardIterToSourceMark Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> TextIter

iter: an iterator.

-> Maybe Text

category: category to search for, or Nothing

-> m Bool

Returns: whether iter was moved.

Moves iter to the position of the next Mark of the given category. Returns True if iter was moved. If category is NULL, the next source mark can be of any category.

Since: 2.2

getContextClassesAtIter

bufferGetContextClassesAtIter Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> TextIter

iter: a TextIter.

-> m [Text]

Returns: a new Nothing terminated array of context class names. Use strfreev to free the array if it is no longer needed.

Get all defined context classes at iter.

See the Buffer description for the list of default context classes.

Since: 2.10

getHighlightMatchingBrackets

bufferGetHighlightMatchingBrackets Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> m Bool

Returns: True if the source buffer will highlight matching brackets.

Determines whether bracket match highlighting is activated for the source buffer.

getHighlightSyntax

bufferGetHighlightSyntax Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> m Bool

Returns: True if syntax highlighting is enabled, False otherwise.

Determines whether syntax highlighting is activated in the source buffer.

getImplicitTrailingNewline

bufferGetImplicitTrailingNewline Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> m Bool

Returns: whether the buffer has an implicit trailing newline.

No description available in the introspection data.

Since: 3.14

getLanguage

bufferGetLanguage Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> m (Maybe Language)

Returns: the Language associated with the buffer, or Nothing.

Returns the Language associated with the buffer, see bufferSetLanguage. The returned object should not be unreferenced by the user.

getMaxUndoLevels

bufferGetMaxUndoLevels Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> m Int32

Returns: the maximum number of possible undo levels or -1 if no limit is set.

Determines the number of undo levels the buffer will track for buffer edits.

getSourceMarksAtIter

bufferGetSourceMarksAtIter Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> TextIter

iter: an iterator.

-> Maybe Text

category: category to search for, or Nothing

-> m [Mark]

Returns: a newly allocated SList.

Returns the list of marks of the given category at iter. If category is Nothing it returns all marks at iter.

Since: 2.2

getSourceMarksAtLine

bufferGetSourceMarksAtLine Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> Int32

line: a line number.

-> Maybe Text

category: category to search for, or Nothing

-> m [Mark]

Returns: a newly allocated SList.

Returns the list of marks of the given category at line. If category is Nothing, all marks at line are returned.

Since: 2.2

getStyleScheme

bufferGetStyleScheme Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> m (Maybe StyleScheme)

Returns: the StyleScheme associated with the buffer, or Nothing.

Returns the StyleScheme associated with the buffer, see bufferSetStyleScheme. The returned object should not be unreferenced by the user.

getUndoManager

bufferGetUndoManager Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> m (Maybe UndoManager)

Returns: the UndoManager associated with the buffer, or Nothing.

Returns the UndoManager associated with the buffer, see bufferSetUndoManager. The returned object should not be unreferenced by the user.

iterBackwardToContextClassToggle

bufferIterBackwardToContextClassToggle Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> TextIter

iter: a TextIter.

-> Text

contextClass: the context class.

-> m Bool

Returns: whether we found a context class toggle before iter

Moves backward to the next toggle (on or off) of the context class. If no matching context class toggles are found, returns False, otherwise True. Does not return toggles located at iter, only toggles after iter. Sets iter to the location of the toggle, or to the end of the buffer if no toggle is found.

See the Buffer description for the list of default context classes.

Since: 2.10

iterForwardToContextClassToggle

bufferIterForwardToContextClassToggle Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> TextIter

iter: a TextIter.

-> Text

contextClass: the context class.

-> m Bool

Returns: whether we found a context class toggle after iter

Moves forward to the next toggle (on or off) of the context class. If no matching context class toggles are found, returns False, otherwise True. Does not return toggles located at iter, only toggles after iter. Sets iter to the location of the toggle, or to the end of the buffer if no toggle is found.

See the Buffer description for the list of default context classes.

Since: 2.10

iterHasContextClass

bufferIterHasContextClass Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> TextIter

iter: a TextIter.

-> Text

contextClass: class to search for.

-> m Bool

Returns: whether iter has the context class.

Check if the class contextClass is set on iter.

See the Buffer description for the list of default context classes.

Since: 2.10

joinLines

bufferJoinLines Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> TextIter

start: a TextIter.

-> TextIter

end: a TextIter.

-> m () 

Joins the lines of text between the specified iterators.

Since: 3.16

new

bufferNew Source #

Arguments

:: (HasCallStack, MonadIO m, IsTextTagTable a) 
=> Maybe a

table: a TextTagTable, or Nothing to create a new one.

-> m Buffer

Returns: a new source buffer.

Creates a new source buffer.

newWithLanguage

bufferNewWithLanguage Source #

Arguments

:: (HasCallStack, MonadIO m, IsLanguage a) 
=> a

language: a Language.

-> m Buffer

Returns: a new source buffer which will highlight text according to the highlighting patterns in language.

Creates a new source buffer using the highlighting patterns in language. This is equivalent to creating a new source buffer with a new tag table and then calling bufferSetLanguage.

redo

bufferRedo Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> m () 

Redoes the last undo operation. Use bufferCanRedo to check whether a call to this function will have any effect.

This function emits the redo signal.

removeSourceMarks

bufferRemoveSourceMarks Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> TextIter

start: a TextIter.

-> TextIter

end: a TextIter.

-> Maybe Text

category: category to search for, or Nothing.

-> m () 

Remove all marks of category between start and end from the buffer. If category is NULL, all marks in the range will be removed.

Since: 2.2

setHighlightMatchingBrackets

bufferSetHighlightMatchingBrackets Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> Bool

highlight: True if you want matching brackets highlighted.

-> m () 

Controls the bracket match highlighting function in the buffer. If activated, when you position your cursor over a bracket character (a parenthesis, a square bracket, etc.) the matching opening or closing bracket character will be highlighted.

setHighlightSyntax

bufferSetHighlightSyntax Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> Bool

highlight: True to enable syntax highlighting, False to disable it.

-> m () 

Controls whether syntax is highlighted in the buffer.

If highlight is True, the text will be highlighted according to the syntax patterns specified in the Language set with bufferSetLanguage.

If highlight is False, syntax highlighting is disabled and all the TextTag objects that have been added by the syntax highlighting engine are removed from the buffer.

setImplicitTrailingNewline

bufferSetImplicitTrailingNewline Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> Bool

implicitTrailingNewline: the new value.

-> m () 

Sets whether the buffer has an implicit trailing newline.

If an explicit trailing newline is present in a TextBuffer, TextView shows it as an empty line. This is generally not what the user expects.

If implicitTrailingNewline is True (the default value): - when a FileLoader loads the content of a file into the buffer, the trailing newline (if present in the file) is not inserted into the buffer. - when a FileSaver saves the content of the buffer into a file, a trailing newline is added to the file.

On the other hand, if implicitTrailingNewline is False, the file's content is not modified when loaded into the buffer, and the buffer's content is not modified when saved into a file.

Since: 3.14

setLanguage

bufferSetLanguage Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a, IsLanguage b) 
=> a

buffer: a Buffer.

-> Maybe b

language: a Language to set, or Nothing.

-> m () 

Associates a Language with the buffer.

Note that a Language affects not only the syntax highlighting, but also the [context classes][context-classes]. If you want to disable just the syntax highlighting, see bufferSetHighlightSyntax.

The buffer holds a reference to language.

setMaxUndoLevels

bufferSetMaxUndoLevels Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> Int32

maxUndoLevels: the desired maximum number of undo levels.

-> m () 

Sets the number of undo levels for user actions the buffer will track. If the number of user actions exceeds the limit set by this function, older actions will be discarded.

If maxUndoLevels is -1, the undo/redo is unlimited.

If maxUndoLevels is 0, the undo/redo is disabled.

setStyleScheme

bufferSetStyleScheme Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a, IsStyleScheme b) 
=> a

buffer: a Buffer.

-> Maybe b

scheme: a StyleScheme or Nothing.

-> m () 

Sets a StyleScheme to be used by the buffer and the view.

Note that a StyleScheme affects not only the syntax highlighting, but also other View features such as highlighting the current line, matching brackets, the line numbers, etc.

Instead of setting a Nothing scheme, it is better to disable syntax highlighting with bufferSetHighlightSyntax, and setting the StyleScheme with the "classic" or "tango" ID, because those two style schemes follow more closely the GTK+ theme (for example for the background color).

The buffer holds a reference to scheme.

setUndoManager

bufferSetUndoManager Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a, IsUndoManager b) 
=> a

buffer: a Buffer.

-> Maybe b

manager: A UndoManager or Nothing.

-> m () 

Set the buffer undo manager. If manager is Nothing the default undo manager will be set.

sortLines

bufferSortLines Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> TextIter

start: a TextIter.

-> TextIter

end: a TextIter.

-> [SortFlags]

flags: SortFlags specifying how the sort should behave

-> Int32

column: sort considering the text starting at the given column

-> m () 

Sort the lines of text between the specified iterators.

Since: 3.18

undo

bufferUndo Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a) 
=> a

buffer: a Buffer.

-> m () 

Undoes the last user action which modified the buffer. Use bufferCanUndo to check whether a call to this function will have any effect.

This function emits the undo signal.

Properties

canRedo

No description available in the introspection data.

getBufferCanRedo :: (MonadIO m, IsBuffer o) => o -> m Bool Source #

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

get buffer #canRedo

canUndo

No description available in the introspection data.

getBufferCanUndo :: (MonadIO m, IsBuffer o) => o -> m Bool Source #

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

get buffer #canUndo

highlightMatchingBrackets

Whether to highlight matching brackets in the buffer.

constructBufferHighlightMatchingBrackets :: (IsBuffer o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getBufferHighlightMatchingBrackets :: (MonadIO m, IsBuffer o) => o -> m Bool Source #

Get the value of the “highlight-matching-brackets” property. When overloading is enabled, this is equivalent to

get buffer #highlightMatchingBrackets

setBufferHighlightMatchingBrackets :: (MonadIO m, IsBuffer o) => o -> Bool -> m () Source #

Set the value of the “highlight-matching-brackets” property. When overloading is enabled, this is equivalent to

set buffer [ #highlightMatchingBrackets := value ]

highlightSyntax

Whether to highlight syntax in the buffer.

constructBufferHighlightSyntax :: (IsBuffer o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getBufferHighlightSyntax :: (MonadIO m, IsBuffer o) => o -> m Bool Source #

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

get buffer #highlightSyntax

setBufferHighlightSyntax :: (MonadIO m, IsBuffer o) => o -> Bool -> m () Source #

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

set buffer [ #highlightSyntax := value ]

implicitTrailingNewline

Whether the buffer has an implicit trailing newline. See bufferSetImplicitTrailingNewline.

Since: 3.14

constructBufferImplicitTrailingNewline :: (IsBuffer o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getBufferImplicitTrailingNewline :: (MonadIO m, IsBuffer o) => o -> m Bool Source #

Get the value of the “implicit-trailing-newline” property. When overloading is enabled, this is equivalent to

get buffer #implicitTrailingNewline

setBufferImplicitTrailingNewline :: (MonadIO m, IsBuffer o) => o -> Bool -> m () Source #

Set the value of the “implicit-trailing-newline” property. When overloading is enabled, this is equivalent to

set buffer [ #implicitTrailingNewline := value ]

language

No description available in the introspection data.

clearBufferLanguage :: (MonadIO m, IsBuffer o) => o -> m () Source #

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

clear #language

constructBufferLanguage :: (IsBuffer o, MonadIO m, IsLanguage a) => a -> m (GValueConstruct o) Source #

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

getBufferLanguage :: (MonadIO m, IsBuffer o) => o -> m (Maybe Language) Source #

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

get buffer #language

setBufferLanguage :: (MonadIO m, IsBuffer o, IsLanguage a) => o -> a -> m () Source #

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

set buffer [ #language := value ]

maxUndoLevels

Number of undo levels for the buffer. -1 means no limit. This property will only affect the default undo manager.

constructBufferMaxUndoLevels :: (IsBuffer o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getBufferMaxUndoLevels :: (MonadIO m, IsBuffer o) => o -> m Int32 Source #

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

get buffer #maxUndoLevels

setBufferMaxUndoLevels :: (MonadIO m, IsBuffer o) => o -> Int32 -> m () Source #

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

set buffer [ #maxUndoLevels := value ]

styleScheme

Style scheme. It contains styles for syntax highlighting, optionally foreground, background, cursor color, current line color, and matching brackets style.

clearBufferStyleScheme :: (MonadIO m, IsBuffer o) => o -> m () Source #

Set the value of the “style-scheme” property to Nothing. When overloading is enabled, this is equivalent to

clear #styleScheme

constructBufferStyleScheme :: (IsBuffer o, MonadIO m, IsStyleScheme a) => a -> m (GValueConstruct o) Source #

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

getBufferStyleScheme :: (MonadIO m, IsBuffer o) => o -> m (Maybe StyleScheme) Source #

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

get buffer #styleScheme

setBufferStyleScheme :: (MonadIO m, IsBuffer o, IsStyleScheme a) => o -> a -> m () Source #

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

set buffer [ #styleScheme := value ]

undoManager

No description available in the introspection data.

clearBufferUndoManager :: (MonadIO m, IsBuffer o) => o -> m () Source #

Set the value of the “undo-manager” property to Nothing. When overloading is enabled, this is equivalent to

clear #undoManager

constructBufferUndoManager :: (IsBuffer o, MonadIO m, IsUndoManager a) => a -> m (GValueConstruct o) Source #

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

getBufferUndoManager :: (MonadIO m, IsBuffer o) => o -> m (Maybe UndoManager) Source #

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

get buffer #undoManager

setBufferUndoManager :: (MonadIO m, IsBuffer o, IsUndoManager a) => o -> a -> m () Source #

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

set buffer [ #undoManager := value ]

Signals

bracketMatched

type BufferBracketMatchedCallback Source #

Arguments

 = Maybe TextIter

iter: if found, the location of the matching bracket.

-> BracketMatchType

state: state of bracket matching.

-> IO () 

iter is set to a valid iterator pointing to the matching bracket if state is BracketMatchTypeFound. Otherwise iter is meaningless.

The signal is emitted only when the state changes, typically when the cursor moves.

A use-case for this signal is to show messages in a Statusbar.

Since: 2.12

type C_BufferBracketMatchedCallback = Ptr () -> Ptr TextIter -> CUInt -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

afterBufferBracketMatched :: (IsBuffer a, MonadIO m) => a -> BufferBracketMatchedCallback -> m SignalHandlerId Source #

Connect a signal handler for the bracketMatched signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after buffer #bracketMatched callback

onBufferBracketMatched :: (IsBuffer a, MonadIO m) => a -> BufferBracketMatchedCallback -> m SignalHandlerId Source #

Connect a signal handler for the bracketMatched signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on buffer #bracketMatched callback

highlightUpdated

type BufferHighlightUpdatedCallback Source #

Arguments

 = TextIter

start: the start of the updated region

-> TextIter

end: the end of the updated region

-> IO () 

The highlightUpdated signal is emitted when the syntax highlighting and [context classes][context-classes] are updated in a certain region of the buffer.

type C_BufferHighlightUpdatedCallback = Ptr () -> Ptr TextIter -> Ptr TextIter -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

afterBufferHighlightUpdated :: (IsBuffer a, MonadIO m) => a -> BufferHighlightUpdatedCallback -> m SignalHandlerId Source #

Connect a signal handler for the highlightUpdated signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after buffer #highlightUpdated callback

onBufferHighlightUpdated :: (IsBuffer a, MonadIO m) => a -> BufferHighlightUpdatedCallback -> m SignalHandlerId Source #

Connect a signal handler for the highlightUpdated signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on buffer #highlightUpdated callback

redo

type BufferRedoCallback = IO () Source #

The redo signal is emitted to redo the last undo operation.

type C_BufferRedoCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

afterBufferRedo :: (IsBuffer a, MonadIO m) => a -> BufferRedoCallback -> m SignalHandlerId Source #

Connect a signal handler for the redo signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after buffer #redo callback

genClosure_BufferRedo :: MonadIO m => BufferRedoCallback -> m (GClosure C_BufferRedoCallback) Source #

Wrap the callback into a GClosure.

mk_BufferRedoCallback :: C_BufferRedoCallback -> IO (FunPtr C_BufferRedoCallback) Source #

Generate a function pointer callable from C code, from a C_BufferRedoCallback.

onBufferRedo :: (IsBuffer a, MonadIO m) => a -> BufferRedoCallback -> m SignalHandlerId Source #

Connect a signal handler for the redo signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on buffer #redo callback

sourceMarkUpdated

type BufferSourceMarkUpdatedCallback Source #

Arguments

 = TextMark

mark: the Mark

-> IO () 

The sourceMarkUpdated signal is emitted each time a mark is added to, moved or removed from the buffer.

type C_BufferSourceMarkUpdatedCallback = Ptr () -> Ptr TextMark -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

afterBufferSourceMarkUpdated :: (IsBuffer a, MonadIO m) => a -> BufferSourceMarkUpdatedCallback -> m SignalHandlerId Source #

Connect a signal handler for the sourceMarkUpdated signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after buffer #sourceMarkUpdated callback

onBufferSourceMarkUpdated :: (IsBuffer a, MonadIO m) => a -> BufferSourceMarkUpdatedCallback -> m SignalHandlerId Source #

Connect a signal handler for the sourceMarkUpdated signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on buffer #sourceMarkUpdated callback

undo

type BufferUndoCallback = IO () Source #

The undo signal is emitted to undo the last user action which modified the buffer.

type C_BufferUndoCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

afterBufferUndo :: (IsBuffer a, MonadIO m) => a -> BufferUndoCallback -> m SignalHandlerId Source #

Connect a signal handler for the undo signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after buffer #undo callback

genClosure_BufferUndo :: MonadIO m => BufferUndoCallback -> m (GClosure C_BufferUndoCallback) Source #

Wrap the callback into a GClosure.

mk_BufferUndoCallback :: C_BufferUndoCallback -> IO (FunPtr C_BufferUndoCallback) Source #

Generate a function pointer callable from C code, from a C_BufferUndoCallback.

onBufferUndo :: (IsBuffer a, MonadIO m) => a -> BufferUndoCallback -> m SignalHandlerId Source #

Connect a signal handler for the undo signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on buffer #undo callback