Gtk2Hs Contents Index

Graphics.UI.Gtk.Buttons.ToggleButton

Description

A ToggleButton is the base class for all buttons that have an inherit state.

Synopsis

data ToggleButton class ButtonClass o => ToggleButtonClass o castToToggleButton :: GObjectClass obj => obj -> ToggleButton toggleButtonNew :: IO ToggleButton toggleButtonNewWithLabel :: String -> IO ToggleButton toggleButtonNewWithMnemonic :: String -> IO ToggleButton toggleButtonSetMode :: ToggleButtonClass tb => tb -> Bool -> IO () toggleButtonGetMode :: ToggleButtonClass tb => tb -> IO Bool toggleButtonToggled :: ToggleButtonClass tb => tb -> IO () toggleButtonGetActive :: ToggleButtonClass tb => tb -> IO Bool toggleButtonSetActive :: ToggleButtonClass tb => Bool -> tb -> IO () toggleButtonGetInconsistent :: ToggleButtonClass tb => tb -> IO Bool toggleButtonSetInconsistent :: ToggleButtonClass tb => Bool -> tb -> IO () onToggled :: ButtonClass b => b -> IO () -> IO (ConnectId b) afterToggled :: ButtonClass b => b -> IO () -> IO (ConnectId b)

Documentation

data ToggleButton

Instances ToggleButtonClass ToggleButton ButtonClass ToggleButton BinClass ToggleButton ContainerClass ToggleButton WidgetClass ToggleButton ObjectClass ToggleButton GObjectClass ToggleButton

class ButtonClass o => ToggleButtonClass o

Instances ToggleButtonClass ToggleButton ToggleButtonClass CheckButton ToggleButtonClass RadioButton

castToToggleButton :: GObjectClass obj => obj -> ToggleButton

toggleButtonNew :: IO ToggleButton

Create a new ToggleButton widget.

toggleButtonNewWithLabel :: String -> IO ToggleButton

Create a ToggleButton with a label in it.

toggleButtonNewWithMnemonic :: String -> IO ToggleButton

Create a ToggleButton with a label in it. Underscores in label indicate the mnemonic for the button.

toggleButtonSetMode :: ToggleButtonClass tb => tb -> Bool -> IO ()

Sets whether the button is displayed as a separate indicator and label. You can call this function on a CheckButton or a RadioButton with False to make the button look like a normal button.

toggleButtonGetMode :: ToggleButtonClass tb => tb -> IO Bool

Retrieves whether the button is displayed as a separate indicator and label.

toggleButtonToggled :: ToggleButtonClass tb => tb -> IO ()

Emit the toggled signal on the button.

toggleButtonGetActive :: ToggleButtonClass tb => tb -> IO Bool

Retrieve the current state of the button. Returns True if the button is depressed.

toggleButtonSetActive :: ToggleButtonClass tb => Bool -> tb -> IO ()

Sets the state of the ToggleButton. True means the button should be depressed.

toggleButtonGetInconsistent :: ToggleButtonClass tb => tb -> IO Bool

Retrieve the inconsistent flag of the button. An inconsistent state only visually affects the button. It will be displayed in an "in-between" state.

toggleButtonSetInconsistent :: ToggleButtonClass tb => Bool -> tb -> IO ()

Sets the inconsistent flag of the ToggleButton.

onToggled :: ButtonClass b => b -> IO () -> IO (ConnectId b)

Whenever the state of the button is changed, the toggled signal is emitted.

afterToggled :: ButtonClass b => b -> IO () -> IO (ConnectId b)

Produced by Haddock version 0.6