[Contents] [Back] [Prev] [Up] [Next] [Forward]

# Package Gtk.Check`_`Menu`_`Item

A Gtk_Check_Menu_Item is a menu item that maintains the state of a boolean value in addition to a Gtk_Menu_Item's usual role in activating application code.

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

- Gtk.Check_Menu_Item Widget Hierarchy
- Gtk.Check_Menu_Item Signals
- Gtk.Check_Menu_Item Subprograms

## Widget Hierarchy

    GObject                       (see section Package Glib.Object)
    Gtk_Object                    (see section Package Gtk.Object)
       \___ Gtk_Widget            (see section Package Gtk.Widget)
          \___ Gtk_Container      (see section Package Gtk.Container)
             \___ Gtk_Bin         (see section Package Gtk.Bin)
                \___ Gtk_Item     (see section Package Gtk.Item)
                   \___ Gtk_Menu_Item (see section Package Gtk.Menu_Item)
                      \___ Gtk_Check_Menu_Item (see section Package Gtk.Check_Menu_Item)

## Signals

- "toggled" procedure Handler
  (Check_Menu_Item : access Gtk_Check_Menu_Item_Record'Class);
  Emitted when the state of the check box is changed. A signal handler can call Get_Active to discover the new state.

## Subprograms

    procedure Gtk_New
      (Check_Menu_Item    : out    Gtk_Check_Menu_Item;
       Label              :        UTF8_String := "");

| Create a new Gtk_Check_Menu_Item with a label, if label isn't null.

    procedure Gtk_New_With_Mnemonic
      (Check_Menu_Item    : out    Gtk_Check_Menu_Item;
       Label              :        UTF8_String);

| Create a new Gtk_Check_Menu_Item containing a label. The label will be created will be created using Gtk.Label.New_With_Mnemonic, so underscores in the label indicate the mnemonic for the menu item.

    procedure Initialize_With_Mnemonic
      (Check_Menu_Item    : access Gtk_Check_Menu_Item_Record'Class;
       Label              :        UTF8_String);

| Internal initialization function. See the section "Creating your own widgets" in the documentation.

    function Get_Type              return Gtk.Gtk_Type;

| Return the internal value associated with a Gtk_Calendar.

    procedure Set_Active
      (Check_Menu_Item    : access Gtk_Check_Menu_Item_Record;
       Is_Active          :        Boolean);

| Set the active state of the menu item's check box.

    function Get_Active
      (Check_Menu_Item    : access Gtk_Check_Menu_Item_Record)
       return Boolean;

| Return True if the Item is active

    procedure Toggled
      (Check_Menu_Item    : access Gtk_Check_Menu_Item_Record);

| Emit the "toggled" signal.

    procedure Set_Inconsistent
      (Check_Menu_Item    : access Gtk_Check_Menu_Item_Record;
       Setting            :        Boolean);

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, Set_Inconsistent only affects visual appearance, it doesn't affect the semantics of the widget.

    function Get_Inconsistent
      (Check_Menu_Item    : access Gtk_Check_Menu_Item_Record)
       return Boolean;

| Return True if the Item is inconsistent.

[Contents] [Back] [Prev] [Up] [Next] [Forward]