GI.Gtk.Objects.CheckMenuItem

A CheckMenuItem is a menu item that maintains the state of a boolean value in addition to a MenuItem usual role in activating application code.

A check box indicating the state of the boolean value is displayed at the left side of the MenuItem. Activating the MenuItem toggles the value.

CSS nodes

plain code

menuitem
├── check.left
╰── <child>

GtkCheckMenuItem has a main CSS node with name menuitem, and a subnode with name check, which gets the .left or .right style class.

Exported types

newtype CheckMenuItem

Constructors

CheckMenuItem (ManagedPtr CheckMenuItem)

Instances

GObject CheckMenuItem

Methods

gobjectType :: CheckMenuItem -> IO GType

IsImplementorIface CheckMenuItem

IsObject CheckMenuItem

IsWidget CheckMenuItem

IsMenuItem CheckMenuItem

IsContainer CheckMenuItem

IsCheckMenuItem CheckMenuItem

IsBin CheckMenuItem

IsBuildable CheckMenuItem

IsActivatable CheckMenuItem

IsActionable CheckMenuItem

((~) * info (ResolveCheckMenuItemMethod t CheckMenuItem), MethodInfo * info CheckMenuItem p) => IsLabel t (CheckMenuItem -> p)

Methods

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

((~) * info (ResolveCheckMenuItemMethod t CheckMenuItem), MethodInfo * info CheckMenuItem p) => IsLabelProxy t (CheckMenuItem -> p)

Methods

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

HasAttributeList * CheckMenuItem

type AttributeList CheckMenuItem

type AttributeList CheckMenuItem

type SignalList CheckMenuItem

type SignalList CheckMenuItem

class GObject o => IsCheckMenuItem o

Instances

(GObject a, UnknownAncestorError Constraint CheckMenuItem a) => IsCheckMenuItem a

IsCheckMenuItem CheckMenuItem

IsCheckMenuItem RadioMenuItem

toCheckMenuItem :: IsCheckMenuItem o => o -> IO CheckMenuItem

noCheckMenuItem :: Maybe CheckMenuItem

Methods

getActive

data CheckMenuItemGetActiveMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsCheckMenuItem a) => MethodInfo * CheckMenuItemGetActiveMethodInfo a signature

Methods

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

checkMenuItemGetActive

Arguments

:: (HasCallStack, MonadIO m, IsCheckMenuItem a)

=> a

checkMenuItem: a CheckMenuItem

-> m Bool

Returns: True if the menu item is checked.

Returns whether the check menu item is active. See gtk_check_menu_item_set_active ().

getDrawAsRadio

data CheckMenuItemGetDrawAsRadioMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsCheckMenuItem a) => MethodInfo * CheckMenuItemGetDrawAsRadioMethodInfo a signature

Methods

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

checkMenuItemGetDrawAsRadio

Arguments

:: (HasCallStack, MonadIO m, IsCheckMenuItem a)

=> a

checkMenuItem: a CheckMenuItem

-> m Bool

Returns: Whether checkMenuItem looks like a RadioMenuItem

Returns whether checkMenuItem looks like a RadioMenuItem

Since: 2.4

getInconsistent

data CheckMenuItemGetInconsistentMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsCheckMenuItem a) => MethodInfo * CheckMenuItemGetInconsistentMethodInfo a signature

Methods

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

checkMenuItemGetInconsistent

Arguments

:: (HasCallStack, MonadIO m, IsCheckMenuItem a)

=> a

checkMenuItem: a CheckMenuItem

-> m Bool

Returns: True if inconsistent

Retrieves the value set by checkMenuItemSetInconsistent.

new

checkMenuItemNew

Arguments

:: (HasCallStack, MonadIO m)

=> m CheckMenuItem

Returns: a new CheckMenuItem.

Creates a new CheckMenuItem.

newWithLabel

checkMenuItemNewWithLabel

Arguments

:: (HasCallStack, MonadIO m)

=> Text

label: the string to use for the label.

-> m CheckMenuItem

Returns: a new CheckMenuItem.

Creates a new CheckMenuItem with a label.

newWithMnemonic

checkMenuItemNewWithMnemonic

Arguments

:: (HasCallStack, MonadIO m)

=> Text

label: The text of the button, with an underscore in front of the character

-> m CheckMenuItem

Returns: a new CheckMenuItem

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

setActive

data CheckMenuItemSetActiveMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsCheckMenuItem a) => MethodInfo * CheckMenuItemSetActiveMethodInfo a signature

Methods

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

checkMenuItemSetActive

Arguments

:: (HasCallStack, MonadIO m, IsCheckMenuItem a)

=> a

checkMenuItem: a CheckMenuItem.

-> Bool

isActive: boolean value indicating whether the check box is active.

-> m ()

Sets the active state of the menu item’s check box.

setDrawAsRadio

data CheckMenuItemSetDrawAsRadioMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsCheckMenuItem a) => MethodInfo * CheckMenuItemSetDrawAsRadioMethodInfo a signature

Methods

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

checkMenuItemSetDrawAsRadio

Arguments

:: (HasCallStack, MonadIO m, IsCheckMenuItem a)

=> a

checkMenuItem: a CheckMenuItem

-> Bool

drawAsRadio: whether checkMenuItem is drawn like a RadioMenuItem

-> m ()

Sets whether checkMenuItem is drawn like a RadioMenuItem

Since: 2.4

setInconsistent

data CheckMenuItemSetInconsistentMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsCheckMenuItem a) => MethodInfo * CheckMenuItemSetInconsistentMethodInfo a signature

Methods

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

checkMenuItemSetInconsistent

Arguments

:: (HasCallStack, MonadIO m, IsCheckMenuItem a)

=> a

checkMenuItem: a CheckMenuItem

-> Bool

setting: True to display an “inconsistent” third state check

-> m ()

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

toggled

data CheckMenuItemToggledMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsCheckMenuItem a) => MethodInfo * CheckMenuItemToggledMethodInfo a signature

Methods

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

checkMenuItemToggled

Arguments

:: (HasCallStack, MonadIO m, IsCheckMenuItem a)

=> a

checkMenuItem: a CheckMenuItem.

-> m ()

Emits the CheckMenuItem::toggled signal.

Properties

active

data CheckMenuItemActivePropertyInfo

Instances

AttrInfo CheckMenuItemActivePropertyInfo

Associated Types

type AttrAllowedOps CheckMenuItemActivePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint CheckMenuItemActivePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint CheckMenuItemActivePropertyInfo :: * -> Constraint

type AttrGetType CheckMenuItemActivePropertyInfo :: *

type AttrLabel CheckMenuItemActivePropertyInfo :: Symbol

type AttrOrigin CheckMenuItemActivePropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin CheckMenuItemActivePropertyInfo

type AttrOrigin CheckMenuItemActivePropertyInfo = CheckMenuItem

type AttrLabel CheckMenuItemActivePropertyInfo

type AttrLabel CheckMenuItemActivePropertyInfo = "active"

type AttrGetType CheckMenuItemActivePropertyInfo

type AttrGetType CheckMenuItemActivePropertyInfo = Bool

type AttrBaseTypeConstraint CheckMenuItemActivePropertyInfo

type AttrBaseTypeConstraint CheckMenuItemActivePropertyInfo = IsCheckMenuItem

type AttrSetTypeConstraint CheckMenuItemActivePropertyInfo

type AttrSetTypeConstraint CheckMenuItemActivePropertyInfo = * ~ Bool

type AttrAllowedOps CheckMenuItemActivePropertyInfo

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

checkMenuItemActive :: AttrLabelProxy "active"

constructCheckMenuItemActive :: IsCheckMenuItem o => Bool -> IO (GValueConstruct o)

getCheckMenuItemActive :: (MonadIO m, IsCheckMenuItem o) => o -> m Bool

setCheckMenuItemActive :: (MonadIO m, IsCheckMenuItem o) => o -> Bool -> m ()

drawAsRadio

data CheckMenuItemDrawAsRadioPropertyInfo

Instances

AttrInfo CheckMenuItemDrawAsRadioPropertyInfo

Associated Types

type AttrAllowedOps CheckMenuItemDrawAsRadioPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint CheckMenuItemDrawAsRadioPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint CheckMenuItemDrawAsRadioPropertyInfo :: * -> Constraint

type AttrGetType CheckMenuItemDrawAsRadioPropertyInfo :: *

type AttrLabel CheckMenuItemDrawAsRadioPropertyInfo :: Symbol

type AttrOrigin CheckMenuItemDrawAsRadioPropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin CheckMenuItemDrawAsRadioPropertyInfo

type AttrOrigin CheckMenuItemDrawAsRadioPropertyInfo = CheckMenuItem

type AttrLabel CheckMenuItemDrawAsRadioPropertyInfo

type AttrLabel CheckMenuItemDrawAsRadioPropertyInfo = "draw-as-radio"

type AttrGetType CheckMenuItemDrawAsRadioPropertyInfo

type AttrGetType CheckMenuItemDrawAsRadioPropertyInfo = Bool

type AttrBaseTypeConstraint CheckMenuItemDrawAsRadioPropertyInfo

type AttrBaseTypeConstraint CheckMenuItemDrawAsRadioPropertyInfo = IsCheckMenuItem

type AttrSetTypeConstraint CheckMenuItemDrawAsRadioPropertyInfo

type AttrSetTypeConstraint CheckMenuItemDrawAsRadioPropertyInfo = * ~ Bool

type AttrAllowedOps CheckMenuItemDrawAsRadioPropertyInfo

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

checkMenuItemDrawAsRadio :: AttrLabelProxy "drawAsRadio"

constructCheckMenuItemDrawAsRadio :: IsCheckMenuItem o => Bool -> IO (GValueConstruct o)

getCheckMenuItemDrawAsRadio :: (MonadIO m, IsCheckMenuItem o) => o -> m Bool

setCheckMenuItemDrawAsRadio :: (MonadIO m, IsCheckMenuItem o) => o -> Bool -> m ()

inconsistent

data CheckMenuItemInconsistentPropertyInfo

Instances

AttrInfo CheckMenuItemInconsistentPropertyInfo

Associated Types

type AttrAllowedOps CheckMenuItemInconsistentPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint CheckMenuItemInconsistentPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint CheckMenuItemInconsistentPropertyInfo :: * -> Constraint

type AttrGetType CheckMenuItemInconsistentPropertyInfo :: *

type AttrLabel CheckMenuItemInconsistentPropertyInfo :: Symbol

type AttrOrigin CheckMenuItemInconsistentPropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin CheckMenuItemInconsistentPropertyInfo

type AttrOrigin CheckMenuItemInconsistentPropertyInfo = CheckMenuItem

type AttrLabel CheckMenuItemInconsistentPropertyInfo

type AttrLabel CheckMenuItemInconsistentPropertyInfo = "inconsistent"

type AttrGetType CheckMenuItemInconsistentPropertyInfo

type AttrGetType CheckMenuItemInconsistentPropertyInfo = Bool

type AttrBaseTypeConstraint CheckMenuItemInconsistentPropertyInfo

type AttrBaseTypeConstraint CheckMenuItemInconsistentPropertyInfo = IsCheckMenuItem

type AttrSetTypeConstraint CheckMenuItemInconsistentPropertyInfo

type AttrSetTypeConstraint CheckMenuItemInconsistentPropertyInfo = * ~ Bool

type AttrAllowedOps CheckMenuItemInconsistentPropertyInfo

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

checkMenuItemInconsistent :: AttrLabelProxy "inconsistent"

constructCheckMenuItemInconsistent :: IsCheckMenuItem o => Bool -> IO (GValueConstruct o)

getCheckMenuItemInconsistent :: (MonadIO m, IsCheckMenuItem o) => o -> m Bool

setCheckMenuItemInconsistent :: (MonadIO m, IsCheckMenuItem o) => o -> Bool -> m ()

Signals

toggled

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

type CheckMenuItemToggledCallback = IO ()

data CheckMenuItemToggledSignalInfo

Instances

SignalInfo CheckMenuItemToggledSignalInfo

Associated Types

type HaskellCallbackType CheckMenuItemToggledSignalInfo :: *

Methods

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

type HaskellCallbackType CheckMenuItemToggledSignalInfo

type HaskellCallbackType CheckMenuItemToggledSignalInfo = CheckMenuItemToggledCallback

afterCheckMenuItemToggled :: (GObject a, MonadIO m) => a -> CheckMenuItemToggledCallback -> m SignalHandlerId

genClosure_CheckMenuItemToggled :: CheckMenuItemToggledCallback -> IO Closure

mk_CheckMenuItemToggledCallback :: C_CheckMenuItemToggledCallback -> IO (FunPtr C_CheckMenuItemToggledCallback)

noCheckMenuItemToggledCallback :: Maybe CheckMenuItemToggledCallback

onCheckMenuItemToggled :: (GObject a, MonadIO m) => a -> CheckMenuItemToggledCallback -> m SignalHandlerId

wrap_CheckMenuItemToggledCallback :: CheckMenuItemToggledCallback -> Ptr () -> Ptr () -> IO ()