org.eclipse.swt.widgets.ToolTip Maven / Gradle / Ivy
Show all versions of org.eclipse.swt.gtk.linux.ppc64le Show documentation
/******************************************************************************* * Copyright (c) 2000, 2018 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 * which accompanies this distribution, and is available at * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.eclipse.swt.widgets; import org.eclipse.swt.*; import org.eclipse.swt.events.*; import org.eclipse.swt.graphics.*; import org.eclipse.swt.internal.*; import org.eclipse.swt.internal.cairo.*; import org.eclipse.swt.internal.gtk.*; import org.eclipse.swt.internal.gtk3.*; import org.eclipse.swt.internal.gtk4.*; /** * Instances of this class represent popup windows that are used * to inform or warn the user. *
if the receiver is visible and all * of the receiver's ancestors are visible and*
*- Styles:
*- BALLOON, ICON_ERROR, ICON_INFORMATION, ICON_WARNING
*- Events:
*- Selection
** Note: Only one of the styles ICON_ERROR, ICON_INFORMATION, * and ICON_WARNING may be specified. *
* IMPORTANT: This class is not intended to be subclassed. *
* * @see Tool Tips snippets * @see SWT Example: ControlExample * @see Sample code and further information * * @since 3.2 * @noextend This class is not intended to be subclassed by clients. */ public class ToolTip extends Widget { Shell parent; String text, message; TrayItem item; int x, y, timerId; long layoutText = 0, layoutMessage = 0; long provider; int [] borderPolygon; boolean spikeAbove, autohide; static final int BORDER = 5; static final int PADDING = 5; static final int INSET = 4; static final int TIP_HEIGHT = 20; static final int IMAGE_SIZE = 16; static final int DELAY = 8000; /** * Constructs a new instance of this class given its parent * and a style value describing its behavior and appearance. ** The style value is either one of the style constants defined in * class
* * @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 IllegalArgumentExceptionSWT
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. **
* @exception SWTException- ERROR_NULL_ARGUMENT - if the parent is null
**
* * @see SWT#BALLOON * @see SWT#ICON_ERROR * @see SWT#ICON_INFORMATION * @see SWT#ICON_WARNING * @see Widget#checkSubclass * @see Widget#getStyle */ public ToolTip (Shell parent, int style) { super (parent, checkStyle (style)); this.parent = parent; createWidget (0); parent.addToolTip (this); } static int checkStyle (int style) { int mask = SWT.ICON_ERROR | SWT.ICON_INFORMATION | SWT.ICON_WARNING; if ((style & mask) == 0) return style; return checkBits (style, SWT.ICON_INFORMATION, SWT.ICON_WARNING, SWT.ICON_ERROR, 0, 0, 0); } /** * Adds the listener to the collection of listeners who will * be notified when the receiver is selected by the user, 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
*SelectionListener
* interface. **
* * @param listener the listener which should be notified when the receiver is selected by the user * * @exception IllegalArgumentExceptionwidgetSelected
is called when the receiver is selected. *widgetDefaultSelected
is not called. **
* @exception SWTException- ERROR_NULL_ARGUMENT - if the listener is null
**
* * @see SelectionListener * @see #removeSelectionListener * @see SelectionEvent */ public void addSelectionListener (SelectionListener listener) { addTypedListener(listener, SWT.Selection, SWT.DefaultSelection); } void configure () { /* * Bug in GTK4: A lot of the functions that SWT uses to configure tooltips * in this function were removed from GTK4. Due to this, whenever configure() * gets called it causes a crash. The replacement functions for * gtk_widget_shape_combine_region has not been found. So for now, allow this * function to be called without causing the program to crash. * * TODO: Find the replacement for all GTK3 functions called here * * See Bug 577600 */ if(GTK.GTK4) { System.err.println("SWT Error: ToolTip.java: ToolTip with style SWT.BALLOON not supported on GTK 4."); return; } GTK.gtk_widget_realize (handle); /* * Feature in GTK: using gdk_screen_get_monitor_at_window() does not accurately get the correct monitor on the machine. * Using gdk_screen_get_monitor_at_point() returns it correctly. Using getLocation() on point will get * the coordinates for where the tooltip should appear on the host. */ Point point = getLocation(); boolean multipleMonitors; GdkRectangle dest = new GdkRectangle (); long displayHandle = GDK.gdk_display_get_default(); if (GTK.GTK4) { long monitorList = GDK.gdk_display_get_monitors(displayHandle); multipleMonitors = OS.g_list_model_get_n_items(monitorList) > 1; } else { multipleMonitors = GDK.gdk_display_get_n_monitors(displayHandle) > 1; } long monitor = GDK.gdk_display_get_monitor_at_point(displayHandle, point.x, point.y); GDK.gdk_monitor_get_geometry (monitor, dest); point = getSize (dest.width / 4); int w = point.x; int h = point.y; point = getLocation (); int x = point.x; int y = point.y; GTK3.gtk_window_resize (handle, w, h + TIP_HEIGHT); int[] polyline; Rectangle bounds = display.getBounds(); int width = bounds != null && GTK.GTK4 ? bounds.width : GDK.gdk_screen_width(); spikeAbove = dest.height >= y + h + TIP_HEIGHT; if ((dest.width >= x + w) || (multipleMonitors && width >= x + w)) { if (dest.height >= y + h + TIP_HEIGHT) { int t = TIP_HEIGHT; polyline = new int[] { 0, 5+t, 1, 5+t, 1, 3+t, 3, 1+t, 5, 1+t, 5, t, 16, t, 16, 0, 35, t, w-5, t, w-5, 1+t, w-3, 1+t, w-1, 3+t, w-1, 5+t, w, 5+t, w, h-5+t, w-1, h-5+t, w-1, h-3+t, w-2, h-3+t, w-2, h-2+t, w-3, h-2+t, w-3, h-1+t, w-5, h-1+t, w-5, h+t, 5, h+t, 5, h-1+t, 3, h-1+t, 3, h-2+t, 2, h-2+t, 2, h-3+t, 1, h-3+t, 1, h-5+t, 0, h-5+t, 0, 5+t}; borderPolygon = new int[] { 0, 5+t, 1, 4+t, 1, 3+t, 3, 1+t, 4, 1+t, 5, t, 16, t, 16, 1, 35, t, w-6, 0+t, w-5, 1+t, w-4, 1+t, w-2, 3+t, w-2, 4+t, w-1, 5+t, w-1, h-6+t, w-2, h-5+t, w-2, h-4+t, w-4, h-2+t, w-5, h-2+t, w-6, h-1+t, 5, h-1+t, 4, h-2+t, 3, h-2+t, 1, h-4+t, 1, h-5+t, 0, h-6+t, 0, 5+t}; if ((parent.style & SWT.MIRRORED) != 0) { x -= w - 36; polyline[12] = w-36; polyline[14] = w-16; polyline[16] = w-15; borderPolygon[12] = w-35; borderPolygon[14] = borderPolygon[16] = w-16; } GTK3.gtk_window_move (handle, Math.max(0, x - 17), y); } else { polyline = new int[] { 0, 5, 1, 5, 1, 3, 3, 1, 5, 1, 5, 0, w-5, 0, w-5, 1, w-3, 1, w-1, 3, w-1, 5, w, 5, w, h-5, w-1, h-5, w-1, h-3, w-2, h-3, w-2, h-2, w-3, h-2, w-3, h-1, w-5, h-1, w-5, h, 35, h, 16, h+TIP_HEIGHT, 16, h, 5, h, 5, h-1, 3, h-1, 3, h-2, 2, h-2, 2, h-3, 1, h-3, 1, h-5, 0, h-5, 0, 5}; borderPolygon = new int[] { 0, 5, 1, 4, 1, 3, 3, 1, 4, 1, 5, 0, w-6, 0, w-5, 1, w-4, 1, w-2, 3, w-2, 4, w-1, 5, w-1, h-6, w-2, h-5, w-2, h-4, w-4, h-2, w-5, h-2, w-6, h-1, 35, h-1, 17, h+TIP_HEIGHT-2, 17, h-1, 5, h-1, 4, h-2, 3, h-2, 1, h-4, 1, h-5, 0, h-6, 0, 5}; if ((parent.style & SWT.MIRRORED) != 0) { x -= w - 36; polyline [42] = polyline [44] = w-16; polyline [46] = w-35; borderPolygon[36] = borderPolygon[38] = w-17; borderPolygon [40] = w-35; } GTK3.gtk_window_move (handle, Math.max(0, x - 17), y - h - TIP_HEIGHT); } } else { if (dest.height >= y + h + TIP_HEIGHT) { int t = TIP_HEIGHT; polyline = new int[] { 0, 5+t, 1, 5+t, 1, 3+t, 3, 1+t, 5, 1+t, 5, t, w-35, t, w-16, 0, w-16, t, w-5, t, w-5, 1+t, w-3, 1+t, w-1, 3+t, w-1, 5+t, w, 5+t, w, h-5+t, w-1, h-5+t, w-1, h-3+t, w-2, h-3+t, w-2, h-2+t, w-3, h-2+t, w-3, h-1+t, w-5, h-1+t, w-5, h+t, 5, h+t, 5, h-1+t, 3, h-1+t, 3, h-2+t, 2, h-2+t, 2, h-3+t, 1, h-3+t, 1, h-5+t, 0, h-5+t, 0, 5+t}; borderPolygon = new int[] { 0, 5+t, 1, 4+t, 1, 3+t, 3, 1+t, 4, 1+t, 5, t, w-35, t, w-17, 2, w-17, t, w-6, t, w-5, 1+t, w-4, 1+t, w-2, 3+t, w-2, 4+t, w-1, 5+t, w-1, h-6+t, w-2, h-5+t, w-2, h-4+t, w-4, h-2+t, w-5, h-2+t, w-6, h-1+t, 5, h-1+t, 4, h-2+t, 3, h-2+t, 1, h-4+t, 1, h-5+t, 0, h-6+t, 0, 5+t}; if ((parent.style & SWT.MIRRORED) != 0) { x += w - 35; polyline [12] = polyline [14] = 16; polyline [16] = 35; borderPolygon[12] = borderPolygon[14] = 16; borderPolygon [16] = 35; } GTK3.gtk_window_move (handle, Math.max(dest.width- w, x - w + 17), y); } else { polyline = new int[] { 0, 5, 1, 5, 1, 3, 3, 1, 5, 1, 5, 0, w-5, 0, w-5, 1, w-3, 1, w-1, 3, w-1, 5, w, 5, w, h-5, w-1, h-5, w-1, h-3, w-2, h-3, w-2, h-2, w-3, h-2, w-3, h-1, w-5, h-1, w-5, h, w-16, h, w-16, h+TIP_HEIGHT, w-35, h, 5, h, 5, h-1, 3, h-1, 3, h-2, 2, h-2, 2, h-3, 1, h-3, 1, h-5, 0, h-5, 0, 5}; borderPolygon = new int[] { 0, 5, 1, 4, 1, 3, 3, 1, 4, 1, 5, 0, w-6, 0, w-5, 1, w-4, 1, w-2, 3, w-2, 4, w-1, 5, w-1, h-6, w-2, h-5, w-2, h-4, w-4, h-2, w-5, h-2, w-6, h-1, w-17, h-1, w-17, h+TIP_HEIGHT-2, w-36, h-1, 5, h-1, 4, h-2, 3, h-2, 1, h-4, 1, h-5, 0, h-6, 0, 5}; if ((parent.style & SWT.MIRRORED) != 0) { x += w - 35; polyline [42] = 35; polyline [44] = polyline [46] = 16; borderPolygon[36] = 35; borderPolygon[38] = borderPolygon [40] = 17; } GTK3.gtk_window_move (handle, Math.max(dest.width - w, x - w + 17), y - h - TIP_HEIGHT); } } GTK.gtk_widget_realize(handle); Region region = new Region (display); region.add(DPIUtil.autoScaleDown(polyline)); GTK3.gtk_widget_shape_combine_region (handle, region.handle); region.dispose (); } @Override void createHandle (int index) { if ((style & SWT.BALLOON) != 0) { state |= HANDLE; if (GTK.GTK4) { //TODO: GTK4 implementation of ToolTips } else { handle = GTK3.gtk_window_new (GTK.GTK_WINDOW_POPUP); Color background = display.getSystemColor (SWT.COLOR_INFO_BACKGROUND); long context = GTK.gtk_widget_get_style_context (handle); GdkRGBA bgRGBA = background.handle; String css = "window {background-color: " + display.gtk_rgba_to_css_string(bgRGBA) + ";}"; gtk_css_provider_load_from_css (context, css); GTK3.gtk_style_context_invalidate (context); GTK3.gtk_window_set_type_hint (handle, GDK.GDK_WINDOW_TYPE_HINT_TOOLTIP); } } } void gtk_css_provider_load_from_css (long context, String css) { /* Utility function. */ //@param css : a 'css java' string like "{\nbackground: red;\n}". if (provider == 0) { provider = GTK.gtk_css_provider_new (); GTK.gtk_style_context_add_provider (context, provider, GTK.GTK_STYLE_PROVIDER_PRIORITY_APPLICATION); OS.g_object_unref (provider); } if (GTK.GTK4) { GTK4.gtk_css_provider_load_from_data (provider, Converter.wcsToMbcs (css, true), -1); } else { GTK3.gtk_css_provider_load_from_data (provider, Converter.wcsToMbcs (css, true), -1, null); } } @Override void createWidget (int index) { super.createWidget (index); text = ""; message = ""; x = y = -1; autohide = true; } @Override void destroyWidget () { long topHandle = topHandle (); if (parent != null) parent.removeTooTip (this); releaseHandle (); if (topHandle != 0 && (state & HANDLE) != 0) { if ((style & SWT.BALLOON) != 0) { if (GTK.GTK4) { OS.g_object_unref(topHandle); } else { GTK3.gtk_widget_destroy(topHandle); } } else { OS.g_object_unref(topHandle); } } } /** * 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 automatically * hidden by the platform, andfalse
otherwise. * * @return the receiver's auto hide state * * @exception SWTException*
*/ public boolean getAutoHide () { checkWidget (); return autohide; } Point getLocation () { int x = this.x; int y = this.y; if (item != null) { long itemHandle = item.handle; GdkRectangle area = new GdkRectangle (); GTK3.gtk_status_icon_get_geometry (itemHandle, 0, area, 0); x = area.x + area.width / 2; y = area.y + area.height / 2; } if (x == -1 || y == -1) { if (GTK.GTK4) { double[] px = new double[1], py = new double[1]; display.getPointerPosition(px, py); x = (int)px[0]; y = (int)py[0]; } else { int[] px = new int[1], py = new int[1]; display.getWindowPointerPosition (0, px, py, null); x = px[0]; y = py[0]; } } return new Point(x, y); } /** * Returns the receiver's message, which will be an empty * string if it has never been set. * * @return the receiver's message * * @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 String getMessage () { checkWidget (); return message; } @Override String getNameText () { return getText (); } /** * Returns the receiver's parent, which must be a- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
*- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*Shell
. * * @return the receiver's parent * * @exception SWTException*
*/ public Shell getParent () { checkWidget (); return parent; } Point getSize (int maxWidth) { int textWidth = 0, messageWidth = 0; int [] w = new int [1], h = new int [1]; if (layoutText != 0) { OS.pango_layout_set_width (layoutText, -1); OS.pango_layout_get_pixel_size (layoutText, w, h); textWidth = w [0]; } if (layoutMessage != 0) { OS.pango_layout_set_width (layoutMessage, -1); OS.pango_layout_get_pixel_size (layoutMessage, w, h); messageWidth = w [0]; } int messageTrim = 2 * INSET + 2 * BORDER + 2 * PADDING; boolean hasImage = layoutText != 0 && (style & (SWT.ICON_ERROR | SWT.ICON_INFORMATION | SWT.ICON_WARNING)) != 0; int textTrim = messageTrim + (hasImage ? IMAGE_SIZE : 0); int width = Math.min (maxWidth, Math.max (textWidth + textTrim, messageWidth + messageTrim)); int textHeight = 0, messageHeight = 0; if (layoutText != 0) { OS.pango_layout_set_width (layoutText, (maxWidth - textTrim) * OS.PANGO_SCALE); OS.pango_layout_get_pixel_size (layoutText, w, h); textHeight = h [0]; } if (layoutMessage != 0) { OS.pango_layout_set_width (layoutMessage, (maxWidth - messageTrim) * OS.PANGO_SCALE); OS.pango_layout_get_pixel_size (layoutMessage, w, h); messageHeight = h [0]; } int height = 2 * BORDER + 2 * PADDING + messageHeight; if (layoutText != 0) height += Math.max (IMAGE_SIZE, textHeight) + 2 * PADDING; return new Point(width, height); } /** * Returns the receiver's text, which will be an empty * string if it has never been set. * * @return the receiver's text * * @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 String getText () { checkWidget (); return text; } /** * 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 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*
*/ public boolean getVisible () { checkWidget (); if ((style & SWT.BALLOON) != 0) return GTK.gtk_widget_get_visible (handle); return false; } @Override long gtk_button_press_event (long widget, long event) { sendSelectionEvent (SWT.Selection, null, true); setVisible (false); return 0; } void drawTooltip (long cairo) { int x = BORDER + PADDING; int y = BORDER + PADDING; if (cairo == 0) error (SWT.ERROR_NO_HANDLES); int count = borderPolygon.length / 2; if (count != 0) { Cairo.cairo_set_line_width(cairo, 1); Cairo.cairo_move_to(cairo, borderPolygon[0], borderPolygon[1]); for (int i=1,j=2; i- ERROR_WIDGET_DISPOSED - if the receiver has been disposed
*- ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*true 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_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 *
true
,
* and remain visible when false
.
*
* @param autoHide the auto hide 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. *
* * @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 tooltips. *
* * @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 *
-
*
- ERROR_NULL_ARGUMENT - if the text 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_NULL_ARGUMENT - if the text 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 *
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 *