org.eclipse.swt.widgets.Sash Maven / Gradle / Ivy
Show all versions of org.eclipse.swt.gtk.linux.aarch64 Show documentation
/*******************************************************************************
* Copyright (c) 2000, 2021 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.gtk.*;
import org.eclipse.swt.internal.gtk3.*;
import org.eclipse.swt.internal.gtk4.*;
/**
* Instances of the receiver represent a selectable user interface object
* that allows the user to drag a rubber banded outline of the sash within
* the parent control.
*
* - Styles:
* - HORIZONTAL, VERTICAL, SMOOTH
* - Events:
* - Selection
*
*
* Note: Only one of the styles HORIZONTAL and VERTICAL may be specified.
*
* IMPORTANT: This class is not intended to be subclassed.
*
*
* @see Sash snippets
* @see SWT Example: ControlExample
* @see Sample code and further information
* @noextend This class is not intended to be subclassed by clients.
*/
public class Sash extends Control {
boolean dragging;
int startX, startY, lastX, lastY;
long defaultCursor;
private final static int INCREMENT = 1;
private final static int PAGE_INCREMENT = 9;
private final static int DEFAULT_CROSS_AXIS_SIZE = 3;
/**
* 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 SWT
which is applicable to instances of this
* class, or must be built by bitwise OR'ing together
* (that is, using the int
"|" operator) two or more
* of those SWT
style constants. The class description
* lists the style constants that are applicable to the class.
* Style bits are also inherited from superclasses.
*
*
* @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
* - ERROR_NULL_ARGUMENT - if the parent is null
*
* @exception SWTException
* - 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
*
*
* @see SWT#HORIZONTAL
* @see SWT#VERTICAL
* @see SWT#SMOOTH
* @see Widget#checkSubclass
* @see Widget#getStyle
*/
public Sash(Composite parent, int style) {
super(parent, checkStyle(style));
}
/**
* 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 SelectionListener
* interface.
*
* When widgetSelected
is called, the x, y, width, and height fields of the event object are valid.
* If the receiver is being dragged, the event object detail field contains the value SWT.DRAG
.
* widgetDefaultSelected
is not called.
*
*
* @param listener the listener which should be notified when the control is selected by the user
*
* @exception IllegalArgumentException
* - ERROR_NULL_ARGUMENT - if the listener is null
*
* @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
*
*
* @see SelectionListener
* @see #removeSelectionListener
* @see SelectionEvent
*/
public void addSelectionListener(SelectionListener listener) {
addTypedListener(listener, SWT.Selection, SWT.DefaultSelection);
}
static int checkStyle(int style) {
style |= SWT.SMOOTH;
return checkBits(style, SWT.HORIZONTAL, SWT.VERTICAL, 0, 0, 0, 0);
}
@Override
Point computeSizeInPixels(int wHint, int hHint, boolean changed) {
checkWidget();
if (wHint != SWT.DEFAULT && wHint < 0) wHint = 0;
if (hHint != SWT.DEFAULT && hHint < 0) hHint = 0;
int border = getBorderWidthInPixels();
int width = border * 2, height = border * 2;
if ((style & SWT.HORIZONTAL) != 0) {
width += DEFAULT_WIDTH;
height += DEFAULT_CROSS_AXIS_SIZE;
} else {
width += DEFAULT_CROSS_AXIS_SIZE;
height += DEFAULT_HEIGHT;
}
if (wHint != SWT.DEFAULT) width = wHint + (border * 2);
if (hHint != SWT.DEFAULT) height = hHint + (border * 2);
return new Point(width, height);
}
@Override
void createHandle(int index) {
state |= HANDLE | THEME_BACKGROUND;
handle = OS.g_object_new(display.gtk_fixed_get_type(), 0);
if (handle == 0) error(SWT.ERROR_NO_HANDLES);
if (GTK.GTK4) {
GTK4.gtk_widget_set_focusable(handle, true);
if ((style & SWT.VERTICAL) != 0) {
defaultCursor = GDK.gdk_cursor_new_from_name("sb_h_double_arrow", 0);
} else {
defaultCursor = GDK.gdk_cursor_new_from_name("sb_v_double_arrow", 0);
}
} else {
GTK3.gtk_widget_set_has_window(handle, true);
if ((style & SWT.VERTICAL) != 0) {
defaultCursor = GDK.gdk_cursor_new_from_name(GDK.gdk_display_get_default(), "sb_h_double_arrow");
} else {
defaultCursor = GDK.gdk_cursor_new_from_name(GDK.gdk_display_get_default(), "sb_v_double_arrow");
}
}
GTK.gtk_widget_set_can_focus(handle, true);
}
@Override
void gtk_gesture_press_event(long gesture, int n_press, double x, double y, long event) {
super.gtk_gesture_press_event(gesture, n_press, x, y, event);
int eventButton = GDK.gdk_button_event_get_button(event);
if (eventButton != 1 || n_press != 1) return;
startX = (int)x;
startY = (int)y;
GtkAllocation allocation = new GtkAllocation();
GTK.gtk_widget_get_allocation(handle, allocation);
int allocationX = allocation.x;
int allocationY = allocation.y;
int width = allocation.width;
int height = allocation.height;
lastX = allocationX;
lastY = allocationY;
Event jEvent = new Event();
jEvent.time = GDK.gdk_event_get_time(event);
Rectangle eventRect = new Rectangle(lastX, lastY, width, height);
jEvent.setBounds(DPIUtil.autoScaleDown(eventRect));
if ((style & SWT.SMOOTH) == 0) {
jEvent.detail = SWT.DRAG;
}
if ((parent.style & SWT.MIRRORED) != 0) jEvent.x = DPIUtil.autoScaleDown(parent.getClientWidth() - width) - jEvent.x;
sendSelectionEvent(SWT.Selection, jEvent, true);
if (isDisposed()) return;
if (jEvent.doit) {
dragging = true;
}
}
@Override
void gtk_gesture_release_event(long gesture, int n_press, double x, double y, long event) {
super.gtk_gesture_release_event(gesture, n_press, x, y, event);
int eventButton = GDK.gdk_button_event_get_button(event);
if (eventButton != 1 || !dragging) return;
dragging = false;
}
@Override
void gtk4_motion_event(long controller, double x, double y, long event) {
super.gtk4_motion_event(controller, x, y, event);
if (!dragging) return;
GtkAllocation allocation = new GtkAllocation();
GTK.gtk_widget_get_allocation(handle, allocation);
int allocationX = allocation.x;
int allocationY = allocation.y;
int width = allocation.width;
int height = allocation.height;
GTK.gtk_widget_get_allocation(parent.handle, allocation);
int parentWidth = allocation.width;
int parentHeight = allocation.height;
int newX = lastX, newY = lastY;
if ((style & SWT.VERTICAL) != 0) {
newX = Math.min(Math.max(0, (int)x + allocationX - startX), parentWidth - width);
} else {
newY = Math.min(Math.max(0, (int)y + allocationY - startY), parentHeight - height);
}
if (newX == lastX && newY == lastY) return;
Event jEvent = new Event();
jEvent.time = GDK.gdk_event_get_time(event);
Rectangle eventRect = new Rectangle(newX, newY, width, height);
jEvent.setBounds(DPIUtil.autoScaleDown(eventRect));
if ((style & SWT.SMOOTH) == 0) {
jEvent.detail = SWT.DRAG;
}
if ((parent.style & SWT.MIRRORED) != 0) jEvent.x = DPIUtil.autoScaleDown(parent.getClientWidth() - width) - jEvent.x;
sendSelectionEvent(SWT.Selection, jEvent, true);
if (isDisposed()) return;
Rectangle rect = DPIUtil.autoScaleUp(jEvent.getBounds());
if (jEvent.doit) {
lastX = rect.x;
lastY = rect.y;
if ((parent.style & SWT.MIRRORED) != 0) lastX = parent.getClientWidth() - width - lastX;
}
parent.update(true, (style & SWT.SMOOTH) == 0);
if ((style & SWT.SMOOTH) != 0) {
/*
* Use lastX instead of rect.x, as lastX takes into account
* the event.doit flag. See bug 522140.
*/
setBoundsInPixels(lastX, lastY, width, height);
}
}
@Override
boolean gtk4_key_press_event(long controller, int keyval, int keycode, int state, long event) {
boolean handled = super.gtk4_key_press_event(controller, keyval, keycode, state, event);
if (!handled) return handled;
switch (keyval) {
case GDK.GDK_Left:
case GDK.GDK_Right:
case GDK.GDK_Up:
case GDK.GDK_Down:
int xChange = 0, yChange = 0;
int stepSize = PAGE_INCREMENT;
if ((state & GDK.GDK_CONTROL_MASK) != 0) stepSize = INCREMENT;
if ((style & SWT.VERTICAL) != 0) {
if (keyval == GDK.GDK_Up || keyval == GDK.GDK_Down) break;
xChange = keyval == GDK.GDK_Left ? -stepSize : stepSize;
} else {
if (keyval == GDK.GDK_Left || keyval == GDK.GDK_Right) break;
yChange = keyval == GDK.GDK_Up ? -stepSize : stepSize;
}
GtkAllocation allocation = new GtkAllocation();
GTK.gtk_widget_get_allocation(handle, allocation);
int width = allocation.width;
int height = allocation.height;
GTK.gtk_widget_get_allocation(parent.handle, allocation);
int parentWidth = allocation.width;
int parentHeight = allocation.height;
int newX = lastX, newY = lastY;
if ((style & SWT.VERTICAL) != 0) {
newX = Math.min(Math.max(0, lastX + xChange - startX), parentWidth - width);
} else {
newY = Math.min(Math.max(0, lastY + yChange - startY), parentHeight - height);
}
if (newX == lastX && newY == lastY) return handled;
/* The event must be sent because its doit flag is used. */
Event jEvent = new Event();
jEvent.time = GDK.gdk_event_get_time(event);
Rectangle eventRect = new Rectangle(newX, newY, width, height);
jEvent.setBounds(DPIUtil.autoScaleDown(eventRect));
if ((parent.style & SWT.MIRRORED) != 0) jEvent.x = DPIUtil.autoScaleDown(parent.getClientWidth() - width) - jEvent.x;
sendSelectionEvent(SWT.Selection, jEvent, true);
if (isDisposed()) break;
if (jEvent.doit) {
Rectangle rect = DPIUtil.autoScaleUp(jEvent.getBounds());
lastX = rect.x;
lastY = rect.y;
if ((parent.style & SWT.MIRRORED) != 0) lastX = parent.getClientWidth() - width - lastX;
if ((style & SWT.SMOOTH) != 0) {
setBoundsInPixels(rect.x, rect.y, width, height);
if (isDisposed()) break;
}
}
}
return handled;
}
@Override
long gtk_button_press_event(long widget, long event) {
long result = super.gtk_button_press_event(widget, event);
if (result != 0) return result;
int[] eventButton = new int[1];
GDK.gdk_event_get_button(event, eventButton);
if (eventButton[0] != 1) return 0;
int eventType = GDK.gdk_event_get_event_type(event);
if (eventType == GDK.GDK_2BUTTON_PRESS) return 0;
if (eventType == GDK.GDK_3BUTTON_PRESS) return 0;
double[] eventRX = new double[1], eventRY = new double[1];
GDK.gdk_event_get_root_coords(event, eventRX, eventRY);
long window = gtk_widget_get_window(widget);
int[] origin_x = new int[1], origin_y = new int[1];
GDK.gdk_window_get_origin(window, origin_x, origin_y);
startX = (int)(eventRX[0] - origin_x[0]);
startY = (int)(eventRY[0] - origin_y[0]);
GtkAllocation allocation = new GtkAllocation();
GTK.gtk_widget_get_allocation(handle, allocation);
int x = allocation.x;
int y = allocation.y;
int width = allocation.width;
int height = allocation.height;
lastX = x;
lastY = y;
Event jEvent = new Event();
jEvent.time = GDK.gdk_event_get_time(event);
Rectangle eventRect = new Rectangle(lastX, lastY, width, height);
jEvent.setBounds(DPIUtil.autoScaleDown(eventRect));
if ((style & SWT.SMOOTH) == 0) {
jEvent.detail = SWT.DRAG;
}
if ((parent.style & SWT.MIRRORED) != 0) jEvent.x = DPIUtil.autoScaleDown(parent.getClientWidth() - width) - jEvent.x;
sendSelectionEvent(SWT.Selection, jEvent, true);
if (isDisposed()) return 0;
if (jEvent.doit) {
dragging = true;
Rectangle rect = DPIUtil.autoScaleUp(jEvent.getBounds());
lastX = rect.x;
lastY = rect.y;
if ((parent.style & SWT.MIRRORED) != 0) lastX = parent.getClientWidth() - width - lastX;
parent.update(true, (style & SWT.SMOOTH) == 0);
if ((style & SWT.SMOOTH) != 0) {
setBoundsInPixels(rect.x, rect.y, width, height);
// widget could be disposed at this point
}
}
return result;
}
@Override
long gtk_button_release_event(long widget, long event) {
long result = super.gtk_button_release_event(widget, event);
if (result != 0) return result;
int[] eventButton = new int[1];
GDK.gdk_event_get_button(event, eventButton);
if (eventButton[0] != 1 || !dragging) return 0;
dragging = false;
GtkAllocation allocation = new GtkAllocation();
GTK.gtk_widget_get_allocation(handle, allocation);
int width = allocation.width;
int height = allocation.height;
Event jEvent = new Event();
jEvent.time = GDK.gdk_event_get_time(event);
Rectangle eventRect = new Rectangle(lastX, lastY, width, height);
jEvent.setBounds(DPIUtil.autoScaleDown(eventRect));
if ((parent.style & SWT.MIRRORED) != 0) jEvent.x = DPIUtil.autoScaleDown(parent.getClientWidth() - width) - jEvent.x;
sendSelectionEvent(SWT.Selection, jEvent, true);
if (isDisposed()) return result;
if (jEvent.doit) {
if ((style & SWT.SMOOTH) != 0) {
Rectangle rect = DPIUtil.autoScaleUp(jEvent.getBounds());
setBoundsInPixels(rect.x, rect.y, width, height);
// widget could be disposed at this point
}
}
return result;
}
@Override
long gtk_draw(long widget, long cairo) {
long context = GTK.gtk_widget_get_style_context(widget);
GtkAllocation allocation = new GtkAllocation();
GTK.gtk_widget_get_allocation(widget, allocation);
int width = (state & ZERO_WIDTH) != 0 ? 0 : allocation.width;
int height = (state & ZERO_HEIGHT) != 0 ? 0 : allocation.height;
// We specify a 0 value for x & y as we want the whole widget to be
// colored, not some portion of it.
GTK.gtk_render_background(context, cairo, 0, 0, width, height);
return super.gtk_draw(widget, cairo);
}
@Override
long gtk_focus_in_event(long widget, long event) {
long result = super.gtk_focus_in_event(widget, event);
if (result != 0) return result;
// widget could be disposed at this point
if (handle != 0) {
GtkAllocation allocation = new GtkAllocation();
GTK.gtk_widget_get_allocation(handle, allocation);
lastX = allocation.x;
lastY = allocation.y;
}
return 0;
}
@Override
long gtk_key_press_event(long widget, long eventPtr) {
long result = super.gtk_key_press_event(widget, eventPtr);
if (result != 0) return result;
int[] key = new int[1], state = new int[1];
GDK.gdk_event_get_keyval(eventPtr, key);
GDK.gdk_event_get_state(eventPtr, state);
switch (key[0]) {
case GDK.GDK_Left:
case GDK.GDK_Right:
case GDK.GDK_Up:
case GDK.GDK_Down:
int xChange = 0, yChange = 0;
int stepSize = PAGE_INCREMENT;
if ((state[0] & GDK.GDK_CONTROL_MASK) != 0) stepSize = INCREMENT;
if ((style & SWT.VERTICAL) != 0) {
if (key[0] == GDK.GDK_Up || key[0] == GDK.GDK_Down) break;
xChange = key[0] == GDK.GDK_Left ? -stepSize : stepSize;
} else {
if (key[0] == GDK.GDK_Left || key[0] == GDK.GDK_Right) break;
yChange = key[0] == GDK.GDK_Up ? -stepSize : stepSize;
}
GtkAllocation allocation = new GtkAllocation();
GTK.gtk_widget_get_allocation (handle, allocation);
int width = allocation.width;
int height = allocation.height;
GTK.gtk_widget_get_allocation (parent.handle, allocation);
int parentWidth = allocation.width;
int parentHeight = allocation.height;
int newX = lastX, newY = lastY;
if ((style & SWT.VERTICAL) != 0) {
newX = Math.min(Math.max(0, lastX + xChange - startX), parentWidth - width);
} else {
newY = Math.min(Math.max(0, lastY + yChange - startY), parentHeight - height);
}
if (newX == lastX && newY == lastY) return result;
/* Ensure that the pointer image does not change */
long gdkResource = gtk_widget_get_window(handle);
int grabMask = GDK.GDK_POINTER_MOTION_MASK | GDK.GDK_BUTTON_RELEASE_MASK;
long gdkCursor = cursor != null ? cursor.handle : defaultCursor;
int ptrGrabResult = gdk_pointer_grab(gdkResource, GDK.GDK_OWNERSHIP_NONE, false, grabMask, gdkResource, gdkCursor, GDK.GDK_CURRENT_TIME);
/* The event must be sent because its doit flag is used. */
Event event = new Event();
event.time = GDK.gdk_event_get_time(eventPtr);
Rectangle eventRect = new Rectangle(newX, newY, width, height);
event.setBounds(DPIUtil.autoScaleDown(eventRect));
if ((parent.style & SWT.MIRRORED) != 0) event.x = DPIUtil.autoScaleDown(parent.getClientWidth() - width) - event.x;
sendSelectionEvent(SWT.Selection, event, true);
if (ptrGrabResult == GDK.GDK_GRAB_SUCCESS) gdk_pointer_ungrab(gdkResource, GDK.GDK_CURRENT_TIME);
if (isDisposed()) break;
if (event.doit) {
Rectangle rect = DPIUtil.autoScaleUp(event.getBounds());
lastX = rect.x;
lastY = rect.y;
if ((parent.style & SWT.MIRRORED) != 0) lastX = parent.getClientWidth() - width - lastX;
if ((style & SWT.SMOOTH) != 0) {
setBoundsInPixels(rect.x, rect.y, width, height);
if (isDisposed()) break;
}
int cursorX = rect.x, cursorY = rect.y;
if ((style & SWT.VERTICAL) != 0) {
cursorY += height / 2;
} else {
cursorX += width / 2;
}
display.setCursorLocation(parent.toDisplayInPixels(cursorX, cursorY));
}
break;
}
return result;
}
@Override
long gtk_motion_notify_event(long widget, long eventPtr) {
long result = super.gtk_motion_notify_event(widget, eventPtr);
if (result != 0) return result;
if (!dragging) return 0;
int eventX, eventY, eventState;
double[] fetchedX = new double[1], fetchedY = new double[1];
GDK.gdk_event_get_root_coords(eventPtr, fetchedX, fetchedY);
int[] state = new int[1];
GDK.gdk_event_get_state(eventPtr, state);
long gdkResource = gdk_event_get_surface_or_window(eventPtr);
boolean isHint;
GdkEventMotion gdkEvent = new GdkEventMotion();
GTK3.memmove(gdkEvent, eventPtr, GdkEventMotion.sizeof);
isHint = gdkEvent.is_hint != 0;
if (isHint) {
int[] pointer_x = new int[1], pointer_y = new int[1], mask = new int[1];
display.getWindowPointerPosition(gdkResource, pointer_x, pointer_y, mask);
eventX = pointer_x[0];
eventY = pointer_y[0];
eventState = mask[0];
} else {
int[] origin_x = new int[1], origin_y = new int[1];
GDK.gdk_window_get_origin(gdkResource, origin_x, origin_y);
eventX = (int)(fetchedX[0] - origin_x [0]);
eventY = (int)(fetchedY[0] - origin_y [0]);
eventState = state[0];
}
if ((eventState & GDK.GDK_BUTTON1_MASK) == 0) return 0;
GtkAllocation allocation = new GtkAllocation();
GTK.gtk_widget_get_allocation(handle, allocation);
int x = allocation.x;
int y = allocation.y;
int width = allocation.width;
int height = allocation.height;
GTK.gtk_widget_get_allocation(parent.handle, allocation);
int parentWidth = allocation.width;
int parentHeight = allocation.height;
int newX = lastX, newY = lastY;
if ((style & SWT.VERTICAL) != 0) {
newX = Math.min(Math.max(0, eventX + x - startX), parentWidth - width);
} else {
newY = Math.min(Math.max(0, eventY + y - startY), parentHeight - height);
}
if (newX == lastX && newY == lastY) return 0;
Event event = new Event();
event.time = GDK.gdk_event_get_time(eventPtr);
Rectangle eventRect = new Rectangle(newX, newY, width, height);
event.setBounds(DPIUtil.autoScaleDown(eventRect));
if ((style & SWT.SMOOTH) == 0) {
event.detail = SWT.DRAG;
}
if ((parent.style & SWT.MIRRORED) != 0) event.x = DPIUtil.autoScaleDown(parent.getClientWidth() - width) - event.x;
sendSelectionEvent(SWT.Selection, event, true);
if (isDisposed()) return 0;
Rectangle rect = DPIUtil.autoScaleUp(event.getBounds());
if (event.doit) {
lastX = rect.x;
lastY = rect.y;
if ((parent.style & SWT.MIRRORED) != 0) lastX = parent.getClientWidth() - width - lastX;
}
parent.update(true, (style & SWT.SMOOTH) == 0);
if ((style & SWT.SMOOTH) != 0) {
/*
* Use lastX instead of rect.x, as lastX takes into account
* the event.doit flag. See bug 522140.
*/
setBoundsInPixels(lastX, lastY, width, height);
}
return result;
}
@Override
long gtk_realize(long widget) {
setCursor(cursor != null ? cursor.handle : 0);
return super.gtk_realize (widget);
}
@Override
void hookEvents() {
super.hookEvents();
if (!GTK.GTK4) GTK3.gtk_widget_add_events(handle, GDK.GDK_POINTER_MOTION_HINT_MASK);
}
@Override
void releaseWidget() {
super.releaseWidget();
if (defaultCursor != 0) OS.g_object_unref(defaultCursor);
defaultCursor = 0;
}
/**
* 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
* - ERROR_NULL_ARGUMENT - if the listener is null
*
* @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
*
*
* @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);
}
@Override
void setCursor(long cursor) {
super.setCursor(cursor != 0 ? cursor : defaultCursor);
}
@Override
int traversalCode(int key, long event) {
return 0;
}
}