GI.Pango.Structs.Color

The Color structure is used to represent a color in an uncalibrated RGB color-space.

Exported types

newtype Color

Memory-managed wrapper type.

Constructors

Color (ManagedPtr Color)

Instances

Eq Color

Defined in GI.Pango.Structs.Color

Methods

(==) :: Color -> Color -> Bool

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

GBoxed Color

Defined in GI.Pango.Structs.Color

ManagedPtrNewtype Color

Defined in GI.Pango.Structs.Color

Methods

toManagedPtr :: Color -> ManagedPtr Color

TypedObject Color

Defined in GI.Pango.Structs.Color

Methods

glibType :: IO GType

HasParentTypes Color

Defined in GI.Pango.Structs.Color

tag ~ 'AttrSet => Constructible Color tag

Defined in GI.Pango.Structs.Color

Methods

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

IsGValue (Maybe Color)

Convert Color to and from GValue. See toGValue and fromGValue.

Defined in GI.Pango.Structs.Color

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Color -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Color)

type ParentTypes Color

Defined in GI.Pango.Structs.Color

type ParentTypes Color = '[] :: [Type]

newZeroColor :: MonadIO m => m Color

Construct a Color struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Methods

copy, free, parse, parseWithAlpha, toString.

Getters

None.

Setters

None.

copy

colorCopy

Arguments

:: (HasCallStack, MonadIO m)

=> Color

src: color to copy, may be Nothing

-> m (Maybe Color)

Returns: the newly allocated Color, which should be freed with colorFree, or Nothing if src was Nothing.

Creates a copy of src, which should be freed with colorFree. Primarily used by language bindings, not that useful otherwise (since colors can just be copied by assignment in C).

free

colorFree

Arguments

:: (HasCallStack, MonadIO m)

=> Color

color: an allocated Color, may be Nothing

-> m ()

Frees a color allocated by colorCopy.

parse

colorParse

Arguments

:: (HasCallStack, MonadIO m)

=> Color

color: a Color structure in which to store the result, or Nothing

-> Text

spec: a string specifying the new color

-> m Bool

Returns: True if parsing of the specifier succeeded, otherwise false.

Fill in the fields of a color from a string specification. The string can either one of a large set of standard names. (Taken from the CSS <ulink url="http://dev.w3.org/csswg/css-color/named-colors">specification</ulink>), or it can be a hexadecimal value in the form '&num;rgb' '&num;rrggbb' '&num;rrrgggbbb' or '&num;rrrrggggbbbb' where 'r', 'g' and 'b' are hex digits of the red, green, and blue components of the color, respectively. (White in the four forms is '&num;fff' '&num;ffffff' '&num;fffffffff' and '&num;ffffffffffff')

parseWithAlpha

colorParseWithAlpha

Arguments

:: (HasCallStack, MonadIO m)

=> Color

color: a Color structure in which to store the result, or Nothing

-> Text

spec: a string specifying the new color

-> m (Bool, Word16)

Returns: True if parsing of the specifier succeeded, otherwise false.

Fill in the fields of a color from a string specification. The string can either one of a large set of standard names. (Taken from the CSS <ulink url="http://dev.w3.org/csswg/css-color/named-colors">specification</ulink>), or it can be a hexadecimal value in the form '&num;rgb' '&num;rrggbb' '&num;rrrgggbbb' or '&num;rrrrggggbbbb' where 'r', 'g' and 'b' are hex digits of the red, green, and blue components of the color, respectively. (White in the four forms is '&num;fff' '&num;ffffff' '&num;fffffffff' and '&num;ffffffffffff')

Additionally, parse strings of the form '&num;rgba', '&num;rrggbbaa', '&num;rrrrggggbbbbaaaa', if alpha is not Nothing, and set alpha to the value specified by the hex digits for 'a'. If no alpha component is found in spec, alpha is set to 0xffff (for a solid color).

Since: 1.46

toString

colorToString

Arguments

:: (HasCallStack, MonadIO m)

=> Color

color: a Color

-> m Text

Returns: a newly-allocated text string that must be freed with free.

Returns a textual specification of color in the hexadecimal form <literal>&num;rrrrggggbbbb</literal>, where <literal>r</literal>, <literal>g</literal> and <literal>b</literal> are hex digits representing the red, green, and blue components respectively.

Since: 1.16

Properties

blue

value of blue component

getColorBlue :: MonadIO m => Color -> m Word16

Get the value of the “blue” field. When overloading is enabled, this is equivalent to

get color #blue

setColorBlue :: MonadIO m => Color -> Word16 -> m ()

Set the value of the “blue” field. When overloading is enabled, this is equivalent to

set color [ #blue := value ]

green

value of green component

getColorGreen :: MonadIO m => Color -> m Word16

Get the value of the “green” field. When overloading is enabled, this is equivalent to

get color #green

setColorGreen :: MonadIO m => Color -> Word16 -> m ()

Set the value of the “green” field. When overloading is enabled, this is equivalent to

set color [ #green := value ]

red

value of red component

getColorRed :: MonadIO m => Color -> m Word16

Get the value of the “red” field. When overloading is enabled, this is equivalent to

get color #red

setColorRed :: MonadIO m => Color -> Word16 -> m ()

Set the value of the “red” field. When overloading is enabled, this is equivalent to

set color [ #red := value ]