gi-poppler-0.18.21: Poppler bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Poppler.Structs.Color

Description

A Color describes a RGB color. Color components are values between 0 and 65535

Synopsis

Exported types

newtype Color Source #

Memory-managed wrapper type.

Constructors

Color (ManagedPtr Color) 

Instances

Instances details
Eq Color Source # 
Instance details

Defined in GI.Poppler.Structs.Color

Methods

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

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

BoxedObject Color Source # 
Instance details

Defined in GI.Poppler.Structs.Color

Methods

boxedType :: Color -> IO GType #

IsGValue Color Source #

Convert Color to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.Poppler.Structs.Color

tag ~ 'AttrSet => Constructible Color tag Source # 
Instance details

Defined in GI.Poppler.Structs.Color

Methods

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

newZeroColor :: MonadIO m => m Color Source #

Construct a Color struct initialized to zero.

noColor :: Maybe Color Source #

A convenience alias for Nothing :: Maybe Color.

Methods

Overloaded methods

copy

colorCopy Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Color

color: a Color to copy

-> m Color

Returns: a new allocated copy of color

Creates a copy of color

free

colorFree Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Color

color: a Color

-> m () 

Frees the given Color

new

colorNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m Color

Returns: a new Color, use colorFree to free it

Creates a new Color

Properties

blue

the blue component of color

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

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

get color #blue

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

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

set color [ #blue := value ]

green

the green component of color

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

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

get color #green

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

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

set color [ #green := value ]

red

the red component of color

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

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

get color #red

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

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

set color [ #red := value ]