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.ToggleButton

Contents

Exported types
Methods
Properties
Signals
- toggled

Description

A ToggleButton is a Button which will remain “pressed-in” when clicked. Clicking again will cause the toggle button to return to its normal state.

A toggle button is created by calling either toggleButtonNew or toggleButtonNewWithLabel. If using the former, it is advisable to pack a widget, (such as a Label and/or a Image), into the toggle button’s container. (See Button for more information).

The state of a ToggleButton can be set specifically using toggleButtonSetActive, and retrieved using toggleButtonGetActive.

To simply switch the state of a toggle button, use toggleButtonToggled.

CSS nodes

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

## Creating two ToggleButton widgets.

C code

void make_toggles (void) {
   GtkWidget *dialog, *toggle1, *toggle2;
   GtkWidget *content_area;
   const char *text;

   dialog = gtk_dialog_new (text);
   content_area = gtk_dialog_get_content_area ();

   text = "Hi, i’m a toggle button.";
   toggle1 = gtk_toggle_button_new_with_label (text);

   // Makes this toggle button invisible
   gtk_toggle_button_set_mode (GTK_TOGGLE_BUTTON (toggle1),
                               TRUE);

   g_signal_connect (toggle1, "toggled",
                     G_CALLBACK (output_state),
                     NULL);
   gtk_box_pack_start (GTK_BOX (content_area),
                       toggle1, FALSE, FALSE, 2);

   text = "Hi, i’m a toggle button.";
   toggle2 = gtk_toggle_button_new_with_label (text);
   gtk_toggle_button_set_mode (GTK_TOGGLE_BUTTON (toggle2),
                               FALSE);
   g_signal_connect (toggle2, "toggled",
                     G_CALLBACK (output_state),
                     NULL);
   gtk_box_pack_start (GTK_BOX (content_area),
                       toggle2, FALSE, FALSE, 2);

   gtk_widget_show_all (dialog);
}

Synopsis

Exported types

newtype ToggleButton Source #

Constructors

ToggleButton (ManagedPtr ToggleButton)

Instances

GObject ToggleButton Source #
Methods gobjectType :: ToggleButton -> IO GType #
IsImplementorIface ToggleButton Source #

IsObject ToggleButton Source #

IsWidget ToggleButton Source #

IsToggleButton ToggleButton Source #

IsContainer ToggleButton Source #

IsButton ToggleButton Source #

IsBin ToggleButton Source #

IsBuildable ToggleButton Source #

IsActivatable ToggleButton Source #

IsActionable ToggleButton Source #

((~) * info (ResolveToggleButtonMethod t ToggleButton), MethodInfo * info ToggleButton p) => IsLabel t (ToggleButton -> p) Source #
Methods fromLabel :: Proxy# Symbol t -> ToggleButton -> p #
((~) * info (ResolveToggleButtonMethod t ToggleButton), MethodInfo * info ToggleButton p) => IsLabelProxy t (ToggleButton -> p) Source #
Methods fromLabelProxy :: Proxy Symbol t -> ToggleButton -> p #
HasAttributeList * ToggleButton Source #

type AttributeList ToggleButton Source #
type AttributeList ToggleButton
type SignalList ToggleButton Source #
type SignalList ToggleButton

class GObject o => IsToggleButton o Source #

toToggleButton :: IsToggleButton o => o -> IO ToggleButton Source #

noToggleButton :: Maybe ToggleButton Source #

Methods

getActive

data ToggleButtonGetActiveMethodInfo Source #

Instances

((~) * signature (m Bool), MonadIO m, IsToggleButton a) => MethodInfo * ToggleButtonGetActiveMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ToggleButtonGetActiveMethodInfo a -> signature -> s #

toggleButtonGetActive Source #

Arguments

:: (HasCallStack, MonadIO m, IsToggleButton a)
=> a	`toggleButton`: a `ToggleButton`.
-> m Bool	Returns: a `Bool` value.

Queries a ToggleButton and returns its current state. Returns True if the toggle button is pressed in and False if it is raised.

getInconsistent

data ToggleButtonGetInconsistentMethodInfo Source #

Instances

((~) * signature (m Bool), MonadIO m, IsToggleButton a) => MethodInfo * ToggleButtonGetInconsistentMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ToggleButtonGetInconsistentMethodInfo a -> signature -> s #

toggleButtonGetInconsistent Source #

Arguments

:: (HasCallStack, MonadIO m, IsToggleButton a)
=> a	`toggleButton`: a `ToggleButton`
-> m Bool	Returns: `True` if the button is displayed as inconsistent, `False` otherwise

Gets the value set by toggleButtonSetInconsistent.

getMode

data ToggleButtonGetModeMethodInfo Source #

Instances

((~) * signature (m Bool), MonadIO m, IsToggleButton a) => MethodInfo * ToggleButtonGetModeMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ToggleButtonGetModeMethodInfo a -> signature -> s #

toggleButtonGetMode Source #

Arguments

:: (HasCallStack, MonadIO m, IsToggleButton a)
=> a	`toggleButton`: a `ToggleButton`
-> m Bool	Returns: `True` if the togglebutton is drawn as a separate indicator and label.

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

new

toggleButtonNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m ToggleButton	Returns: a new toggle button.

Creates a new toggle button. A widget should be packed into the button, as in buttonNew.

newWithLabel

toggleButtonNewWithLabel Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Text	`label`: a string containing the message to be placed in the toggle button.
-> m ToggleButton	Returns: a new toggle button.

Creates a new toggle button with a text label.

newWithMnemonic

toggleButtonNewWithMnemonic Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Text	`label`: the text of the button, with an underscore in front of the mnemonic character
-> m ToggleButton	Returns: a new `ToggleButton`

Creates a new ToggleButton containing a label. The label will be created using labelNewWithMnemonic, so underscores in label indicate the mnemonic for the button.

setActive

data ToggleButtonSetActiveMethodInfo Source #

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsToggleButton a) => MethodInfo * ToggleButtonSetActiveMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ToggleButtonSetActiveMethodInfo a -> signature -> s #

toggleButtonSetActive Source #

Arguments

:: (HasCallStack, MonadIO m, IsToggleButton a)
=> a	`toggleButton`: a `ToggleButton`.
-> Bool	`isActive`: `True` or `False`.
-> m ()

Sets the status of the toggle button. Set to True if you want the GtkToggleButton to be “pressed in”, and False to raise it. This action causes the ToggleButton::toggled signal and the Button::clicked signal to be emitted.

setInconsistent

data ToggleButtonSetInconsistentMethodInfo Source #

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsToggleButton a) => MethodInfo * ToggleButtonSetInconsistentMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ToggleButtonSetInconsistentMethodInfo a -> signature -> s #

toggleButtonSetInconsistent Source #

Arguments

:: (HasCallStack, MonadIO m, IsToggleButton a)
=> a	`toggleButton`: a `ToggleButton`
-> Bool	`setting`: `True` if state is inconsistent
-> m ()

If the user has selected a range of elements (such as some text or spreadsheet cells) that are affected by a toggle button, and the current values in that range are inconsistent, you may want to display the toggle in an “in between” state. This function turns on “in between” display. Normally you would turn off the inconsistent state again if the user toggles the toggle button. This has to be done manually, toggleButtonSetInconsistent only affects visual appearance, it doesn’t affect the semantics of the button.

setMode

data ToggleButtonSetModeMethodInfo Source #

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsToggleButton a) => MethodInfo * ToggleButtonSetModeMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ToggleButtonSetModeMethodInfo a -> signature -> s #

toggleButtonSetMode Source #

Arguments

:: (HasCallStack, MonadIO m, IsToggleButton a)
=> a	`toggleButton`: a `ToggleButton`
-> Bool	`drawIndicator`: if `True`, draw the button as a separate indicator and label; if `False`, draw the button like a normal button
-> m ()

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

This can be used to create linked strip of buttons that work like a StackSwitcher.

This function only affects instances of classes like CheckButton and RadioButton that derive from ToggleButton, not instances of ToggleButton itself.

toggled

data ToggleButtonToggledMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m, IsToggleButton a) => MethodInfo * ToggleButtonToggledMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ToggleButtonToggledMethodInfo a -> signature -> s #

toggleButtonToggled Source #

Arguments

:: (HasCallStack, MonadIO m, IsToggleButton a)
=> a	`toggleButton`: a `ToggleButton`.
-> m ()

Emits the ToggleButton::toggled signal on the ToggleButton. There is no good reason for an application ever to call this function.

Properties

active

data ToggleButtonActivePropertyInfo Source #

Instances

AttrInfo ToggleButtonActivePropertyInfo Source #
Associated Types type AttrAllowedOps ToggleButtonActivePropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint ToggleButtonActivePropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint ToggleButtonActivePropertyInfo :: * -> Constraint # type AttrGetType ToggleButtonActivePropertyInfo :: * # type AttrLabel ToggleButtonActivePropertyInfo :: Symbol # type AttrOrigin ToggleButtonActivePropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint ToggleButtonActivePropertyInfo o => Proxy * ToggleButtonActivePropertyInfo -> o -> IO (AttrGetType ToggleButtonActivePropertyInfo) # attrSet :: (AttrBaseTypeConstraint ToggleButtonActivePropertyInfo o, AttrSetTypeConstraint ToggleButtonActivePropertyInfo b) => Proxy * ToggleButtonActivePropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint ToggleButtonActivePropertyInfo o => Proxy * ToggleButtonActivePropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint ToggleButtonActivePropertyInfo o, AttrSetTypeConstraint ToggleButtonActivePropertyInfo b) => Proxy * ToggleButtonActivePropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin ToggleButtonActivePropertyInfo Source #
type AttrOrigin ToggleButtonActivePropertyInfo = ToggleButton
type AttrLabel ToggleButtonActivePropertyInfo Source #
type AttrLabel ToggleButtonActivePropertyInfo = "active"
type AttrGetType ToggleButtonActivePropertyInfo Source #
type AttrGetType ToggleButtonActivePropertyInfo = Bool
type AttrBaseTypeConstraint ToggleButtonActivePropertyInfo Source #
type AttrBaseTypeConstraint ToggleButtonActivePropertyInfo = IsToggleButton
type AttrSetTypeConstraint ToggleButtonActivePropertyInfo Source #
type AttrSetTypeConstraint ToggleButtonActivePropertyInfo = * ~ Bool
type AttrAllowedOps ToggleButtonActivePropertyInfo Source #
type AttrAllowedOps ToggleButtonActivePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructToggleButtonActive :: IsToggleButton o => Bool -> IO (GValueConstruct o) Source #

getToggleButtonActive :: (MonadIO m, IsToggleButton o) => o -> m Bool Source #

setToggleButtonActive :: (MonadIO m, IsToggleButton o) => o -> Bool -> m () Source #

toggleButtonActive :: AttrLabelProxy "active" Source #

drawIndicator

data ToggleButtonDrawIndicatorPropertyInfo Source #

Instances

AttrInfo ToggleButtonDrawIndicatorPropertyInfo Source #
Associated Types type AttrAllowedOps ToggleButtonDrawIndicatorPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint ToggleButtonDrawIndicatorPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint ToggleButtonDrawIndicatorPropertyInfo :: * -> Constraint # type AttrGetType ToggleButtonDrawIndicatorPropertyInfo :: * # type AttrLabel ToggleButtonDrawIndicatorPropertyInfo :: Symbol # type AttrOrigin ToggleButtonDrawIndicatorPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint ToggleButtonDrawIndicatorPropertyInfo o => Proxy * ToggleButtonDrawIndicatorPropertyInfo -> o -> IO (AttrGetType ToggleButtonDrawIndicatorPropertyInfo) # attrSet :: (AttrBaseTypeConstraint ToggleButtonDrawIndicatorPropertyInfo o, AttrSetTypeConstraint ToggleButtonDrawIndicatorPropertyInfo b) => Proxy * ToggleButtonDrawIndicatorPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint ToggleButtonDrawIndicatorPropertyInfo o => Proxy * ToggleButtonDrawIndicatorPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint ToggleButtonDrawIndicatorPropertyInfo o, AttrSetTypeConstraint ToggleButtonDrawIndicatorPropertyInfo b) => Proxy * ToggleButtonDrawIndicatorPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin ToggleButtonDrawIndicatorPropertyInfo Source #
type AttrOrigin ToggleButtonDrawIndicatorPropertyInfo = ToggleButton
type AttrLabel ToggleButtonDrawIndicatorPropertyInfo Source #
type AttrLabel ToggleButtonDrawIndicatorPropertyInfo = "draw-indicator"
type AttrGetType ToggleButtonDrawIndicatorPropertyInfo Source #
type AttrGetType ToggleButtonDrawIndicatorPropertyInfo = Bool
type AttrBaseTypeConstraint ToggleButtonDrawIndicatorPropertyInfo Source #
type AttrBaseTypeConstraint ToggleButtonDrawIndicatorPropertyInfo = IsToggleButton
type AttrSetTypeConstraint ToggleButtonDrawIndicatorPropertyInfo Source #
type AttrSetTypeConstraint ToggleButtonDrawIndicatorPropertyInfo = * ~ Bool
type AttrAllowedOps ToggleButtonDrawIndicatorPropertyInfo Source #
type AttrAllowedOps ToggleButtonDrawIndicatorPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructToggleButtonDrawIndicator :: IsToggleButton o => Bool -> IO (GValueConstruct o) Source #

getToggleButtonDrawIndicator :: (MonadIO m, IsToggleButton o) => o -> m Bool Source #

setToggleButtonDrawIndicator :: (MonadIO m, IsToggleButton o) => o -> Bool -> m () Source #

toggleButtonDrawIndicator :: AttrLabelProxy "drawIndicator" Source #

inconsistent

data ToggleButtonInconsistentPropertyInfo Source #

Instances

AttrInfo ToggleButtonInconsistentPropertyInfo Source #
Associated Types type AttrAllowedOps ToggleButtonInconsistentPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint ToggleButtonInconsistentPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint ToggleButtonInconsistentPropertyInfo :: * -> Constraint # type AttrGetType ToggleButtonInconsistentPropertyInfo :: * # type AttrLabel ToggleButtonInconsistentPropertyInfo :: Symbol # type AttrOrigin ToggleButtonInconsistentPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint ToggleButtonInconsistentPropertyInfo o => Proxy * ToggleButtonInconsistentPropertyInfo -> o -> IO (AttrGetType ToggleButtonInconsistentPropertyInfo) # attrSet :: (AttrBaseTypeConstraint ToggleButtonInconsistentPropertyInfo o, AttrSetTypeConstraint ToggleButtonInconsistentPropertyInfo b) => Proxy * ToggleButtonInconsistentPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint ToggleButtonInconsistentPropertyInfo o => Proxy * ToggleButtonInconsistentPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint ToggleButtonInconsistentPropertyInfo o, AttrSetTypeConstraint ToggleButtonInconsistentPropertyInfo b) => Proxy * ToggleButtonInconsistentPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin ToggleButtonInconsistentPropertyInfo Source #
type AttrOrigin ToggleButtonInconsistentPropertyInfo = ToggleButton
type AttrLabel ToggleButtonInconsistentPropertyInfo Source #
type AttrLabel ToggleButtonInconsistentPropertyInfo = "inconsistent"
type AttrGetType ToggleButtonInconsistentPropertyInfo Source #
type AttrGetType ToggleButtonInconsistentPropertyInfo = Bool
type AttrBaseTypeConstraint ToggleButtonInconsistentPropertyInfo Source #
type AttrBaseTypeConstraint ToggleButtonInconsistentPropertyInfo = IsToggleButton
type AttrSetTypeConstraint ToggleButtonInconsistentPropertyInfo Source #
type AttrSetTypeConstraint ToggleButtonInconsistentPropertyInfo = * ~ Bool
type AttrAllowedOps ToggleButtonInconsistentPropertyInfo Source #
type AttrAllowedOps ToggleButtonInconsistentPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructToggleButtonInconsistent :: IsToggleButton o => Bool -> IO (GValueConstruct o) Source #

getToggleButtonInconsistent :: (MonadIO m, IsToggleButton o) => o -> m Bool Source #

setToggleButtonInconsistent :: (MonadIO m, IsToggleButton o) => o -> Bool -> m () Source #

toggleButtonInconsistent :: AttrLabelProxy "inconsistent" Source #

Signals

toggled

type C_ToggleButtonToggledCallback = Ptr () -> Ptr () -> IO () Source #

type ToggleButtonToggledCallback = IO () Source #

data ToggleButtonToggledSignalInfo Source #

Instances

SignalInfo ToggleButtonToggledSignalInfo Source #
Associated Types type HaskellCallbackType ToggleButtonToggledSignalInfo :: * # Methods connectSignal :: GObject o => SignalProxy o ToggleButtonToggledSignalInfo -> o -> HaskellCallbackType ToggleButtonToggledSignalInfo -> SignalConnectMode -> IO SignalHandlerId #
type HaskellCallbackType ToggleButtonToggledSignalInfo Source #
type HaskellCallbackType ToggleButtonToggledSignalInfo = ToggleButtonToggledCallback

afterToggleButtonToggled :: (GObject a, MonadIO m) => a -> ToggleButtonToggledCallback -> m SignalHandlerId Source #

genClosure_ToggleButtonToggled :: ToggleButtonToggledCallback -> IO Closure Source #

mk_ToggleButtonToggledCallback :: C_ToggleButtonToggledCallback -> IO (FunPtr C_ToggleButtonToggledCallback) Source #

noToggleButtonToggledCallback :: Maybe ToggleButtonToggledCallback Source #

onToggleButtonToggled :: (GObject a, MonadIO m) => a -> ToggleButtonToggledCallback -> m SignalHandlerId Source #

wrap_ToggleButtonToggledCallback :: ToggleButtonToggledCallback -> Ptr () -> Ptr () -> IO () Source #

(GObject a, UnknownAncestorError Constraint ToggleButton a) => IsToggleButton a Source #

IsToggleButton ToggleButton Source #

IsToggleButton RadioButton Source #

IsToggleButton CheckButton Source #

IsToggleButton MenuButton Source #