GI.GtkSource.Objects.Region

No description available in the introspection data.

Exported types

newtype Region

Memory-managed wrapper type.

Constructors

Region (ManagedPtr Region)

Instances

GObject Region

Defined in GI.GtkSource.Objects.Region

Methods

gobjectType :: Region -> IO GType

IsObject Region

Defined in GI.GtkSource.Objects.Region

IsRegion Region

Defined in GI.GtkSource.Objects.Region

class GObject o => IsRegion o

Type class for types which can be safely cast to Region, for instance with toRegion.

Instances

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

Defined in GI.GtkSource.Objects.Region

IsRegion Region

Defined in GI.GtkSource.Objects.Region

toRegion :: (MonadIO m, IsRegion o) => o -> m Region

Cast to Region, for types for which this is known to be safe. For general casts, use castTo.

noRegion :: Maybe Region

A convenience alias for Nothing :: Maybe Region.

Methods

addRegion

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

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

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

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

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

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

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

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

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

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

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

The TextBuffer. The Region has a weak reference to the buffer.

Since: 3.22

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

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

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

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

get region #buffer