CheckMenuItem

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

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

CSS nodes

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

class CheckMenuItem : MenuItem {

protected

GtkCheckMenuItem* gtkCheckMenuItem;

GtkCheckMenuItem* getCheckMenuItemStruct(bool transferOwnership);

void* getStruct();

this(GtkCheckMenuItem* gtkCheckMenuItem, bool ownedRef);

this(string label, bool mnemonic);

static GType getType();

this();

bool getActive();

bool getDrawAsRadio();

bool getInconsistent();

void setActive(bool isActive);

void setDrawAsRadio(bool drawAsRadio);

void setInconsistent(bool setting);

void toggled();

gulong addOnToggled(void delegate(CheckMenuItem) dlg, ConnectFlags connectFlags);

}

Constructors

this this(GtkCheckMenuItem* gtkCheckMenuItem, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(string label, bool mnemonic): Creates a new GtkCheckMenuItem with a label.
this this(): Creates a new #GtkCheckMenuItem.

Members

Functions

addOnToggled gulong addOnToggled(void delegate(CheckMenuItem) dlg, ConnectFlags connectFlags): This signal is emitted when the state of the check box is changed.
getActive bool getActive(): Returns whether the check menu item is active. See gtk_check_menu_item_set_active ().
getCheckMenuItemStruct GtkCheckMenuItem* getCheckMenuItemStruct(bool transferOwnership): Get the main Gtk struct
getDrawAsRadio bool getDrawAsRadio(): Returns whether @check_menu_item looks like a #GtkRadioMenuItem
getInconsistent bool getInconsistent(): Retrieves the value set by gtk_check_menu_item_set_inconsistent().
getStruct void* getStruct(): the main Gtk struct as a void*
setActive void setActive(bool isActive): Sets the active state of the menu item’s check box.
setDrawAsRadio void setDrawAsRadio(bool drawAsRadio): Sets whether @check_menu_item is drawn like a #GtkRadioMenuItem
setInconsistent void setInconsistent(bool setting): 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, gtk_check_menu_item_set_inconsistent() only affects visual appearance, it doesn’t affect the semantics of the widget.
toggled void toggled(): Emits the #GtkCheckMenuItem::toggled signal.

Static functions

getType GType getType()

Variables

gtkCheckMenuItem GtkCheckMenuItem* gtkCheckMenuItem;: the main Gtk struct

Inherited Members

From MenuItem

gtkMenuItem GtkMenuItem* gtkMenuItem;: the main Gtk struct
getMenuItemStruct GtkMenuItem* getMenuItemStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
__anonymous mixin ActionableT!(GtkMenuItem): Undocumented in source.
__anonymous mixin ActivatableT!(GtkMenuItem): Undocumented in source.
getActionName string getActionName(): Gets the application set action code
getType GType getType()
itemActivate void itemActivate(): Emits the #GtkMenuItem::activate signal on the given item
deselect void deselect(): Emits the #GtkMenuItem::deselect signal on the given item.
getAccelPath string getAccelPath(): Retrieve the accelerator path that was previously set on @menu_item.
getLabel string getLabel(): Sets @text on the @menu_item label
getReserveIndicator bool getReserveIndicator(): Returns whether the @menu_item reserves space for the submenu indicator, regardless if it has a submenu or not.
getRightJustified bool getRightJustified(): Gets whether the menu item appears justified at the right side of the menu bar.
getSubmenu Widget getSubmenu(): Gets the submenu underneath this menu item, if any. See gtk_menu_item_set_submenu().
getUseUnderline bool getUseUnderline(): Checks if an underline in the text indicates the next character should be used for the mnemonic accelerator key.
select void select(): Emits the #GtkMenuItem::select signal on the given item.
setAccelPath void setAccelPath(string accelPath): Set the accelerator path on @menu_item, through which runtime changes of the menu item’s accelerator caused by the user can be identified and saved to persistent storage (see gtk_accel_map_save() on this). To set up a default accelerator for this menu item, call gtk_accel_map_add_entry() with the same @accel_path. See also gtk_accel_map_add_entry() on the specifics of accelerator paths, and gtk_menu_set_accel_path() for a more convenient variant of this function.
setLabel void setLabel(string label): Sets @text on the @menu_item label
setReserveIndicator void setReserveIndicator(bool reserve): Sets whether the @menu_item should reserve space for the submenu indicator, regardless if it actually has a submenu or not.
setRightJustified void setRightJustified(bool rightJustified): Sets whether the menu item appears justified at the right side of a menu bar. This was traditionally done for “Help” menu items, but is now considered a bad idea. (If the widget layout is reversed for a right-to-left language like Hebrew or Arabic, right-justified-menu-items appear at the left.)
setSubmenu void setSubmenu(Menu submenu): Sets or replaces the menu item’s submenu, or removes it when a %NULL submenu is passed.
setUseUnderline void setUseUnderline(bool setting): If true, an underline in the text indicates the next character should be used for the mnemonic accelerator key.
toggleSizeAllocate void toggleSizeAllocate(int allocation): Emits the #GtkMenuItem::toggle-size-allocate signal on the given item.
toggleSizeRequest void toggleSizeRequest(int requisition): Emits the #GtkMenuItem::toggle-size-request signal on the given item.
addOnActivate gulong addOnActivate(void delegate(MenuItem) dlg, ConnectFlags connectFlags): Emitted when the item is activated.
addOnActivateItem gulong addOnActivateItem(void delegate(MenuItem) dlg, ConnectFlags connectFlags): Emitted when the item is activated, but also if the menu item has a submenu. For normal applications, the relevant signal is #GtkMenuItem::activate.
addOnDeselect gulong addOnDeselect(void delegate(MenuItem) dlg, ConnectFlags connectFlags)
addOnSelect gulong addOnSelect(void delegate(MenuItem) dlg, ConnectFlags connectFlags)
addOnToggleSizeAllocate gulong addOnToggleSizeAllocate(void delegate(int, MenuItem) dlg, ConnectFlags connectFlags)
addOnToggleSizeRequest gulong addOnToggleSizeRequest(void delegate(void*, MenuItem) dlg, ConnectFlags connectFlags)