# HG changeset patch # User Frank Benoit # Date 1200141594 -3600 # Node ID a4880dcb413993f066f588b848ac20a61f850f21 # Parent 1d461bec7afbcd2e797c2e27e7df035b10523b19 Slider diff -r 1d461bec7afb -r a4880dcb4139 dwt/widgets/Slider.d --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/dwt/widgets/Slider.d Sat Jan 12 13:39:54 2008 +0100 @@ -0,0 +1,579 @@ +/******************************************************************************* + * Copyright (c) 2000, 2007 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 + *******************************************************************************/ +module dwt.widgets.Slider; + + +import dwt.widgets.Control; +import dwt.widgets.Composite; +import dwt.widgets.TypedListener; +import dwt.widgets.Event; +import dwt.SWT; +import dwt.internal.gtk.OS; +import dwt.graphics.Point; +import dwt.events.SelectionListener; + +/** + * 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. + *
  3. a page decrement area for decrementing the value by a larger amount
  4. + *
  5. a thumb for modifying the value by mouse dragging
  6. + *
  7. a page increment area for incrementing the value by a larger amount
  8. + *
  9. an arrow button for incrementing the value
  10. + *
+ * 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 + */ +public class Slider : Control { + int detail; + bool 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 this (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 is 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); +} + +override void createHandle (int index) { + state |= HANDLE; + fixedHandle = cast(GtkWidget*)OS.g_object_new (display.gtk_fixed_get_type (), null); + if (fixedHandle is null) error (SWT.ERROR_NO_HANDLES); + OS.gtk_fixed_set_has_window (cast(GtkFixed*)fixedHandle, true); + auto hAdjustment = OS.gtk_adjustment_new (0, 0, 100, 1, 10, 10); + if (hAdjustment is null) error (SWT.ERROR_NO_HANDLES); + if ((style & SWT.HORIZONTAL) !is 0) { + handle = cast(GtkWidget*)OS.gtk_hscrollbar_new (cast(GtkAdjustment*)hAdjustment); + } else { + handle = cast(GtkWidget*)OS.gtk_vscrollbar_new (cast(GtkAdjustment*)hAdjustment); + } + if (handle is null) error (SWT.ERROR_NO_HANDLES); + OS.GTK_WIDGET_SET_FLAGS (handle, OS.GTK_CAN_FOCUS); + OS.gtk_container_add (cast(GtkContainer*)fixedHandle, handle); +} + +override int /*long*/ gtk_button_press_event (GtkWidget* widget, GdkEventButton* event) { + auto result = super.gtk_button_press_event (widget, event); + if (result !is 0) return result; + detail = OS.GTK_SCROLL_NONE; + dragSent = false; + return result; +} + +override int /*long*/ gtk_change_value (GtkWidget* widget, int /*long*/ scroll, int /*long*/ value1, int /*long*/ value2) { + detail = cast(int)/*64*/scroll; + return 0; +} + +override int /*long*/ gtk_value_changed (int /*long*/ adjustment) { + Event event = new Event (); + dragSent = detail is 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; + default: + } + if (!dragSent) detail = OS.GTK_SCROLL_NONE; + postEvent (SWT.Selection, event); + return 0; +} + +override int /*long*/ gtk_event_after (GtkWidget* widget, GdkEvent* gdkEvent) { + switch (gdkEvent.type) { + case OS.GDK_BUTTON_RELEASE: { + GdkEventButton* gdkEventButton = cast(GdkEventButton*)gdkEvent; + if (gdkEventButton.button is 1 && detail is SWT.DRAG) { + if (!dragSent) { + Event event = new Event (); + event.detail = SWT.DRAG; + postEvent (SWT.Selection, event); + } + postEvent (SWT.Selection); + } + detail = OS.GTK_SCROLL_NONE; + dragSent = false; + break; + default: + } + } + return super.gtk_event_after (widget, gdkEvent); +} + +override void hookEvents () { + super.hookEvents (); + if (OS.GTK_VERSION >= OS.buildVERSION (2, 6, 0)) { + OS.g_signal_connect_closure (handle, OS.change_value.ptr, display.closures [CHANGE_VALUE], false); + } + OS.g_signal_connect_closure (handle, OS.value_changed.ptr, display.closures [VALUE_CHANGED], false); +} + +override void register () { + super.register (); + auto hAdjustment = OS.gtk_range_get_adjustment (cast(GtkRange*)handle); + display.addWidget (cast(GtkWidget*)hAdjustment, this); +} + +override void deregister () { + super.deregister (); + auto hAdjustment = OS.gtk_range_get_adjustment (cast(GtkRange*)handle); + display.removeWidget (cast(GtkWidget*)hAdjustment); +} + +override public Point computeSize (int wHint, int hHint, bool changed) { + checkWidget(); + if (wHint !is SWT.DEFAULT && wHint < 0) wHint = 0; + if (hHint !is SWT.DEFAULT && hHint < 0) hHint = 0; + Point size = computeNativeSize(handle, wHint, hHint, changed); + if ((style & SWT.HORIZONTAL) !is 0) { + if (wHint is SWT.DEFAULT) size.x = 2 * size.x; + } else { + if (hHint is 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 (); + auto hAdjustment = OS.gtk_range_get_adjustment (cast(GtkRange*)handle); + return cast(int) hAdjustment.step_increment; +} + +/** + * Returns the maximum value which the receiver will allow. + * + * @return the maximum + * + * @exception SWTException + */ +public int getMaximum () { + checkWidget (); + auto hAdjustment = OS.gtk_range_get_adjustment (cast(GtkRange*)handle); + return cast(int) hAdjustment.upper; +} + +/** + * Returns the minimum value which the receiver will allow. + * + * @return the minimum + * + * @exception SWTException + */ +public int getMinimum () { + checkWidget (); + auto hAdjustment = OS.gtk_range_get_adjustment (cast(GtkRange*)handle); + return cast(int) hAdjustment.lower; +} + +/** + * 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 (); + auto hAdjustment = OS.gtk_range_get_adjustment (cast(GtkRange*)handle); + return cast(int) hAdjustment.page_increment; +} + +/** + * Returns the 'selection', which is the receiver's value. + * + * @return the selection + * + * @exception SWTException + */ +public int getSelection () { + checkWidget (); + auto hAdjustment = OS.gtk_range_get_adjustment (cast(GtkRange*)handle); + return cast(int) hAdjustment.value; +} + +/** + * Returns the size of the receiver's thumb relative to the + * difference between its maximum and minimum values. + * + * @return the thumb value + * + * @exception SWTException + */ +public int getThumb () { + checkWidget (); + auto hAdjustment = OS.gtk_range_get_adjustment (cast(GtkRange*)handle); + return cast(int) hAdjustment.page_size; +} + +/** + * 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 is null) error (SWT.ERROR_NULL_ARGUMENT); + if (eventTable is 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, null, null, cast(void*)VALUE_CHANGED); + OS.gtk_range_set_increments (cast(GtkRange*)handle, value, getPageIncrement ()); + OS.g_signal_handlers_unblock_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, null, null, cast(void*)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 (); + auto adjustment = OS.gtk_range_get_adjustment (cast(GtkRange*)handle); + int minimum = cast(int) adjustment.lower; + if (value <= minimum) return; + adjustment.upper = value; + adjustment.page_size = Math.min (cast(int)adjustment.page_size, value - minimum); + adjustment.value = Math.min (cast(int)adjustment.value, cast(int)(value - adjustment.page_size)); + OS.g_signal_handlers_block_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, null, null, cast(void*)VALUE_CHANGED); + OS.gtk_adjustment_changed (adjustment); + OS.g_signal_handlers_unblock_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, null, null, cast(void*)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; + auto adjustment = OS.gtk_range_get_adjustment (cast(GtkRange*)handle); + int maximum = cast(int) adjustment.upper; + if (value >= maximum) return; + adjustment.lower = value; + adjustment.page_size = Math.min (cast(int)adjustment.page_size, maximum - value); + adjustment.value = Math.max (cast(int)adjustment.value, value); + OS.g_signal_handlers_block_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, null, null, cast(void*)VALUE_CHANGED); + OS.gtk_adjustment_changed (adjustment); + OS.g_signal_handlers_unblock_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, null, null, cast(void*)VALUE_CHANGED); +} + +void setOrientation () { + super.setOrientation (); + if ((style & SWT.RIGHT_TO_LEFT) !is 0) { + if ((style & SWT.HORIZONTAL) !is 0) { + OS.gtk_range_set_inverted (cast(GtkRange*)handle, true); + } + } +} + +/** + * 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, null, null, cast(void*)VALUE_CHANGED); + OS.gtk_range_set_increments (cast(GtkRange*)handle, getIncrement (), value); + OS.g_signal_handlers_unblock_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, null, null, cast(void*)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, null, null, cast(void*)VALUE_CHANGED); + OS.gtk_range_set_value (cast(GtkRange*)handle, value); + OS.g_signal_handlers_unblock_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, null, null, cast(void*)VALUE_CHANGED); +} + +/** + * Sets the size of the receiver's thumb relative to the + * difference between its maximum and minimum values. 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; + auto adjustment = OS.gtk_range_get_adjustment (cast(GtkRange*)handle); + value = cast(int) Math.min (value, cast(int)(adjustment.upper - adjustment.lower)); + adjustment.page_size = cast(double) value; + adjustment.value = Math.min (cast(int)adjustment.value, cast(int)(adjustment.upper - value)); + OS.g_signal_handlers_block_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, null, null, cast(void*)VALUE_CHANGED); + OS.gtk_adjustment_changed (adjustment); + OS.g_signal_handlers_unblock_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, null, null, cast(void*)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); + auto adjustment = OS.gtk_range_get_adjustment (cast(GtkRange*)handle); + adjustment.value = Math.min (Math.max (selection, minimum), maximum - thumb); + adjustment.lower = cast(double) minimum; + adjustment.upper = cast(double) maximum; + adjustment.page_size = cast(double) thumb; + adjustment.step_increment = cast(double) increment; + adjustment.page_increment = cast(double) pageIncrement; + OS.g_signal_handlers_block_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, null, null, cast(void*)VALUE_CHANGED); + OS.gtk_adjustment_changed (adjustment); + OS.gtk_adjustment_value_changed (adjustment); + OS.g_signal_handlers_unblock_matched (handle, OS.G_SIGNAL_MATCH_DATA, 0, 0, null, null, cast(void*)VALUE_CHANGED); +} + +} diff -r 1d461bec7afb -r a4880dcb4139 todo.txt --- a/todo.txt Sat Jan 12 13:23:38 2008 +0100 +++ b/todo.txt Sat Jan 12 13:39:54 2008 +0100 @@ -106,7 +106,7 @@ widgets/ImageList // OKs widgets/Item // OKs widgets/Label -widgets/Layout +widgets/Layout // OKs widgets/Link widgets/List widgets/Listener // OKs @@ -121,7 +121,7 @@ widgets/Scrollable // OKs widgets/ScrollBar // OKs widgets/Shell // OKs -widgets/Slider +widgets/Slider // OKs widgets/Spinner widgets/Synchronizer // OKs widgets/TabFolder