GI.Gtk.Objects.ColorButton

The ColorButton is a button which displays the currently selected color and allows to open a color selection dialog to change the color. It is suitable widget for selecting a color in a preference dialog.

CSS nodes

GtkColorButton has a single CSS node with name button. To differentiate it from a plain Button, it gets the .color style class.

Exported types

newtype ColorButton

Constructors

ColorButton (ManagedPtr ColorButton)

Instances

GObject ColorButton

Methods

gobjectType :: ColorButton -> IO GType

IsImplementorIface ColorButton

IsObject ColorButton

IsWidget ColorButton

IsContainer ColorButton

IsButton ColorButton

IsBin ColorButton

IsColorChooser ColorButton

IsBuildable ColorButton

IsActivatable ColorButton

IsActionable ColorButton

IsColorButton ColorButton

class GObject o => IsColorButton o

Instances

(GObject a, UnknownAncestorError Constraint ColorButton a) => IsColorButton a

IsColorButton ColorButton

toColorButton :: (MonadIO m, IsColorButton o) => o -> m ColorButton

noColorButton :: Maybe ColorButton

Methods

getAlpha

colorButtonGetAlpha

Arguments

:: (HasCallStack, MonadIO m, IsColorButton a)

=> a

button: a ColorButton

-> m Word16

Returns: an integer between 0 and 65535

Deprecated: (Since version 3.4)Use colorChooserGetRgba instead.

Returns the current alpha value.

Since: 2.4

getColor

colorButtonGetColor

Arguments

:: (HasCallStack, MonadIO m, IsColorButton a)

=> a

button: a ColorButton

-> m Color

Deprecated: (Since version 3.4)Use colorChooserGetRgba instead.

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

Since: 2.4

getTitle

colorButtonGetTitle

Arguments

:: (HasCallStack, MonadIO m, IsColorButton a)

=> a

button: a ColorButton

-> m Text

Returns: An internal string, do not free the return value

Gets the title of the color selection dialog.

Since: 2.4

getUseAlpha

colorButtonGetUseAlpha

Arguments

:: (HasCallStack, MonadIO m, IsColorButton a)

=> a

button: a ColorButton

-> m Bool

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

Deprecated: (Since version 3.4)Use colorChooserGetUseAlpha instead.

Does the color selection dialog use the alpha channel ?

Since: 2.4

new

colorButtonNew

Arguments

:: (HasCallStack, MonadIO m)

=> m ColorButton

Returns: a new color button

Creates a new color button.

This returns a widget in the form of a small button containing a swatch representing the current selected color. When the button is clicked, a color-selection dialog will open, allowing the user to select a color. The swatch will be updated to reflect the new color when the user finishes.

Since: 2.4

newWithColor

colorButtonNewWithColor

Arguments

:: (HasCallStack, MonadIO m)

=> Color

color: A Color to set the current color with

-> m ColorButton

Returns: a new color button

Deprecated: (Since version 3.4)Use colorButtonNewWithRgba instead.

Creates a new color button.

Since: 2.4

newWithRgba

colorButtonNewWithRgba

Arguments

:: (HasCallStack, MonadIO m)

=> RGBA

rgba: A RGBA to set the current color with

-> m ColorButton

Returns: a new color button

Creates a new color button.

Since: 3.0

setAlpha

colorButtonSetAlpha

Arguments

:: (HasCallStack, MonadIO m, IsColorButton a)

=> a

button: a ColorButton

-> Word16

alpha: an integer between 0 and 65535

-> m ()

Deprecated: (Since version 3.4)Use colorChooserSetRgba instead.

Sets the current opacity to be alpha.

Since: 2.4

setColor

colorButtonSetColor

Arguments

:: (HasCallStack, MonadIO m, IsColorButton a)

=> a

button: a ColorButton

-> Color

color: A Color to set the current color with

-> m ()

Deprecated: Use colorChooserSetRgba instead.

Sets the current color to be color.

Since: 2.4

setTitle

colorButtonSetTitle

Arguments

:: (HasCallStack, MonadIO m, IsColorButton a)

=> a

button: a ColorButton

-> Text

title: String containing new window title

-> m ()

Sets the title for the color selection dialog.

Since: 2.4

setUseAlpha

colorButtonSetUseAlpha

Arguments

:: (HasCallStack, MonadIO m, IsColorButton a)

=> a

button: a ColorButton

-> Bool

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

-> m ()

Deprecated: (Since version 3.4)Use colorChooserSetUseAlpha instead.

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

Since: 2.4

Properties

alpha

constructColorButtonAlpha :: IsColorButton o => Word32 -> IO (GValueConstruct o)

getColorButtonAlpha :: (MonadIO m, IsColorButton o) => o -> m Word32

setColorButtonAlpha :: (MonadIO m, IsColorButton o) => o -> Word32 -> m ()

color

constructColorButtonColor :: IsColorButton o => Color -> IO (GValueConstruct o)

getColorButtonColor :: (MonadIO m, IsColorButton o) => o -> m (Maybe Color)

setColorButtonColor :: (MonadIO m, IsColorButton o) => o -> Color -> m ()

rgba

clearColorButtonRgba :: (MonadIO m, IsColorButton o) => o -> m ()

constructColorButtonRgba :: IsColorButton o => RGBA -> IO (GValueConstruct o)

getColorButtonRgba :: (MonadIO m, IsColorButton o) => o -> m (Maybe RGBA)

setColorButtonRgba :: (MonadIO m, IsColorButton o) => o -> RGBA -> m ()

showEditor

constructColorButtonShowEditor :: IsColorButton o => Bool -> IO (GValueConstruct o)

getColorButtonShowEditor :: (MonadIO m, IsColorButton o) => o -> m Bool

setColorButtonShowEditor :: (MonadIO m, IsColorButton o) => o -> Bool -> m ()

title

constructColorButtonTitle :: IsColorButton o => Text -> IO (GValueConstruct o)

getColorButtonTitle :: (MonadIO m, IsColorButton o) => o -> m Text

setColorButtonTitle :: (MonadIO m, IsColorButton o) => o -> Text -> m ()

useAlpha

constructColorButtonUseAlpha :: IsColorButton o => Bool -> IO (GValueConstruct o)

getColorButtonUseAlpha :: (MonadIO m, IsColorButton o) => o -> m Bool

setColorButtonUseAlpha :: (MonadIO m, IsColorButton o) => o -> Bool -> m ()

Signals

colorSet

type C_ColorButtonColorSetCallback = Ptr () -> Ptr () -> IO ()

type ColorButtonColorSetCallback = IO ()

afterColorButtonColorSet :: (IsColorButton a, MonadIO m) => a -> ColorButtonColorSetCallback -> m SignalHandlerId

genClosure_ColorButtonColorSet :: ColorButtonColorSetCallback -> IO Closure

mk_ColorButtonColorSetCallback :: C_ColorButtonColorSetCallback -> IO (FunPtr C_ColorButtonColorSetCallback)

noColorButtonColorSetCallback :: Maybe ColorButtonColorSetCallback

onColorButtonColorSet :: (IsColorButton a, MonadIO m) => a -> ColorButtonColorSetCallback -> m SignalHandlerId

wrap_ColorButtonColorSetCallback :: ColorButtonColorSetCallback -> Ptr () -> Ptr () -> IO ()