GI.GtkSource.Objects.Region

Exported types

newtype Region

Constructors

Region (ManagedPtr Region)

Instances

GObject Region

Methods

gobjectType :: Region -> IO GType

IsObject Region

IsRegion Region

((~) * info (ResolveRegionMethod t Region), MethodInfo * info Region p) => IsLabel t (Region -> p)

Methods

fromLabel :: Proxy# Symbol t -> Region -> p

((~) * info (ResolveRegionMethod t Region), MethodInfo * info Region p) => IsLabelProxy t (Region -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Region -> p

HasAttributeList * Region

type AttributeList Region

type AttributeList Region

type SignalList Region

type SignalList Region

class GObject o => IsRegion o

Instances

(GObject a, UnknownAncestorError Constraint Region a) => IsRegion a

IsRegion Region

toRegion :: IsRegion o => o -> IO Region

noRegion :: Maybe Region

Methods

addRegion

data RegionAddRegionMethodInfo

Instances

((~) * signature (Maybe b -> m ()), MonadIO m, IsRegion a, IsRegion b) => MethodInfo * RegionAddRegionMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RegionAddRegionMethodInfo a -> signature -> s

regionAddRegion

Arguments

:: (HasCallStack, MonadIO m, IsRegion a, IsRegion b)

=> a

region: a Region.

-> Maybe b

regionToAdd: the Region to add to region, or Nothing.

-> m ()

Adds regionToAdd to region. regionToAdd is not modified.

Since: 3.22

addSubregion

data RegionAddSubregionMethodInfo

Instances

((~) * signature (TextIter -> TextIter -> m ()), MonadIO m, IsRegion a) => MethodInfo * RegionAddSubregionMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RegionAddSubregionMethodInfo a -> signature -> s

regionAddSubregion

Arguments

:: (HasCallStack, MonadIO m, IsRegion a)

=> a

region: a Region.

-> TextIter

start_: the start of the subregion.

-> TextIter

end_: the end of the subregion.

-> m ()

Adds the subregion delimited by start_ and end_ to region.

Since: 3.22

getBounds

data RegionGetBoundsMethodInfo

Instances

((~) * signature (m (Bool, TextIter, TextIter)), MonadIO m, IsRegion a) => MethodInfo * RegionGetBoundsMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RegionGetBoundsMethodInfo a -> signature -> s

regionGetBounds

Arguments

:: (HasCallStack, MonadIO m, IsRegion a)

=> a

region: a Region.

-> m (Bool, TextIter, TextIter)

Returns: True if start and end have been set successfully (if non-Nothing), or False if the region is empty.

Gets the start and end bounds of the region.

Since: 3.22

getBuffer

data RegionGetBufferMethodInfo

Instances

((~) * signature (m (Maybe TextBuffer)), MonadIO m, IsRegion a) => MethodInfo * RegionGetBufferMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RegionGetBufferMethodInfo a -> signature -> s

regionGetBuffer

Arguments

:: (HasCallStack, MonadIO m, IsRegion a)

=> a

region: a Region.

-> m (Maybe TextBuffer)

Returns: the TextBuffer.

No description available in the introspection data.

Since: 3.22

getStartRegionIter

data RegionGetStartRegionIterMethodInfo

Instances

((~) * signature (m RegionIter), MonadIO m, IsRegion a) => MethodInfo * RegionGetStartRegionIterMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RegionGetStartRegionIterMethodInfo a -> signature -> s

regionGetStartRegionIter

Arguments

:: (HasCallStack, MonadIO m, IsRegion a)

=> a

region: a Region.

-> m RegionIter

Initializes a RegionIter to the first subregion of region. If region is empty, iter will be initialized to the end iterator.

Since: 3.22

intersectRegion

data RegionIntersectRegionMethodInfo

Instances

((~) * signature (Maybe b -> m (Maybe Region)), MonadIO m, IsRegion a, IsRegion b) => MethodInfo * RegionIntersectRegionMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RegionIntersectRegionMethodInfo a -> signature -> s

regionIntersectRegion

Arguments

:: (HasCallStack, MonadIO m, IsRegion a, IsRegion b)

=> a

region1: a Region, or Nothing.

-> Maybe b

region2: a Region, or Nothing.

-> m (Maybe Region)

Returns: the intersection as a Region object.

Returns the intersection between region1 and region2. region1 and region2 are not modified.

Since: 3.22

intersectSubregion

data RegionIntersectSubregionMethodInfo

Instances

((~) * signature (TextIter -> TextIter -> m (Maybe Region)), MonadIO m, IsRegion a) => MethodInfo * RegionIntersectSubregionMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RegionIntersectSubregionMethodInfo a -> signature -> s

regionIntersectSubregion

Arguments

:: (HasCallStack, MonadIO m, IsRegion a)

=> a

region: a Region.

-> TextIter

start_: the start of the subregion.

-> TextIter

end_: the end of the subregion.

-> m (Maybe Region)

Returns: the intersection as a new Region.

Returns the intersection between region and the subregion delimited by start_ and end_. region is not modified.

Since: 3.22

isEmpty

data RegionIsEmptyMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsRegion a) => MethodInfo * RegionIsEmptyMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RegionIsEmptyMethodInfo a -> signature -> s

regionIsEmpty

Arguments

:: (HasCallStack, MonadIO m, IsRegion a)

=> a

region: a Region, or Nothing.

-> m Bool

Returns: whether the region is empty.

Returns whether the region is empty. A Nothing region is considered empty.

Since: 3.22

new

regionNew

Arguments

:: (HasCallStack, MonadIO m, IsTextBuffer a)

=> a

buffer: a TextBuffer.

-> m Region

Returns: a new Region object for buffer.

No description available in the introspection data.

Since: 3.22

subtractRegion

data RegionSubtractRegionMethodInfo

Instances

((~) * signature (Maybe b -> m ()), MonadIO m, IsRegion a, IsRegion b) => MethodInfo * RegionSubtractRegionMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RegionSubtractRegionMethodInfo a -> signature -> s

regionSubtractRegion

Arguments

:: (HasCallStack, MonadIO m, IsRegion a, IsRegion b)

=> a

region: a Region.

-> Maybe b

regionToSubtract: the Region to subtract from region, or Nothing.

-> m ()

Subtracts regionToSubtract from region. regionToSubtract is not modified.

Since: 3.22

subtractSubregion

data RegionSubtractSubregionMethodInfo

Instances

((~) * signature (TextIter -> TextIter -> m ()), MonadIO m, IsRegion a) => MethodInfo * RegionSubtractSubregionMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RegionSubtractSubregionMethodInfo a -> signature -> s

regionSubtractSubregion

Arguments

:: (HasCallStack, MonadIO m, IsRegion a)

=> a

region: a Region.

-> TextIter

start_: the start of the subregion.

-> TextIter

end_: the end of the subregion.

-> m ()

Subtracts the subregion delimited by start_ and end_ from region.

Since: 3.22

toString

data RegionToStringMethodInfo

Instances

((~) * signature (m (Maybe Text)), MonadIO m, IsRegion a) => MethodInfo * RegionToStringMethodInfo a signature

Methods

overloadedMethod :: MethodProxy RegionToStringMethodInfo a -> signature -> s

regionToString

Arguments

:: (HasCallStack, MonadIO m, IsRegion a)

=> a

region: a Region.

-> m (Maybe Text)

Returns: a string represention of region. Free with free when no longer needed.

Gets a string represention of region, for debugging purposes.

The returned string contains the character offsets of the subregions. It doesn't include a newline character at the end of the string.

Since: 3.22

Properties

buffer

data RegionBufferPropertyInfo

Instances

AttrInfo RegionBufferPropertyInfo

Associated Types

type AttrAllowedOps RegionBufferPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint RegionBufferPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint RegionBufferPropertyInfo :: * -> Constraint

type AttrGetType RegionBufferPropertyInfo :: *

type AttrLabel RegionBufferPropertyInfo :: Symbol

type AttrOrigin RegionBufferPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint RegionBufferPropertyInfo o => Proxy * RegionBufferPropertyInfo -> o -> IO (AttrGetType RegionBufferPropertyInfo)

attrSet :: (AttrBaseTypeConstraint RegionBufferPropertyInfo o, AttrSetTypeConstraint RegionBufferPropertyInfo b) => Proxy * RegionBufferPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint RegionBufferPropertyInfo o => Proxy * RegionBufferPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint RegionBufferPropertyInfo o, AttrSetTypeConstraint RegionBufferPropertyInfo b) => Proxy * RegionBufferPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin RegionBufferPropertyInfo

type AttrOrigin RegionBufferPropertyInfo = Region

type AttrLabel RegionBufferPropertyInfo

type AttrLabel RegionBufferPropertyInfo = "buffer"

type AttrGetType RegionBufferPropertyInfo

type AttrGetType RegionBufferPropertyInfo = Maybe TextBuffer

type AttrBaseTypeConstraint RegionBufferPropertyInfo

type AttrBaseTypeConstraint RegionBufferPropertyInfo = IsRegion

type AttrSetTypeConstraint RegionBufferPropertyInfo

type AttrSetTypeConstraint RegionBufferPropertyInfo = IsTextBuffer

type AttrAllowedOps RegionBufferPropertyInfo

type AttrAllowedOps RegionBufferPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructRegionBuffer :: (IsRegion o, IsTextBuffer a) => a -> IO (GValueConstruct o)

getRegionBuffer :: (MonadIO m, IsRegion o) => o -> m (Maybe TextBuffer)

regionBuffer :: AttrLabelProxy "buffer"