GI.Gdk.Structs.Color

A Color is used to describe a color, similar to the XColor struct used in the X11 drawing API.

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

newZeroColor :: MonadIO m => m Color

Construct a Color struct initialized to zero.

noColor :: Maybe Color

Methods

copy

colorCopy

Arguments

:: (HasCallStack, MonadIO m)

=> Color

color: a Color

-> m Color

Returns: a copy of color

Deprecated: (Since version 3.14)Use RGBA

Makes a copy of a Color.

The result must be freed using colorFree.

equal

colorEqual

Arguments

:: (HasCallStack, MonadIO m)

=> Color

colora: a Color

-> Color

colorb: another Color

-> m Bool

Returns: True if the two colors compare equal

Deprecated: (Since version 3.14)Use RGBA

Compares two colors.

free

colorFree

Arguments

:: (HasCallStack, MonadIO m)

=> Color

color: a Color

-> m ()

Deprecated: (Since version 3.14)Use RGBA

Frees a Color created with colorCopy.

hash

colorHash

Arguments

:: (HasCallStack, MonadIO m)

=> Color

color: a Color

-> m Word32

Returns: The hash function applied to color

Deprecated: (Since version 3.14)Use RGBA

A hash function suitable for using for a hash table that stores GdkColors.

parse

colorParse

Arguments

:: (HasCallStack, MonadIO m)

=> Text

spec: the string specifying the color

-> m (Bool, Color)

Returns: True if the parsing succeeded

Deprecated: (Since version 3.14)Use RGBA

Parses a textual specification of a color and fill in the red, green, and blue fields of a Color.

The string can either one of a large set of standard names (taken from the X11 rgb.txt file), or it can be a hexadecimal value in the form “rrggbb”, “#rrrgggbbb” or “#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 “ffffff”, “#fffffffff” and “#ffffffffffff”).

toString

colorToString

Arguments

:: (HasCallStack, MonadIO m)

=> Color

color: a Color

-> m Text

Returns: a newly-allocated text string

Deprecated: (Since version 3.14)Use RGBA

Returns a textual specification of color in the hexadecimal form “#rrrrggggbbbb” where “r”, “g” and “b” are hex digits representing the red, green and blue components respectively.

The returned string can be parsed by colorParse.

Since: 2.12

Properties

blue

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

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

green

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

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

pixel

getColorPixel :: MonadIO m => Color -> m Word32

setColorPixel :: MonadIO m => Color -> Word32 -> m ()

red

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

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