GI.GtkSource.Objects.Buffer

Exported types

newtype Buffer

Constructors

Buffer (ManagedPtr Buffer)

Instances

GObject Buffer

Methods

gobjectType :: Buffer -> IO GType

IsObject Buffer

IsTextBuffer Buffer

IsBuffer Buffer

class GObject o => IsBuffer o

Instances

(GObject a, UnknownAncestorError Constraint Buffer a) => IsBuffer a

IsBuffer Buffer

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

noBuffer :: Maybe Buffer

Methods

backwardIterToSourceMark

bufferBackwardIterToSourceMark

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 Buffer::redo signal.

removeSourceMarks

bufferRemoveSourceMarks

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

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

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

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

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

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

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

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

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

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 Buffer::undo signal.

Properties

canRedo

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

canUndo

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

highlightMatchingBrackets

constructBufferHighlightMatchingBrackets :: IsBuffer o => Bool -> IO (GValueConstruct o)

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

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

highlightSyntax

constructBufferHighlightSyntax :: IsBuffer o => Bool -> IO (GValueConstruct o)

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

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

implicitTrailingNewline

constructBufferImplicitTrailingNewline :: IsBuffer o => Bool -> IO (GValueConstruct o)

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

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

language

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

constructBufferLanguage :: (IsBuffer o, IsLanguage a) => a -> IO (GValueConstruct o)

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

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

maxUndoLevels

constructBufferMaxUndoLevels :: IsBuffer o => Int32 -> IO (GValueConstruct o)

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

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

styleScheme

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

constructBufferStyleScheme :: (IsBuffer o, IsStyleScheme a) => a -> IO (GValueConstruct o)

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

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

undoManager

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

constructBufferUndoManager :: (IsBuffer o, IsUndoManager a) => a -> IO (GValueConstruct o)

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

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

Signals

bracketMatched

type BufferBracketMatchedCallback = TextIter -> BracketMatchType -> IO ()

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

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

genClosure_BufferBracketMatched :: BufferBracketMatchedCallback -> IO Closure

mk_BufferBracketMatchedCallback :: C_BufferBracketMatchedCallback -> IO (FunPtr C_BufferBracketMatchedCallback)

noBufferBracketMatchedCallback :: Maybe BufferBracketMatchedCallback

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

wrap_BufferBracketMatchedCallback :: BufferBracketMatchedCallback -> Ptr () -> Ptr TextIter -> CUInt -> Ptr () -> IO ()

highlightUpdated

type BufferHighlightUpdatedCallback = TextIter -> TextIter -> IO ()

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

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

genClosure_BufferHighlightUpdated :: BufferHighlightUpdatedCallback -> IO Closure

mk_BufferHighlightUpdatedCallback :: C_BufferHighlightUpdatedCallback -> IO (FunPtr C_BufferHighlightUpdatedCallback)

noBufferHighlightUpdatedCallback :: Maybe BufferHighlightUpdatedCallback

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

wrap_BufferHighlightUpdatedCallback :: BufferHighlightUpdatedCallback -> Ptr () -> Ptr TextIter -> Ptr TextIter -> Ptr () -> IO ()

redo

type BufferRedoCallback = IO ()

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

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

genClosure_BufferRedo :: BufferRedoCallback -> IO Closure

mk_BufferRedoCallback :: C_BufferRedoCallback -> IO (FunPtr C_BufferRedoCallback)

noBufferRedoCallback :: Maybe BufferRedoCallback

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

wrap_BufferRedoCallback :: BufferRedoCallback -> Ptr () -> Ptr () -> IO ()

sourceMarkUpdated

type BufferSourceMarkUpdatedCallback = TextMark -> IO ()

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

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

genClosure_BufferSourceMarkUpdated :: BufferSourceMarkUpdatedCallback -> IO Closure

mk_BufferSourceMarkUpdatedCallback :: C_BufferSourceMarkUpdatedCallback -> IO (FunPtr C_BufferSourceMarkUpdatedCallback)

noBufferSourceMarkUpdatedCallback :: Maybe BufferSourceMarkUpdatedCallback

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

wrap_BufferSourceMarkUpdatedCallback :: BufferSourceMarkUpdatedCallback -> Ptr () -> Ptr TextMark -> Ptr () -> IO ()

undo

type BufferUndoCallback = IO ()

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

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

genClosure_BufferUndo :: BufferUndoCallback -> IO Closure

mk_BufferUndoCallback :: C_BufferUndoCallback -> IO (FunPtr C_BufferUndoCallback)

noBufferUndoCallback :: Maybe BufferUndoCallback

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

wrap_BufferUndoCallback :: BufferUndoCallback -> Ptr () -> Ptr () -> IO ()