/******************************************************************************* * 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.gtk.*; import org.eclipse.swt.graphics.*; import org.eclipse.swt.events.*; /** * Instances of this class are selectable user interface * objects that represent a range of positive, numeric values. *

* At any given moment, a given slider will have a * single 'selection' that is considered to be its * value, which is constrained to be within the range of * values the slider represents (that is, between its * minimum and maximum values). *

* Typically, sliders will be made up of five areas: *

    *
  1. an arrow button for decrementing the value
    2. *
  2. a page decrement area for decrementing the value by a larger amount
    3. *
  3. a thumb for modifying the value by mouse dragging
    4. *
  4. a page increment area for incrementing the value by a larger amount
    5. *
  5. an arrow button for incrementing the value
    6. *
* Based on their style, sliders are either HORIZONTAL * (which have a left facing button for decrementing the value and a * right facing button for incrementing it) or VERTICAL * (which have an upward facing button for decrementing the value * and a downward facing buttons for incrementing it). *

* On some platforms, the size of the slider's thumb can be * varied relative to the magnitude of the range of values it * represents (that is, relative to the difference between its * maximum and minimum values). Typically, this is used to * indicate some proportional value such as the ratio of the * visible area of a document to the total amount of space that * it would take to display it. SWT supports setting the thumb * size even if the underlying platform does not, but in this * case the appearance of the slider will not change. *

*
*
Styles:
*
HORIZONTAL, VERTICAL
*
Events:
*
Selection
*
*

* Note: Only one of the styles HORIZONTAL and VERTICAL may be specified. *

* IMPORTANT: This class is not intended to be subclassed. *

* * @see ScrollBar * @see Slider snippets * @see SWT Example: ControlExample * @see Sample code and further information * @noextend This class is not intended to be subclassed by clients. */ public class Slider extends Control { int detail; boolean dragSent; /** * 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 * @exception SWTException * * @see SWT#HORIZONTAL * @see SWT#VERTICAL * @see Widget#checkSubclass * @see Widget#getStyle */ public Slider (Composite parent, int style) { super (parent, checkStyle (style)); } /** * Adds the listener to the collection of listeners who will * be notified when the user changes the receiver's value, by sending * it one of the messages defined in the SelectionListener * interface. *

* When widgetSelected is called, the event object detail field contains one of the following values: * SWT.NONE - for the end of a drag. * SWT.DRAG. * SWT.HOME. * SWT.END. * SWT.ARROW_DOWN. * SWT.ARROW_UP. * SWT.PAGE_DOWN. * SWT.PAGE_UP. * widgetDefaultSelected is not called. *

* * @param listener the listener which should be notified when the user changes the receiver's value * * @exception IllegalArgumentException * @exception SWTException * * @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.HORIZONTAL, SWT.VERTICAL, 0, 0, 0, 0); } void createHandle (int index) { state |= HANDLE; fixedHandle = OS.g_object_new (display.gtk_fixed_get_type (), 0); if (fixedHandle == 0) error (SWT.ERROR_NO_HANDLES); gtk_widget_set_has_window (fixedHandle, true); long /*int*/ hAdjustment = OS.gtk_adjustment_new (0, 0, 100, 1, 10, 10); if (hAdjustment == 0) error (SWT.ERROR_NO_HANDLES); if ((style & SWT.HORIZONTAL) != 0) { handle = gtk_scrollbar_new (OS.GTK_ORIENTATION_HORIZONTAL, hAdjustment); } else { handle = gtk_scrollbar_new (OS.GTK_ORIENTATION_VERTICAL, hAdjustment); } if (handle == 0) error (SWT.ERROR_NO_HANDLES); /* * Bug in GTK. In GTK 2.10, the buttons on either end of * a horizontal slider are created taller then the slider bar * when the GTK_CAN_FOCUS flag is set. The fix is not to set * the flag for horizontal bars in all versions of 2.10. Note * that a bug has been logged with GTK about this issue. * (http://bugzilla.gnome.org/show_bug.cgi?id=475909) */ if (OS.GTK_VERSION < OS.VERSION (2, 10, 0) || (style & SWT.VERTICAL) != 0) { gtk_widget_set_can_focus (handle, true); } OS.gtk_container_add (fixedHandle, handle); } long /*int*/ gtk_button_press_event (long /*int*/ widget, long /*int*/ eventPtr) { long /*int*/ result = super.gtk_button_press_event (widget, eventPtr); if (result != 0) return result; detail = OS.GTK_SCROLL_NONE; dragSent = false; return result; } long /*int*/ gtk_change_value (long /*int*/ widget, long /*int*/ scroll, long /*int*/ value1, long /*int*/ value2) { detail = (int)/*64*/scroll; return 0; } long /*int*/ gtk_value_changed (long /*int*/ adjustment) { Event event = new Event (); dragSent = detail == OS.GTK_SCROLL_JUMP; switch (detail) { case OS.GTK_SCROLL_NONE: event.detail = SWT.NONE; break; case OS.GTK_SCROLL_JUMP: event.detail = SWT.DRAG; break; case OS.GTK_SCROLL_START: event.detail = SWT.HOME; break; case OS.GTK_SCROLL_END: event.detail = SWT.END; break; case OS.GTK_SCROLL_PAGE_DOWN: case OS.GTK_SCROLL_PAGE_RIGHT: case OS.GTK_SCROLL_PAGE_FORWARD: event.detail = SWT.PAGE_DOWN; break; case OS.GTK_SCROLL_PAGE_UP: case OS.GTK_SCROLL_PAGE_LEFT: case OS.GTK_SCROLL_PAGE_BACKWARD: event.detail = SWT.PAGE_UP; break; case OS.GTK_SCROLL_STEP_DOWN: case OS.GTK_SCROLL_STEP_RIGHT: case OS.GTK_SCROLL_STEP_FORWARD: event.detail = SWT.ARROW_DOWN; break; case OS.GTK_SCROLL_STEP_UP: case OS.GTK_SCROLL_STEP_LEFT: case OS.GTK_SCROLL_STEP_BACKWARD: event.detail = SWT.ARROW_UP; break; } if (!dragSent) detail = OS.GTK_SCROLL_NONE; sendSelectionEvent (SWT.Selection, event, false); return 0; } long /*int*/ gtk_event_after (long /*int*/ widget, long /*int*/ gdkEvent) { GdkEvent gtkEvent = new GdkEvent (); OS.memmove (gtkEvent, gdkEvent, GdkEvent.sizeof); switch (gtkEvent.type) { case OS.GDK_BUTTON_RELEASE: { GdkEventButton gdkEventButton = new GdkEventButton (); OS.memmove (gdkEventButton, gdkEvent, GdkEventButton.sizeof); if (gdkEventButton.button == 1 && detail == SWT.DRAG) { if (!dragSent) { Event event = new Event (); event.detail = SWT.DRAG; sendSelectionEvent (SWT.Selection, event, false); } sendSelectionEvent (SWT.Selection); } detail = OS.GTK_SCROLL_NONE; dragSent = false; break; } } return super.gtk_event_after (widget, gdkEvent); } void hookEvents () { super.hookEvents (); OS.g_signal_connect_closure (handle, OS.change_value, display.closures [CHANGE_VALUE], false); OS.g_signal_connect_closure (handle, OS.value_changed, display.closures [VALUE_CHANGED], false); } void register () { super.register (); long /*int*/ hAdjustment = OS.gtk_range_get_adjustment (handle); display.addWidget (hAdjustment, this); } void deregister () { super.deregister (); long /*int*/ hAdjustment = OS.gtk_range_get_adjustment (handle); display.removeWidget (hAdjustment); } public Point computeSize (int wHint, int hHint, boolean changed) { checkWidget(); OS.gtk_widget_realize(handle); if (wHint != SWT.DEFAULT && wHint < 0) wHint = 0; if (hHint != SWT.DEFAULT && hHint < 0) hHint = 0; Point size = computeNativeSize(handle, wHint, hHint, changed); if ((style & SWT.HORIZONTAL) != 0) { if (wHint == SWT.DEFAULT) size.x = 2 * size.x; } else { if (hHint == SWT.DEFAULT) size.y = 2 * size.y; } return size; } /** * Returns the amount that the receiver's value will be * modified by when the up/down (or right/left) arrows * are pressed. * * @return the increment * * @exception SWTException */ public int getIncrement () { checkWidget (); long /*int*/ hAdjustment = OS.gtk_range_get_adjustment (handle); return (int) gtk_adjustment_get_step_increment (hAdjustment); } /** * Returns the maximum value which the receiver will allow. * * @return the maximum * * @exception SWTException */ public int getMaximum () { checkWidget (); long /*int*/ hAdjustment = OS.gtk_range_get_adjustment (handle); return (int) gtk_adjustment_get_upper (hAdjustment); } /** * Returns the minimum value which the receiver will allow. * * @return the minimum * * @exception SWTException */ public int getMinimum () { checkWidget (); long /*int*/ hAdjustment = OS.gtk_range_get_adjustment (handle); return (int) gtk_adjustment_get_lower (hAdjustment); } /** * Returns the amount that the receiver's value will be * modified by when the page increment/decrement areas * are selected. * * @return the page increment * * @exception SWTException */ public int getPageIncrement () { checkWidget (); long /*int*/ hAdjustment = OS.gtk_range_get_adjustment (handle); return (int) gtk_adjustment_get_page_increment (hAdjustment); } /** * Returns the 'selection', which is the receiver's value. * * @return the selection * * @exception SWTException */ public int getSelection () { checkWidget (); long /*int*/ hAdjustment = OS.gtk_range_get_adjustment (handle); return (int) gtk_adjustment_get_value (hAdjustment); } /** * Returns the receiver's thumb value. * * @return the thumb value * * @exception SWTException */ public int getThumb () { checkWidget (); long /*int*/ hAdjustment = OS.gtk_range_get_adjustment (handle); return (int) gtk_adjustment_get_page_size (hAdjustment); } /** * Removes the listener from the collection of listeners who will * be notified when the user changes the receiver's value. * * @param listener the listener which should no longer be notified * * @exception IllegalArgumentException * @exception SWTException * * @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); } /** * Sets the amount that the receiver's value will be * modified by when the up/down (or right/left) arrows * are pressed to the argument, which must be at least * one. * * @param value the new increment (must be greater than zero) * * @exception SWTException */ public void setIncrement (int value) { checkWidget (); if (value < 1) return; OS.g_signal_handlers_block_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, VALUE_CHANGED); OS.gtk_range_set_increments (handle, value, getPageIncrement ()); OS.g_signal_handlers_unblock_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, VALUE_CHANGED); } /** * Sets the maximum. If this value is negative or less than or * equal to the minimum, the value is ignored. If necessary, first * the thumb and then the selection are adjusted to fit within the * new range. * * @param value the new maximum, which must be greater than the current minimum * * @exception SWTException */ public void setMaximum (int value) { checkWidget (); long /*int*/ hAdjustment = OS.gtk_range_get_adjustment (handle); GtkAdjustment adjustment = new GtkAdjustment (); gtk_adjustment_get (hAdjustment, adjustment); int minimum = (int) adjustment.lower; if (value <= minimum) return; adjustment.upper = value; adjustment.page_size = Math.min ((int)adjustment.page_size, value - minimum); adjustment.value = Math.min ((int)adjustment.value, (int)(value - adjustment.page_size)); OS.g_signal_handlers_block_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, VALUE_CHANGED); gtk_adjustment_configure (hAdjustment, adjustment); OS.g_signal_handlers_unblock_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, VALUE_CHANGED); } /** * Sets the minimum value. If this value is negative or greater * than or equal to the maximum, the value is ignored. If necessary, * first the thumb and then the selection are adjusted to fit within * the new range. * * @param value the new minimum * * @exception SWTException */ public void setMinimum (int value) { checkWidget (); if (value < 0) return; long /*int*/ hAdjustment = OS.gtk_range_get_adjustment (handle); GtkAdjustment adjustment = new GtkAdjustment (); gtk_adjustment_get (hAdjustment, adjustment); int maximum = (int) adjustment.upper; if (value >= maximum) return; adjustment.lower = value; adjustment.page_size = Math.min ((int)adjustment.page_size, maximum - value); adjustment.value = Math.max ((int)adjustment.value, value); OS.g_signal_handlers_block_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, VALUE_CHANGED); gtk_adjustment_configure (hAdjustment, adjustment); OS.g_signal_handlers_unblock_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, VALUE_CHANGED); } void setOrientation (boolean create) { super.setOrientation (create); if ((style & SWT.RIGHT_TO_LEFT) != 0 || !create) { if ((style & SWT.HORIZONTAL) != 0) { OS.gtk_range_set_inverted (handle, (style & SWT.RIGHT_TO_LEFT) != 0); } } } /** * Sets the amount that the receiver's value will be * modified by when the page increment/decrement areas * are selected to the argument, which must be at least * one. * * @param value the page increment (must be greater than zero) * * @exception SWTException */ public void setPageIncrement (int value) { checkWidget (); if (value < 1) return; OS.g_signal_handlers_block_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, VALUE_CHANGED); OS.gtk_range_set_increments (handle, getIncrement (), value); OS.g_signal_handlers_unblock_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, VALUE_CHANGED); } /** * Sets the 'selection', which is the receiver's * value, to the argument which must be greater than or equal * to zero. * * @param value the new selection (must be zero or greater) * * @exception SWTException */ public void setSelection (int value) { checkWidget (); OS.g_signal_handlers_block_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, VALUE_CHANGED); OS.gtk_range_set_value (handle, value); OS.g_signal_handlers_unblock_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, VALUE_CHANGED); } /** * Sets the thumb value. The thumb value should be used to represent * the size of the visual portion of the current range. This value is * usually the same as the page increment value. *

* This new value will be ignored if it is less than one, and will be * clamped if it exceeds the receiver's current range. *

* * @param value the new thumb value, which must be at least one and not * larger than the size of the current range * * @exception SWTException */ public void setThumb (int value) { checkWidget (); if (value < 1) return; long /*int*/ hAdjustment = OS.gtk_range_get_adjustment (handle); GtkAdjustment adjustment = new GtkAdjustment (); gtk_adjustment_get (hAdjustment, adjustment); value = (int) Math.min (value, (int)(adjustment.upper - adjustment.lower)); adjustment.page_size = (double) value; adjustment.value = Math.min ((int)adjustment.value, (int)(adjustment.upper - value)); OS.g_signal_handlers_block_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, VALUE_CHANGED); gtk_adjustment_configure (hAdjustment, adjustment); OS.g_signal_handlers_unblock_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, VALUE_CHANGED); } /** * Sets the receiver's selection, minimum value, maximum * value, thumb, increment and page increment all at once. *

* Note: This is similar to setting the values individually * using the appropriate methods, but may be implemented in a * more efficient fashion on some platforms. *

* * @param selection the new selection value * @param minimum the new minimum value * @param maximum the new maximum value * @param thumb the new thumb value * @param increment the new increment value * @param pageIncrement the new pageIncrement value * * @exception SWTException */ public void setValues (int selection, int minimum, int maximum, int thumb, int increment, int pageIncrement) { checkWidget (); if (minimum < 0) return; if (maximum < 0) return; if (thumb < 1) return; if (increment < 1) return; if (pageIncrement < 1) return; thumb = Math.min (thumb, maximum - minimum); long /*int*/ hAdjustment = OS.gtk_range_get_adjustment (handle); GtkAdjustment adjustment = new GtkAdjustment (); adjustment.value = Math.min (Math.max (selection, minimum), maximum - thumb); adjustment.lower = (double) minimum; adjustment.upper = (double) maximum; adjustment.page_size = (double) thumb; adjustment.step_increment = (double) increment; adjustment.page_increment = (double) pageIncrement; OS.g_signal_handlers_block_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, VALUE_CHANGED); gtk_adjustment_configure (hAdjustment, adjustment); OS.gtk_adjustment_value_changed (hAdjustment); OS.g_signal_handlers_unblock_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, VALUE_CHANGED); } long /*int*/ gtk_scrollbar_new (int orientation, long /*int*/ adjustment) { long /*int*/ scrollbar = 0; if (OS.GTK3) { scrollbar = OS.gtk_scrollbar_new (orientation, adjustment); } else { if (orientation == OS.GTK_ORIENTATION_HORIZONTAL) { scrollbar = OS.gtk_hscrollbar_new (adjustment); } else { scrollbar = OS.gtk_vscrollbar_new (adjustment); } } return scrollbar; } }