Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	None
Language	Haskell2010

GI.Gtk.Objects.ColorSelection

Contents

Exported types
Methods
Properties
Signals
- colorChanged

Description

No description available in the introspection data.

Synopsis

newtype ColorSelection = ColorSelection (ManagedPtr ColorSelection)
class (GObject o, IsDescendantOf ColorSelection o) => IsColorSelection o
toColorSelection :: (MonadIO m, IsColorSelection o) => o -> m ColorSelection
noColorSelection :: Maybe ColorSelection
colorSelectionGetCurrentAlpha :: (HasCallStack, MonadIO m, IsColorSelection a) => a -> m Word16
colorSelectionGetCurrentColor :: (HasCallStack, MonadIO m, IsColorSelection a) => a -> m Color
colorSelectionGetCurrentRgba :: (HasCallStack, MonadIO m, IsColorSelection a) => a -> m RGBA
colorSelectionGetHasOpacityControl :: (HasCallStack, MonadIO m, IsColorSelection a) => a -> m Bool
colorSelectionGetHasPalette :: (HasCallStack, MonadIO m, IsColorSelection a) => a -> m Bool
colorSelectionGetPreviousAlpha :: (HasCallStack, MonadIO m, IsColorSelection a) => a -> m Word16
colorSelectionGetPreviousColor :: (HasCallStack, MonadIO m, IsColorSelection a) => a -> m Color
colorSelectionGetPreviousRgba :: (HasCallStack, MonadIO m, IsColorSelection a) => a -> m RGBA
colorSelectionIsAdjusting :: (HasCallStack, MonadIO m, IsColorSelection a) => a -> m Bool
colorSelectionNew :: (HasCallStack, MonadIO m) => m ColorSelection
colorSelectionPaletteFromString :: (HasCallStack, MonadIO m) => Text -> m (Bool, [Color])
colorSelectionPaletteToString :: (HasCallStack, MonadIO m) => [Color] -> m Text
colorSelectionSetCurrentAlpha :: (HasCallStack, MonadIO m, IsColorSelection a) => a -> Word16 -> m ()
colorSelectionSetCurrentColor :: (HasCallStack, MonadIO m, IsColorSelection a) => a -> Color -> m ()
colorSelectionSetCurrentRgba :: (HasCallStack, MonadIO m, IsColorSelection a) => a -> RGBA -> m ()
colorSelectionSetHasOpacityControl :: (HasCallStack, MonadIO m, IsColorSelection a) => a -> Bool -> m ()
colorSelectionSetHasPalette :: (HasCallStack, MonadIO m, IsColorSelection a) => a -> Bool -> m ()
colorSelectionSetPreviousAlpha :: (HasCallStack, MonadIO m, IsColorSelection a) => a -> Word16 -> m ()
colorSelectionSetPreviousColor :: (HasCallStack, MonadIO m, IsColorSelection a) => a -> Color -> m ()
colorSelectionSetPreviousRgba :: (HasCallStack, MonadIO m, IsColorSelection a) => a -> RGBA -> m ()
constructColorSelectionCurrentAlpha :: IsColorSelection o => Word32 -> IO (GValueConstruct o)
getColorSelectionCurrentAlpha :: (MonadIO m, IsColorSelection o) => o -> m Word32
setColorSelectionCurrentAlpha :: (MonadIO m, IsColorSelection o) => o -> Word32 -> m ()
constructColorSelectionCurrentColor :: IsColorSelection o => Color -> IO (GValueConstruct o)
getColorSelectionCurrentColor :: (MonadIO m, IsColorSelection o) => o -> m (Maybe Color)
setColorSelectionCurrentColor :: (MonadIO m, IsColorSelection o) => o -> Color -> m ()
constructColorSelectionCurrentRgba :: IsColorSelection o => RGBA -> IO (GValueConstruct o)
getColorSelectionCurrentRgba :: (MonadIO m, IsColorSelection o) => o -> m (Maybe RGBA)
setColorSelectionCurrentRgba :: (MonadIO m, IsColorSelection o) => o -> RGBA -> m ()
constructColorSelectionHasOpacityControl :: IsColorSelection o => Bool -> IO (GValueConstruct o)
getColorSelectionHasOpacityControl :: (MonadIO m, IsColorSelection o) => o -> m Bool
setColorSelectionHasOpacityControl :: (MonadIO m, IsColorSelection o) => o -> Bool -> m ()
constructColorSelectionHasPalette :: IsColorSelection o => Bool -> IO (GValueConstruct o)
getColorSelectionHasPalette :: (MonadIO m, IsColorSelection o) => o -> m Bool
setColorSelectionHasPalette :: (MonadIO m, IsColorSelection o) => o -> Bool -> m ()
type C_ColorSelectionColorChangedCallback = Ptr () -> Ptr () -> IO ()
type ColorSelectionColorChangedCallback = IO ()
afterColorSelectionColorChanged :: (IsColorSelection a, MonadIO m) => a -> ColorSelectionColorChangedCallback -> m SignalHandlerId
genClosure_ColorSelectionColorChanged :: MonadIO m => ColorSelectionColorChangedCallback -> m (GClosure C_ColorSelectionColorChangedCallback)
mk_ColorSelectionColorChangedCallback :: C_ColorSelectionColorChangedCallback -> IO (FunPtr C_ColorSelectionColorChangedCallback)
noColorSelectionColorChangedCallback :: Maybe ColorSelectionColorChangedCallback
onColorSelectionColorChanged :: (IsColorSelection a, MonadIO m) => a -> ColorSelectionColorChangedCallback -> m SignalHandlerId
wrap_ColorSelectionColorChangedCallback :: ColorSelectionColorChangedCallback -> C_ColorSelectionColorChangedCallback

Exported types

newtype ColorSelection Source #

Memory-managed wrapper type.

Constructors

ColorSelection (ManagedPtr ColorSelection)

Instances

Instances details

Eq ColorSelection Source #
Instance details Defined in GI.Gtk.Objects.ColorSelection Methods (==) :: ColorSelection -> ColorSelection -> Bool # (/=) :: ColorSelection -> ColorSelection -> Bool #
IsGValue ColorSelection Source #	Convert `ColorSelection` to and from `GValue` with `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.ColorSelection Methods toGValue :: ColorSelection -> IO GValue # fromGValue :: GValue -> IO ColorSelection #
GObject ColorSelection Source #
Instance details Defined in GI.Gtk.Objects.ColorSelection Methods gobjectType :: IO GType #
HasParentTypes ColorSelection Source #
Instance details Defined in GI.Gtk.Objects.ColorSelection
type ParentTypes ColorSelection Source #
Instance details Defined in GI.Gtk.Objects.ColorSelection type ParentTypes ColorSelection = '[Box, Container, Widget, Object, ImplementorIface, Buildable, Orientable]

class (GObject o, IsDescendantOf ColorSelection o) => IsColorSelection o Source #

Type class for types which can be safely cast to ColorSelection, for instance with toColorSelection.

Instances

Instances details

(GObject o, IsDescendantOf ColorSelection o) => IsColorSelection o Source #
Instance details Defined in GI.Gtk.Objects.ColorSelection

toColorSelection :: (MonadIO m, IsColorSelection o) => o -> m ColorSelection Source #

Cast to ColorSelection, for types for which this is known to be safe. For general casts, use castTo.

noColorSelection :: Maybe ColorSelection Source #

A convenience alias for Nothing :: Maybe ColorSelection.

Methods

getCurrentColor

colorSelectionGetCurrentColor Source #

Arguments

:: (HasCallStack, MonadIO m, IsColorSelection a)
=> a	`colorsel`: a `ColorSelection`
-> m Color

Deprecated: (Since version 3.4)Use colorSelectionGetCurrentRgba instead.

Sets color to be the current color in the GtkColorSelection widget.

getCurrentRgba

colorSelectionGetCurrentRgba Source #

Arguments

:: (HasCallStack, MonadIO m, IsColorSelection a)
=> a	`colorsel`: a `ColorSelection`
-> m RGBA

Sets rgba to be the current color in the GtkColorSelection widget.

Since: 3.0

getHasOpacityControl

colorSelectionGetHasOpacityControl Source #

Arguments

:: (HasCallStack, MonadIO m, IsColorSelection a)
=> a	`colorsel`: a `ColorSelection`
-> m Bool	Returns: `True` if the `colorsel` has an opacity control, `False` if it does't

Determines whether the colorsel has an opacity control.

getHasPalette

colorSelectionGetHasPalette Source #

Arguments

:: (HasCallStack, MonadIO m, IsColorSelection a)
=> a	`colorsel`: a `ColorSelection`
-> m Bool	Returns: `True` if the selector has a palette, `False` if it hasn't

Determines whether the color selector has a color palette.

getPreviousColor

colorSelectionGetPreviousColor Source #

Arguments

:: (HasCallStack, MonadIO m, IsColorSelection a)
=> a	`colorsel`: a `ColorSelection`
-> m Color

Deprecated: (Since version 3.4)Use colorSelectionGetPreviousRgba instead.

Fills color in with the original color value.

getPreviousRgba

colorSelectionGetPreviousRgba Source #

Arguments

:: (HasCallStack, MonadIO m, IsColorSelection a)
=> a	`colorsel`: a `ColorSelection`
-> m RGBA

Fills rgba in with the original color value.

Since: 3.0

isAdjusting

colorSelectionIsAdjusting Source #

Arguments

:: (HasCallStack, MonadIO m, IsColorSelection a)
=> a	`colorsel`: a `ColorSelection`
-> m Bool	Returns: `True` if the user is currently dragging a color around, and `False` if the selection has stopped

Gets the current state of the colorsel.

paletteFromString

colorSelectionPaletteFromString Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Text	`str`: a string encoding a color palette
-> m (Bool, [Color])	Returns: `True` if a palette was successfully parsed

Parses a color palette string; the string is a colon-separated list of color names readable by colorParse.

paletteToString

colorSelectionPaletteToString Source #

Arguments

:: (HasCallStack, MonadIO m)
=> [Color]	`colors`: an array of colors
-> m Text	Returns: allocated string encoding the palette

Encodes a palette as a string, useful for persistent storage.

setCurrentAlpha

colorSelectionSetCurrentAlpha Source #

Arguments

:: (HasCallStack, MonadIO m, IsColorSelection a)
=> a	`colorsel`: a `ColorSelection`
-> Word16	`alpha`: an integer between 0 and 65535
-> m ()

Sets the current opacity to be alpha.

The first time this is called, it will also set the original opacity to be alpha too.

setCurrentColor

colorSelectionSetCurrentColor Source #

Arguments

:: (HasCallStack, MonadIO m, IsColorSelection a)
=> a	`colorsel`: a `ColorSelection`
-> Color	`color`: a `Color` to set the current color with
-> m ()

Deprecated: (Since version 3.4)Use colorSelectionSetCurrentRgba instead.

Sets the current color to be color.

The first time this is called, it will also set the original color to be color too.

setCurrentRgba

colorSelectionSetCurrentRgba Source #

Arguments

:: (HasCallStack, MonadIO m, IsColorSelection a)
=> a	`colorsel`: a `ColorSelection`
-> RGBA	`rgba`: A `RGBA` to set the current color with
-> m ()

Sets the current color to be rgba.

The first time this is called, it will also set the original color to be rgba too.

Since: 3.0

setHasOpacityControl

colorSelectionSetHasOpacityControl Source #

Arguments

:: (HasCallStack, MonadIO m, IsColorSelection a)
=> a	`colorsel`: a `ColorSelection`
-> Bool	`hasOpacity`: `True` if `colorsel` can set the opacity, `False` otherwise
-> m ()

Sets the colorsel to use or not use opacity.

setHasPalette

colorSelectionSetHasPalette Source #

Arguments

:: (HasCallStack, MonadIO m, IsColorSelection a)
=> a	`colorsel`: a `ColorSelection`
-> Bool	`hasPalette`: `True` if palette is to be visible, `False` otherwise
-> m ()

Shows and hides the palette based upon the value of hasPalette.

setPreviousAlpha

colorSelectionSetPreviousAlpha Source #

Arguments

:: (HasCallStack, MonadIO m, IsColorSelection a)
=> a	`colorsel`: a `ColorSelection`
-> Word16	`alpha`: an integer between 0 and 65535
-> m ()

Sets the “previous” alpha to be alpha.

This function should be called with some hesitations, as it might seem confusing to have that alpha change.

setPreviousColor

colorSelectionSetPreviousColor Source #

Arguments

:: (HasCallStack, MonadIO m, IsColorSelection a)
=> a	`colorsel`: a `ColorSelection`
-> Color	`color`: a `Color` to set the previous color with
-> m ()

Deprecated: (Since version 3.4)Use colorSelectionSetPreviousRgba instead.

Sets the “previous” color to be color.

This function should be called with some hesitations, as it might seem confusing to have that color change. Calling colorSelectionSetCurrentColor will also set this color the first time it is called.

setPreviousRgba

colorSelectionSetPreviousRgba Source #

Arguments

:: (HasCallStack, MonadIO m, IsColorSelection a)
=> a	`colorsel`: a `ColorSelection`
-> RGBA	`rgba`: a `RGBA` to set the previous color with
-> m ()

Sets the “previous” color to be rgba.

This function should be called with some hesitations, as it might seem confusing to have that color change. Calling colorSelectionSetCurrentRgba will also set this color the first time it is called.

Since: 3.0

Properties

currentAlpha

No description available in the introspection data.

constructColorSelectionCurrentAlpha :: IsColorSelection o => Word32 -> IO (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “current-alpha” property. This is rarely needed directly, but it is used by new.

getColorSelectionCurrentAlpha :: (MonadIO m, IsColorSelection o) => o -> m Word32 Source #

Get the value of the “current-alpha” property. When overloading is enabled, this is equivalent to

get colorSelection #currentAlpha

setColorSelectionCurrentAlpha :: (MonadIO m, IsColorSelection o) => o -> Word32 -> m () Source #

Set the value of the “current-alpha” property. When overloading is enabled, this is equivalent to

set colorSelection [ #currentAlpha := value ]

currentColor

The current GdkColor color.

constructColorSelectionCurrentColor :: IsColorSelection o => Color -> IO (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “current-color” property. This is rarely needed directly, but it is used by new.

getColorSelectionCurrentColor :: (MonadIO m, IsColorSelection o) => o -> m (Maybe Color) Source #

Get the value of the “current-color” property. When overloading is enabled, this is equivalent to

get colorSelection #currentColor

setColorSelectionCurrentColor :: (MonadIO m, IsColorSelection o) => o -> Color -> m () Source #

Set the value of the “current-color” property. When overloading is enabled, this is equivalent to

set colorSelection [ #currentColor := value ]

currentRgba

The current RGBA color.

Since: 3.0

constructColorSelectionCurrentRgba :: IsColorSelection o => RGBA -> IO (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “current-rgba” property. This is rarely needed directly, but it is used by new.

getColorSelectionCurrentRgba :: (MonadIO m, IsColorSelection o) => o -> m (Maybe RGBA) Source #

Get the value of the “current-rgba” property. When overloading is enabled, this is equivalent to

get colorSelection #currentRgba

setColorSelectionCurrentRgba :: (MonadIO m, IsColorSelection o) => o -> RGBA -> m () Source #

Set the value of the “current-rgba” property. When overloading is enabled, this is equivalent to

set colorSelection [ #currentRgba := value ]

hasOpacityControl

No description available in the introspection data.

constructColorSelectionHasOpacityControl :: IsColorSelection o => Bool -> IO (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “has-opacity-control” property. This is rarely needed directly, but it is used by new.

getColorSelectionHasOpacityControl :: (MonadIO m, IsColorSelection o) => o -> m Bool Source #

Get the value of the “has-opacity-control” property. When overloading is enabled, this is equivalent to

get colorSelection #hasOpacityControl

setColorSelectionHasOpacityControl :: (MonadIO m, IsColorSelection o) => o -> Bool -> m () Source #

Set the value of the “has-opacity-control” property. When overloading is enabled, this is equivalent to

set colorSelection [ #hasOpacityControl := value ]

hasPalette

No description available in the introspection data.

constructColorSelectionHasPalette :: IsColorSelection o => Bool -> IO (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “has-palette” property. This is rarely needed directly, but it is used by new.

getColorSelectionHasPalette :: (MonadIO m, IsColorSelection o) => o -> m Bool Source #

Get the value of the “has-palette” property. When overloading is enabled, this is equivalent to

get colorSelection #hasPalette

setColorSelectionHasPalette :: (MonadIO m, IsColorSelection o) => o -> Bool -> m () Source #

Set the value of the “has-palette” property. When overloading is enabled, this is equivalent to

set colorSelection [ #hasPalette := value ]

Signals

colorChanged

type C_ColorSelectionColorChangedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type ColorSelectionColorChangedCallback = IO () Source #

This signal is emitted when the color changes in the ColorSelection according to its update policy.

afterColorSelectionColorChanged :: (IsColorSelection a, MonadIO m) => a -> ColorSelectionColorChangedCallback -> m SignalHandlerId Source #

Connect a signal handler for the colorChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after colorSelection #colorChanged callback

genClosure_ColorSelectionColorChanged :: MonadIO m => ColorSelectionColorChangedCallback -> m (GClosure C_ColorSelectionColorChangedCallback) Source #

Wrap the callback into a GClosure.

mk_ColorSelectionColorChangedCallback :: C_ColorSelectionColorChangedCallback -> IO (FunPtr C_ColorSelectionColorChangedCallback) Source #

Generate a function pointer callable from C code, from a C_ColorSelectionColorChangedCallback.

noColorSelectionColorChangedCallback :: Maybe ColorSelectionColorChangedCallback Source #

A convenience synonym for Nothing :: Maybe ColorSelectionColorChangedCallback.

onColorSelectionColorChanged :: (IsColorSelection a, MonadIO m) => a -> ColorSelectionColorChangedCallback -> m SignalHandlerId Source #

Connect a signal handler for the colorChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on colorSelection #colorChanged callback

wrap_ColorSelectionColorChangedCallback :: ColorSelectionColorChangedCallback -> C_ColorSelectionColorChangedCallback Source #

Wrap a ColorSelectionColorChangedCallback into a C_ColorSelectionColorChangedCallback.

Exported types

Instances

Instances

Methods

Overloaded methods

getCurrentAlpha

getCurrentColor

getCurrentRgba

getHasOpacityControl

getHasPalette

getPreviousAlpha

getPreviousColor

getPreviousRgba

isAdjusting

new

paletteFromString

paletteToString

setCurrentAlpha

setCurrentColor

setCurrentRgba

setHasOpacityControl

setHasPalette

setPreviousAlpha

setPreviousColor

setPreviousRgba

Properties

currentAlpha

currentColor

currentRgba

hasOpacityControl

hasPalette

Signals

colorChanged

:: (HasCallStack, MonadIO m)
=> m ColorSelection	Returns: a new `ColorSelection`