Mercurial > projects > dwt-linux
view dwt/widgets/ExpandBar.d @ 351:f1bb3949939b
Update to SWT 3.4.1
author | Frank Benoit <benoit@tionex.de> |
---|---|
date | Mon, 03 Nov 2008 23:35:30 +0100 |
parents | c0d810de7093 |
children |
line wrap: on
line source
/******************************************************************************* * Copyright (c) 2000, 2008 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 * Port to the D programming language: * Frank Benoit <benoit@tionex.de> *******************************************************************************/ module dwt.widgets.ExpandBar; import dwt.DWT; import dwt.DWTException; import dwt.events.ExpandAdapter; import dwt.events.ExpandEvent; import dwt.events.ExpandListener; import dwt.graphics.FontMetrics; import dwt.graphics.GC; import dwt.graphics.GCData; import dwt.graphics.Point; import dwt.internal.gtk.OS; import dwt.widgets.ExpandItem; import dwt.widgets.Composite; import dwt.widgets.ScrollBar; import dwt.widgets.TypedListener; import dwt.widgets.Event; import dwt.widgets.Control; import dwt.dwthelper.utils; /** * Instances of this class support the layout of selectable * expand bar items. * <p> * The item children that may be added to instances of this class * must be of type <code>ExpandItem</code>. * </p><p> * <dl> * <dt><b>Styles:</b></dt> * <dd>V_SCROLL</dd> * <dt><b>Events:</b></dt> * <dd>Expand, Collapse</dd> * </dl> * </p><p> * IMPORTANT: This class is <em>not</em> intended to be subclassed. * </p> * * @see ExpandItem * @see ExpandEvent * @see ExpandListener * @see ExpandAdapter * @see <a href="http://www.eclipse.org/swt/snippets/#expandbar">ExpandBar snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">DWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> * * @since 3.2 */ public class ExpandBar : Composite { alias Composite.computeSize computeSize; alias Composite.createHandle createHandle; alias Composite.forceFocus forceFocus; alias Composite.setBounds setBounds; alias Composite.setForegroundColor setForegroundColor; ExpandItem [] items; ExpandItem lastFocus; int itemCount; int spacing; int yCurrentScroll; /** * Constructs a new instance of this class given its parent * and a style value describing its behavior and appearance. * <p> * The style value is either one of the style constants defined in * class <code>DWT</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>DWT</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 DWTException <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 Widget#checkSubclass * @see Widget#getStyle */ public this (Composite parent, int style) { super (parent, style); } /** * Adds the listener to the collection of listeners who will * be notified when an item in the receiver is expanded or collapsed * by sending it one of the messages defined in the <code>ExpandListener</code> * interface. * * @param listener the listener which should be notified * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the listener is null</li> * </ul> * @exception DWTException <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 ExpandListener * @see #removeExpandListener */ public void addExpandListener (ExpandListener listener) { checkWidget (); if (listener is null) error (DWT.ERROR_NULL_ARGUMENT); TypedListener typedListener = new TypedListener (listener); addListener (DWT.Expand, typedListener); addListener (DWT.Collapse, typedListener); } protected override void checkSubclass () { if (!isValidSubclass ()) error (DWT.ERROR_INVALID_SUBCLASS); } public override Point computeSize (int wHint, int hHint, bool changed) { if (OS.GTK_VERSION >= OS.buildVERSION (2, 4, 0)) { if (wHint !is DWT.DEFAULT && wHint < 0) wHint = 0; if (hHint !is DWT.DEFAULT && hHint < 0) hHint = 0; Point size = computeNativeSize (handle, wHint, hHint, changed); int border = OS.gtk_container_get_border_width (handle); size.x += 2 * border; size.y += 2 * border; return size; } else { int height = 0, width = 0; if (wHint is DWT.DEFAULT || hHint is DWT.DEFAULT) { if (itemCount > 0) { height += spacing; GC gc = new GC (this); for (int i = 0; i < itemCount; i++) { ExpandItem item = items [i]; height += item.getHeaderHeight (); if (item.expanded) height += item.height; height += spacing; width = Math.max (width, item.getPreferredWidth (gc)); } gc.dispose (); } } if (width is 0) width = DEFAULT_WIDTH; if (height is 0) height = DEFAULT_HEIGHT; if (wHint !is DWT.DEFAULT) width = wHint; if (hHint !is DWT.DEFAULT) height = hHint; return new Point (width, height); } } override void createHandle (int index) { state |= HANDLE; if (OS.GTK_VERSION >= OS.buildVERSION (2, 4, 0)) { fixedHandle = cast(GtkWidget*)OS.g_object_new (display.gtk_fixed_get_type (), null); if (fixedHandle is null) error (DWT.ERROR_NO_HANDLES); OS.gtk_fixed_set_has_window (fixedHandle, true); handle = cast(GtkWidget*)OS.gtk_vbox_new (false, 0); if (handle is null) error (DWT.ERROR_NO_HANDLES); if ((style & DWT.V_SCROLL) !is 0) { scrolledHandle = cast(GtkWidget*)OS.gtk_scrolled_window_new (null, null); if (scrolledHandle is null) error (DWT.ERROR_NO_HANDLES); int vsp = (style & DWT.V_SCROLL) !is 0 ? OS.GTK_POLICY_AUTOMATIC : OS.GTK_POLICY_NEVER; OS.gtk_scrolled_window_set_policy (scrolledHandle, OS.GTK_POLICY_NEVER, vsp); OS.gtk_container_add (fixedHandle, scrolledHandle); OS.gtk_scrolled_window_add_with_viewport (scrolledHandle, handle); } else { OS.gtk_container_add (fixedHandle, handle); } OS.gtk_container_set_border_width (handle, 0); } else { auto topHandle = cast(GtkWidget*)OS.g_object_new (display.gtk_fixed_get_type (), null); if (topHandle is null) error (DWT.ERROR_NO_HANDLES); OS.gtk_fixed_set_has_window (topHandle, true); if ((style & DWT.V_SCROLL) !is 0) { fixedHandle = topHandle; scrolledHandle = cast(GtkWidget*)OS.gtk_scrolled_window_new (null, null); if (scrolledHandle is null) error (DWT.ERROR_NO_HANDLES); handle = cast(GtkWidget*)OS.g_object_new (display.gtk_fixed_get_type (), null); if (handle is null) error (DWT.ERROR_NO_HANDLES); OS.gtk_fixed_set_has_window (handle, true); OS.gtk_container_add (fixedHandle, scrolledHandle); /* * Force the scrolledWindow to have a single child that is * not scrolled automatically. Calling gtk_container_add() * seems to add the child correctly but cause a warning. */ bool warnings = display.getWarnings (); display.setWarnings (false); OS.gtk_container_add (scrolledHandle, handle); display.setWarnings (warnings); } else { handle = topHandle; } OS.GTK_WIDGET_SET_FLAGS (handle, OS.GTK_CAN_FOCUS); } } void createItem (ExpandItem item, int style, int index) { if (!(0 <= index && index <= itemCount)) error (DWT.ERROR_INVALID_RANGE); if (itemCount is items.length) { ExpandItem [] newItems = new ExpandItem [itemCount + 4]; System.arraycopy (items, 0, newItems, 0, items.length); items = newItems; } System.arraycopy (items, index, items, index + 1, itemCount - index); items [index] = item; itemCount++; if (OS.GTK_VERSION < OS.buildVERSION (2, 4, 0)) { if (lastFocus is null) lastFocus = item; } item.width = Math.max (0, getClientArea ().width - spacing * 2); layoutItems (index, true); } override void createWidget (int index) { super.createWidget (index); items = new ExpandItem [4]; } void destroyItem (ExpandItem item) { int index = 0; while (index < itemCount) { if (items [index] is item) break; index++; } if (index is itemCount) return; if (OS.GTK_VERSION < OS.buildVERSION (2, 4, 0)) { if (item is lastFocus) { int focusIndex = index > 0 ? index - 1 : 1; if (focusIndex < itemCount) { lastFocus = items [focusIndex]; lastFocus.redraw (); } else { lastFocus = null; } } } System.arraycopy (items, index + 1, items, index, --itemCount - index); items [itemCount] = null; item.redraw (); layoutItems (index, true); } override GtkWidget* eventHandle () { return OS.GTK_VERSION >= OS.buildVERSION (2, 4, 0) ? fixedHandle : handle; } override bool forceFocus (GtkWidget* focusHandle) { if (OS.GTK_VERSION >= OS.buildVERSION (2, 4, 0)) { if (lastFocus !is null && lastFocus.setFocus ()) return true; for (int i = 0; i < itemCount; i++) { ExpandItem item = items [i]; if (item.setFocus ()) return true; } } return super.forceFocus (focusHandle); } override bool hasFocus () { if (OS.GTK_VERSION >= OS.buildVERSION (2, 4, 0)) { for (int i=0; i<itemCount; i++) { ExpandItem item = items [i]; if (item.hasFocus ()) return true; } } return super.hasFocus(); } int getBandHeight () { if (font is null) return ExpandItem.CHEVRON_SIZE; GC gc = new GC (this); FontMetrics metrics = gc.getFontMetrics (); gc.dispose (); return Math.max (ExpandItem.CHEVRON_SIZE, metrics.getHeight ()); } override GdkColor* getForegroundColor () { if (OS.GTK_VERSION < OS.buildVERSION (2, 4, 0)) { if ((state & FOREGROUND) is 0) { return display.getSystemColor (DWT.COLOR_TITLE_FOREGROUND).handle; } } return super.getForegroundColor (); } /** * Returns the item at the given, zero-relative index in the * receiver. Throws an exception if the index is out of range. * * @param index the index of the item to return * @return the item at the given index * * @exception IllegalArgumentException <ul> * <li>ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)</li> * </ul> * @exception DWTException <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 ExpandItem getItem (int index) { checkWidget(); if (!(0 <= index && index < itemCount)) error (DWT.ERROR_INVALID_RANGE); return items [index]; } /** * Returns the number of items contained in the receiver. * * @return the number of items * * @exception DWTException <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 getItemCount () { checkWidget(); return itemCount; } /** * Returns an array of <code>ExpandItem</code>s which are the items * in the receiver. * <p> * Note: This is not the actual structure used by the receiver * to maintain its list of items, so modifying the array will * not affect the receiver. * </p> * * @return the items in the receiver * * @exception DWTException <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 ExpandItem [] getItems () { checkWidget (); ExpandItem [] result = new ExpandItem [itemCount]; System.arraycopy (items, 0, result, 0, itemCount); return result; } /** * Returns the receiver's spacing. * * @return the spacing * * @exception DWTException <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 getSpacing () { checkWidget (); return spacing; } override int /*long*/ gtk_button_press_event (GtkWidget* widget, GdkEventButton* gdkEvent) { if (OS.GTK_VERSION < OS.buildVERSION (2, 4, 0)) { int x = cast(int)gdkEvent.x; int y = cast(int)gdkEvent.y; for (int i = 0; i < itemCount; i++) { ExpandItem item = items[i]; bool hover = item.x <= x && x < (item.x + item.width) && item.y <= y && y < (item.y + getBandHeight ()); if (hover && item !is lastFocus) { lastFocus.redraw (); lastFocus = item; lastFocus.redraw (); forceFocus (); break; } } } return super.gtk_button_press_event (widget, gdkEvent); } override int /*long*/ gtk_button_release_event (GtkWidget* widget, GdkEventButton* gdkEvent) { if (OS.GTK_VERSION < OS.buildVERSION (2, 4, 0)) { if (lastFocus !is null) { int x = cast(int)gdkEvent.x; int y = cast(int)gdkEvent.y; bool hover = lastFocus.x <= x && x < (lastFocus.x + lastFocus.width) && lastFocus.y <= y && y < (lastFocus.y + getBandHeight ()); if (hover) { Event ev = new Event (); ev.item = lastFocus; notifyListeners (lastFocus.expanded ? DWT.Collapse : DWT.Expand, ev); lastFocus.expanded = !lastFocus.expanded; showItem (lastFocus); } } } return super.gtk_button_release_event (widget, gdkEvent); } override int /*long*/ gtk_expose_event (GtkWidget* widget, GdkEventExpose* gdkEvent) { if (OS.GTK_VERSION < OS.buildVERSION (2, 4, 0)) { GCData data = new GCData (); data.damageRgn = gdkEvent.region; GC gc = GC.gtk_new (this, data); OS.gdk_gc_set_clip_region (gc.handle, gdkEvent.region); bool hasFocus = isFocusControl (); for (int i = 0; i < itemCount; i++) { ExpandItem item = items [i]; item.drawItem (gc, hasFocus && item is lastFocus); } gc.dispose (); } return super.gtk_expose_event (widget, gdkEvent); } override int /*long*/ gtk_focus_in_event (GtkWidget* widget, GdkEventFocus* event) { if (OS.GTK_VERSION < OS.buildVERSION (2, 4, 0)) { if (lastFocus !is null) lastFocus.redraw (); } return super.gtk_focus_in_event(widget, event); } override int /*long*/ gtk_focus_out_event (GtkWidget* widget, GdkEventFocus* event) { if (OS.GTK_VERSION < OS.buildVERSION (2, 4, 0)) { if (lastFocus !is null) lastFocus.redraw (); } return super.gtk_focus_out_event (widget, event); } override int /*long*/ gtk_key_press_event (GtkWidget* widget, GdkEventKey* gdkEvent) { if (OS.GTK_VERSION >= OS.buildVERSION (2, 4, 0)) { if (!hasFocus ()) return 0; auto result = super.gtk_key_press_event (widget, gdkEvent); if (result !is 0) return result; int index = 0; while (index < itemCount) { if (items [index].hasFocus ()) break; index++; } bool next = false; switch (gdkEvent.keyval) { case OS.GDK_Up: case OS.GDK_Left: next = false; break; case OS.GDK_Down: case OS.GDK_Right: next = true; break; default: return result; } int start = index, offset = next ? 1 : -1; while ((index = (index + offset + itemCount) % itemCount) !is start) { ExpandItem item = items [index]; if (item.setFocus ()) return result; } return result; } else { if (lastFocus !is null) { switch (gdkEvent.keyval) { case OS.GDK_Return: case OS.GDK_space: Event ev = new Event (); ev.item = lastFocus; sendEvent (lastFocus.expanded ? DWT.Collapse :DWT.Expand, ev); lastFocus.expanded = !lastFocus.expanded; showItem (lastFocus); break; case OS.GDK_Up: case OS.GDK_KP_Up: { int focusIndex = indexOf (lastFocus); if (focusIndex > 0) { lastFocus.redraw (); lastFocus = items [focusIndex - 1]; lastFocus.redraw (); } break; } case OS.GDK_Down: case OS.GDK_KP_Down: { int focusIndex = indexOf (lastFocus); if (focusIndex < itemCount - 1) { lastFocus.redraw (); lastFocus = items [focusIndex + 1]; lastFocus.redraw (); } break; } default: } } } return super.gtk_key_press_event (widget, gdkEvent); } /** * Searches the receiver's list starting at the first item * (index 0) until an item is found that is equal to the * argument, and returns the index of that item. If no item * is found, returns -1. * * @param item the search item * @return the index of the item * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the item is null</li> * <li>ERROR_INVALID_ARGUMENT - if the item has been disposed</li> * </ul> * @exception DWTException <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 indexOf (ExpandItem item) { checkWidget(); if (item is null) error (DWT.ERROR_NULL_ARGUMENT); for (int i = 0; i < itemCount; i++) { if (items [i] is item) return i; } return -1; } void layoutItems (int index, bool setScrollbar_) { if (OS.GTK_VERSION >= OS.buildVERSION (2, 4, 0)) { for (int i = 0; i < itemCount; i++) { ExpandItem item = items [i]; if (item !is null) item.resizeControl (yCurrentScroll); } } else { if (index < itemCount) { int y = spacing - yCurrentScroll; for (int i = 0; i < index; i++) { ExpandItem item = items [i]; if (item.expanded) y += item.height; y += item.getHeaderHeight() + spacing; } for (int i = index; i < itemCount; i++) { ExpandItem item = items [i]; item.setBounds (spacing, y, 0, 0, true, false); if (item.expanded) y += item.height; y += item.getHeaderHeight() + spacing; } } if (setScrollbar_) setScrollbar (); } } override GtkWidget* parentingHandle () { return OS.GTK_VERSION >= OS.buildVERSION (2, 4, 0) ? fixedHandle : handle; } override void releaseChildren (bool destroy) { for (int i = 0; i < itemCount; i++) { ExpandItem item = items [i]; if (item !is null && !item.isDisposed ()) { item.release (false); } } super.releaseChildren (destroy); } /** * Removes the listener from the collection of listeners who will * be notified when items in the receiver are expanded or collapsed. * * @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 DWTException <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 ExpandListener * @see #addExpandListener */ public void removeExpandListener (ExpandListener listener) { checkWidget (); if (listener is null) error (DWT.ERROR_NULL_ARGUMENT); if (eventTable is null) return; eventTable.unhook (DWT.Expand, listener); eventTable.unhook (DWT.Collapse, listener); } override int setBounds (int x, int y, int width, int height, bool move, bool resize) { int result = super.setBounds (x, y, width, height, move, resize); if (OS.GTK_VERSION < OS.buildVERSION (2, 4, 0)) { if (resize) { if ((style & DWT.V_SCROLL) !is 0) { setScrollbar (); } else { for (int i = 0; i < itemCount; i++) { ExpandItem item = items [i]; int newWidth = Math.max (0, getClientArea ().width - spacing * 2); if (item.width !is newWidth) { item.setBounds (0, 0, newWidth, item.height, false, true); } } } } } return result; } override void setFontDescription (PangoFontDescription* font) { super.setFontDescription (font); if (OS.GTK_VERSION >= OS.buildVERSION (2, 4, 0)) { for (int i = 0; i < itemCount; i++) { items[i].setFontDescription (font); } layoutItems (0, true); } } override void setForegroundColor (GdkColor* color) { super.setForegroundColor (color); if (OS.GTK_VERSION >= OS.buildVERSION (2, 4, 0)) { for (int i = 0; i < itemCount; i++) { items[i].setForegroundColor (color); } } } void setScrollbar () { if (itemCount is 0) return; if ((style & DWT.V_SCROLL) is 0) return; int height = getClientArea ().height; ExpandItem item = items [itemCount - 1]; int maxHeight = item.y + getBandHeight () + spacing; if (item.expanded) maxHeight += item.height; auto adjustmentHandle = OS.gtk_scrolled_window_get_vadjustment (scrolledHandle); yCurrentScroll = cast(int)adjustmentHandle.value; //claim bottom free space if (yCurrentScroll > 0 && height > maxHeight) { yCurrentScroll = Math.max (0, yCurrentScroll + maxHeight - height); layoutItems (0, false); } maxHeight += yCurrentScroll; adjustmentHandle.value = Math.min (yCurrentScroll, maxHeight); adjustmentHandle.upper = maxHeight; adjustmentHandle.page_size = height; OS.gtk_adjustment_changed (adjustmentHandle); int policy = maxHeight > height ? OS.GTK_POLICY_ALWAYS : OS.GTK_POLICY_NEVER; OS.gtk_scrolled_window_set_policy (scrolledHandle, OS.GTK_POLICY_NEVER, policy); int width = OS.GTK_WIDGET_WIDTH (fixedHandle) - spacing * 2; if (policy is OS.GTK_POLICY_ALWAYS) { auto vHandle = OS.GTK_SCROLLED_WINDOW_VSCROLLBAR (scrolledHandle); GtkRequisition requisition; OS.gtk_widget_size_request (vHandle, &requisition); width -= requisition.width; } width = Math.max (0, width); for (int i = 0; i < itemCount; i++) { ExpandItem item2 = items[i]; item2.setBounds (0, 0, width, item2.height, false, true); } } /** * Sets the receiver's spacing. Spacing specifies the number of pixels allocated around * each item. * * @param spacing the spacing around each item * * @exception DWTException <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 setSpacing (int spacing) { checkWidget (); if (spacing < 0) return; if (spacing is this.spacing) return; this.spacing = spacing; if (OS.GTK_VERSION >= OS.buildVERSION (2, 4, 0)) { OS.gtk_box_set_spacing (handle, spacing); OS.gtk_container_set_border_width (handle, spacing); } else { if ((style & DWT.V_SCROLL) is 0) { int width = Math.max (0, getClientArea ().width - spacing * 2); for (int i = 0; i < itemCount; i++) { ExpandItem item = items [i]; if (item.width !is width) item.setBounds (0, 0, width, item.height, false, true); } } layoutItems (0, true); redraw (); } } void showItem (ExpandItem item) { Control control = item.control; if (control !is null && !control.isDisposed ()) { control.setVisible (item.expanded); } item.redraw (); int index = indexOf (item); layoutItems (index + 1, true); } override void updateScrollBarValue (ScrollBar bar) { yCurrentScroll = bar.getSelection(); layoutItems (0, false); } }