GI.GtkSource.Structs.RegionIter

RegionIter is an opaque datatype; ignore all its fields. Initialize the iter with regionGetStartRegionIter.

Since: 3.22

Exported types

newtype RegionIter

Memory-managed wrapper type.

Constructors

RegionIter (ManagedPtr RegionIter)

Instances

Eq RegionIter

Defined in GI.GtkSource.Structs.RegionIter

Methods

(==) :: RegionIter -> RegionIter -> Bool

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

BoxedPtr RegionIter

Defined in GI.GtkSource.Structs.RegionIter

Methods

boxedPtrCopy :: RegionIter -> IO RegionIter

boxedPtrFree :: RegionIter -> IO ()

CallocPtr RegionIter

Defined in GI.GtkSource.Structs.RegionIter

Methods

boxedPtrCalloc :: IO (Ptr RegionIter)

ManagedPtrNewtype RegionIter

Defined in GI.GtkSource.Structs.RegionIter

Methods

toManagedPtr :: RegionIter -> ManagedPtr RegionIter

tag ~ 'AttrSet => Constructible RegionIter tag

Defined in GI.GtkSource.Structs.RegionIter

Methods

new :: MonadIO m => (ManagedPtr RegionIter -> RegionIter) -> [AttrOp RegionIter tag] -> m RegionIter

newZeroRegionIter :: MonadIO m => m RegionIter

Construct a RegionIter struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Methods

isEnd, next.

Getters

getSubregion.

Setters

None.

getSubregion

regionIterGetSubregion

Arguments

:: (HasCallStack, MonadIO m)

=> RegionIter

iter: a RegionIter.

-> m (Bool, TextIter, TextIter)

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

Gets the subregion at this iterator.

Since: 3.22

isEnd

regionIterIsEnd

Arguments

:: (HasCallStack, MonadIO m)

=> RegionIter

iter: a RegionIter.

-> m Bool

Returns: whether iter is the end iterator.

No description available in the introspection data.

Since: 3.22

next

regionIterNext

Arguments

:: (HasCallStack, MonadIO m)

=> RegionIter

iter: a RegionIter.

-> m Bool

Returns: True if iter moved and is dereferenceable, or False if iter has been set to the end iterator.

Moves iter to the next subregion.

Since: 3.22