| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.Pango.Objects.Coverage
Description
A PangoCoverage structure is a map from Unicode characters
to CoverageLevel values.
It is often necessary in Pango to determine if a particular
font can represent a particular character, and also how well
it can represent that character. The PangoCoverage is a data
structure that is used to represent that information. It is an
opaque structure with no public fields.
Synopsis
- newtype Coverage = Coverage (ManagedPtr Coverage)
- class (GObject o, IsDescendantOf Coverage o) => IsCoverage o
- toCoverage :: (MonadIO m, IsCoverage o) => o -> m Coverage
- coverageCopy :: (HasCallStack, MonadIO m, IsCoverage a) => a -> m Coverage
- coverageFromBytes :: (HasCallStack, MonadIO m) => ByteString -> m (Maybe Coverage)
- coverageGet :: (HasCallStack, MonadIO m, IsCoverage a) => a -> Int32 -> m CoverageLevel
- coverageMax :: (HasCallStack, MonadIO m, IsCoverage a, IsCoverage b) => a -> b -> m ()
- coverageNew :: (HasCallStack, MonadIO m) => m Coverage
- coverageRef :: (HasCallStack, MonadIO m, IsCoverage a) => a -> m Coverage
- coverageSet :: (HasCallStack, MonadIO m, IsCoverage a) => a -> Int32 -> CoverageLevel -> m ()
- coverageToBytes :: (HasCallStack, MonadIO m, IsCoverage a) => a -> m ByteString
- coverageUnref :: (HasCallStack, MonadIO m, IsCoverage a) => a -> m ()
Exported types
Memory-managed wrapper type.
Constructors
| Coverage (ManagedPtr Coverage) |
Instances
| Eq Coverage Source # | |
| GObject Coverage Source # | |
Defined in GI.Pango.Objects.Coverage | |
| ManagedPtrNewtype Coverage Source # | |
Defined in GI.Pango.Objects.Coverage Methods toManagedPtr :: Coverage -> ManagedPtr Coverage # | |
| TypedObject Coverage Source # | |
Defined in GI.Pango.Objects.Coverage | |
| HasParentTypes Coverage Source # | |
Defined in GI.Pango.Objects.Coverage | |
| IsGValue (Maybe Coverage) Source # | Convert |
Defined in GI.Pango.Objects.Coverage | |
| type ParentTypes Coverage Source # | |
Defined in GI.Pango.Objects.Coverage | |
class (GObject o, IsDescendantOf Coverage o) => IsCoverage o Source #
Type class for types which can be safely cast to Coverage, for instance with toCoverage.
Instances
| (GObject o, IsDescendantOf Coverage o) => IsCoverage o Source # | |
Defined in GI.Pango.Objects.Coverage | |
toCoverage :: (MonadIO m, IsCoverage o) => o -> m Coverage Source #
Methods
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, copy, forceFloating, freezeNotify, get, getv, isFloating, max, notify, notifyByPspec, ref, refSink, runDispose, set, stealData, stealQdata, thawNotify, toBytes, unref, watchClosure.
Getters
getData, getProperty, getQdata.
Setters
copy
Arguments
| :: (HasCallStack, MonadIO m, IsCoverage a) | |
| => a |
|
| -> m Coverage | Returns: the newly allocated |
Copy an existing PangoCoverage.
fromBytes
Arguments
| :: (HasCallStack, MonadIO m) | |
| => ByteString |
|
| -> m (Maybe Coverage) | Returns: a newly allocated |
Deprecated: (Since version 1.44)This returns Nothing
Convert data generated from coverageToBytes
back to a PangoCoverage.
get
Arguments
| :: (HasCallStack, MonadIO m, IsCoverage a) | |
| => a |
|
| -> Int32 |
|
| -> m CoverageLevel | Returns: the coverage level of |
Determine whether a particular index is covered by coverage.
max
Arguments
| :: (HasCallStack, MonadIO m, IsCoverage a, IsCoverage b) | |
| => a |
|
| -> b |
|
| -> 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
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m Coverage | Returns: the newly allocated |
Create a new PangoCoverage
ref
Arguments
| :: (HasCallStack, MonadIO m, IsCoverage a) | |
| => a |
|
| -> m Coverage | Returns: |
Increase the reference count on the PangoCoverage by one.
set
Arguments
| :: (HasCallStack, MonadIO m, IsCoverage a) | |
| => a |
|
| -> Int32 |
|
| -> CoverageLevel |
|
| -> m () |
Modify a particular index within coverage
toBytes
Arguments
| :: (HasCallStack, MonadIO m, IsCoverage a) | |
| => a |
|
| -> m ByteString |
Deprecated: (Since version 1.44)This returns Nothing
Convert a PangoCoverage structure into a flat binary format.
unref
Arguments
| :: (HasCallStack, MonadIO m, IsCoverage a) | |
| => a |
|
| -> m () |
Decrease the reference count on the PangoCoverage by one.
If the result is zero, free the coverage and all associated memory.