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

((~) * info (ResolveSwitchMethod t Switch), MethodInfo * info Switch p) => IsLabel t (Switch -> p)

Methods

fromLabel :: Proxy# Symbol t -> Switch -> p

((~) * info (ResolveSwitchMethod t Switch), MethodInfo * info Switch p) => IsLabelProxy t (Switch -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Switch -> p

HasAttributeList * Switch

type AttributeList Switch

type AttributeList Switch

type SignalList Switch

type SignalList Switch

class GObject o => IsSwitch o

Instances

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

IsSwitch Switch

toSwitch :: IsSwitch o => o -> IO Switch

noSwitch :: Maybe Switch

Methods

getActive

data SwitchGetActiveMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsSwitch a) => MethodInfo * SwitchGetActiveMethodInfo a signature

Methods

overloadedMethod :: MethodProxy SwitchGetActiveMethodInfo a -> signature -> s

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

data SwitchGetStateMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsSwitch a) => MethodInfo * SwitchGetStateMethodInfo a signature

Methods

overloadedMethod :: MethodProxy SwitchGetStateMethodInfo a -> signature -> s

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

data SwitchSetActiveMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsSwitch a) => MethodInfo * SwitchSetActiveMethodInfo a signature

Methods

overloadedMethod :: MethodProxy SwitchSetActiveMethodInfo a -> signature -> s

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

data SwitchSetStateMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsSwitch a) => MethodInfo * SwitchSetStateMethodInfo a signature

Methods

overloadedMethod :: MethodProxy SwitchSetStateMethodInfo a -> signature -> s

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

data SwitchActivePropertyInfo

Instances

AttrInfo SwitchActivePropertyInfo

Associated Types

type AttrAllowedOps SwitchActivePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint SwitchActivePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint SwitchActivePropertyInfo :: * -> Constraint

type AttrGetType SwitchActivePropertyInfo :: *

type AttrLabel SwitchActivePropertyInfo :: Symbol

type AttrOrigin SwitchActivePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint SwitchActivePropertyInfo o => Proxy * SwitchActivePropertyInfo -> o -> IO (AttrGetType SwitchActivePropertyInfo)

attrSet :: (AttrBaseTypeConstraint SwitchActivePropertyInfo o, AttrSetTypeConstraint SwitchActivePropertyInfo b) => Proxy * SwitchActivePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint SwitchActivePropertyInfo o => Proxy * SwitchActivePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint SwitchActivePropertyInfo o, AttrSetTypeConstraint SwitchActivePropertyInfo b) => Proxy * SwitchActivePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin SwitchActivePropertyInfo

type AttrOrigin SwitchActivePropertyInfo = Switch

type AttrLabel SwitchActivePropertyInfo

type AttrLabel SwitchActivePropertyInfo = "active"

type AttrGetType SwitchActivePropertyInfo

type AttrGetType SwitchActivePropertyInfo = Bool

type AttrBaseTypeConstraint SwitchActivePropertyInfo

type AttrBaseTypeConstraint SwitchActivePropertyInfo = IsSwitch

type AttrSetTypeConstraint SwitchActivePropertyInfo

type AttrSetTypeConstraint SwitchActivePropertyInfo = * ~ Bool

type AttrAllowedOps SwitchActivePropertyInfo

type AttrAllowedOps SwitchActivePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

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

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

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

switchActive :: AttrLabelProxy "active"

state

data SwitchStatePropertyInfo

Instances

AttrInfo SwitchStatePropertyInfo

Associated Types

type AttrAllowedOps SwitchStatePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint SwitchStatePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint SwitchStatePropertyInfo :: * -> Constraint

type AttrGetType SwitchStatePropertyInfo :: *

type AttrLabel SwitchStatePropertyInfo :: Symbol

type AttrOrigin SwitchStatePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint SwitchStatePropertyInfo o => Proxy * SwitchStatePropertyInfo -> o -> IO (AttrGetType SwitchStatePropertyInfo)

attrSet :: (AttrBaseTypeConstraint SwitchStatePropertyInfo o, AttrSetTypeConstraint SwitchStatePropertyInfo b) => Proxy * SwitchStatePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint SwitchStatePropertyInfo o => Proxy * SwitchStatePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint SwitchStatePropertyInfo o, AttrSetTypeConstraint SwitchStatePropertyInfo b) => Proxy * SwitchStatePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin SwitchStatePropertyInfo

type AttrOrigin SwitchStatePropertyInfo = Switch

type AttrLabel SwitchStatePropertyInfo

type AttrLabel SwitchStatePropertyInfo = "state"

type AttrGetType SwitchStatePropertyInfo

type AttrGetType SwitchStatePropertyInfo = Bool

type AttrBaseTypeConstraint SwitchStatePropertyInfo

type AttrBaseTypeConstraint SwitchStatePropertyInfo = IsSwitch

type AttrSetTypeConstraint SwitchStatePropertyInfo

type AttrSetTypeConstraint SwitchStatePropertyInfo = * ~ Bool

type AttrAllowedOps SwitchStatePropertyInfo

type AttrAllowedOps SwitchStatePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

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

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

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

switchState :: AttrLabelProxy "state"

Signals

activate

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

type SwitchActivateCallback = IO ()

data SwitchActivateSignalInfo

Instances

SignalInfo SwitchActivateSignalInfo

Associated Types

type HaskellCallbackType SwitchActivateSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o SwitchActivateSignalInfo -> o -> HaskellCallbackType SwitchActivateSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType SwitchActivateSignalInfo

type HaskellCallbackType SwitchActivateSignalInfo = SwitchActivateCallback

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

genClosure_SwitchActivate :: SwitchActivateCallback -> IO Closure

mk_SwitchActivateCallback :: C_SwitchActivateCallback -> IO (FunPtr C_SwitchActivateCallback)

noSwitchActivateCallback :: Maybe SwitchActivateCallback

onSwitchActivate :: (GObject 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

data SwitchStateSetSignalInfo

Instances

SignalInfo SwitchStateSetSignalInfo

Associated Types

type HaskellCallbackType SwitchStateSetSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o SwitchStateSetSignalInfo -> o -> HaskellCallbackType SwitchStateSetSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType SwitchStateSetSignalInfo

type HaskellCallbackType SwitchStateSetSignalInfo = SwitchStateSetCallback

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

genClosure_SwitchStateSet :: SwitchStateSetCallback -> IO Closure

mk_SwitchStateSetCallback :: C_SwitchStateSetCallback -> IO (FunPtr C_SwitchStateSetCallback)

noSwitchStateSetCallback :: Maybe SwitchStateSetCallback

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

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