GI.Pango.Structs.Color

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

Exported types

newtype Color

Constructors

Color (ManagedPtr Color)

Instances

BoxedObject Color

Methods

boxedType :: Color -> IO GType

(~) AttrOpTag tag AttrSet => Constructible Color tag

Methods

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

((~) * info (ResolveColorMethod t Color), MethodInfo * info Color p) => IsLabel t (Color -> p)

Methods

fromLabel :: Proxy# Symbol t -> Color -> p

((~) * info (ResolveColorMethod t Color), MethodInfo * info Color p) => IsLabelProxy t (Color -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Color -> p

HasAttributeList * Color

((~) * signature (m Text), MonadIO m) => MethodInfo * ColorToStringMethodInfo Color signature

Methods

overloadedMethod :: MethodProxy ColorToStringMethodInfo Color -> signature -> s

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * ColorParseMethodInfo Color signature

Methods

overloadedMethod :: MethodProxy ColorParseMethodInfo Color -> signature -> s

((~) * signature (m ()), MonadIO m) => MethodInfo * ColorFreeMethodInfo Color signature

Methods

overloadedMethod :: MethodProxy ColorFreeMethodInfo Color -> signature -> s

((~) * signature (m (Maybe Color)), MonadIO m) => MethodInfo * ColorCopyMethodInfo Color signature

Methods

overloadedMethod :: MethodProxy ColorCopyMethodInfo Color -> signature -> s

type AttributeList Color

type AttributeList Color

newZeroColor :: MonadIO m => m Color

Construct a Color struct initialized to zero.

noColor :: Maybe Color

Methods

copy

data ColorCopyMethodInfo

Instances

((~) * signature (m (Maybe Color)), MonadIO m) => MethodInfo * ColorCopyMethodInfo Color signature

Methods

overloadedMethod :: MethodProxy ColorCopyMethodInfo Color -> signature -> s

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

data ColorFreeMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * ColorFreeMethodInfo Color signature

Methods

overloadedMethod :: MethodProxy ColorFreeMethodInfo Color -> signature -> s

colorFree

Arguments

:: (HasCallStack, MonadIO m)

=> Color

color: an allocated Color, may be Nothing

-> m ()

Frees a color allocated by colorCopy.

parse

data ColorParseMethodInfo

Instances

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * ColorParseMethodInfo Color signature

Methods

overloadedMethod :: MethodProxy ColorParseMethodInfo Color -> signature -> s

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')

toString

data ColorToStringMethodInfo

Instances

((~) * signature (m Text), MonadIO m) => MethodInfo * ColorToStringMethodInfo Color signature

Methods

overloadedMethod :: MethodProxy ColorToStringMethodInfo Color -> signature -> s

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

color_blue :: AttrLabelProxy "blue"

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

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

green

color_green :: AttrLabelProxy "green"

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

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

red

color_red :: AttrLabelProxy "red"

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

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