GtkCheckMenuItem

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.

gtk_check_menu_item_new ()

GtkWidget *
gtk_check_menu_item_new (void);

Creates a new GtkCheckMenuItem.

gtk_check_menu_item_new_with_label ()

GtkWidget *
gtk_check_menu_item_new_with_label (const gchar *label);

Creates a new GtkCheckMenuItem with a label.

gtk_check_menu_item_new_with_mnemonic ()

GtkWidget *
gtk_check_menu_item_new_with_mnemonic (const gchar *label);

Creates a new GtkCheckMenuItem containing a label. The label will be created using gtk_label_new_with_mnemonic(), so underscores in label indicate the mnemonic for the menu item.

gtk_check_menu_item_get_active ()

gboolean
gtk_check_menu_item_get_active (GtkCheckMenuItem *check_menu_item);

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

gtk_check_menu_item_set_active ()

void
gtk_check_menu_item_set_active (GtkCheckMenuItem *check_menu_item,
                                gboolean is_active);

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

gtk_check_menu_item_toggled ()

void
gtk_check_menu_item_toggled (GtkCheckMenuItem *check_menu_item);

Emits the “toggled” signal.

gtk_check_menu_item_get_inconsistent ()

gboolean
gtk_check_menu_item_get_inconsistent (GtkCheckMenuItem *check_menu_item);

Retrieves the value set by gtk_check_menu_item_set_inconsistent().

gtk_check_menu_item_set_inconsistent ()

void
gtk_check_menu_item_set_inconsistent (GtkCheckMenuItem *check_menu_item,
                                      gboolean 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.

gtk_check_menu_item_set_draw_as_radio ()

void
gtk_check_menu_item_set_draw_as_radio (GtkCheckMenuItem *check_menu_item,
                                       gboolean draw_as_radio);

Sets whether check_menu_item is drawn like a GtkRadioMenuItem

Since: 2.4

gtk_check_menu_item_get_draw_as_radio ()

gboolean
gtk_check_menu_item_get_draw_as_radio (GtkCheckMenuItem *check_menu_item);

Returns whether check_menu_item looks like a GtkRadioMenuItem

Since: 2.4

struct GtkCheckMenuItem

struct GtkCheckMenuItem;

struct GtkCheckMenuItemClass

struct GtkCheckMenuItemClass {
  GtkMenuItemClass parent_class;

  void (* toggled)	  (GtkCheckMenuItem *check_menu_item);
  void (* draw_indicator) (GtkCheckMenuItem *check_menu_item,
			   cairo_t          *cr);
};

The “active” property

  “active”                   gboolean

Whether the menu item is checked.

Owner: GtkCheckMenuItem

Flags: Read / Write

Default value: FALSE

The “draw-as-radio” property

  “draw-as-radio”            gboolean

Whether the menu item looks like a radio menu item.

Owner: GtkCheckMenuItem

Flags: Read / Write

Default value: FALSE

The “inconsistent” property

  “inconsistent”             gboolean

Whether to display an "inconsistent" state.

Owner: GtkCheckMenuItem

Flags: Read / Write

Default value: FALSE

The “indicator-size” style property

  “indicator-size”           int

The size of the check or radio indicator.

Owner: GtkCheckMenuItem

Flags: Read

Allowed values: >= 0

Default value: 16

The “toggled” signal

void
user_function (GtkCheckMenuItem *checkmenuitem,
               gpointer          user_data)

This signal is emitted when the state of the check box is changed.

A signal handler can use gtk_check_menu_item_get_active() to discover the new state.

Flags: Run First