ImageMenuItem

Description A GtkImageMenuItem is a menu item which has an icon next to the text label. Note that the user can disable display of menu icons, so make sure to still fill in the text label.

Constructors

this
this(GtkImageMenuItem* gtkImageMenuItem)

Sets our main struct and passes it to the parent class

this
this(string label, bool mnemonic)

Creates a new GtkImageMenuItem containing a label. If mnemonic it true the label will be created using gtk_label_new_with_mnemonic(), so underscores in label indicate the mnemonic for the menu item.

this
this(StockID stockID, AccelGroup accelGroup)

Creates a new GtkImageMenuItem containing the image and text from a stock item. Some stock ids have preprocessor macros like GTK_STOCK_OK and GTK_STOCK_APPLY. If you want this menu item to have changeable accelerators, then pass in NULL for accel_group. Next call gtk_menu_item_set_accel_path() with an appropriate path for the menu item, use gtk_stock_lookup() to look up the standard accelerator for the stock item, and if one is found, call gtk_accel_map_add_entry() to register it.

this
this()

Creates a new GtkImageMenuItem with an empty label.

Members

Functions

getAlwaysShowImage
int getAlwaysShowImage()

Returns whether the menu item will ignore the "gtk-menu-images" setting and always show the image, if available. Since 2.16

getImage
Widget getImage()

Gets the widget that is currently set as the image of image_menu_item. See gtk_image_menu_item_set_image().

getImageMenuItemStruct
GtkImageMenuItem* getImageMenuItemStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStruct
void* getStruct()

the main Gtk struct as a void*

getUseStock
int getUseStock()

Checks whether the label set in the menuitem is used as a stock id to select the stock item for the item. Since 2.16

setAccelGroup
void setAccelGroup(AccelGroup accelGroup)

Specifies an accel_group to add the menu items accelerator to (this only applies to stock items so a stock item must already be set, make sure to call gtk_image_menu_item_set_use_stock() and gtk_menu_item_set_label() with a valid stock item first). If you want this menu item to have changeable accelerators then you shouldnt need this (see gtk_image_menu_item_new_from_stock()). Since 2.16

setAlwaysShowImage
void setAlwaysShowImage(int alwaysShow)

If TRUE, the menu item will ignore the "gtk-menu-images" setting and always show the image, if available. Use this property if the menuitem would be useless or hard to use without the image. Since 2.16

setImage
void setImage(Widget image)

Sets the image of image_menu_item to the given widget. Note that it depends on the show-menu-images setting whether the image will be displayed or not.

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
setUseStock
void setUseStock(int useStock)

If TRUE, the label set in the menuitem is used as a stock id to select the stock item for the item. Since 2.16

Variables

gtkImageMenuItem
GtkImageMenuItem* gtkImageMenuItem;

the main Gtk struct

Inherited Members

From MenuItem

gtkMenuItem
GtkMenuItem* gtkMenuItem;

the main Gtk struct

getMenuItemStruct
GtkMenuItem* getMenuItemStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStruct
void* getStruct()

the main Gtk struct as a void*

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
__anonymous
mixin ActivatableT!(GtkMenuItem)
Undocumented in source.
getActionName
string getActionName()

Gets the application set action code

connectedSignals
int[string] connectedSignals;
onActivateListeners
void delegate(MenuItem)[] onActivateListeners;
Undocumented in source.
addOnActivate
void addOnActivate(void delegate(MenuItem) dlg, ConnectFlags connectFlags)

Emitted when the item is activated.

callBackActivate
void callBackActivate(GtkMenuItem* menuitemStruct, MenuItem _menuItem)
Undocumented in source. Be warned that the author may not have intended to support it.
onActivateItemListeners
void delegate(MenuItem)[] onActivateItemListeners;
Undocumented in source.
addOnActivateItem
void 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 "activate".

callBackActivateItem
void callBackActivateItem(GtkMenuItem* menuitemStruct, MenuItem _menuItem)
Undocumented in source. Be warned that the author may not have intended to support it.
onToggleSizeAllocateListeners
void delegate(gint, MenuItem)[] onToggleSizeAllocateListeners;
Undocumented in source.
addOnToggleSizeAllocate
void addOnToggleSizeAllocate(void delegate(gint, MenuItem) dlg, ConnectFlags connectFlags)
callBackToggleSizeAllocate
void callBackToggleSizeAllocate(GtkMenuItem* menuitemStruct, gint arg1, MenuItem _menuItem)
Undocumented in source. Be warned that the author may not have intended to support it.
onToggleSizeRequestListeners
void delegate(void*, MenuItem)[] onToggleSizeRequestListeners;
Undocumented in source.
addOnToggleSizeRequest
void addOnToggleSizeRequest(void delegate(void*, MenuItem) dlg, ConnectFlags connectFlags)

See Also GtkBin for how to handle the child. GtkItem is the abstract class for all sorts of items. GtkMenuShell is always the parent of GtkMenuItem.

callBackToggleSizeRequest
void callBackToggleSizeRequest(GtkMenuItem* menuitemStruct, void* arg1, MenuItem _menuItem)
Undocumented in source. Be warned that the author may not have intended to support it.
setRightJustified
void setRightJustified(int 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.)

getRightJustified
int getRightJustified()

Gets whether the menu item appears justified at the right side of the menu bar.

getLabel
string getLabel()

Sets text on the menu_item label Since 2.16

setLabel
void setLabel(string label)

Sets text on the menu_item label Since 2.16

getUseUnderline
int getUseUnderline()

Checks if an underline in the text indicates the next character should be used for the mnemonic accelerator key. Since 2.16

setUseUnderline
void setUseUnderline(int setting)

If true, an underline in the text indicates the next character should be used for the mnemonic accelerator key. Since 2.16

setSubmenu
void setSubmenu(Widget submenu)

Sets or replaces the menu item's submenu, or removes it when a NULL submenu is passed.

getSubmenu
Widget getSubmenu()

Gets the submenu underneath this menu item, if any. See gtk_menu_item_set_submenu().

removeSubmenu
void removeSubmenu()

Warning gtk_menu_item_remove_submenu has been deprecated since version 2.12 and should not be used in newly-written code. gtk_menu_item_remove_submenu() is deprecated and should not be used in newly written code. Use gtk_menu_item_set_submenu() instead. Removes the widget's submenu.

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 persistant storage (see gtk_accel_map_save() on this). To setup 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. This function is basically a convenience wrapper that handles calling gtk_widget_set_accel_path() with the appropriate accelerator group for the menu item. Note that you do need to set an accelerator on the parent menu with gtk_menu_set_accel_group() for this to work. Note that accel_path string will be stored in a GQuark. Therefore, if you pass a static string, you can save some memory by interning it first with g_intern_static_string().

getAccelPath
string getAccelPath()

Retrieve the accelerator path that was previously set on menu_item. See gtk_menu_item_set_accel_path() for details. Since 2.14

select
void select()

Emits the "select" signal on the given item. Behaves exactly like gtk_item_select.

deselect
void deselect()

Emits the "deselect" signal on the given item. Behaves exactly like gtk_item_deselect.

itemActivate
void itemActivate()

Emits the "activate" signal on the given item

toggleSizeRequest
void toggleSizeRequest(int* requisition)

Emits the "toggle_size_request" signal on the given item.

toggleSizeAllocate
void toggleSizeAllocate(int allocation)

Emits the "toggle_size_allocate" signal on the given item.

Meta