| Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Gtk.Objects.ColorButton
Contents
Description
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.
- newtype ColorButton = ColorButton (ManagedPtr ColorButton)
- class GObject o => IsColorButton o
- toColorButton :: IsColorButton o => o -> IO ColorButton
- noColorButton :: Maybe ColorButton
- data ColorButtonGetAlphaMethodInfo
- colorButtonGetAlpha :: (HasCallStack, MonadIO m, IsColorButton a) => a -> m Word16
- data ColorButtonGetColorMethodInfo
- colorButtonGetColor :: (HasCallStack, MonadIO m, IsColorButton a) => a -> m Color
- data ColorButtonGetTitleMethodInfo
- colorButtonGetTitle :: (HasCallStack, MonadIO m, IsColorButton a) => a -> m Text
- data ColorButtonGetUseAlphaMethodInfo
- colorButtonGetUseAlpha :: (HasCallStack, MonadIO m, IsColorButton a) => a -> m Bool
- colorButtonNew :: (HasCallStack, MonadIO m) => m ColorButton
- colorButtonNewWithColor :: (HasCallStack, MonadIO m) => Color -> m ColorButton
- colorButtonNewWithRgba :: (HasCallStack, MonadIO m) => RGBA -> m ColorButton
- data ColorButtonSetAlphaMethodInfo
- colorButtonSetAlpha :: (HasCallStack, MonadIO m, IsColorButton a) => a -> Word16 -> m ()
- data ColorButtonSetColorMethodInfo
- colorButtonSetColor :: (HasCallStack, MonadIO m, IsColorButton a) => a -> Color -> m ()
- data ColorButtonSetTitleMethodInfo
- colorButtonSetTitle :: (HasCallStack, MonadIO m, IsColorButton a) => a -> Text -> m ()
- data ColorButtonSetUseAlphaMethodInfo
- colorButtonSetUseAlpha :: (HasCallStack, MonadIO m, IsColorButton a) => a -> Bool -> m ()
- data ColorButtonAlphaPropertyInfo
- colorButtonAlpha :: AttrLabelProxy "alpha"
- constructColorButtonAlpha :: IsColorButton o => Word32 -> IO (GValueConstruct o)
- getColorButtonAlpha :: (MonadIO m, IsColorButton o) => o -> m Word32
- setColorButtonAlpha :: (MonadIO m, IsColorButton o) => o -> Word32 -> m ()
- data ColorButtonColorPropertyInfo
- colorButtonColor :: AttrLabelProxy "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 ()
- data ColorButtonRgbaPropertyInfo
- clearColorButtonRgba :: (MonadIO m, IsColorButton o) => o -> m ()
- colorButtonRgba :: AttrLabelProxy "rgba"
- constructColorButtonRgba :: IsColorButton o => RGBA -> IO (GValueConstruct o)
- getColorButtonRgba :: (MonadIO m, IsColorButton o) => o -> m (Maybe RGBA)
- setColorButtonRgba :: (MonadIO m, IsColorButton o) => o -> RGBA -> m ()
- data ColorButtonShowEditorPropertyInfo
- colorButtonShowEditor :: AttrLabelProxy "showEditor"
- constructColorButtonShowEditor :: IsColorButton o => Bool -> IO (GValueConstruct o)
- getColorButtonShowEditor :: (MonadIO m, IsColorButton o) => o -> m Bool
- setColorButtonShowEditor :: (MonadIO m, IsColorButton o) => o -> Bool -> m ()
- data ColorButtonTitlePropertyInfo
- colorButtonTitle :: AttrLabelProxy "title"
- constructColorButtonTitle :: IsColorButton o => Text -> IO (GValueConstruct o)
- getColorButtonTitle :: (MonadIO m, IsColorButton o) => o -> m Text
- setColorButtonTitle :: (MonadIO m, IsColorButton o) => o -> Text -> m ()
- data ColorButtonUseAlphaPropertyInfo
- colorButtonUseAlpha :: AttrLabelProxy "useAlpha"
- constructColorButtonUseAlpha :: IsColorButton o => Bool -> IO (GValueConstruct o)
- getColorButtonUseAlpha :: (MonadIO m, IsColorButton o) => o -> m Bool
- setColorButtonUseAlpha :: (MonadIO m, IsColorButton o) => o -> Bool -> m ()
- type C_ColorButtonColorSetCallback = Ptr () -> Ptr () -> IO ()
- type ColorButtonColorSetCallback = IO ()
- data ColorButtonColorSetSignalInfo
- afterColorButtonColorSet :: (GObject a, MonadIO m) => a -> ColorButtonColorSetCallback -> m SignalHandlerId
- genClosure_ColorButtonColorSet :: ColorButtonColorSetCallback -> IO Closure
- mk_ColorButtonColorSetCallback :: C_ColorButtonColorSetCallback -> IO (FunPtr C_ColorButtonColorSetCallback)
- noColorButtonColorSetCallback :: Maybe ColorButtonColorSetCallback
- onColorButtonColorSet :: (GObject a, MonadIO m) => a -> ColorButtonColorSetCallback -> m SignalHandlerId
- wrap_ColorButtonColorSetCallback :: ColorButtonColorSetCallback -> Ptr () -> Ptr () -> IO ()
Exported types
newtype ColorButton Source #
Constructors
| ColorButton (ManagedPtr ColorButton) |
Instances
| GObject ColorButton Source # | |
| IsImplementorIface ColorButton Source # | |
| IsObject ColorButton Source # | |
| IsWidget ColorButton Source # | |
| IsContainer ColorButton Source # | |
| IsButton ColorButton Source # | |
| IsBin ColorButton Source # | |
| IsColorChooser ColorButton Source # | |
| IsBuildable ColorButton Source # | |
| IsActivatable ColorButton Source # | |
| IsActionable ColorButton Source # | |
| IsColorButton ColorButton Source # | |
| ((~) * info (ResolveColorButtonMethod t ColorButton), MethodInfo * info ColorButton p) => IsLabel t (ColorButton -> p) Source # | |
| ((~) * info (ResolveColorButtonMethod t ColorButton), MethodInfo * info ColorButton p) => IsLabelProxy t (ColorButton -> p) Source # | |
| HasAttributeList * ColorButton Source # | |
| type AttributeList ColorButton Source # | |
| type SignalList ColorButton Source # | |
class GObject o => IsColorButton o Source #
Instances
toColorButton :: IsColorButton o => o -> IO ColorButton Source #
Methods
getAlpha
data ColorButtonGetAlphaMethodInfo Source #
Instances
| ((~) * signature (m Word16), MonadIO m, IsColorButton a) => MethodInfo * ColorButtonGetAlphaMethodInfo a signature Source # | |
Arguments
| :: (HasCallStack, MonadIO m, IsColorButton a) | |
| => a |
|
| -> 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
data ColorButtonGetColorMethodInfo Source #
Instances
| ((~) * signature (m Color), MonadIO m, IsColorButton a) => MethodInfo * ColorButtonGetColorMethodInfo a signature Source # | |
Arguments
| :: (HasCallStack, MonadIO m, IsColorButton a) | |
| => a |
|
| -> 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
data ColorButtonGetTitleMethodInfo Source #
Instances
| ((~) * signature (m Text), MonadIO m, IsColorButton a) => MethodInfo * ColorButtonGetTitleMethodInfo a signature Source # | |
Arguments
| :: (HasCallStack, MonadIO m, IsColorButton a) | |
| => a |
|
| -> m Text | Returns: An internal string, do not free the return value |
Gets the title of the color selection dialog.
Since: 2.4
getUseAlpha
data ColorButtonGetUseAlphaMethodInfo Source #
Instances
| ((~) * signature (m Bool), MonadIO m, IsColorButton a) => MethodInfo * ColorButtonGetUseAlphaMethodInfo a signature Source # | |
colorButtonGetUseAlpha Source #
Arguments
| :: (HasCallStack, MonadIO m, IsColorButton a) | |
| => a |
|
| -> m Bool | Returns: |
Deprecated: (Since version 3.4)Use colorChooserGetUseAlpha instead.
Does the color selection dialog use the alpha channel ?
Since: 2.4
new
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 Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Color |
|
| -> 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 Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => RGBA |
|
| -> m ColorButton | Returns: a new color button |
Creates a new color button.
Since: 3.0
setAlpha
data ColorButtonSetAlphaMethodInfo Source #
Instances
| ((~) * signature (Word16 -> m ()), MonadIO m, IsColorButton a) => MethodInfo * ColorButtonSetAlphaMethodInfo a signature Source # | |
Arguments
| :: (HasCallStack, MonadIO m, IsColorButton a) | |
| => a |
|
| -> Word16 |
|
| -> m () |
Deprecated: (Since version 3.4)Use colorChooserSetRgba instead.
Sets the current opacity to be alpha.
Since: 2.4
setColor
data ColorButtonSetColorMethodInfo Source #
Instances
| ((~) * signature (Color -> m ()), MonadIO m, IsColorButton a) => MethodInfo * ColorButtonSetColorMethodInfo a signature Source # | |
Arguments
| :: (HasCallStack, MonadIO m, IsColorButton a) | |
| => a |
|
| -> Color |
|
| -> m () |
setTitle
data ColorButtonSetTitleMethodInfo Source #
Instances
| ((~) * signature (Text -> m ()), MonadIO m, IsColorButton a) => MethodInfo * ColorButtonSetTitleMethodInfo a signature Source # | |
Arguments
| :: (HasCallStack, MonadIO m, IsColorButton a) | |
| => a |
|
| -> Text |
|
| -> m () |
Sets the title for the color selection dialog.
Since: 2.4
setUseAlpha
data ColorButtonSetUseAlphaMethodInfo Source #
Instances
| ((~) * signature (Bool -> m ()), MonadIO m, IsColorButton a) => MethodInfo * ColorButtonSetUseAlphaMethodInfo a signature Source # | |
colorButtonSetUseAlpha Source #
Arguments
| :: (HasCallStack, MonadIO m, IsColorButton a) | |
| => a |
|
| -> Bool |
|
| -> 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
data ColorButtonAlphaPropertyInfo Source #
Instances
colorButtonAlpha :: AttrLabelProxy "alpha" Source #
constructColorButtonAlpha :: IsColorButton o => Word32 -> IO (GValueConstruct o) Source #
getColorButtonAlpha :: (MonadIO m, IsColorButton o) => o -> m Word32 Source #
setColorButtonAlpha :: (MonadIO m, IsColorButton o) => o -> Word32 -> m () Source #
color
data ColorButtonColorPropertyInfo Source #
Instances
colorButtonColor :: AttrLabelProxy "color" Source #
constructColorButtonColor :: IsColorButton o => Color -> IO (GValueConstruct o) Source #
getColorButtonColor :: (MonadIO m, IsColorButton o) => o -> m (Maybe Color) Source #
setColorButtonColor :: (MonadIO m, IsColorButton o) => o -> Color -> m () Source #
rgba
data ColorButtonRgbaPropertyInfo Source #
Instances
clearColorButtonRgba :: (MonadIO m, IsColorButton o) => o -> m () Source #
colorButtonRgba :: AttrLabelProxy "rgba" Source #
constructColorButtonRgba :: IsColorButton o => RGBA -> IO (GValueConstruct o) Source #
getColorButtonRgba :: (MonadIO m, IsColorButton o) => o -> m (Maybe RGBA) Source #
setColorButtonRgba :: (MonadIO m, IsColorButton o) => o -> RGBA -> m () Source #
showEditor
data ColorButtonShowEditorPropertyInfo Source #
Instances
colorButtonShowEditor :: AttrLabelProxy "showEditor" Source #
constructColorButtonShowEditor :: IsColorButton o => Bool -> IO (GValueConstruct o) Source #
getColorButtonShowEditor :: (MonadIO m, IsColorButton o) => o -> m Bool Source #
setColorButtonShowEditor :: (MonadIO m, IsColorButton o) => o -> Bool -> m () Source #
title
data ColorButtonTitlePropertyInfo Source #
Instances
colorButtonTitle :: AttrLabelProxy "title" Source #
constructColorButtonTitle :: IsColorButton o => Text -> IO (GValueConstruct o) Source #
getColorButtonTitle :: (MonadIO m, IsColorButton o) => o -> m Text Source #
setColorButtonTitle :: (MonadIO m, IsColorButton o) => o -> Text -> m () Source #
useAlpha
data ColorButtonUseAlphaPropertyInfo Source #
Instances
colorButtonUseAlpha :: AttrLabelProxy "useAlpha" Source #
constructColorButtonUseAlpha :: IsColorButton o => Bool -> IO (GValueConstruct o) Source #
getColorButtonUseAlpha :: (MonadIO m, IsColorButton o) => o -> m Bool Source #
setColorButtonUseAlpha :: (MonadIO m, IsColorButton o) => o -> Bool -> m () Source #
Signals
colorSet
type ColorButtonColorSetCallback = IO () Source #
afterColorButtonColorSet :: (GObject a, MonadIO m) => a -> ColorButtonColorSetCallback -> m SignalHandlerId Source #
mk_ColorButtonColorSetCallback :: C_ColorButtonColorSetCallback -> IO (FunPtr C_ColorButtonColorSetCallback) Source #
onColorButtonColorSet :: (GObject a, MonadIO m) => a -> ColorButtonColorSetCallback -> m SignalHandlerId Source #
wrap_ColorButtonColorSetCallback :: ColorButtonColorSetCallback -> Ptr () -> Ptr () -> IO () Source #