GI.Gtk.Interfaces.ColorChooser

ColorChooser is an interface that is implemented by widgets for choosing colors. Depending on the situation, colors may be allowed to have alpha (translucency).

In GTK+, the main widgets that implement this interface are ColorChooserWidget, ColorChooserDialog and ColorButton.

Since: 3.4

Exported types

newtype ColorChooser

Memory-managed wrapper type.

Constructors

ColorChooser (ManagedPtr ColorChooser)

Instances

Eq ColorChooser

Defined in GI.Gtk.Interfaces.ColorChooser

Methods

(==) :: ColorChooser -> ColorChooser -> Bool

(/=) :: ColorChooser -> ColorChooser -> Bool

GObject ColorChooser

Defined in GI.Gtk.Interfaces.ColorChooser

ManagedPtrNewtype ColorChooser

Defined in GI.Gtk.Interfaces.ColorChooser

Methods

toManagedPtr :: ColorChooser -> ManagedPtr ColorChooser

TypedObject ColorChooser

Defined in GI.Gtk.Interfaces.ColorChooser

Methods

glibType :: IO GType

HasParentTypes ColorChooser

Defined in GI.Gtk.Interfaces.ColorChooser

IsGValue (Maybe ColorChooser)

Convert ColorChooser to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Interfaces.ColorChooser

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe ColorChooser -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe ColorChooser)

type ParentTypes ColorChooser

Defined in GI.Gtk.Interfaces.ColorChooser

type ParentTypes ColorChooser = '[Object]

class (GObject o, IsDescendantOf ColorChooser o) => IsColorChooser o

Type class for types which can be safely cast to ColorChooser, for instance with toColorChooser.

Instances

(GObject o, IsDescendantOf ColorChooser o) => IsColorChooser o

Defined in GI.Gtk.Interfaces.ColorChooser

toColorChooser :: (MonadIO m, IsColorChooser o) => o -> m ColorChooser

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

Methods

Click to display all available methods, including inherited ones

Methods

addPalette, bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getProperty, getQdata, getRgba, getUseAlpha.

Setters

setData, setDataFull, setProperty, setRgba, setUseAlpha.

addPalette

colorChooserAddPalette

Arguments

:: (HasCallStack, MonadIO m, IsColorChooser a)

=> a

chooser: a ColorChooser

-> Orientation

orientation: OrientationHorizontal if the palette should be displayed in rows, OrientationVertical for columns

-> Int32

colorsPerLine: the number of colors to show in each row/column

-> Maybe [RGBA]

colors: the colors of the palette, or Nothing

-> m ()

Adds a palette to the color chooser. If orientation is horizontal, the colors are grouped in rows, with colorsPerLine colors in each row. If horizontal is False, the colors are grouped in columns instead.

The default color palette of ColorChooserWidget has 27 colors, organized in columns of 3 colors. The default gray palette has 9 grays in a single row.

The layout of the color chooser widget works best when the palettes have 9-10 columns.

Calling this function for the first time has the side effect of removing the default color and gray palettes from the color chooser.

If colors is Nothing, removes all previously added palettes.

Since: 3.4

getRgba

colorChooserGetRgba

Arguments

:: (HasCallStack, MonadIO m, IsColorChooser a)

=> a

chooser: a ColorChooser

-> m RGBA

Gets the currently-selected color.

Since: 3.4

getUseAlpha

colorChooserGetUseAlpha

Arguments

:: (HasCallStack, MonadIO m, IsColorChooser a)

=> a

chooser: a ColorChooser

-> m Bool

Returns: True if the color chooser uses the alpha channel, False if not

Returns whether the color chooser shows the alpha channel.

Since: 3.4

setRgba

colorChooserSetRgba

Arguments

:: (HasCallStack, MonadIO m, IsColorChooser a)

=> a

chooser: a ColorChooser

-> RGBA

color: the new color

-> m ()

Sets the color.

Since: 3.4

setUseAlpha

colorChooserSetUseAlpha

Arguments

:: (HasCallStack, MonadIO m, IsColorChooser a)

=> a

chooser: a ColorChooser

-> Bool

useAlpha: True if color chooser should use alpha channel, False if not

-> m ()

Sets whether or not the color chooser should use the alpha channel.

Since: 3.4

Properties

rgba

The rgba property contains the currently selected color, as a RGBA struct. The property can be set to change the current selection programmatically.

Since: 3.4

constructColorChooserRgba :: (IsColorChooser o, MonadIO m) => RGBA -> m (GValueConstruct o)

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

getColorChooserRgba :: (MonadIO m, IsColorChooser o) => o -> m (Maybe RGBA)

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

get colorChooser #rgba

setColorChooserRgba :: (MonadIO m, IsColorChooser o) => o -> RGBA -> m ()

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

set colorChooser [ #rgba := value ]

useAlpha

When useAlpha is True, colors may have alpha (translucency) information. When it is False, the RGBA struct obtained via the ColorChooser:rgba property will be forced to have alpha == 1.

Implementations are expected to show alpha by rendering the color over a non-uniform background (like a checkerboard pattern).

Since: 3.4

constructColorChooserUseAlpha :: (IsColorChooser o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getColorChooserUseAlpha :: (MonadIO m, IsColorChooser o) => o -> m Bool

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

get colorChooser #useAlpha

setColorChooserUseAlpha :: (MonadIO m, IsColorChooser o) => o -> Bool -> m ()

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

set colorChooser [ #useAlpha := value ]

Signals

colorActivated

type ColorChooserColorActivatedCallback

Arguments

 = RGBA

color: the color

-> IO ()

Emitted when a color is activated from the color chooser. This usually happens when the user clicks a color swatch, or a color is selected and the user presses one of the keys Space, Shift+Space, Return or Enter.

Since: 3.4

afterColorChooserColorActivated :: (IsColorChooser a, MonadIO m) => a -> ((?self :: a) => ColorChooserColorActivatedCallback) -> m SignalHandlerId

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

after colorChooser #colorActivated callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onColorChooserColorActivated :: (IsColorChooser a, MonadIO m) => a -> ((?self :: a) => ColorChooserColorActivatedCallback) -> m SignalHandlerId

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

on colorChooser #colorActivated callback