![JAR search and dependency download from the Maven repository](/logo.png)
org.eclipse.swt.widgets.Menu Maven / Gradle / Ivy
Show all versions of org.eclipse.swt.gtk.linux.ppc64 Show documentation
/******************************************************************************* * Copyright (c) 2000, 2013 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.eclipse.swt.widgets; import org.eclipse.swt.internal.*; import org.eclipse.swt.internal.gtk.*; import org.eclipse.swt.*; import org.eclipse.swt.events.*; import org.eclipse.swt.graphics.*; /** * Instances of this class are user interface objects that contain * menu items. *
or*
*- Styles:
*- BAR, DROP_DOWN, POP_UP, NO_RADIO_GROUP
*- LEFT_TO_RIGHT, RIGHT_TO_LEFT
*- Events:
*- Help, Hide, Show
** Note: Only one of BAR, DROP_DOWN and POP_UP may be specified. * Only one of LEFT_TO_RIGHT or RIGHT_TO_LEFT may be specified. *
* IMPORTANT: This class is not intended to be subclassed. *
* * @see Menu snippets * @see SWT Example: ControlExample * @see Sample code and further information * @noextend This class is not intended to be subclassed by clients. */ public class Menu extends Widget { int x, y; boolean hasLocation; MenuItem cascade, selectedItem; Decorations parent; long /*int*/ imItem, imSeparator, imHandle; ImageList imageList; /** * Constructs a new instance of this class given its parent, * and sets the style for the instance so that the instance * will be a popup menu on the given parent's shell. ** After constructing a menu, it can be set into its parent * using
* * @param parent a control which will be the parent of the new instance (cannot be null) * * @exception IllegalArgumentExceptionparent.setMenu(menu)
. In this case, the parent may * be any control in the same widget tree as the parent. **
* @exception SWTException- ERROR_NULL_ARGUMENT - if the parent is null
**
* * @see SWT#POP_UP * @see Widget#checkSubclass * @see Widget#getStyle */ public Menu (Control parent) { this (checkNull (parent).menuShell (), SWT.POP_UP); } /** * Constructs a new instance of this class given its parent * (which must be a- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
*- ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass
*Decorations
) and a style value * describing its behavior and appearance. ** The style value is either one of the style constants defined in * class
SWT
which is applicable to instances of this * class, or must be built by bitwise OR'ing together * (that is, using theint
"|" operator) two or more * of thoseSWT
style constants. The class description * lists the style constants that are applicable to the class. * Style bits are also inherited from superclasses. ** After constructing a menu or menuBar, it can be set into its parent * using
* * @param parent a decorations control which will be the parent of the new instance (cannot be null) * @param style the style of menu to construct * * @exception IllegalArgumentExceptionparent.setMenu(menu)
orparent.setMenuBar(menuBar)
. **
* @exception SWTException- ERROR_NULL_ARGUMENT - if the parent is null
**
* * @see SWT#BAR * @see SWT#DROP_DOWN * @see SWT#POP_UP * @see SWT#NO_RADIO_GROUP * @see SWT#LEFT_TO_RIGHT * @see SWT#RIGHT_TO_LEFT * @see Widget#checkSubclass * @see Widget#getStyle */ public Menu (Decorations parent, int style) { super (parent, checkStyle (style)); this.parent = parent; createWidget (0); } /** * Constructs a new instance of this class given its parent * (which must be a- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
*- ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass
*Menu
) and sets the style * for the instance so that the instance will be a drop-down * menu on the given parent's parent. ** After constructing a drop-down menu, it can be set into its parentMenu * using
* * @param parentMenu a menu which will be the parent of the new instance (cannot be null) * * @exception IllegalArgumentExceptionparentMenu.setMenu(menu)
. **
* @exception SWTException- ERROR_NULL_ARGUMENT - if the parent is null
**
* * @see SWT#DROP_DOWN * @see Widget#checkSubclass * @see Widget#getStyle */ public Menu (Menu parentMenu) { this (checkNull (parentMenu).parent, SWT.DROP_DOWN); } /** * Constructs a new instance of this class given its parent * (which must be a- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
*- ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass
*MenuItem
) and sets the style * for the instance so that the instance will be a drop-down * menu on the given parent's parent menu. ** After constructing a drop-down menu, it can be set into its parentItem * using
* * @param parentItem a menu item which will be the parent of the new instance (cannot be null) * * @exception IllegalArgumentExceptionparentItem.setMenu(menu)
. **
* @exception SWTException- ERROR_NULL_ARGUMENT - if the parent is null
**
* * @see SWT#DROP_DOWN * @see Widget#checkSubclass * @see Widget#getStyle */ public Menu (MenuItem parentItem) { this (checkNull (parentItem).parent); } static Control checkNull (Control control) { if (control == null) SWT.error (SWT.ERROR_NULL_ARGUMENT); return control; } static Menu checkNull (Menu menu) { if (menu == null) SWT.error (SWT.ERROR_NULL_ARGUMENT); return menu; } static MenuItem checkNull (MenuItem item) { if (item == null) SWT.error (SWT.ERROR_NULL_ARGUMENT); return item; } static int checkStyle (int style) { return checkBits (style, SWT.POP_UP, SWT.BAR, SWT.DROP_DOWN, 0, 0, 0); } void _setVisible (boolean visible) { if (visible == gtk_widget_get_mapped (handle)) return; if (visible) { sendEvent (SWT.Show); if (getItemCount () != 0) { if ((OS.GTK_VERSION >= OS.VERSION (2, 8, 0))) { /* * Feature in GTK. ON_TOP shells will send out * SWT.Deactivate whenever a context menu is shown. * The fix is to prevent the menu from taking focus * when it is being shown in an ON_TOP shell. */ if ((parent._getShell ().style & SWT.ON_TOP) != 0) { OS.gtk_menu_shell_set_take_focus (handle, false); } } long /*int*/ address = hasLocation ? display.menuPositionProc: 0; hasLocation = false; long /*int*/ data = 0; if ((OS.GTK_VERSION >= OS.VERSION (2, 10, 0))) { /* * Popup-menu to the status icon should be aligned to * Tray rather than to cursor position. There is a * possibility (unlikely) that TrayItem might have * been disposed in the listener, for which case * the menu should be shown in the cursor position. */ TrayItem item = display.currentTrayItem; if (item != null && !item.isDisposed()) { data = item.handle; address = OS.gtk_status_icon_position_menu_func (); } } /* * Bug in GTK. The timestamp passed into gtk_menu_popup is used * to perform an X pointer grab. It cannot be zero, else the grab * will fail. The fix is to ensure that the timestamp of the last * event processed is used. */ OS.gtk_menu_popup (handle, 0, 0, address, data, 0, display.getLastEventTime ()); } else { sendEvent (SWT.Hide); } } else { OS.gtk_menu_popdown (handle); } } void addAccelerators (long /*int*/ accelGroup) { MenuItem [] items = getItems (); for (int i = 0; i < items.length; i++) { MenuItem item = items[i]; item.addAccelerators (accelGroup); } } /** * Adds the listener to the collection of listeners who will * be notified when menus are hidden or shown, by sending it * one of the messages defined in the- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
*- ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass
*MenuListener
* interface. * * @param listener the listener which should be notified * * @exception IllegalArgumentException*
* @exception SWTException- ERROR_NULL_ARGUMENT - if the listener is null
**
* * @see MenuListener * @see #removeMenuListener */ public void addMenuListener (MenuListener listener) { checkWidget(); if (listener == null) error (SWT.ERROR_NULL_ARGUMENT); TypedListener typedListener = new TypedListener (listener); addListener (SWT.Hide,typedListener); addListener (SWT.Show,typedListener); } /** * Adds the listener to the collection of listeners who will * be notified when help events are generated for the control, * by sending it one of the messages defined in the *- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
*- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*HelpListener
interface. * * @param listener the listener which should be notified * * @exception IllegalArgumentException*
* @exception SWTException- ERROR_NULL_ARGUMENT - if the listener is null
**
* * @see HelpListener * @see #removeHelpListener */ public void addHelpListener (HelpListener listener) { checkWidget(); if (listener == null) error (SWT.ERROR_NULL_ARGUMENT); TypedListener typedListener = new TypedListener (listener); addListener (SWT.Help, typedListener); } void createHandle (int index) { state |= HANDLE; if ((style & SWT.BAR) != 0) { handle = OS.gtk_menu_bar_new (); if (handle == 0) error (SWT.ERROR_NO_HANDLES); long /*int*/ vboxHandle = parent.vboxHandle; OS.gtk_container_add (vboxHandle, handle); OS.gtk_box_set_child_packing (vboxHandle, handle, false, true, 0, OS.GTK_PACK_START); } else { handle = OS.gtk_menu_new (); if (handle == 0) error (SWT.ERROR_NO_HANDLES); } } void createIMMenu (long /*int*/ imHandle) { boolean showInputMethod = false; long /*int*/ settings = OS.gtk_settings_get_default (); if (settings != 0) { int [] buffer = new int [1]; OS.g_object_get (settings, OS.gtk_show_input_method_menu, buffer, 0); showInputMethod = buffer[0] != 0; } if (imHandle == 0 || !showInputMethod) { this.imHandle = 0; if (imItem != 0) { OS.gtk_widget_destroy (imItem); imItem = 0; } if (imSeparator != 0) { OS.gtk_widget_destroy (imSeparator); imSeparator = 0; } return; } if (this.imHandle == imHandle) return; this.imHandle = imHandle; if (imSeparator == 0) { imSeparator = OS.gtk_separator_menu_item_new (); OS.gtk_widget_show (imSeparator); OS.gtk_menu_shell_insert (handle, imSeparator, -1); } if (imItem == 0) { byte[] buffer = Converter.wcsToMbcs (null, SWT.getMessage("SWT_InputMethods"), true); imItem = OS.gtk_image_menu_item_new_with_label (buffer); OS.gtk_widget_show (imItem); OS.gtk_menu_shell_insert (handle, imItem, -1); } long /*int*/ imSubmenu = OS.gtk_menu_new (); OS.gtk_im_multicontext_append_menuitems (imHandle, imSubmenu); OS.gtk_menu_item_set_submenu (imItem, imSubmenu); } void createWidget (int index) { checkOrientation (parent); super.createWidget (index); parent.addMenu (this); } void fixMenus (Decorations newParent) { MenuItem [] items = getItems (); for (int i=0; i- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
*- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
** @exception SWTException *
*/ public MenuItem getDefaultItem () { checkWidget(); return null; } /** * Returns- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
*- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*true
if the receiver is enabled, and *false
otherwise. A disabled menu is typically * not selectable from the user interface and draws with an * inactive or "grayed" look. * * @return the receiver's enabled state * * @exception SWTException*
* * @see #isEnabled */ public boolean getEnabled () { checkWidget(); return gtk_widget_get_sensitive (handle); } /** * Returns the item at the given, zero-relative index in the * receiver. Throws an exception if the index is out of range. * * @param index the index of the item to return * @return the item at the given index * * @exception IllegalArgumentException- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
*- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
**
* @exception SWTException- ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)
**
*/ public MenuItem getItem (int index) { checkWidget(); long /*int*/ list = OS.gtk_container_get_children (handle); if (list == 0) error (SWT.ERROR_CANNOT_GET_ITEM); int count = OS.g_list_length (list); if (imSeparator != 0) count--; if (imItem != 0) count--; if (!(0 <= index && index < count)) error (SWT.ERROR_INVALID_RANGE); long /*int*/ data = OS.g_list_nth_data (list, index); OS.g_list_free (list); if (data == 0) error (SWT.ERROR_CANNOT_GET_ITEM); return (MenuItem) display.getWidget (data); } /** * Returns the number of items contained in the receiver. * * @return the number of items * * @exception SWTException- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
*- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
**
*/ public int getItemCount () { checkWidget(); long /*int*/ list = OS.gtk_container_get_children (handle); if (list == 0) return 0; int count = OS.g_list_length (list); OS.g_list_free (list); if (imSeparator != 0) count--; if (imItem != 0) count--; return count; } /** * Returns a (possibly empty) array of- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
*- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*MenuItem
s which * are the items in the receiver. ** Note: This is not the actual structure used by the receiver * to maintain its list of items, so modifying the array will * not affect the receiver. *
* * @return the items in the receiver * * @exception SWTException*
*/ public MenuItem [] getItems () { checkWidget(); long /*int*/ list = OS.gtk_container_get_children (handle); if (list == 0) return new MenuItem [0]; int count = OS.g_list_length (list); if (imSeparator != 0) count--; if (imItem != 0) count--; MenuItem [] items = new MenuItem [count]; int index = 0; for (int i=0; i- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
*- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*0) { for (int i=0; i SWT.LEFT_TO_RIGHT SWT.RIGHT_TO_LEFT
. * * @return the orientation style * * @exception SWTException
-
*
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed *
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver *
Decorations
.
*
* @return the receiver's parent
*
* @exception SWTException -
*
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed *
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver *
MenuItem
or null when the receiver is a
* root.
*
* @return the receiver's parent item
*
* @exception SWTException -
*
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed *
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver *
Menu
or null when the receiver is a
* root.
*
* @return the receiver's parent item
*
* @exception SWTException -
*
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed *
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver *
-
*
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed *
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver *
true
if the receiver is visible, and
* false
otherwise.
* * If one of the receiver's ancestors is not visible or some * other condition makes the receiver not visible, this method * may still indicate that it is considered visible even though * it may not actually be showing. *
* * @return the receiver's visibility state * * @exception SWTException-
*
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed *
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver *
-
*
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed *
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver *
false
* otherwise. A disabled menu is typically not selectable from the
* user interface and draws with an inactive or "grayed" look.
*
* @return the receiver's enabled state
*
* @exception SWTException -
*
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed *
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver *
true
if the receiver is visible and all
* of the receiver's ancestors are visible and false
* otherwise.
*
* @return the receiver's visibility state
*
* @exception SWTException -
*
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed *
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver *
-
*
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed *
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver *
-
*
- ERROR_NULL_ARGUMENT - if the listener is null *
-
*
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed *
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver *
-
*
- ERROR_INVALID_ARGUMENT - if the menu item has been disposed *
-
*
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed *
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver *
true
,
* and disables it otherwise. A disabled menu is typically
* not selectable from the user interface and draws with an
* inactive or "grayed" look.
*
* @param enabled the new enabled state
*
* @exception SWTException -
*
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed *
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver *
* Note that this is different from most widgets where the * location of the widget is relative to the parent. *
* Note that the platform window manager ultimately has control * over the location of popup menus. *
* * @param x the new x coordinate for the receiver * @param y the new y coordinate for the receiver * * @exception SWTException-
*
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed *
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver *
* Note that this is different from most widgets where the * location of the widget is relative to the parent. *
* Note that the platform window manager ultimately has control * over the location of popup menus. *
* * @param location the new location for the receiver * * @exception IllegalArgumentException-
*
- ERROR_NULL_ARGUMENT - if the point is null *
-
*
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed *
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver *
SWT.LEFT_TO_RIGHT
or SWT.RIGHT_TO_LEFT
.
* * * @param orientation new orientation style * * @exception SWTException
-
*
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed *
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver *
true
,
* and marks it invisible otherwise.
* * If one of the receiver's ancestors is not visible or some * other condition makes the receiver not visible, marking * it visible may not actually cause it to be displayed. *
* * @param visible the new visibility state * * @exception SWTException-
*
- ERROR_WIDGET_DISPOSED - if the receiver has been disposed *
- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver *