GI.GtkSource.Objects.Gutter

Gutter object for [classview].

The GtkSourceGutter object represents the left or right gutter of the text view. It is used by [classview] to draw the line numbers and [classmark]s that might be present on a line. By packing additional [classgutterRenderer] objects in the gutter, you can extend the gutter with your own custom drawings.

To get a GtkSourceGutter, use the [methodview.get_gutter] function.

The gutter works very much the same way as cells rendered in a TreeView. The concept is similar, with the exception that the gutter does not have an underlying TreeModel. The builtin line number renderer is at position ViewGutterPositionLines (-30) and the marks renderer is at ViewGutterPositionMarks (-20). The gutter sorts the renderers in ascending order, from left to right. So the marks are displayed on the right of the line numbers.

Exported types

newtype Gutter

Memory-managed wrapper type.

Constructors

Gutter (ManagedPtr Gutter)

Instances

Eq Gutter

Defined in GI.GtkSource.Objects.Gutter

Methods

(==) :: Gutter -> Gutter -> Bool

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

GObject Gutter

Defined in GI.GtkSource.Objects.Gutter

ManagedPtrNewtype Gutter

Defined in GI.GtkSource.Objects.Gutter

Methods

toManagedPtr :: Gutter -> ManagedPtr Gutter

TypedObject Gutter

Defined in GI.GtkSource.Objects.Gutter

Methods

glibType :: IO GType

HasParentTypes Gutter

Defined in GI.GtkSource.Objects.Gutter

IsGValue (Maybe Gutter)

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

Defined in GI.GtkSource.Objects.Gutter

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Gutter

Defined in GI.GtkSource.Objects.Gutter

type ParentTypes Gutter = '[Widget, Object, Accessible, Buildable, ConstraintTarget]

class (GObject o, IsDescendantOf Gutter o) => IsGutter o

Type class for types which can be safely cast to Gutter, for instance with toGutter.

Instances

(GObject o, IsDescendantOf Gutter o) => IsGutter o

Defined in GI.GtkSource.Objects.Gutter

toGutter :: (MonadIO m, IsGutter o) => o -> m Gutter

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

actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, bindProperty, bindPropertyFull, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, disposeTemplate, dragCheckThreshold, errorBell, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insert, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFloating, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, remove, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, reorder, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateNextAccessibleSibling, updateProperty, updateRelation, updateState, watchClosure.

Getters

getAccessibleParent, getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getAtContext, getBounds, getBuildableId, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getFirstAccessibleChild, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextAccessibleSibling, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPlatformState, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getView, getVisible, getWidth.

Setters

setAccessibleParent, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setProperty, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible.

getView

gutterGetView

Arguments

:: (HasCallStack, MonadIO m, IsGutter a)

=> a

gutter: a Gutter.

-> m View

Returns: the associated View.

No description available in the introspection data.

insert

gutterInsert

Arguments

:: (HasCallStack, MonadIO m, IsGutter a, IsGutterRenderer b)

=> a

gutter: a Gutter.

-> b

renderer: a gutter renderer (must inherit from GutterRenderer).

-> Int32

position: the renderer position.

-> m Bool

Returns: True if operation succeeded. Otherwise False.

Insert renderer into the gutter. If renderer is yet unowned then gutter claims its ownership. Otherwise just increases renderer's reference count. renderer cannot be already inserted to another gutter.

remove

gutterRemove :: (HasCallStack, MonadIO m, IsGutter a, IsGutterRenderer b) => a -> b -> m ()

No description available in the introspection data.

reorder

gutterReorder

Arguments

:: (HasCallStack, MonadIO m, IsGutter a, IsGutterRenderer b)

=> a

gutter: a GutterRenderer.

-> b

renderer: a CellRenderer.

-> Int32

position: the new renderer position.

-> m ()

Reorders renderer in gutter to new position.

Properties

view

The View of the gutter.

constructGutterView :: (IsGutter o, MonadIO m, IsView a) => a -> m (GValueConstruct o)

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

getGutterView :: (MonadIO m, IsGutter o) => o -> m View

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

get gutter #view

windowType

The text window type on which the window is placed.

constructGutterWindowType :: (IsGutter o, MonadIO m) => TextWindowType -> m (GValueConstruct o)

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

getGutterWindowType :: (MonadIO m, IsGutter o) => o -> m TextWindowType

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

get gutter #windowType