GI.GtkSource.Objects.Gutter

No description available in the introspection data.

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 = '[Object]

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

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, insert, isFloating, notify, notifyByPspec, queueDraw, ref, refSink, remove, reorder, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getPadding, getProperty, getQdata, getRendererAtPos, getView, getWindow, getWindowType.

Setters

setData, setDataFull, setPadding, setProperty.

getPadding

gutterGetPadding :: (HasCallStack, MonadIO m, IsGutter a) => a -> Int32 -> Int32 -> m ()

Deprecated: (Since version 3.12)Use gutterRendererGetPadding instead.

No description available in the introspection data.

getRendererAtPos

gutterGetRendererAtPos

Arguments

:: (HasCallStack, MonadIO m, IsGutter a)

=> a

gutter: A Gutter.

-> Int32

x: The x position to get identified.

-> Int32

y: The y position to get identified.

-> m (Maybe GutterRenderer)

Returns: the renderer at (x, y) or Nothing.

Finds the GutterRenderer at (x, y).

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.

Since: 3.24

getWindow

gutterGetWindow

Arguments

:: (HasCallStack, MonadIO m, IsGutter a)

=> a

gutter: a Gutter.

-> m Window

Returns: the Window of the gutter, or Nothing if the gutter has no window.

Deprecated: (Since version 3.12)Use textViewGetWindow instead.

Get the Window of the gutter. The window will only be available when the gutter has at least one, non-zero width, cell renderer packed.

Since: 2.8

getWindowType

gutterGetWindowType

Arguments

:: (HasCallStack, MonadIO m, IsGutter a)

=> a

gutter: a Gutter.

-> m TextWindowType

Returns: the TextWindowType of gutter.

No description available in the introspection data.

Since: 3.24

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.

Since: 3.0

queueDraw

gutterQueueDraw

Arguments

:: (HasCallStack, MonadIO m, IsGutter a)

=> a

gutter: a Gutter.

-> m ()

Invalidates the drawable area of the gutter. You can use this to force a redraw of the gutter if something has changed and needs to be redrawn.

Since: 2.8

remove

gutterRemove

Arguments

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

=> a

gutter: a Gutter.

-> b

renderer: a GutterRenderer.

-> m ()

Removes renderer from gutter.

Since: 2.8

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.

Since: 2.8

setPadding

gutterSetPadding :: (HasCallStack, MonadIO m, IsGutter a) => a -> Int32 -> Int32 -> m ()

Deprecated: (Since version 3.12)Use gutterRendererSetPadding instead.

No description available in the introspection data.

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

xpad

The x-padding.

constructGutterXpad :: (IsGutter o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getGutterXpad :: (MonadIO m, IsGutter o) => o -> m Int32

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

get gutter #xpad

setGutterXpad :: (MonadIO m, IsGutter o) => o -> Int32 -> m ()

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

set gutter [ #xpad := value ]

ypad

The y-padding.

constructGutterYpad :: (IsGutter o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getGutterYpad :: (MonadIO m, IsGutter o) => o -> m Int32

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

get gutter #ypad

setGutterYpad :: (MonadIO m, IsGutter o) => o -> Int32 -> m ()

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

set gutter [ #ypad := value ]