GI.GtkSource.Objects.View

No description available in the introspection data.

Exported types

newtype View

Memory-managed wrapper type.

Constructors

View (ManagedPtr View)

Instances

Eq View

Defined in GI.GtkSource.Objects.View

Methods

(==) :: View -> View -> Bool

(/=) :: View -> View -> Bool

GObject View

Defined in GI.GtkSource.Objects.View

ManagedPtrNewtype View

Defined in GI.GtkSource.Objects.View

Methods

toManagedPtr :: View -> ManagedPtr View

TypedObject View

Defined in GI.GtkSource.Objects.View

Methods

glibType :: IO GType

HasParentTypes View

Defined in GI.GtkSource.Objects.View

IsGValue (Maybe View)

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

Defined in GI.GtkSource.Objects.View

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes View

Defined in GI.GtkSource.Objects.View

type ParentTypes View = '[TextView, Container, Widget, Object, ImplementorIface, Buildable, Scrollable]

class (GObject o, IsDescendantOf View o) => IsView o

Type class for types which can be safely cast to View, for instance with toView.

Instances

(GObject o, IsDescendantOf View o) => IsView o

Defined in GI.GtkSource.Objects.View

toView :: (MonadIO m, IsView o) => o -> m View

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

Methods

activate, add, addAccelerator, addChild, addChildAtAnchor, addChildInWindow, addDeviceEvents, addEvents, addMnemonicLabel, addTickCallback, backwardDisplayLine, backwardDisplayLineStart, bindProperty, bindPropertyFull, bufferToWindowCoords, canActivateAccel, checkResize, childFocus, childGetProperty, childNotify, childNotifyByPspec, childSetProperty, childType, classPath, computeExpand, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, destroy, destroyed, deviceIsShadowed, dragBegin, dragBeginWithCoordinates, dragCheckThreshold, dragDestAddImageTargets, dragDestAddTextTargets, dragDestAddUriTargets, dragDestFindTarget, dragDestGetTargetList, dragDestGetTrackMotion, dragDestSet, dragDestSetProxy, dragDestSetTargetList, dragDestSetTrackMotion, dragDestUnset, dragGetData, dragHighlight, dragSourceAddImageTargets, dragSourceAddTextTargets, dragSourceAddUriTargets, dragSourceGetTargetList, dragSourceSet, dragSourceSetIconGicon, dragSourceSetIconName, dragSourceSetIconPixbuf, dragSourceSetIconStock, dragSourceSetTargetList, dragSourceUnset, dragUnhighlight, draw, ensureStyle, errorBell, event, forall, forceFloating, foreach, forwardDisplayLine, forwardDisplayLineEnd, freezeChildNotify, freezeNotify, getv, grabAdd, grabDefault, grabFocus, grabRemove, hasDefault, hasFocus, hasGrab, hasRcStyle, hasScreen, hasVisibleFocus, hide, hideOnDelete, imContextFilterKeypress, inDestruction, indentLines, initTemplate, inputShapeCombineRegion, insertActionGroup, intersect, isAncestor, isComposited, isDrawable, isFloating, isFocus, isSensitive, isToplevel, isVisible, keynavFailed, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, moveChild, moveMarkOnscreen, moveVisually, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parserFinished, path, placeCursorOnscreen, propagateDraw, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetCursorBlink, resetImContext, resetRcStyles, resetStyle, resizeChildren, runDispose, scrollMarkOnscreen, scrollToIter, scrollToMark, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, startsDisplayLine, stealData, stealQdata, styleAttach, styleGetProperty, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unindentLines, unmap, unparent, unrealize, unref, unregisterWindow, unsetFocusChain, unsetStateFlags, watchClosure, windowToBufferCoords.

Getters

getAcceptsTab, getAccessible, getActionGroup, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getAutoIndent, getBackgroundPattern, getBorder, getBorderWidth, getBorderWindowSize, getBottomMargin, getBuffer, getCanDefault, getCanFocus, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompletion, getCompositeName, getCursorLocations, getCursorVisible, getData, getDefaultAttributes, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getDrawSpaces, getEditable, getEvents, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getGutter, getHadjustment, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getHighlightCurrentLine, getHscrollPolicy, getIndent, getIndentOnTab, getIndentWidth, getInputHints, getInputPurpose, getInsertSpacesInsteadOfTabs, getInternalChild, getIterAtLocation, getIterAtPosition, getIterLocation, getJustification, getLeftMargin, getLineAtY, getLineYrange, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getMarkAttributes, getModifierMask, getModifierStyle, getMonospace, getName, getNoShowAll, getOpacity, getOverwrite, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPixelsAboveLines, getPixelsBelowLines, getPixelsInsideWrap, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getResizeMode, getRightMargin, getRightMarginPosition, getRootWindow, getScaleFactor, getScreen, getSensitive, getSettings, getShowLineMarks, getShowLineNumbers, getShowRightMargin, getSizeRequest, getSmartBackspace, getSmartHomeEnd, getSpaceDrawer, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTabWidth, getTabs, getTemplateChild, getTooltipMarkup, getTooltipText, getTooltipWindow, getTopMargin, getToplevel, getVadjustment, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisibleRect, getVisual, getVisualColumn, getVscrollPolicy, getWindow, getWindowType, getWrapMode.

Setters

setAccelPath, setAcceptsTab, setAllocation, setAppPaintable, setAutoIndent, setBackgroundPattern, setBorderWidth, setBorderWindowSize, setBottomMargin, setBuffer, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setCursorVisible, setData, setDataFull, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setDrawSpaces, setEditable, setEvents, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHadjustment, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setHighlightCurrentLine, setHscrollPolicy, setIndent, setIndentOnTab, setIndentWidth, setInputHints, setInputPurpose, setInsertSpacesInsteadOfTabs, setJustification, setLeftMargin, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setMarkAttributes, setMonospace, setName, setNoShowAll, setOpacity, setOverwrite, setParent, setParentWindow, setPixelsAboveLines, setPixelsBelowLines, setPixelsInsideWrap, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizeMode, setRightMargin, setRightMarginPosition, setSensitive, setShowLineMarks, setShowLineNumbers, setShowRightMargin, setSizeRequest, setSmartBackspace, setSmartHomeEnd, setState, setStateFlags, setStyle, setSupportMultidevice, setTabWidth, setTabs, setTooltipMarkup, setTooltipText, setTooltipWindow, setTopMargin, setVadjustment, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setVscrollPolicy, setWindow, setWrapMode.

getAutoIndent

viewGetAutoIndent

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> m Bool

Returns: True if auto indentation is enabled.

Returns whether auto-indentation of text is enabled.

getBackgroundPattern

viewGetBackgroundPattern

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View

-> m BackgroundPatternType

Returns: the BackgroundPatternType.

Returns the BackgroundPatternType specifying if and how the background pattern should be displayed for this view.

Since: 3.16

getCompletion

viewGetCompletion

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> m Completion

Returns: the Completion associated with view.

Gets the Completion associated with view. The returned object is guaranteed to be the same for the lifetime of view. Each View object has a different Completion.

getDrawSpaces

viewGetDrawSpaces

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View

-> m [DrawSpacesFlags]

Returns: the DrawSpacesFlags, 0 if no spaces should be drawn.

Deprecated: (Since version 3.24)Use spaceDrawerGetTypesForLocationsinstead.

Returns the DrawSpacesFlags specifying if and how spaces should be displayed for this view.

getGutter

viewGetGutter

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> TextWindowType

windowType: the gutter window type.

-> m Gutter

Returns: the Gutter.

Returns the Gutter object associated with windowType for view. Only GTK_TEXT_WINDOW_LEFT and GTK_TEXT_WINDOW_RIGHT are supported, respectively corresponding to the left and right gutter. The line numbers and mark category icons are rendered in the left gutter.

Since: 2.8

getHighlightCurrentLine

viewGetHighlightCurrentLine

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> m Bool

Returns: True if the current line is highlighted.

Returns whether the current line is highlighted.

getIndentOnTab

viewGetIndentOnTab

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> m Bool

Returns: True if the selection is indented when tab is pressed.

Returns whether when the tab key is pressed the current selection should get indented instead of replaced with the \t character.

getIndentWidth

viewGetIndentWidth

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> m Int32

Returns: indent width.

Returns the number of spaces to use for each step of indent. See viewSetIndentWidth for details.

getInsertSpacesInsteadOfTabs

viewGetInsertSpacesInsteadOfTabs

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> m Bool

Returns: True if spaces are inserted instead of tabs.

Returns whether when inserting a tabulator character it should be replaced by a group of space characters.

getMarkAttributes

viewGetMarkAttributes

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> Text

category: the category.

-> Int32

priority: place where priority of the category will be stored.

-> m MarkAttributes

Returns: MarkAttributes for the category. The object belongs to view, so it must not be unreffed.

Gets attributes and priority for the category.

getRightMarginPosition

viewGetRightMarginPosition

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> m Word32

Returns: the position of the right margin.

Gets the position of the right margin in the given view.

getShowLineMarks

viewGetShowLineMarks

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> m Bool

Returns: True if the line marks are displayed.

Returns whether line marks are displayed beside the text.

Since: 2.2

getShowLineNumbers

viewGetShowLineNumbers

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> m Bool

Returns: True if the line numbers are displayed.

Returns whether line numbers are displayed beside the text.

getShowRightMargin

viewGetShowRightMargin

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> m Bool

Returns: True if the right margin is shown.

Returns whether a right margin is displayed.

getSmartBackspace

viewGetSmartBackspace

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> m Bool

Returns: True if smart Backspace handling is enabled.

Returns True if pressing the Backspace key will try to delete spaces up to the previous tab stop.

Since: 3.18

getSmartHomeEnd

viewGetSmartHomeEnd

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> m SmartHomeEndType

Returns: a SmartHomeEndType value.

Returns a SmartHomeEndType end value specifying how the cursor will move when HOME and END keys are pressed.

getSpaceDrawer

viewGetSpaceDrawer

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> m SpaceDrawer

Returns: the SpaceDrawer associated with view.

Gets the SpaceDrawer associated with view. The returned object is guaranteed to be the same for the lifetime of view. Each View object has a different SpaceDrawer.

Since: 3.24

getTabWidth

viewGetTabWidth

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> m Word32

Returns: width of tab.

Returns the width of tabulation in characters.

getVisualColumn

viewGetVisualColumn

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> TextIter

iter: a position in view.

-> m Word32

Returns: the visual column at iter.

Determines the visual column at iter taking into consideration the View:tab-width of view.

indentLines

viewIndentLines

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> TextIter

start: TextIter of the first line to indent

-> TextIter

end: TextIter of the last line to indent

-> m ()

Inserts one indentation level at the beginning of the specified lines. The empty lines are not indented.

Since: 3.16

new

viewNew

Arguments

:: (HasCallStack, MonadIO m)

=> m View

Returns: a new View.

Creates a new View.

By default, an empty Buffer will be lazily created and can be retrieved with textViewGetBuffer.

If you want to specify your own buffer, either override the TextViewClass create_buffer factory method, or use viewNewWithBuffer.

newWithBuffer

viewNewWithBuffer

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a)

=> a

buffer: a Buffer.

-> m View

Returns: a new View.

Creates a new View widget displaying the buffer buffer. One buffer can be shared among many widgets.

setAutoIndent

viewSetAutoIndent

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> Bool

enable: whether to enable auto indentation.

-> m ()

If True auto-indentation of text is enabled.

When Enter is pressed to create a new line, the auto-indentation inserts the same indentation as the previous line. This is <emphasis>not</emphasis> a "smart indentation" where an indentation level is added or removed depending on the context.

setBackgroundPattern

viewSetBackgroundPattern

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> BackgroundPatternType

backgroundPattern: the BackgroundPatternType.

-> m ()

Set if and how the background pattern should be displayed.

Since: 3.16

setDrawSpaces

viewSetDrawSpaces

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> [DrawSpacesFlags]

flags: DrawSpacesFlags specifing how white spaces should be displayed

-> m ()

Deprecated: (Since version 3.24)Use spaceDrawerSetTypesForLocationsinstead.

Set if and how the spaces should be visualized. Specifying flags as 0 will disable display of spaces.

For a finer-grained method, there is also the GtkSourceTag's Tag:draw-spaces property.

setHighlightCurrentLine

viewSetHighlightCurrentLine

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> Bool

highlight: whether to highlight the current line.

-> m ()

If highlight is True the current line will be highlighted.

setIndentOnTab

viewSetIndentOnTab

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> Bool

enable: whether to indent a block when tab is pressed.

-> m ()

If True, when the tab key is pressed when several lines are selected, the selected lines are indented of one level instead of being replaced with a \t character. Shift+Tab unindents the selection.

If the first or last line is not selected completely, it is also indented or unindented.

When the selection doesn't span several lines, the tab key always replaces the selection with a normal \t character.

setIndentWidth

viewSetIndentWidth

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> Int32

width: indent width in characters.

-> m ()

Sets the number of spaces to use for each step of indent when the tab key is pressed. If width is -1, the value of the View:tab-width property will be used.

The View:indent-width interacts with the View:insert-spaces-instead-of-tabs property and View:tab-width. An example will be clearer: if the View:indent-width is 4 and View:tab-width is 8 and View:insert-spaces-instead-of-tabs is False, then pressing the tab key at the beginning of a line will insert 4 spaces. So far so good. Pressing the tab key a second time will remove the 4 spaces and insert a \t character instead (since View:tab-width is 8). On the other hand, if View:insert-spaces-instead-of-tabs is True, the second tab key pressed will insert 4 more spaces for a total of 8 spaces in the TextBuffer.

The test-widget program (available in the GtkSourceView repository) may be useful to better understand the indentation settings (enable the space drawing!).

setInsertSpacesInsteadOfTabs

viewSetInsertSpacesInsteadOfTabs

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> Bool

enable: whether to insert spaces instead of tabs.

-> m ()

If True a tab key pressed is replaced by a group of space characters. Of course it is still possible to insert a real \t programmatically with the TextBuffer API.

setMarkAttributes

viewSetMarkAttributes

Arguments

:: (HasCallStack, MonadIO m, IsView a, IsMarkAttributes b)

=> a

view: a View.

-> Text

category: the category.

-> b

attributes: mark attributes.

-> Int32

priority: priority of the category.

-> m ()

Sets attributes and priority for the category.

setRightMarginPosition

viewSetRightMarginPosition

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> Word32

pos: the width in characters where to position the right margin.

-> m ()

Sets the position of the right margin in the given view.

setShowLineMarks

viewSetShowLineMarks

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> Bool

show: whether line marks should be displayed.

-> m ()

If True line marks will be displayed beside the text.

Since: 2.2

setShowLineNumbers

viewSetShowLineNumbers

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> Bool

show: whether line numbers should be displayed.

-> m ()

If True line numbers will be displayed beside the text.

setShowRightMargin

viewSetShowRightMargin

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> Bool

show: whether to show a right margin.

-> m ()

If True a right margin is displayed.

setSmartBackspace

viewSetSmartBackspace

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> Bool

smartBackspace: whether to enable smart Backspace handling.

-> m ()

When set to True, pressing the Backspace key will try to delete spaces up to the previous tab stop.

Since: 3.18

setSmartHomeEnd

viewSetSmartHomeEnd

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> SmartHomeEndType

smartHomeEnd: the desired behavior among SmartHomeEndType.

-> m ()

Set the desired movement of the cursor when HOME and END keys are pressed.

setTabWidth

viewSetTabWidth

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> Word32

width: width of tab in characters.

-> m ()

Sets the width of tabulation in characters. The TextBuffer still contains \t characters, but they can take a different visual width in a View widget.

unindentLines

viewUnindentLines

Arguments

:: (HasCallStack, MonadIO m, IsView a)

=> a

view: a View.

-> TextIter

start: TextIter of the first line to indent

-> TextIter

end: TextIter of the last line to indent

-> m ()

Removes one indentation level at the beginning of the specified lines.

Since: 3.16

Properties

autoIndent

No description available in the introspection data.

constructViewAutoIndent :: (IsView o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getViewAutoIndent :: (MonadIO m, IsView o) => o -> m Bool

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

get view #autoIndent

setViewAutoIndent :: (MonadIO m, IsView o) => o -> Bool -> m ()

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

set view [ #autoIndent := value ]

backgroundPattern

Draw a specific background pattern on the view.

Since: 3.16

constructViewBackgroundPattern :: (IsView o, MonadIO m) => BackgroundPatternType -> m (GValueConstruct o)

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

getViewBackgroundPattern :: (MonadIO m, IsView o) => o -> m BackgroundPatternType

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

get view #backgroundPattern

setViewBackgroundPattern :: (MonadIO m, IsView o) => o -> BackgroundPatternType -> m ()

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

set view [ #backgroundPattern := value ]

completion

The completion object associated with the view

getViewCompletion :: (MonadIO m, IsView o) => o -> m Completion

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

get view #completion

drawSpaces

Set if and how the spaces should be visualized.

For a finer-grained method, there is also the GtkSourceTag's Tag:draw-spaces property.

Since: 2.4

constructViewDrawSpaces :: (IsView o, MonadIO m) => [DrawSpacesFlags] -> m (GValueConstruct o)

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

getViewDrawSpaces :: (MonadIO m, IsView o) => o -> m [DrawSpacesFlags]

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

get view #drawSpaces

setViewDrawSpaces :: (MonadIO m, IsView o) => o -> [DrawSpacesFlags] -> m ()

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

set view [ #drawSpaces := value ]

highlightCurrentLine

No description available in the introspection data.

constructViewHighlightCurrentLine :: (IsView o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getViewHighlightCurrentLine :: (MonadIO m, IsView o) => o -> m Bool

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

get view #highlightCurrentLine

setViewHighlightCurrentLine :: (MonadIO m, IsView o) => o -> Bool -> m ()

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

set view [ #highlightCurrentLine := value ]

indentOnTab

No description available in the introspection data.

constructViewIndentOnTab :: (IsView o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getViewIndentOnTab :: (MonadIO m, IsView o) => o -> m Bool

Get the value of the “indent-on-tab” property. When overloading is enabled, this is equivalent to

get view #indentOnTab

setViewIndentOnTab :: (MonadIO m, IsView o) => o -> Bool -> m ()

Set the value of the “indent-on-tab” property. When overloading is enabled, this is equivalent to

set view [ #indentOnTab := value ]

indentWidth

Width of an indentation step expressed in number of spaces.

constructViewIndentWidth :: (IsView o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getViewIndentWidth :: (MonadIO m, IsView o) => o -> m Int32

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

get view #indentWidth

setViewIndentWidth :: (MonadIO m, IsView o) => o -> Int32 -> m ()

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

set view [ #indentWidth := value ]

insertSpacesInsteadOfTabs

No description available in the introspection data.

constructViewInsertSpacesInsteadOfTabs :: (IsView o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “insert-spaces-instead-of-tabs” property. This is rarely needed directly, but it is used by new.

getViewInsertSpacesInsteadOfTabs :: (MonadIO m, IsView o) => o -> m Bool

Get the value of the “insert-spaces-instead-of-tabs” property. When overloading is enabled, this is equivalent to

get view #insertSpacesInsteadOfTabs

setViewInsertSpacesInsteadOfTabs :: (MonadIO m, IsView o) => o -> Bool -> m ()

Set the value of the “insert-spaces-instead-of-tabs” property. When overloading is enabled, this is equivalent to

set view [ #insertSpacesInsteadOfTabs := value ]

rightMarginPosition

Position of the right margin.

constructViewRightMarginPosition :: (IsView o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getViewRightMarginPosition :: (MonadIO m, IsView o) => o -> m Word32

Get the value of the “right-margin-position” property. When overloading is enabled, this is equivalent to

get view #rightMarginPosition

setViewRightMarginPosition :: (MonadIO m, IsView o) => o -> Word32 -> m ()

Set the value of the “right-margin-position” property. When overloading is enabled, this is equivalent to

set view [ #rightMarginPosition := value ]

showLineMarks

Whether to display line mark pixbufs

constructViewShowLineMarks :: (IsView o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getViewShowLineMarks :: (MonadIO m, IsView o) => o -> m Bool

Get the value of the “show-line-marks” property. When overloading is enabled, this is equivalent to

get view #showLineMarks

setViewShowLineMarks :: (MonadIO m, IsView o) => o -> Bool -> m ()

Set the value of the “show-line-marks” property. When overloading is enabled, this is equivalent to

set view [ #showLineMarks := value ]

showLineNumbers

Whether to display line numbers

constructViewShowLineNumbers :: (IsView o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getViewShowLineNumbers :: (MonadIO m, IsView o) => o -> m Bool

Get the value of the “show-line-numbers” property. When overloading is enabled, this is equivalent to

get view #showLineNumbers

setViewShowLineNumbers :: (MonadIO m, IsView o) => o -> Bool -> m ()

Set the value of the “show-line-numbers” property. When overloading is enabled, this is equivalent to

set view [ #showLineNumbers := value ]

showRightMargin

Whether to display the right margin.

constructViewShowRightMargin :: (IsView o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getViewShowRightMargin :: (MonadIO m, IsView o) => o -> m Bool

Get the value of the “show-right-margin” property. When overloading is enabled, this is equivalent to

get view #showRightMargin

setViewShowRightMargin :: (MonadIO m, IsView o) => o -> Bool -> m ()

Set the value of the “show-right-margin” property. When overloading is enabled, this is equivalent to

set view [ #showRightMargin := value ]

smartBackspace

Whether smart Backspace should be used.

Since: 3.18

constructViewSmartBackspace :: (IsView o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getViewSmartBackspace :: (MonadIO m, IsView o) => o -> m Bool

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

get view #smartBackspace

setViewSmartBackspace :: (MonadIO m, IsView o) => o -> Bool -> m ()

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

set view [ #smartBackspace := value ]

smartHomeEnd

Set the behavior of the HOME and END keys.

Since: 2.0

constructViewSmartHomeEnd :: (IsView o, MonadIO m) => SmartHomeEndType -> m (GValueConstruct o)

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

getViewSmartHomeEnd :: (MonadIO m, IsView o) => o -> m SmartHomeEndType

Get the value of the “smart-home-end” property. When overloading is enabled, this is equivalent to

get view #smartHomeEnd

setViewSmartHomeEnd :: (MonadIO m, IsView o) => o -> SmartHomeEndType -> m ()

Set the value of the “smart-home-end” property. When overloading is enabled, this is equivalent to

set view [ #smartHomeEnd := value ]

spaceDrawer

The SpaceDrawer object associated with the view.

Since: 3.24

getViewSpaceDrawer :: (MonadIO m, IsView o) => o -> m SpaceDrawer

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

get view #spaceDrawer

tabWidth

Width of a tab character expressed in number of spaces.

constructViewTabWidth :: (IsView o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getViewTabWidth :: (MonadIO m, IsView o) => o -> m Word32

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

get view #tabWidth

setViewTabWidth :: (MonadIO m, IsView o) => o -> Word32 -> m ()

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

set view [ #tabWidth := value ]

Signals

changeCase

type ViewChangeCaseCallback

Arguments

 = ChangeCaseType

caseType: the case to use

-> IO ()

Keybinding signal to change case of the text at the current cursor position.

Since: 3.16

afterViewChangeCase :: (IsView a, MonadIO m) => a -> ((?self :: a) => ViewChangeCaseCallback) -> m SignalHandlerId

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

after view #changeCase callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onViewChangeCase :: (IsView a, MonadIO m) => a -> ((?self :: a) => ViewChangeCaseCallback) -> m SignalHandlerId

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

on view #changeCase callback

changeNumber

type ViewChangeNumberCallback

Arguments

 = Int32

count: the number to add to the number at the current position

-> IO ()

Keybinding signal to edit a number at the current cursor position.

Since: 3.16

afterViewChangeNumber :: (IsView a, MonadIO m) => a -> ((?self :: a) => ViewChangeNumberCallback) -> m SignalHandlerId

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

after view #changeNumber callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onViewChangeNumber :: (IsView a, MonadIO m) => a -> ((?self :: a) => ViewChangeNumberCallback) -> m SignalHandlerId

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

on view #changeNumber callback

joinLines

type ViewJoinLinesCallback = IO ()

Keybinding signal to join the lines currently selected.

Since: 3.16

afterViewJoinLines :: (IsView a, MonadIO m) => a -> ((?self :: a) => ViewJoinLinesCallback) -> m SignalHandlerId

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

after view #joinLines callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onViewJoinLines :: (IsView a, MonadIO m) => a -> ((?self :: a) => ViewJoinLinesCallback) -> m SignalHandlerId

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

on view #joinLines callback

lineMarkActivated

type ViewLineMarkActivatedCallback

Arguments

 = TextIter

iter: a TextIter

-> Event

event: the Event that activated the event

-> IO ()

Emitted when a line mark has been activated (for instance when there was a button press in the line marks gutter). You can use iter to determine on which line the activation took place.

afterViewLineMarkActivated :: (IsView a, MonadIO m) => a -> ((?self :: a) => ViewLineMarkActivatedCallback) -> m SignalHandlerId

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

after view #lineMarkActivated callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onViewLineMarkActivated :: (IsView a, MonadIO m) => a -> ((?self :: a) => ViewLineMarkActivatedCallback) -> m SignalHandlerId

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

on view #lineMarkActivated callback

moveLines

type ViewMoveLinesCallback

Arguments

 = Bool

copy: True if the line should be copied, False if it should be moved. This parameter is deprecated and will be removed in a later version, it should be always False.

-> Int32

count: the number of lines to move over. Only 1 and -1 are supported.

-> IO ()

The moveLines signal is a keybinding which gets emitted when the user initiates moving a line. The default binding key is Alt+Up/Down arrow. And moves the currently selected lines, or the current line by count. For the moment, only count of -1 or 1 is valid.

The copy parameter is deprecated, it has never been used by GtkSourceView (the value is always False) and was buggy.

Since: 2.10

afterViewMoveLines :: (IsView a, MonadIO m) => a -> ((?self :: a) => ViewMoveLinesCallback) -> m SignalHandlerId

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

after view #moveLines callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onViewMoveLines :: (IsView a, MonadIO m) => a -> ((?self :: a) => ViewMoveLinesCallback) -> m SignalHandlerId

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

on view #moveLines callback

moveToMatchingBracket

type ViewMoveToMatchingBracketCallback

Arguments

 = Bool

extendSelection: True if the move should extend the selection

-> IO ()

Keybinding signal to move the cursor to the matching bracket.

Since: 3.16

afterViewMoveToMatchingBracket :: (IsView a, MonadIO m) => a -> ((?self :: a) => ViewMoveToMatchingBracketCallback) -> m SignalHandlerId

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

after view #moveToMatchingBracket callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onViewMoveToMatchingBracket :: (IsView a, MonadIO m) => a -> ((?self :: a) => ViewMoveToMatchingBracketCallback) -> m SignalHandlerId

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

on view #moveToMatchingBracket callback

moveWords

type ViewMoveWordsCallback

Arguments

 = Int32

count: the number of words to move over

-> IO ()

The moveWords signal is a keybinding which gets emitted when the user initiates moving a word. The default binding key is Alt+Left/Right Arrow and moves the current selection, or the current word by one word.

Since: 3.0

afterViewMoveWords :: (IsView a, MonadIO m) => a -> ((?self :: a) => ViewMoveWordsCallback) -> m SignalHandlerId

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

after view #moveWords callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onViewMoveWords :: (IsView a, MonadIO m) => a -> ((?self :: a) => ViewMoveWordsCallback) -> m SignalHandlerId

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

on view #moveWords callback

redo

type ViewRedoCallback = IO ()

No description available in the introspection data.

afterViewRedo :: (IsView a, MonadIO m) => a -> ((?self :: a) => ViewRedoCallback) -> m SignalHandlerId

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

after view #redo callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onViewRedo :: (IsView a, MonadIO m) => a -> ((?self :: a) => ViewRedoCallback) -> m SignalHandlerId

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

on view #redo callback

showCompletion

type ViewShowCompletionCallback = IO ()

The showCompletion signal is a key binding signal which gets emitted when the user requests a completion, by pressing <keycombo><keycap>Control</keycap><keycap>space</keycap></keycombo>.

This will create a CompletionContext with the activation type as CompletionActivationUserRequested.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to activate the completion by another means, for example with another key binding or a menu entry.

afterViewShowCompletion :: (IsView a, MonadIO m) => a -> ((?self :: a) => ViewShowCompletionCallback) -> m SignalHandlerId

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

after view #showCompletion callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onViewShowCompletion :: (IsView a, MonadIO m) => a -> ((?self :: a) => ViewShowCompletionCallback) -> m SignalHandlerId

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

on view #showCompletion callback

smartHomeEnd

type ViewSmartHomeEndCallback

Arguments

 = TextIter

iter: a TextIter

-> Int32

count: the count

-> IO ()

Emitted when a the cursor was moved according to the smart home end setting. The signal is emitted after the cursor is moved, but during the GtkTextView[moveCursor](#g:signal:moveCursor) action. This can be used to find out whether the cursor was moved by a normal home/end or by a smart home/end.

Since: 3.0

afterViewSmartHomeEnd :: (IsView a, MonadIO m) => a -> ((?self :: a) => ViewSmartHomeEndCallback) -> m SignalHandlerId

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

after view #smartHomeEnd callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onViewSmartHomeEnd :: (IsView a, MonadIO m) => a -> ((?self :: a) => ViewSmartHomeEndCallback) -> m SignalHandlerId

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

on view #smartHomeEnd callback

undo

type ViewUndoCallback = IO ()

No description available in the introspection data.

afterViewUndo :: (IsView a, MonadIO m) => a -> ((?self :: a) => ViewUndoCallback) -> m SignalHandlerId

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

after view #undo callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onViewUndo :: (IsView a, MonadIO m) => a -> ((?self :: a) => ViewUndoCallback) -> m SignalHandlerId

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

on view #undo callback