/*******************************************************************************
* 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.*;
import org.eclipse.swt.internal.*;
import org.eclipse.swt.internal.gtk.*;
import org.eclipse.swt.graphics.*;
import org.eclipse.swt.events.*;
/**
* Instances of this class represent a selectable user interface object
* that represents a button in a tool bar.
* <dl>
* <dt><b>Styles:</b></dt>
* <dd>PUSH, CHECK, RADIO, SEPARATOR, DROP_DOWN</dd>
* <dt><b>Events:</b></dt>
* <dd>Selection</dd>
* </dl>
* <p>
* Note: Only one of the styles CHECK, PUSH, RADIO, SEPARATOR and DROP_DOWN
* may be specified.
* </p><p>
* IMPORTANT: This class is <em>not</em> intended to be subclassed.
* </p>
*
* @see <a href="http://www.eclipse.org/swt/snippets/#toolbar">ToolBar, ToolItem snippets</a>
* @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
* @noextend This class is not intended to be subclassed by clients.
*/
public class ToolItem extends Item {
long /*int*/ arrowHandle, labelHandle, imageHandle;
long /*int*/ eventHandle, proxyMenuItem;
ToolBar parent;
Control control;
Image hotImage, disabledImage;
String toolTipText;
boolean drawHotImage;
/**
* Constructs a new instance of this class given its parent
* (which must be a <code>ToolBar</code>) and a style value
* describing its behavior and appearance. The item is added
* to the end of the items maintained by its parent.
* <p>
* The style value is either one of the style constants defined in
* class <code>SWT</code> which is applicable to instances of this
* class, or must be built by <em>bitwise OR</em>'ing together
* (that is, using the <code>int</code> "|" operator) two or more
* of those <code>SWT</code> style constants. The class description
* lists the style constants that are applicable to the class.
* Style bits are also inherited from superclasses.
* </p>
*
* @param parent a composite control which will be the parent of the new instance (cannot be null)
* @param style the style of control to construct
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li>
* <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li>
* </ul>
*
* @see SWT#PUSH
* @see SWT#CHECK
* @see SWT#RADIO
* @see SWT#SEPARATOR
* @see SWT#DROP_DOWN
* @see Widget#checkSubclass
* @see Widget#getStyle
*/
public ToolItem (ToolBar parent, int style) {
super (parent, checkStyle (style));
this.parent = parent;
createWidget (parent.getItemCount ());
}
/**
* Constructs a new instance of this class given its parent
* (which must be a <code>ToolBar</code>), a style value
* describing its behavior and appearance, and the index
* at which to place it in the items maintained by its parent.
* <p>
* The style value is either one of the style constants defined in
* class <code>SWT</code> which is applicable to instances of this
* class, or must be built by <em>bitwise OR</em>'ing together
* (that is, using the <code>int</code> "|" operator) two or more
* of those <code>SWT</code> style constants. The class description
* lists the style constants that are applicable to the class.
* Style bits are also inherited from superclasses.
* </p>
*
* @param parent a composite control which will be the parent of the new instance (cannot be null)
* @param style the style of control to construct
* @param index the zero-relative index to store the receiver in its parent
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
* <li>ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the parent (inclusive)</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li>
* <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li>
* </ul>
*
* @see SWT#PUSH
* @see SWT#CHECK
* @see SWT#RADIO
* @see SWT#SEPARATOR
* @see SWT#DROP_DOWN
* @see Widget#checkSubclass
* @see Widget#getStyle
*/
public ToolItem (ToolBar parent, int style, int index) {
super (parent, checkStyle (style));
this.parent = parent;
int count = parent.getItemCount ();
if (!(0 <= index && index <= count)) {
error (SWT.ERROR_INVALID_RANGE);
}
createWidget (index);
}
/**
* Adds the listener to the collection of listeners who will
* be notified when the control is selected by the user, by sending
* it one of the messages defined in the <code>SelectionListener</code>
* interface.
* <p>
* When <code>widgetSelected</code> is called when the mouse is over the arrow portion of a drop-down tool,
* the event object detail field contains the value <code>SWT.ARROW</code>.
* <code>widgetDefaultSelected</code> is not called.
* </p>
* <p>
* When the <code>SWT.RADIO</code> style bit is set, the <code>widgetSelected</code> method is
* also called when the receiver loses selection because another item in the same radio group
* was selected by the user. During <code>widgetSelected</code> the application can use
* <code>getSelection()</code> to determine the current selected state of the receiver.
* </p>
*
* @param listener the listener which should be notified when the control is selected by the user,
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @see SelectionListener
* @see #removeSelectionListener
* @see SelectionEvent
*/
public void addSelectionListener(SelectionListener listener) {
checkWidget();
if (listener == null) error (SWT.ERROR_NULL_ARGUMENT);
TypedListener typedListener = new TypedListener (listener);
addListener (SWT.Selection,typedListener);
addListener (SWT.DefaultSelection,typedListener);
}
static int checkStyle (int style) {
return checkBits (style, SWT.PUSH, SWT.CHECK, SWT.RADIO, SWT.SEPARATOR, SWT.DROP_DOWN, 0);
}
@Override
protected void checkSubclass () {
if (!isValidSubclass ()) error (SWT.ERROR_INVALID_SUBCLASS);
}
@Override
void createHandle (int index) {
state |= HANDLE;
int bits = SWT.SEPARATOR | SWT.RADIO | SWT.CHECK | SWT.PUSH | SWT.DROP_DOWN;
if ((style & SWT.SEPARATOR) == 0) {
labelHandle = OS.gtk_label_new_with_mnemonic (null);
if (labelHandle == 0) error (SWT.ERROR_NO_HANDLES);
imageHandle = OS.gtk_image_new_from_pixbuf (0);
if (imageHandle == 0) error (SWT.ERROR_NO_HANDLES);
}
switch (style & bits) {
case SWT.SEPARATOR:
handle = OS.gtk_separator_tool_item_new ();
if (handle == 0) error (SWT.ERROR_NO_HANDLES);
OS.gtk_separator_tool_item_set_draw (handle, true);
break;
case SWT.DROP_DOWN:
handle = OS.gtk_menu_tool_button_new (0, null);
if (handle == 0) error (SWT.ERROR_NO_HANDLES);
/*
* Feature in GTK. The arrow button of DropDown tool-item is
* disabled when it does not contain menu. The fix is to
* find the arrow button handle and enable it.
*/
long /*int*/ child = OS.gtk_bin_get_child (handle);
long /*int*/ list = OS.gtk_container_get_children (child);
arrowHandle = OS.g_list_nth_data (list, 1);
OS.gtk_widget_set_sensitive (arrowHandle, true);
OS.gtk_widget_set_size_request(OS.gtk_bin_get_child(arrowHandle), 8, 6);
break;
case SWT.RADIO:
/*
* Because GTK enforces radio behavior in a button group
* a radio group is not created for each set of contiguous
* buttons, each radio button will not draw unpressed.
* The fix is to use toggle buttons instead.
*/
case SWT.CHECK:
handle = OS.gtk_toggle_tool_button_new ();
if (handle == 0) error (SWT.ERROR_NO_HANDLES);
break;
case SWT.PUSH:
default:
handle = OS.gtk_tool_button_new (0, null);
if (handle == 0) error (SWT.ERROR_NO_HANDLES);
break;
}
if (labelHandle != 0) {
OS.gtk_tool_button_set_label_widget(handle, labelHandle);
}
if (imageHandle != 0) {
OS.gtk_tool_button_set_icon_widget(handle, imageHandle);
}
if ((parent.state & FOREGROUND) != 0) {
setForegroundColor (parent.getForegroundColor());
}
if ((parent.state & FONT) != 0) {
setFontDescription (parent.getFontDescription());
}
/*
* Feature in GTK. GtkToolButton class uses this property to
* determine whether to show or hide its label when the toolbar
* style is GTK_TOOLBAR_BOTH_HORIZ (or SWT.RIGHT).
*/
if ((parent.style & SWT.RIGHT) != 0) OS.gtk_tool_item_set_is_important (handle, true);
if ((style & SWT.SEPARATOR) == 0) OS.gtk_tool_button_set_use_underline (handle, true);
}
@Override
void createWidget (int index) {
super.createWidget (index);
showWidget (index);
parent.relayout ();
}
Widget [] computeTabList () {
if (isTabGroup ()) {
if (getEnabled ()) {
if ((style & SWT.SEPARATOR) != 0) {
if (control != null) return control.computeTabList();
} else {
return new Widget [] {this};
}
}
}
return new Widget [0];
}
@Override
void deregister() {
super.deregister ();
if (eventHandle != 0) display.removeWidget (eventHandle);
if (arrowHandle != 0) display.removeWidget (arrowHandle);
}
@Override
public void dispose () {
if (isDisposed ()) return;
ToolBar parent = this.parent;
super.dispose ();
parent.relayout ();
}
/**
* Returns a rectangle describing the receiver's size and location
* relative to its parent.
*
* @return the receiver's bounding rectangle
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public Rectangle getBounds () {
checkWidget();
parent.forceResize ();
long /*int*/ topHandle = topHandle ();
GtkAllocation allocation = new GtkAllocation ();
gtk_widget_get_allocation (topHandle, allocation);
int x = allocation.x;
int y = allocation.y;
int width = allocation.width;
int height = allocation.height;
if ((parent.style & SWT.MIRRORED) != 0) x = parent.getClientWidth () - width - x;
if ((style & SWT.SEPARATOR) != 0 && control != null) height = Math.max (height, 23);
return new Rectangle (x, y, width, height);
}
/**
* Returns the control that is used to fill the bounds of
* the item when the item is a <code>SEPARATOR</code>.
*
* @return the control
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public Control getControl () {
checkWidget();
return control;
}
/**
* Returns the receiver's disabled image if it has one, or null
* if it does not.
* <p>
* The disabled image is displayed when the receiver is disabled.
* </p>
*
* @return the receiver's disabled image
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public Image getDisabledImage () {
checkWidget();
return disabledImage;
}
/**
* Returns <code>true</code> if the receiver is enabled, and
* <code>false</code> otherwise. A disabled control is typically
* not selectable from the user interface and draws with an
* inactive or "grayed" look.
*
* @return the receiver's enabled state
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @see #isEnabled
*/
public boolean getEnabled () {
checkWidget();
long /*int*/ topHandle = topHandle ();
return gtk_widget_get_sensitive (topHandle);
}
/**
* Returns the receiver's hot image if it has one, or null
* if it does not.
* <p>
* The hot image is displayed when the mouse enters the receiver.
* </p>
*
* @return the receiver's hot image
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public Image getHotImage () {
checkWidget();
return hotImage;
}
/**
* Returns the receiver's parent, which must be a <code>ToolBar</code>.
*
* @return the receiver's parent
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public ToolBar getParent () {
checkWidget();
if (parent == null) error (SWT.ERROR_WIDGET_DISPOSED);
return parent;
}
/**
* Returns <code>true</code> if the receiver is selected,
* and false otherwise.
* <p>
* When the receiver is of type <code>CHECK</code> or <code>RADIO</code>,
* it is selected when it is checked (which some platforms draw as a
* pushed in button). If the receiver is of any other type, this method
* returns false.
* </p>
*
* @return the selection state
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public boolean getSelection () {
checkWidget();
if ((style & (SWT.CHECK | SWT.RADIO)) == 0) return false;
return OS.gtk_toggle_tool_button_get_active (handle);
}
/**
* Returns the receiver's tool tip text, or null if it has not been set.
*
* @return the receiver's tool tip text
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public String getToolTipText () {
checkWidget();
return toolTipText;
}
/**
* Gets the width of the receiver.
*
* @return the width
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public int getWidth () {
checkWidget();
parent.forceResize ();
long /*int*/ topHandle = topHandle ();
GtkAllocation allocation = new GtkAllocation();
gtk_widget_get_allocation (topHandle, allocation);
return allocation.width;
}
@Override
long /*int*/ gtk_button_press_event (long /*int*/ widget, long /*int*/ event) {
GdkEventButton gdkEvent = new GdkEventButton ();
OS.memmove (gdkEvent, event, GdkEventButton.sizeof);
GtkAllocation allocation = new GtkAllocation ();
gtk_widget_get_allocation (handle, allocation);
double x = gdkEvent.x + allocation.x;
double y = gdkEvent.y + allocation.y;
OS.memmove (event, gdkEvent, GdkEventButton.sizeof);
long /*int*/ result = parent.gtk_button_press_event (widget, event);
gdkEvent.x = x;
gdkEvent.y = y;
OS.memmove (event, gdkEvent, GdkEventButton.sizeof);
return result;
}
@Override
long /*int*/ gtk_button_release_event (long /*int*/ widget, long /*int*/ event) {
GdkEventButton gdkEvent = new GdkEventButton ();
OS.memmove (gdkEvent, event, GdkEventButton.sizeof);
GtkAllocation allocation = new GtkAllocation ();
gtk_widget_get_allocation (handle, allocation);
double x = gdkEvent.x + allocation.x;
double y = gdkEvent.y + allocation.y;
OS.memmove (event, gdkEvent, GdkEventButton.sizeof);
long /*int*/ result = parent.gtk_button_release_event (widget, event);
gdkEvent.x = x;
gdkEvent.y = y;
OS.memmove(event, gdkEvent, GdkEventButton.sizeof);
return result;
}
@Override
long /*int*/ gtk_clicked (long /*int*/ widget) {
Event event = new Event ();
if ((style & SWT.DROP_DOWN) != 0) {
long /*int*/ eventPtr = OS.gtk_get_current_event ();
if (eventPtr != 0) {
GdkEvent gdkEvent = new GdkEvent ();
OS.memmove (gdkEvent, eventPtr, GdkEvent.sizeof);
long /*int*/ topHandle = topHandle();
switch (gdkEvent.type) {
case OS.GDK_KEY_RELEASE: //Fall Through..
case OS.GDK_BUTTON_PRESS:
case OS.GDK_2BUTTON_PRESS:
case OS.GDK_BUTTON_RELEASE: {
boolean isArrow = false;
if (widget == arrowHandle) {
isArrow = true;
topHandle = widget;
/*
* Feature in GTK. ArrowButton stays in toggled state if there is no popup menu.
* It is required to set back the state of arrow to normal state after it is clicked.
*/
OS.g_signal_handlers_block_matched (widget, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, CLICKED);
OS.gtk_toggle_button_set_active(widget, false);
OS.g_signal_handlers_unblock_matched (widget, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, CLICKED);
}
if (isArrow) {
event.detail = SWT.ARROW;
GtkAllocation allocation = new GtkAllocation ();
gtk_widget_get_allocation (topHandle, allocation);
event.x = allocation.x;
if ((parent.style & SWT.MIRRORED) != 0) event.x = parent.getClientWidth () - allocation.width - event.x;
event.y = allocation.y + allocation.height;
}
break;
}
}
OS.gdk_event_free (eventPtr);
}
}
if ((style & SWT.RADIO) != 0) {
if ((parent.getStyle () & SWT.NO_RADIO_GROUP) == 0) {
selectRadio ();
}
}
sendSelectionEvent (SWT.Selection, event, false);
return 0;
}
@Override
long /*int*/ gtk_create_menu_proxy (long /*int*/ widget) {
/*
* Feature in GTK. If the item is a radio/check button
* with only image, then that image does not appear in
* the overflow menu.
* The fix is to create and use the proxy menu for the
* items appearing in the overflow menu.
*/
byte [] buffer = Converter.wcsToMbcs (null, "menu-id", true); //$NON-NLS-1$
if (proxyMenuItem != 0) {
/*
* The menuItem to appear in the overflow menu is cached
* for the tool-item. If the text/image of the item changes,
* then the proxyMenu is reset.
*/
OS.gtk_tool_item_set_proxy_menu_item (widget, buffer, proxyMenuItem);
return 1;
}
if (image != null) {
ImageList imageList = parent.imageList;
if (imageList != null) {
int index = imageList.indexOf (image);
if (index != -1) {
long /*int*/ pixbuf = imageList.getPixbuf (index);
byte[] label = null;
int [] showImages = new int []{1};
long /*int*/ settings = OS.gtk_settings_get_default();
if (settings != 0) {
long /*int*/ property = OS.g_object_class_find_property(OS.G_OBJECT_GET_CLASS(settings), OS.gtk_menu_images);
if (property != 0) OS.g_object_get (settings, OS.gtk_menu_images, showImages, 0);
}
/*
* GTK tool items with only image appear as blank items
* in overflow menu when the system property "gtk-menu-images"
* is set to false. To avoid that, display the tooltip text
* if available, in the overflow menu.
* Feature in GTK. When the menuItem is initialised only
* with the image, the overflow menu appears very sloppy.
* The fix is to initialise menu item with empty string.
*/
if (text == null || text.length() == 0) {
if ((showImages [0] == 0) && (toolTipText != null))
label = Converter.wcsToMbcs(null, toolTipText, true);
else
label = new byte[]{0};
}
else {
label = Converter.wcsToMbcs(null, text, true);
}
long /*int*/ menuItem = OS.gtk_image_menu_item_new_with_label (label);
long /*int*/ menuImage = OS.gtk_image_new_from_pixbuf (pixbuf);
OS.gtk_image_menu_item_set_image (menuItem, menuImage);
OS.gtk_tool_item_set_proxy_menu_item (widget, buffer, menuItem);
/*
* Since the arrow button does not appear in the drop_down
* item, we request the menu-item and then, hook the
* activate signal to send the Arrow selection signal.
*/
proxyMenuItem = OS.gtk_tool_item_get_proxy_menu_item (widget, buffer);
OS.g_signal_connect(menuItem, OS.activate, ToolBar.menuItemSelectedFunc.getAddress(), handle);
return 1;
}
}
}
return 0;
}
@Override
long /*int*/ gtk_enter_notify_event (long /*int*/ widget, long /*int*/ event) {
parent.gtk_enter_notify_event (widget, event);
drawHotImage = (parent.style & SWT.FLAT) != 0 && hotImage != null;
if (drawHotImage) {
ImageList imageList = parent.imageList;
if (imageList != null) {
int index = imageList.indexOf (hotImage);
if (index != -1 && imageHandle != 0) {
long /*int*/ pixbuf = imageList.getPixbuf (index);
gtk_image_set_from_pixbuf(imageHandle, pixbuf);
}
}
}
return 0;
}
@Override
long /*int*/ gtk_event_after (long /*int*/ widget, long /*int*/ gdkEvent) {
GdkEvent event = new GdkEvent ();
OS.memmove (event, gdkEvent, GdkEvent.sizeof);
switch (event.type) {
case OS.GDK_BUTTON_PRESS: {
GdkEventButton gdkEventButton = new GdkEventButton ();
OS.memmove (gdkEventButton, gdkEvent, GdkEventButton.sizeof);
if (gdkEventButton.button == 3) {
parent.showMenu ((int) gdkEventButton.x_root, (int) gdkEventButton.y_root);
}
break;
}
}
return 0;
}
@Override
long /*int*/ gtk_focus_in_event (long /*int*/ widget, long /*int*/ event) {
parent.hasChildFocus = true;
parent.currentFocusItem = this;
return 0;
}
@Override
long /*int*/ gtk_focus_out_event (long /*int*/ widget, long /*int*/ event) {
parent.hasChildFocus = false;
return 0;
}
@Override
long /*int*/ gtk_leave_notify_event (long /*int*/ widget, long /*int*/ event) {
parent.gtk_leave_notify_event (widget, event);
if (drawHotImage) {
drawHotImage = false;
if (image != null) {
ImageList imageList = parent.imageList;
if (imageList != null) {
int index = imageList.indexOf (image);
if (index != -1 && imageHandle != 0) {
long /*int*/ pixbuf = imageList.getPixbuf (index);
gtk_image_set_from_pixbuf(imageHandle, pixbuf);
}
}
}
}
return 0;
}
@Override
long /*int*/ gtk_map (long /*int*/ widget) {
parent.fixZOrder ();
return 0;
}
@Override
long /*int*/ gtk_mnemonic_activate (long /*int*/ widget, long /*int*/ arg1) {
return parent.gtk_mnemonic_activate (widget, arg1);
}
@Override
void hookEvents () {
super.hookEvents ();
if ((style & SWT.SEPARATOR) != 0) return;
OS.g_signal_connect_closure (handle, OS.clicked, display.getClosure (CLICKED), false);
/*
* Feature in GTK. GtkToolItem does not respond to basic listeners
* such as button-press, enter-notify to it. The fix is to assign
* the listener to child (GtkButton) of the tool-item.
*/
eventHandle = OS.gtk_bin_get_child(handle);
if ((style & SWT.DROP_DOWN) != 0) {
long /*int*/ list = OS.gtk_container_get_children(eventHandle);
eventHandle = OS.g_list_nth_data(list, 0);
if (arrowHandle != 0) OS.g_signal_connect_closure (arrowHandle, OS.clicked, display.getClosure (CLICKED), false);
}
OS.g_signal_connect_closure (handle, OS.create_menu_proxy, display.getClosure (CREATE_MENU_PROXY), false);
OS.g_signal_connect_closure_by_id (eventHandle, display.signalIds [ENTER_NOTIFY_EVENT], 0, display.getClosure (ENTER_NOTIFY_EVENT), false);
OS.g_signal_connect_closure_by_id (eventHandle, display.signalIds [LEAVE_NOTIFY_EVENT], 0, display.getClosure (LEAVE_NOTIFY_EVENT), false);
OS.g_signal_connect_closure_by_id (eventHandle, display.signalIds [FOCUS_IN_EVENT], 0, display.getClosure (FOCUS_IN_EVENT), false);
OS.g_signal_connect_closure_by_id (eventHandle, display.signalIds [FOCUS_OUT_EVENT], 0, display.getClosure (FOCUS_OUT_EVENT), false);
/*
* Feature in GTK. Usually, GTK widgets propagate all events to their
* parent when they are done their own processing. However, in contrast
* to other widgets, the buttons that make up the tool items, do not propagate
* the mouse up/down events. It is interesting to note that they DO propagate
* mouse motion events. The fix is to explicitly forward mouse up/down events
* to the parent.
*/
int mask =
OS.GDK_EXPOSURE_MASK | OS.GDK_POINTER_MOTION_MASK |
OS.GDK_BUTTON_PRESS_MASK | OS.GDK_BUTTON_RELEASE_MASK |
OS.GDK_ENTER_NOTIFY_MASK | OS.GDK_LEAVE_NOTIFY_MASK |
OS.GDK_KEY_PRESS_MASK | OS.GDK_KEY_RELEASE_MASK |
OS.GDK_FOCUS_CHANGE_MASK;
OS.gtk_widget_add_events (eventHandle, mask);
OS.g_signal_connect_closure_by_id (eventHandle, display.signalIds [BUTTON_PRESS_EVENT], 0, display.getClosure (BUTTON_PRESS_EVENT), false);
OS.g_signal_connect_closure_by_id (eventHandle, display.signalIds [BUTTON_RELEASE_EVENT], 0, display.getClosure (BUTTON_RELEASE_EVENT), false);
OS.g_signal_connect_closure_by_id (eventHandle, display.signalIds [EVENT_AFTER], 0, display.getClosure (EVENT_AFTER), false);
long /*int*/ topHandle = topHandle ();
OS.g_signal_connect_closure_by_id (topHandle, display.signalIds [MAP], 0, display.getClosure (MAP), true);
}
/**
* Returns <code>true</code> if the receiver is enabled and all
* of the receiver's ancestors are enabled, and <code>false</code>
* otherwise. A disabled control is typically not selectable from the
* user interface and draws with an inactive or "grayed" look.
*
* @return the receiver's enabled state
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @see #getEnabled
*/
public boolean isEnabled () {
checkWidget();
return getEnabled () && parent.isEnabled ();
}
boolean isTabGroup () {
ToolItem [] tabList = parent._getTabItemList ();
if (tabList != null) {
for (int i=0; i<tabList.length; i++) {
if (tabList [i] == this) return true;
}
}
if ((style & SWT.SEPARATOR) != 0) return true;
int index = parent.indexOf (this);
if (index == 0) return true;
ToolItem previous = parent.getItem (index - 1);
return (previous.getStyle () & SWT.SEPARATOR) != 0;
}
@Override
void register () {
super.register ();
if (eventHandle != 0) display.addWidget (eventHandle, this);
if (arrowHandle != 0) display.addWidget (arrowHandle, this);
}
@Override
void releaseHandle () {
super.releaseHandle ();
arrowHandle = labelHandle = imageHandle = eventHandle = 0;
}
@Override
void releaseWidget () {
super.releaseWidget ();
if (parent.currentFocusItem == this) parent.currentFocusItem = null;
parent = null;
control = null;
hotImage = disabledImage = null;
toolTipText = null;
}
/**
* Removes the listener from the collection of listeners who will
* be notified when the control is selected by the user.
*
* @param listener the listener which should no longer be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*
* @see SelectionListener
* @see #addSelectionListener
*/
public void removeSelectionListener(SelectionListener listener) {
checkWidget();
if (listener == null) error (SWT.ERROR_NULL_ARGUMENT);
if (eventTable == null) return;
eventTable.unhook (SWT.Selection, listener);
eventTable.unhook (SWT.DefaultSelection,listener);
}
void resizeControl () {
if (control != null && !control.isDisposed ()) {
/*
* Set the size and location of the control
* separately to minimize flashing in the
* case where the control does not resize
* to the size that was requested. This
* case can occur when the control is a
* combo box.
*/
Rectangle itemRect = getBounds ();
control.setSize (itemRect.width, itemRect.height);
resizeHandle(itemRect.width, itemRect.height);
Rectangle rect = control.getBounds ();
rect.x = itemRect.x + (itemRect.width - rect.width) / 2;
rect.y = itemRect.y + (itemRect.height - rect.height) / 2;
control.setLocation (rect.x, rect.y);
}
}
void resizeHandle(int width, int height) {
OS.gtk_widget_set_size_request (handle, width, height);
/*
* Cause a size allocation this widget's topHandle. Note that
* all calls to gtk_widget_size_allocate() must be preceded by
* a call to gtk_widget_size_request().
*/
GtkRequisition requisition = new GtkRequisition ();
parent.gtk_widget_size_request (handle, requisition);
GtkAllocation allocation = new GtkAllocation ();
gtk_widget_get_allocation (handle, allocation);
allocation.width = width;
allocation.height = height;
OS.gtk_widget_size_allocate (handle, allocation);
}
void selectRadio () {
int index = 0;
ToolItem [] items = parent.getItems ();
while (index < items.length && items [index] != this) index++;
int i = index - 1;
while (i >= 0 && items [i].setRadioSelection (false)) --i;
int j = index + 1;
while (j < items.length && items [j].setRadioSelection (false)) j++;
setSelection (true);
}
/**
* Sets the control that is used to fill the bounds of
* the item when the item is a <code>SEPARATOR</code>.
*
* @param control the new control
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_INVALID_ARGUMENT - if the control has been disposed</li>
* <li>ERROR_INVALID_PARENT - if the control is not in the same widget tree</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public void setControl (Control control) {
checkWidget ();
if (control != null) {
if (control.isDisposed()) error (SWT.ERROR_INVALID_ARGUMENT);
if (control.parent != parent) error (SWT.ERROR_INVALID_PARENT);
}
if ((style & SWT.SEPARATOR) == 0) return;
if (this.control == control) return;
this.control = control;
parent.relayout ();
}
/**
* Sets the receiver's disabled image to the argument, which may be
* null indicating that no disabled image should be displayed.
* <p>
* The disabled image is displayed when the receiver is disabled.
* </p>
*
* @param image the disabled image to display on the receiver (may be null)
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_INVALID_ARGUMENT - if the image has been disposed</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public void setDisabledImage (Image image) {
checkWidget();
if ((style & SWT.SEPARATOR) != 0) return;
disabledImage = image;
}
/**
* Enables the receiver if the argument is <code>true</code>,
* and disables it otherwise.
* <p>
* A disabled control is typically
* not selectable from the user interface and draws with an
* inactive or "grayed" look.
* </p>
*
* @param enabled the new enabled state
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public void setEnabled (boolean enabled) {
checkWidget();
long /*int*/ topHandle = topHandle ();
if (gtk_widget_get_sensitive (topHandle) == enabled) return;
OS.gtk_widget_set_sensitive (topHandle, enabled);
if (enabled) {
/*
* Bug in GTK. GtkButton requires an enter notify before it
* allows the button to be pressed, but events are dropped when
* widgets are insensitive. The fix is to hide and show the
* button if the pointer is within its bounds.
*/
int [] x = new int [1], y = new int [1];
gdk_window_get_device_position (parent.paintWindow (), x, y, null);
if (getBounds ().contains (x [0], y [0])) {
OS.gtk_widget_hide (handle);
OS.gtk_widget_show (handle);
}
} else {
/*
* Bug in GTK. Starting with 2.14, if a button is disabled
* through on a button press, the field which keeps track
* whether the pointer is currently in the button is never updated.
* As a result, when it is re-enabled it automatically enters
* a PRELIGHT state. The fix is to set a NORMAL state.
*
* Note that on GTK 3 this code causes the item to be re-enabled.
*/
if (OS.GTK_VERSION >= OS.VERSION (2, 14, 0) && !OS.GTK3) {
OS.gtk_widget_set_state (topHandle, OS.GTK_STATE_NORMAL);
}
}
}
boolean setFocus () {
return OS.gtk_widget_child_focus (handle, OS.GTK_DIR_TAB_FORWARD);
}
void setFontDescription (long /*int*/ font) {
if (labelHandle != 0) setFontDescription (labelHandle, font);
}
void setForegroundColor (GdkColor color) {
if (labelHandle != 0) setForegroundColor (labelHandle, color);
}
/**
* Sets the receiver's hot image to the argument, which may be
* null indicating that no hot image should be displayed.
* <p>
* The hot image is displayed when the mouse enters the receiver.
* </p>
*
* @param image the hot image to display on the receiver (may be null)
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_INVALID_ARGUMENT - if the image has been disposed</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public void setHotImage (Image image) {
checkWidget();
if ((style & SWT.SEPARATOR) != 0) return;
hotImage = image;
if (image != null) {
ImageList imageList = parent.imageList;
if (imageList == null) imageList = parent.imageList = new ImageList ();
int imageIndex = imageList.indexOf (image);
if (imageIndex == -1) {
imageIndex = imageList.add (image);
} else {
imageList.put (imageIndex, image);
}
}
}
@Override
public void setImage (Image image) {
checkWidget();
if ((style & SWT.SEPARATOR) != 0) return;
super.setImage (image);
if (image != null) {
ImageList imageList = parent.imageList;
if (imageList == null) imageList = parent.imageList = new ImageList ();
int imageIndex = imageList.indexOf (image);
if (imageIndex == -1) {
imageIndex = imageList.add (image);
} else {
imageList.put (imageIndex, image);
}
long /*int*/ pixbuf = imageList.getPixbuf (imageIndex);
gtk_image_set_from_pixbuf(imageHandle, pixbuf);
} else {
gtk_image_set_from_pixbuf(imageHandle, 0);
}
/*
* If Text/Image of a tool-item changes, then it is
* required to reset the proxy menu. Otherwise, the
* old menuItem appears in the overflow menu.
*/
if ((style & SWT.DROP_DOWN) != 0) {
proxyMenuItem = 0;
proxyMenuItem = OS.gtk_tool_item_retrieve_proxy_menu_item (handle);
OS.g_signal_connect(proxyMenuItem, OS.activate, ToolBar.menuItemSelectedFunc.getAddress(), handle);
}
parent.relayout ();
}
@Override
void setOrientation (boolean create) {
if ((parent.style & SWT.RIGHT_TO_LEFT) != 0 || !create) {
int dir = (parent.style & SWT.RIGHT_TO_LEFT) != 0 ? OS.GTK_TEXT_DIR_RTL : OS.GTK_TEXT_DIR_LTR;
if (handle != 0) OS.gtk_widget_set_direction (handle, dir);
}
}
boolean setRadioSelection (boolean value) {
if ((style & SWT.RADIO) == 0) return false;
if (getSelection () != value) {
setSelection (value);
sendSelectionEvent (SWT.Selection);
}
return true;
}
/**
* Sets the selection state of the receiver.
* <p>
* When the receiver is of type <code>CHECK</code> or <code>RADIO</code>,
* it is selected when it is checked (which some platforms draw as a
* pushed in button).
* </p>
*
* @param selected the new selection state
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public void setSelection (boolean selected) {
checkWidget ();
if ((style & (SWT.CHECK | SWT.RADIO)) == 0) return;
OS.g_signal_handlers_block_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, CLICKED);
OS.gtk_toggle_tool_button_set_active (handle, selected);
OS.g_signal_handlers_unblock_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, CLICKED);
}
@Override
boolean setTabItemFocus (boolean next) {
return setFocus ();
}
/**
* Sets the receiver's text. The string may include
* the mnemonic character.
* </p>
* <p>
* Mnemonics are indicated by an '&' that causes the next
* character to be the mnemonic. When the user presses a
* key sequence that matches the mnemonic, a selection
* event occurs. On most platforms, the mnemonic appears
* underlined but may be emphasised in a platform specific
* manner. The mnemonic indicator character '&' can be
* escaped by doubling it in the string, causing a single
* '&' to be displayed.
* </p>
*
* @param string the new text
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the text is null</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
@Override
public void setText (String string) {
checkWidget();
if (string == null) error (SWT.ERROR_NULL_ARGUMENT);
if ((style & SWT.SEPARATOR) != 0) return;
if (string.equals(this.text)) return;
super.setText (string);
if (labelHandle == 0) return;
char [] chars = fixMnemonic (string);
byte [] buffer = Converter.wcsToMbcs (null, chars, true);
OS.gtk_label_set_text_with_mnemonic (labelHandle, buffer);
/*
* If Text/Image of a tool-item changes, then it is
* required to reset the proxy menu. Otherwise, the
* old menuItem appears in the overflow menu.
*/
if ((style & SWT.DROP_DOWN) != 0) {
proxyMenuItem = 0;
proxyMenuItem = OS.gtk_tool_item_retrieve_proxy_menu_item (handle);
OS.g_signal_connect(proxyMenuItem, OS.activate, ToolBar.menuItemSelectedFunc.getAddress(), handle);
}
parent.relayout ();
}
/**
* Sets the receiver's tool tip text to the argument, which
* may be null indicating that the default tool tip for the
* control will be shown. For a control that has a default
* tool tip, such as the Tree control on Windows, setting
* the tool tip text to an empty string replaces the default,
* causing no tool tip text to be shown.
* <p>
* The mnemonic indicator (character '&') is not displayed in a tool tip.
* To display a single '&' in the tool tip, the character '&' can be
* escaped by doubling it in the string.
* </p>
*
* @param string the new tool tip text (or null)
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public void setToolTipText (String string) {
checkWidget();
if (toolTipText == string || (toolTipText != null && toolTipText.equals(string))) return;
if (parent.toolTipText == null) {
Shell shell = parent._getShell ();
setToolTipText (shell, string);
}
toolTipText = string;
/*
* Since tooltip text of a tool-item is used in overflow
* menu when images are not shown, it is required to
* reset the proxy menu when the tooltip text changes.
* Otherwise, the old menuItem appears in the overflow
* menu as a blank item.
*/
if ((style & SWT.DROP_DOWN) != 0) {
proxyMenuItem = 0;
proxyMenuItem = OS.gtk_tool_item_retrieve_proxy_menu_item (handle);
OS.g_signal_connect(proxyMenuItem, OS.activate, ToolBar.menuItemSelectedFunc.getAddress(), handle);
}
}
void setToolTipText (Shell shell, String newString) {
long /*int*/ child = OS.gtk_bin_get_child (handle);
if ((style & SWT.DROP_DOWN) != 0) {
long /*int*/ list = OS.gtk_container_get_children (child);
child = OS.g_list_nth_data (list, 0);
if (arrowHandle != 0) shell.setToolTipText (arrowHandle, newString);
}
shell.setToolTipText (child != 0 ? child : handle, newString);
}
/**
* Sets the width of the receiver, for <code>SEPARATOR</code> ToolItems.
*
* @param width the new width. If the new value is <code>SWT.DEFAULT</code>,
* the width is a fixed-width area whose amount is determined by the platform.
* If the new value is 0 a vertical or horizontal line will be drawn, depending
* on the setting of the corresponding style bit (<code>SWT.VERTICAL</code> or
* <code>SWT.HORIZONTAL</code>). If the new value is <code>SWT.SEPARATOR_FILL</code>
* a variable-width space is inserted that acts as a spring between the two adjoining
* items which will push them out to the extent of the containing ToolBar.
*
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
*/
public void setWidth (int width) {
checkWidget();
if ((style & SWT.SEPARATOR) == 0) return;
if (width < 0) return;
resizeHandle(width, (parent.style & SWT.VERTICAL) != 0 ? 6 : 15);
parent.relayout ();
}
void showWidget (int index) {
if (handle != 0) OS.gtk_widget_show (handle);
if (labelHandle != 0) OS.gtk_widget_show (labelHandle);
if (imageHandle != 0) OS.gtk_widget_show (imageHandle);
OS.gtk_toolbar_insert(parent.handle, handle, index);
}
}