GI.Pango.Objects.Coverage

The Coverage structure represents a map from Unicode characters to CoverageLevel. It is an opaque structure with no public fields.

Exported types

newtype Coverage

Memory-managed wrapper type.

Constructors

Coverage (ManagedPtr Coverage)

Instances

Eq Coverage

Defined in GI.Pango.Objects.Coverage

Methods

(==) :: Coverage -> Coverage -> Bool

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

IsGValue Coverage

Convert Coverage to and from GValue with toGValue and fromGValue.

Defined in GI.Pango.Objects.Coverage

Methods

toGValue :: Coverage -> IO GValue

fromGValue :: GValue -> IO Coverage

ManagedPtrNewtype Coverage

Defined in GI.Pango.Objects.Coverage

Methods

toManagedPtr :: Coverage -> ManagedPtr Coverage

TypedObject Coverage

Defined in GI.Pango.Objects.Coverage

Methods

glibType :: IO GType

GObject Coverage

Defined in GI.Pango.Objects.Coverage

HasParentTypes Coverage

Defined in GI.Pango.Objects.Coverage

type ParentTypes Coverage

Defined in GI.Pango.Objects.Coverage

type ParentTypes Coverage = '[Object]

class (GObject o, IsDescendantOf Coverage o) => IsCoverage o

Type class for types which can be safely cast to Coverage, for instance with toCoverage.

Instances

(GObject o, IsDescendantOf Coverage o) => IsCoverage o

Defined in GI.Pango.Objects.Coverage

toCoverage :: (MonadIO m, IsCoverage o) => o -> m Coverage

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

Methods

Overloaded methods

copy

coverageCopy

Arguments

:: (HasCallStack, MonadIO m, IsCoverage a)

=> a

coverage: a Coverage

-> m Coverage

Returns: the newly allocated Coverage, with a reference count of one, which should be freed with coverageUnref.

Copy an existing Coverage. (This function may now be unnecessary since we refcount the structure. File a bug if you use it.)

fromBytes

coverageFromBytes

Arguments

:: (HasCallStack, MonadIO m)

=> ByteString

bytes: binary data representing a Coverage

-> m (Maybe Coverage)

Returns: a newly allocated Coverage, or Nothing if the data was invalid.

Deprecated: (Since version 1.44)This returns Nothing

Convert data generated from coverageToBytes back to a Coverage

get

coverageGet

Arguments

:: (HasCallStack, MonadIO m, IsCoverage a)

=> a

coverage: a Coverage

-> Int32

index_: the index to check

-> m CoverageLevel

Returns: the coverage level of coverage for character index_.

Determine whether a particular index is covered by coverage

max

coverageMax

Arguments

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

=> a

coverage: a Coverage

-> b

other: another Coverage

-> m ()

Deprecated: (Since version 1.44)This function does nothing

Set the coverage for each index in coverage to be the max (better) value of the current coverage for the index and the coverage for the corresponding index in other.

new

coverageNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Coverage

Returns: the newly allocated Coverage, initialized to CoverageLevelNone with a reference count of one, which should be freed with coverageUnref.

Create a new Coverage

ref

coverageRef

Arguments

:: (HasCallStack, MonadIO m, IsCoverage a)

=> a

coverage: a Coverage

-> m Coverage

Returns: coverage

Increase the reference count on the Coverage by one

set

coverageSet

Arguments

:: (HasCallStack, MonadIO m, IsCoverage a)

=> a

coverage: a Coverage

-> Int32

index_: the index to modify

-> CoverageLevel

level: the new level for index_

-> m ()

Modify a particular index within coverage

toBytes

coverageToBytes

Arguments

:: (HasCallStack, MonadIO m, IsCoverage a)

=> a

coverage: a Coverage

-> m ByteString

Deprecated: (Since version 1.44)This returns Nothing

Convert a Coverage structure into a flat binary format

unref

coverageUnref

Arguments

:: (HasCallStack, MonadIO m, IsCoverage a)

=> a

coverage: a Coverage

-> m ()

Decrease the reference count on the Coverage by one. If the result is zero, free the coverage and all associated memory.