| gtk-0.11.2: Binding to the Gtk+ graphical user interface library. | Contents | Index
Graphics.UI.Gtk.Selectors.ColorButton |
Portability | portable (depends on GHC)
Stability | provisional
Maintainer | gtk2hs-users@lists.sourceforge.net
Contents
Detail Class Hierarchy Types Constructors Methods Attributes Signals
Description
A button to launch a color selection dialog Module available since Gtk+ version 2.4
Synopsis
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
     | GObject
     | +----Object
     | +----Widget
     | +----Container
     | +----Bin
     | +----Button
     | +----ColorButton
Types
data ColorButton
Instances
Eq ColorButton |
Ord ColorButton |
GObjectClass ColorButton |
ColorButtonClass ColorButton |
ButtonClass ColorButton |
BinClass ColorButton |
ContainerClass ColorButton |
WidgetClass ColorButton |
ObjectClass ColorButton |
class ButtonClass o => ColorButtonClass o
Instances
ColorButtonClass ColorButton |
castToColorButton :: GObjectClass obj => obj -> ColorButton
gTypeColorButton :: GType
toColorButton :: ColorButtonClass o => o -> ColorButton
Constructors
colorButtonNew :: IO ColorButton
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.
colorButtonNewWithColor
:: Color | `color` - A `Color` to set the current color with.
-> IO ColorButton |
Creates a new color button.
Methods
colorButtonSetColor
:: ColorButtonClass self |
=> self |
-> Color | `color` - A `Color` to set the current color with.
-> IO () |
Sets the current color to be `color`.
colorButtonGetColor :: ColorButtonClass self => self -> IO Color
Returns the current color value.
colorButtonSetAlpha
:: ColorButtonClass self |
=> self |
-> Word16 | `alpha` - an integer between 0 and 65535.
-> IO () |
Sets the current opacity to be `alpha`.
colorButtonGetAlpha
:: ColorButtonClass self |
=> self |
-> IO Word16 | returns an integer between 0 and 65535.
Returns the current alpha value.
colorButtonSetUseAlpha
:: ColorButtonClass self |
=> self |
-> Bool | `useAlpha` - `True` if color button should use alpha channel, `False` if not.
-> IO () |
Sets whether or not the color button should use the alpha channel.
colorButtonGetUseAlpha
:: ColorButtonClass self |
=> self |
-> IO Bool | returns `True` if the color sample uses alpha channel, `False` if not.
Does the color selection dialog use the alpha channel?
colorButtonSetTitle
:: ColorButtonClass self |
=> self |
-> String | `title` - String containing new window title.
-> IO () |
Sets the title for the color selection dialog.
colorButtonGetTitle
:: 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 Bool
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 String
The title of the color selection dialog Default value: "Pick a Color"
colorButtonAlpha :: ColorButtonClass self => Attr self Word16
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)
afterColorSet :: ColorButtonClass self => self -> IO () -> IO (ConnectId self)
The ::color-set 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.
Produced by Haddock version 2.7.2