GI.GtkSource.Objects.SpaceDrawer

Exported types

newtype SpaceDrawer

Constructors

SpaceDrawer (ManagedPtr SpaceDrawer)

Instances

GObject SpaceDrawer

Methods

gobjectType :: SpaceDrawer -> IO GType

IsObject SpaceDrawer

IsSpaceDrawer SpaceDrawer

class GObject o => IsSpaceDrawer o

Instances

(GObject a, UnknownAncestorError Constraint SpaceDrawer a) => IsSpaceDrawer a

IsSpaceDrawer SpaceDrawer

toSpaceDrawer :: (MonadIO m, IsSpaceDrawer o) => o -> m SpaceDrawer

noSpaceDrawer :: Maybe SpaceDrawer

Methods

bindMatrixSetting

spaceDrawerBindMatrixSetting

Arguments

:: (HasCallStack, MonadIO m, IsSpaceDrawer a, IsSettings b)

=> a

drawer: a SpaceDrawer object.

-> b

settings: a Settings object.

-> Text

key: the settings key to bind.

-> [SettingsBindFlags]

flags: flags for the binding.

-> m ()

Binds the SpaceDrawer:matrix property to a Settings key.

The Settings key must be of the same type as the SpaceDrawer:matrix property, that is, "au".

The settingsBind function cannot be used, because the default GIO mapping functions don't support GVariant properties (maybe it will be supported by a future GIO version, in which case this function can be deprecated).

Since: 3.24

getEnableMatrix

spaceDrawerGetEnableMatrix

Arguments

:: (HasCallStack, MonadIO m, IsSpaceDrawer a)

=> a

drawer: a SpaceDrawer.

-> m Bool

Returns: whether the SpaceDrawer:matrix property is enabled.

No description available in the introspection data.

Since: 3.24

getMatrix

spaceDrawerGetMatrix

Arguments

:: (HasCallStack, MonadIO m, IsSpaceDrawer a)

=> a

drawer: a SpaceDrawer.

-> m GVariant

Returns: the SpaceDrawer:matrix value as a new floating GVariant instance.

Gets the value of the SpaceDrawer:matrix property, as a GVariant. An empty array can be returned in case the matrix is a zero matrix.

The spaceDrawerGetTypesForLocations function may be more convenient to use.

Since: 3.24

getTypesForLocations

spaceDrawerGetTypesForLocations

Arguments

:: (HasCallStack, MonadIO m, IsSpaceDrawer a)

=> a

drawer: a SpaceDrawer.

-> [SpaceLocationFlags]

locations: one or several SpaceLocationFlags.

-> m [SpaceTypeFlags]

Returns: a combination of SpaceTypeFlags.

If only one location is specified, this function returns what kind of white spaces are drawn at that location. The value is retrieved from the SpaceDrawer:matrix property.

If several locations are specified, this function returns the logical AND for those locations. Which means that if a certain kind of white space is present in the return value, then that kind of white space is drawn at all the specified locations.

Since: 3.24

new

spaceDrawerNew

Arguments

:: (HasCallStack, MonadIO m)

=> m SpaceDrawer

Returns: a new SpaceDrawer.

Creates a new SpaceDrawer object. Useful for storing space drawing settings independently of a View.

Since: 3.24

setEnableMatrix

spaceDrawerSetEnableMatrix

Arguments

:: (HasCallStack, MonadIO m, IsSpaceDrawer a)

=> a

drawer: a SpaceDrawer.

-> Bool

enableMatrix: the new value.

-> m ()

Sets whether the SpaceDrawer:matrix property is enabled.

Since: 3.24

setMatrix

spaceDrawerSetMatrix

Arguments

:: (HasCallStack, MonadIO m, IsSpaceDrawer a)

=> a

drawer: a SpaceDrawer.

-> Maybe GVariant

matrix: the new matrix value, or Nothing.

-> m ()

Sets a new value to the SpaceDrawer:matrix property, as a GVariant. If matrix is Nothing, then an empty array is set.

If matrix is floating, it is consumed.

The spaceDrawerSetTypesForLocations function may be more convenient to use.

Since: 3.24

setTypesForLocations

spaceDrawerSetTypesForLocations

Arguments

:: (HasCallStack, MonadIO m, IsSpaceDrawer a)

=> a

drawer: a SpaceDrawer.

-> [SpaceLocationFlags]

locations: one or several SpaceLocationFlags.

-> [SpaceTypeFlags]

types: a combination of SpaceTypeFlags.

-> m ()

Modifies the SpaceDrawer:matrix property at the specified locations.

Since: 3.24

Properties

enableMatrix

constructSpaceDrawerEnableMatrix :: IsSpaceDrawer o => Bool -> IO (GValueConstruct o)

getSpaceDrawerEnableMatrix :: (MonadIO m, IsSpaceDrawer o) => o -> m Bool

setSpaceDrawerEnableMatrix :: (MonadIO m, IsSpaceDrawer o) => o -> Bool -> m ()

matrix

clearSpaceDrawerMatrix :: (MonadIO m, IsSpaceDrawer o) => o -> m ()

constructSpaceDrawerMatrix :: IsSpaceDrawer o => GVariant -> IO (GValueConstruct o)

getSpaceDrawerMatrix :: (MonadIO m, IsSpaceDrawer o) => o -> m (Maybe GVariant)

setSpaceDrawerMatrix :: (MonadIO m, IsSpaceDrawer o) => o -> GVariant -> m ()