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

class GObject o => IsCheckMenuItem o

Instances

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

IsCheckMenuItem CheckMenuItem

IsCheckMenuItem RadioMenuItem

toCheckMenuItem :: (MonadIO m, IsCheckMenuItem o) => o -> m CheckMenuItem

noCheckMenuItem :: Maybe CheckMenuItem

Methods

getActive

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

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

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

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

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

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

checkMenuItemToggled

Arguments

:: (HasCallStack, MonadIO m, IsCheckMenuItem a)

=> a

checkMenuItem: a CheckMenuItem.

-> m ()

Emits the CheckMenuItem::toggled signal.

Properties

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

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

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

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

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 ()

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

genClosure_CheckMenuItemToggled :: CheckMenuItemToggledCallback -> IO Closure

mk_CheckMenuItemToggledCallback :: C_CheckMenuItemToggledCallback -> IO (FunPtr C_CheckMenuItemToggledCallback)

noCheckMenuItemToggledCallback :: Maybe CheckMenuItemToggledCallback

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

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