GI.Gtk.Objects.Switch

Switch is a widget that has two states: on or off. The user can control which state should be active by clicking the empty area, or by dragging the handle.

GtkSwitch can also handle situations where the underlying state changes with a delay. See Switch::state-set for details.

CSS nodes

plain code

switch
╰── slider

GtkSwitch has two css nodes, the main node with the name switch and a subnode named slider. Neither of them is using any style classes.

Exported types

newtype Switch

Constructors

Switch (ManagedPtr Switch)

Instances

GObject Switch

Methods

gobjectType :: Switch -> IO GType

IsImplementorIface Switch

IsObject Switch

IsWidget Switch

IsBuildable Switch

IsActivatable Switch

IsActionable Switch

IsSwitch Switch

class GObject o => IsSwitch o

Instances

(GObject a, UnknownAncestorError Constraint Switch a) => IsSwitch a

IsSwitch Switch

toSwitch :: (MonadIO m, IsSwitch o) => o -> m Switch

noSwitch :: Maybe Switch

Methods

getActive

switchGetActive

Arguments

:: (HasCallStack, MonadIO m, IsSwitch a)

=> a

sw: a Switch

-> m Bool

Returns: True if the Switch is active, and False otherwise

Gets whether the Switch is in its “on” or “off” state.

Since: 3.0

getState

switchGetState

Arguments

:: (HasCallStack, MonadIO m, IsSwitch a)

=> a

sw: a Switch

-> m Bool

Returns: the underlying state

Gets the underlying state of the Switch.

Since: 3.14

new

switchNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Switch

Returns: the newly created Switch instance

Creates a new Switch widget.

Since: 3.0

setActive

switchSetActive

Arguments

:: (HasCallStack, MonadIO m, IsSwitch a)

=> a

sw: a Switch

-> Bool

isActive: True if sw should be active, and False otherwise

-> m ()

Changes the state of sw to the desired one.

Since: 3.0

setState

switchSetState

Arguments

:: (HasCallStack, MonadIO m, IsSwitch a)

=> a

sw: a Switch

-> Bool

state: the new state

-> m ()

Sets the underlying state of the Switch.

Normally, this is the same as Switch:active, unless the switch is set up for delayed state changes. This function is typically called from a Switch::state-set signal handler.

See Switch::state-set for details.

Since: 3.14

Properties

active

constructSwitchActive :: IsSwitch o => Bool -> IO (GValueConstruct o)

getSwitchActive :: (MonadIO m, IsSwitch o) => o -> m Bool

setSwitchActive :: (MonadIO m, IsSwitch o) => o -> Bool -> m ()

state

constructSwitchState :: IsSwitch o => Bool -> IO (GValueConstruct o)

getSwitchState :: (MonadIO m, IsSwitch o) => o -> m Bool

setSwitchState :: (MonadIO m, IsSwitch o) => o -> Bool -> m ()

Signals

activate

type C_SwitchActivateCallback = Ptr () -> Ptr () -> IO ()

type SwitchActivateCallback = IO ()

afterSwitchActivate :: (IsSwitch a, MonadIO m) => a -> SwitchActivateCallback -> m SignalHandlerId

genClosure_SwitchActivate :: SwitchActivateCallback -> IO Closure

mk_SwitchActivateCallback :: C_SwitchActivateCallback -> IO (FunPtr C_SwitchActivateCallback)

noSwitchActivateCallback :: Maybe SwitchActivateCallback

onSwitchActivate :: (IsSwitch a, MonadIO m) => a -> SwitchActivateCallback -> m SignalHandlerId

wrap_SwitchActivateCallback :: SwitchActivateCallback -> Ptr () -> Ptr () -> IO ()

stateSet

type C_SwitchStateSetCallback = Ptr () -> CInt -> Ptr () -> IO CInt

type SwitchStateSetCallback = Bool -> IO Bool

afterSwitchStateSet :: (IsSwitch a, MonadIO m) => a -> SwitchStateSetCallback -> m SignalHandlerId

genClosure_SwitchStateSet :: SwitchStateSetCallback -> IO Closure

mk_SwitchStateSetCallback :: C_SwitchStateSetCallback -> IO (FunPtr C_SwitchStateSetCallback)

noSwitchStateSetCallback :: Maybe SwitchStateSetCallback

onSwitchStateSet :: (IsSwitch a, MonadIO m) => a -> SwitchStateSetCallback -> m SignalHandlerId

wrap_SwitchStateSetCallback :: SwitchStateSetCallback -> Ptr () -> CInt -> Ptr () -> IO CInt