GI.Gtk.Objects.ColorSelection

No description available in the introspection data.

Exported types

newtype ColorSelection

Memory-managed wrapper type.

Constructors

ColorSelection (ManagedPtr ColorSelection)

Instances

GObject ColorSelection

Defined in GI.Gtk.Objects.ColorSelection

Methods

gobjectType :: ColorSelection -> IO GType

IsImplementorIface ColorSelection

Defined in GI.Gtk.Objects.ColorSelection

IsObject ColorSelection

Defined in GI.Gtk.Objects.ColorSelection

IsBuildable ColorSelection

Defined in GI.Gtk.Objects.ColorSelection

IsOrientable ColorSelection

Defined in GI.Gtk.Objects.ColorSelection

IsBox ColorSelection

Defined in GI.Gtk.Objects.ColorSelection

IsContainer ColorSelection

Defined in GI.Gtk.Objects.ColorSelection

IsWidget ColorSelection

Defined in GI.Gtk.Objects.ColorSelection

IsColorSelection ColorSelection

Defined in GI.Gtk.Objects.ColorSelection

class GObject o => IsColorSelection o

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

Instances

(GObject a, (UnknownAncestorError ColorSelection a :: Constraint)) => IsColorSelection a

Defined in GI.Gtk.Objects.ColorSelection

IsColorSelection ColorSelection

Defined in GI.Gtk.Objects.ColorSelection

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

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

noColorSelection :: Maybe ColorSelection

A convenience alias for Nothing :: Maybe ColorSelection.

Methods

getCurrentAlpha

colorSelectionGetCurrentAlpha

Arguments

:: (HasCallStack, MonadIO m, IsColorSelection a)

=> a

colorsel: a ColorSelection

-> m Word16

Returns: an integer between 0 and 65535

Returns the current alpha value.

getCurrentColor

colorSelectionGetCurrentColor

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

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

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

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.

getPreviousAlpha

colorSelectionGetPreviousAlpha

Arguments

:: (HasCallStack, MonadIO m, IsColorSelection a)

=> a

colorsel: a ColorSelection

-> m Word16

Returns: an integer between 0 and 65535

Returns the previous alpha value.

getPreviousColor

colorSelectionGetPreviousColor

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

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

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.

new

colorSelectionNew

Arguments

:: (HasCallStack, MonadIO m)

=> m ColorSelection

Returns: a new ColorSelection

Creates a new GtkColorSelection.

paletteFromString

colorSelectionPaletteFromString

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

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

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

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

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

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

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

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

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

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)

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

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

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)

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)

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

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)

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)

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

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)

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

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

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)

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

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

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

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

type ColorSelectionColorChangedCallback = IO ()

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

Connect a signal handler for the “color-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after colorSelection #colorChanged callback

genClosure_ColorSelectionColorChanged :: ColorSelectionColorChangedCallback -> IO Closure

Wrap the callback into a Closure.

mk_ColorSelectionColorChangedCallback :: C_ColorSelectionColorChangedCallback -> IO (FunPtr C_ColorSelectionColorChangedCallback)

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

noColorSelectionColorChangedCallback :: Maybe ColorSelectionColorChangedCallback

A convenience synonym for Nothing :: Maybe ColorSelectionColorChangedCallback.

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

Connect a signal handler for the “color-changed” 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

Wrap a ColorSelectionColorChangedCallback into a C_ColorSelectionColorChangedCallback.