| Portability | portable (depends on GHC) |
|---|---|
| Stability | provisional |
| Maintainer | gtk2hs-users@lists.sourceforge.net |
| Safe Haskell | None |
Graphics.UI.Gtk.Selectors.ColorButton
Description
A button to launch a color selection dialog
- Module available since Gtk+ version 2.4
- data ColorButton
- class ButtonClass o => ColorButtonClass o
- castToColorButton :: GObjectClass obj => obj -> ColorButton
- gTypeColorButton :: GType
- toColorButton :: ColorButtonClass o => o -> ColorButton
- colorButtonNew :: IO ColorButton
- colorButtonNewWithColor :: Color -> IO ColorButton
- colorButtonSetColor :: ColorButtonClass self => self -> Color -> IO ()
- colorButtonGetColor :: ColorButtonClass self => self -> IO Color
- colorButtonSetAlpha :: ColorButtonClass self => self -> Word16 -> IO ()
- colorButtonGetAlpha :: ColorButtonClass self => self -> IO Word16
- colorButtonSetUseAlpha :: ColorButtonClass self => self -> Bool -> IO ()
- colorButtonGetUseAlpha :: ColorButtonClass self => self -> IO Bool
- colorButtonSetTitle :: ColorButtonClass self => self -> String -> IO ()
- colorButtonGetTitle :: ColorButtonClass self => self -> IO String
- colorButtonUseAlpha :: ColorButtonClass self => Attr self Bool
- colorButtonTitle :: ColorButtonClass self => Attr self String
- colorButtonAlpha :: ColorButtonClass self => Attr self Word16
- onColorSet :: ColorButtonClass self => self -> IO () -> IO (ConnectId self)
- afterColorSet :: ColorButtonClass self => self -> IO () -> IO (ConnectId self)
Detail
The ColorButton is a button which displays the currently selected color
an allows to open a color selection dialog to change the color. It is
suitable widget for selecting a color in a preference dialog.
Class Hierarchy
Types
data ColorButton Source
class ButtonClass o => ColorButtonClass o Source
Instances
castToColorButton :: GObjectClass obj => obj -> ColorButtonSource
toColorButton :: ColorButtonClass o => o -> ColorButtonSource
Constructors
colorButtonNew :: IO ColorButtonSource
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.
Arguments
| :: Color |
|
| -> IO ColorButton |
Creates a new color button.
Methods
Arguments
| :: ColorButtonClass self | |
| => self | |
| -> Color |
|
| -> IO () |
Sets the current color to be color.
colorButtonGetColor :: ColorButtonClass self => self -> IO ColorSource
Returns the current color value.
Arguments
| :: ColorButtonClass self | |
| => self | |
| -> Word16 |
|
| -> IO () |
Sets the current opacity to be alpha.
Arguments
| :: ColorButtonClass self | |
| => self | |
| -> IO Word16 | returns an integer between 0 and 65535. |
Returns the current alpha value.
Arguments
| :: ColorButtonClass self | |
| => self | |
| -> Bool |
|
| -> IO () |
Sets whether or not the color button should use the alpha channel.
Arguments
| :: ColorButtonClass self | |
| => self | |
| -> IO Bool | returns |
Does the color selection dialog use the alpha channel?
Arguments
| :: ColorButtonClass self | |
| => self | |
| -> String |
|
| -> IO () |
Sets the title for the color selection dialog.
Arguments
| :: ColorButtonClass self | |
| => self | |
| -> IO String | returns An internal string, do not free the return value |
Gets the title of the color selection dialog.
Attributes
colorButtonUseAlpha :: ColorButtonClass self => Attr self BoolSource
If this property is set to True, the color swatch on the button is
rendered against a checkerboard background to show its opacity and the
opacity slider is displayed in the color selection dialog.
Default value: False
colorButtonTitle :: ColorButtonClass self => Attr self StringSource
The title of the color selection dialog
Default value: "Pick a Color"
colorButtonAlpha :: ColorButtonClass self => Attr self Word16Source
The selected opacity value (0 fully transparent, 65535 fully opaque).
Allowed values: <= 65535
Default value: 65535
Signals
onColorSet :: ColorButtonClass self => self -> IO () -> IO (ConnectId self)Source
The colorSet signal is emitted when the user selects a color. When
handling this signal, use colorButtonGetColor and colorButtonGetAlpha to
find out which color was just selected.
afterColorSet :: ColorButtonClass self => self -> IO () -> IO (ConnectId self)Source
The colorSet signal is emitted when the user selects a color. When
handling this signal, use colorButtonGetColor and colorButtonGetAlpha to
find out which color was just selected.