/******************************************************************************* * Copyright (c) 2000, 2003 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Common Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/cpl-v10.html * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.eclipse.swt.graphics; import org.eclipse.swt.internal.carbon.*; import org.eclipse.swt.*; /** * Instances of this class manage operating system resources that * specify the appearance of the on-screen pointer. To create a * cursor you specify the device and either a simple cursor style * describing one of the standard operating system provided cursors * or the image and mask data for the desired appearance. *

* Application code must explicitly invoke the Cursor.dispose() * method to release the operating system resources managed by each instance * when those instances are no longer required. *

*
*
Styles:
*
* CURSOR_ARROW, CURSOR_WAIT, CURSOR_CROSS, CURSOR_APPSTARTING, CURSOR_HELP, * CURSOR_SIZEALL, CURSOR_SIZENESW, CURSOR_SIZENS, CURSOR_SIZENWSE, CURSOR_SIZEWE, * CURSOR_SIZEN, CURSOR_SIZES, CURSOR_SIZEE, CURSOR_SIZEW, CURSOR_SIZENE, CURSOR_SIZESE, * CURSOR_SIZESW, CURSOR_SIZENW, CURSOR_UPARROW, CURSOR_IBEAM, CURSOR_NO, CURSOR_HAND *
*
*

* Note: Only one of the above styles may be specified. *

*/ public final class Cursor { /** * the handle to the OS cursor resource * (Warning: This field is platform dependent) */ public int handle; /** * the device where this cursor was created */ Device device; /** * data and mask used to create a Resize NS Cursor */ static final short [] SIZENS_SOURCE = new short[] { (short)0x0000, (short)0x0180, (short)0x03C0, (short)0x07E0, (short)0x0180, (short)0x0180, (short)0x0180, (short)0x7FFE, (short)0x7FFE, (short)0x0180, (short)0x0180, (short)0x0180, (short)0x07E0, (short)0x03C0, (short)0x0180, (short)0x0000, }; static final short [] SIZENS_MASK = new short[] { (short)0x0180, (short)0x03C0, (short)0x07E0, (short)0x0FF0, (short)0x0FF0, (short)0x03C0, (short)0xFFFF, (short)0xFFFF, (short)0xFFFF, (short)0xFFFF, (short)0x03C0, (short)0x0FF0, (short)0x0FF0, (short)0x07E0, (short)0x03C0, (short)0x0180, }; /** * Prevents uninitialized instances from being created outside the package. */ Cursor() { } /** * Constructs a new cursor given a device and a style * constant describing the desired cursor appearance. *

* You must dispose the cursor when it is no longer required. *

* * @param device the device on which to allocate the cursor * @param style the style of cursor to allocate * * @exception IllegalArgumentException * @exception SWTError * * @see SWT#CURSOR_ARROW * @see SWT#CURSOR_WAIT * @see SWT#CURSOR_CROSS * @see SWT#CURSOR_APPSTARTING * @see SWT#CURSOR_HELP * @see SWT#CURSOR_SIZEALL * @see SWT#CURSOR_SIZENESW * @see SWT#CURSOR_SIZENS * @see SWT#CURSOR_SIZENWSE * @see SWT#CURSOR_SIZEWE * @see SWT#CURSOR_SIZEN * @see SWT#CURSOR_SIZES * @see SWT#CURSOR_SIZEE * @see SWT#CURSOR_SIZEW * @see SWT#CURSOR_SIZENE * @see SWT#CURSOR_SIZESE * @see SWT#CURSOR_SIZESW * @see SWT#CURSOR_SIZENW * @see SWT#CURSOR_UPARROW * @see SWT#CURSOR_IBEAM * @see SWT#CURSOR_NO * @see SWT#CURSOR_HAND */ public Cursor(Device device, int style) { if (device == null) device = Device.getDevice(); if (device == null) SWT.error(SWT.ERROR_NULL_ARGUMENT); this.device = device; switch (style) { case SWT.CURSOR_HAND: handle = OS.kThemePointingHandCursor; break; case SWT.CURSOR_ARROW: handle = OS.kThemeArrowCursor; break; case SWT.CURSOR_WAIT: handle = OS.kThemeSpinningCursor; break; case SWT.CURSOR_CROSS: handle = OS.kThemeCrossCursor; break; case SWT.CURSOR_APPSTARTING: handle = OS.kThemeArrowCursor; break; case SWT.CURSOR_HELP: handle = OS.kThemeCrossCursor; break; case SWT.CURSOR_SIZEALL: handle = OS.kThemeCrossCursor; break; case SWT.CURSOR_SIZENESW: handle = OS.kThemeCrossCursor; break; case SWT.CURSOR_SIZENS: { org.eclipse.swt.internal.carbon.Cursor cursor = new org.eclipse.swt.internal.carbon.Cursor(); cursor.data = SIZENS_SOURCE; cursor.mask = SIZENS_MASK; cursor.hotSpot_h = 7; cursor.hotSpot_v = 7; handle = OS.NewPtr(org.eclipse.swt.internal.carbon.Cursor.sizeof); if (handle == 0) SWT.error(SWT.ERROR_NO_HANDLES); OS.memcpy(handle, cursor, org.eclipse.swt.internal.carbon.Cursor.sizeof); break; } case SWT.CURSOR_SIZENWSE: handle = OS.kThemeCrossCursor; break; case SWT.CURSOR_SIZEWE: handle = OS.kThemeResizeLeftRightCursor; break; case SWT.CURSOR_SIZEN: handle = OS.kThemeCrossCursor; break; case SWT.CURSOR_SIZES: handle = OS.kThemeCrossCursor; break; case SWT.CURSOR_SIZEE: handle = OS.kThemeResizeRightCursor; break; case SWT.CURSOR_SIZEW: handle = OS.kThemeResizeLeftCursor; break; case SWT.CURSOR_SIZENE: handle = OS.kThemeCrossCursor; break; case SWT.CURSOR_SIZESE: handle = OS.kThemeCrossCursor; break; case SWT.CURSOR_SIZESW: handle = OS.kThemeCrossCursor; break; case SWT.CURSOR_SIZENW: handle = OS.kThemeCrossCursor; break; case SWT.CURSOR_UPARROW: handle = OS.kThemeCrossCursor; break; case SWT.CURSOR_IBEAM: handle = OS.kThemeIBeamCursor; break; case SWT.CURSOR_NO: handle = OS.kThemeNotAllowedCursor; break; default: SWT.error(SWT.ERROR_INVALID_ARGUMENT); } } /** * Constructs a new cursor given a device, image and mask * data describing the desired cursor appearance, and the x * and y coordinates of the hotspot (that is, the point * within the area covered by the cursor which is considered * to be where the on-screen pointer is "pointing"). *

* The mask data is allowed to be null, but in this case the source * must be an ImageData representing an icon that specifies both * color data and mask data. *

* You must dispose the cursor when it is no longer required. *

* * @param device the device on which to allocate the cursor * @param source the color data for the cursor * @param mask the mask data for the cursor (or null) * @param hotspotX the x coordinate of the cursor's hotspot * @param hotspotY the y coordinate of the cursor's hotspot * * @exception IllegalArgumentException * @exception SWTError */ public Cursor(Device device, ImageData source, ImageData mask, int hotspotX, int hotspotY) { if (device == null) device = Device.getDevice(); if (device == null) SWT.error(SWT.ERROR_NULL_ARGUMENT); this.device = device; if (source == null) SWT.error(SWT.ERROR_NULL_ARGUMENT); if (mask == null) { if (source.getTransparencyType() != SWT.TRANSPARENCY_MASK) { SWT.error(SWT.ERROR_NULL_ARGUMENT); } mask = source.getTransparencyMask(); } /* Check the bounds. Mask must be the same size as source */ if (mask.width != source.width || mask.height != source.height) { SWT.error(SWT.ERROR_INVALID_ARGUMENT); } /* Check color depths */ if (mask.depth != 1) SWT.error(SWT.ERROR_INVALID_ARGUMENT); if (source.depth != 1) SWT.error(SWT.ERROR_INVALID_ARGUMENT); /* Check the hotspots */ if (hotspotX >= source.width || hotspotX < 0 || hotspotY >= source.height || hotspotY < 0) { SWT.error(SWT.ERROR_INVALID_ARGUMENT); } /* Find the first non transparent pixel if cursor bigger than 16x16. */ int width = source.width; int height = source.height; int minX = 0, minY = 0; if (width > 16 || height > 16) { minX = width; minY = height; int maxX = 0, maxY = 0; for (int y = 0; y < height; y++) { for (int x = 0; x < width; x++) { if (!(source.getPixel(x, y) == 1 && mask.getPixel(x, y) == 0)) { minX = Math.min(minX, x); minY = Math.min(minY, y); maxX = Math.max(maxX, x); maxY = Math.max(maxY, y); } } } width = maxX - minX + 1; height = maxY - minY + 1; /* Stretch cursor if still bigger than 16x16. */ if (width > 16 || height > 16) { int newWidth = Math.min(width, 16); int newHeight = Math.min(height, 16); ImageData newSource = new ImageData(newWidth, newHeight, source.depth, source.palette, 1, null, 0, null, null, -1, -1, source.type, source.x, source.y, source.disposalMethod, source.delayTime); ImageData newMask = new ImageData(newWidth, newHeight, mask.depth, mask.palette, 1, null, 0, null, null, -1, -1, mask.type, mask.x, mask.y, mask.disposalMethod, mask.delayTime); ImageData.blit(ImageData.BLIT_SRC, source.data, source.depth, source.bytesPerLine, source.getByteOrder(), minX, minY, width, height, null, null, null, ImageData.ALPHA_OPAQUE, null, 0, minX, minY, newSource.data, newSource.depth, newSource.bytesPerLine, newSource.getByteOrder(), 0, 0, newWidth, newHeight, null, null, null, false, false); ImageData.blit(ImageData.BLIT_SRC, mask.data, mask.depth, mask.bytesPerLine, mask.getByteOrder(), minX, minY, width, height, null, null, null, ImageData.ALPHA_OPAQUE, null, 0, minX, minY, newMask.data, newMask.depth, newMask.bytesPerLine, newMask.getByteOrder(), 0, 0, newWidth, newHeight, null, null, null, false, false); width = newWidth; height = newHeight; minX = minY = 0; source = newSource; mask = newMask; } } /* Create the cursor */ org.eclipse.swt.internal.carbon.Cursor cursor = new org.eclipse.swt.internal.carbon.Cursor(); short[] srcData = cursor.data; short[] maskData = cursor.mask; for (int y = 0; y < height; y++) { short d = 0, m = 0; for (int x = 0; x < width; x++) { int bit = 1 << (width - 1 - x); if (source.getPixel(minX + x, minY + y) == 0) { m |= bit; if (mask.getPixel(minX + x, minY + y) == 0) d |= bit; } else if (mask.getPixel(minX + x, minY + y) != 0) { d |= bit; } } srcData[y] = d; maskData[y] = m; } cursor.hotSpot_h = (short)Math.max(0, Math.min(15, hotspotY - minX)); cursor.hotSpot_v = (short)Math.max(0, Math.min(15, hotspotY - minY)); handle = OS.NewPtr(org.eclipse.swt.internal.carbon.Cursor.sizeof); if (handle == 0) SWT.error(SWT.ERROR_NO_HANDLES); OS.memcpy(handle, cursor, org.eclipse.swt.internal.carbon.Cursor.sizeof); } /** * Constructs a new cursor given a device, image data describing * the desired cursor appearance, and the x and y coordinates of * the hotspot (that is, the point within the area * covered by the cursor which is considered to be where the * on-screen pointer is "pointing"). *

* You must dispose the cursor when it is no longer required. *

* * @param device the device on which to allocate the cursor * @param source the image data for the cursor * @param hotspotX the x coordinate of the cursor's hotspot * @param hotspotY the y coordinate of the cursor's hotspot * * @exception IllegalArgumentException * @exception SWTError * * @since 3.0 */ public Cursor(Device device, ImageData source, int hotspotX, int hotspotY) { if (device == null) device = Device.getDevice(); if (device == null) SWT.error(SWT.ERROR_NULL_ARGUMENT); this.device = device; if (source == null) SWT.error(SWT.ERROR_NULL_ARGUMENT); if (hotspotX >= source.width || hotspotX < 0 || hotspotY >= source.height || hotspotY < 0) { SWT.error(SWT.ERROR_INVALID_ARGUMENT); } ImageData mask = source.getTransparencyMask(); /* Ensure depth is equal to 1 */ if (source.depth > 1) { /* Create a destination image with no data */ ImageData newSource = new ImageData( source.width, source.height, 1, ImageData.bwPalette(), 1, null, 0, null, null, -1, -1, source.type, source.x, source.y, source.disposalMethod, source.delayTime); /* Convert the source to a black and white image of depth 1 */ PaletteData palette = source.palette; if (palette.isDirect) ImageData.blit(ImageData.BLIT_SRC, source.data, source.depth, source.bytesPerLine, source.getByteOrder(), 0, 0, source.width, source.height, 0, 0, 0, ImageData.ALPHA_OPAQUE, null, 0, 0, 0, newSource.data, newSource.depth, newSource.bytesPerLine, newSource.getByteOrder(), 0, 0, newSource.width, newSource.height, 0, 0, 0, false, false); else ImageData.blit(ImageData.BLIT_SRC, source.data, source.depth, source.bytesPerLine, source.getByteOrder(), 0, 0, source.width, source.height, null, null, null, ImageData.ALPHA_OPAQUE, null, 0, 0, 0, newSource.data, newSource.depth, newSource.bytesPerLine, newSource.getByteOrder(), 0, 0, newSource.width, newSource.height, null, null, null, false, false); source = newSource; } /* Find the first non transparent pixel if cursor bigger than 16x16. */ int width = source.width; int height = source.height; int minX = 0, minY = 0; if (width > 16 || height > 16) { minX = width; minY = height; int maxX = 0, maxY = 0; for (int y = 0; y < height; y++) { for (int x = 0; x < width; x++) { if (!(source.getPixel(x, y) == 1 && mask.getPixel(x, y) == 0)) { minX = Math.min(minX, x); minY = Math.min(minY, y); maxX = Math.max(maxX, x); maxY = Math.max(maxY, y); } } } width = maxX - minX + 1; height = maxY - minY + 1; /* Stretch cursor if still bigger than 16x16. */ if (width > 16 || height > 16) { int newWidth = Math.min(width, 16); int newHeight = Math.min(height, 16); ImageData newSource = new ImageData(newWidth, newHeight, source.depth, source.palette, 1, null, 0, null, null, -1, -1, source.type, source.x, source.y, source.disposalMethod, source.delayTime); ImageData newMask = new ImageData(newWidth, newHeight, mask.depth, mask.palette, 1, null, 0, null, null, -1, -1, mask.type, mask.x, mask.y, mask.disposalMethod, mask.delayTime); ImageData.blit(ImageData.BLIT_SRC, source.data, source.depth, source.bytesPerLine, source.getByteOrder(), minX, minY, width, height, null, null, null, ImageData.ALPHA_OPAQUE, null, 0, minX, minY, newSource.data, newSource.depth, newSource.bytesPerLine, newSource.getByteOrder(), 0, 0, newWidth, newHeight, null, null, null, false, false); ImageData.blit(ImageData.BLIT_SRC, mask.data, mask.depth, mask.bytesPerLine, mask.getByteOrder(), minX, minY, width, height, null, null, null, ImageData.ALPHA_OPAQUE, null, 0, minX, minY, newMask.data, newMask.depth, newMask.bytesPerLine, newMask.getByteOrder(), 0, 0, newWidth, newHeight, null, null, null, false, false); width = newWidth; height = newHeight; minX = minY = 0; source = newSource; mask = newMask; } } /* Create the cursor */ org.eclipse.swt.internal.carbon.Cursor cursor = new org.eclipse.swt.internal.carbon.Cursor(); short[] srcData = cursor.data; short[] maskData = cursor.mask; for (int y= 0; y < height; y++) { short d = 0, m = 0; for (int x = 0; x < width; x++) { int bit = 1 << (width - 1 - x); if (source.getPixel(x + minX, y + minY) == 0) { if (mask.getPixel(x + minX, y + minY) != 0) { d |= bit; m |= bit; } } else { if (mask.getPixel(x + minX, y + minY) != 0) m |= bit; } } srcData[y] = d; maskData[y] = m; } cursor.hotSpot_h = (short)Math.max(0, Math.min(15, hotspotY - minX)); cursor.hotSpot_v = (short)Math.max(0, Math.min(15, hotspotY - minY)); handle = OS.NewPtr(org.eclipse.swt.internal.carbon.Cursor.sizeof); if (handle == 0) SWT.error(SWT.ERROR_NO_HANDLES); OS.memcpy(handle, cursor, org.eclipse.swt.internal.carbon.Cursor.sizeof); } /** * Disposes of the operating system resources associated with * the cursor. Applications must dispose of all cursors which * they allocate. */ public void dispose () { if (handle == -1) return; if (device.isDisposed()) return; switch (handle) { case OS.kThemePointingHandCursor: case OS.kThemeArrowCursor: case OS.kThemeSpinningCursor: case OS.kThemeCrossCursor: case OS.kThemeWatchCursor: case OS.kThemeIBeamCursor: case OS.kThemeNotAllowedCursor: case OS.kThemeResizeLeftRightCursor: case OS.kThemeResizeLeftCursor: case OS.kThemeResizeRightCursor: break; default: OS.DisposePtr(handle); } handle = -1; device = null; } /** * Compares the argument to the receiver, and returns true * if they represent the same object using a class * specific comparison. * * @param object the object to compare with this object * @return true if the object is the same as this object and false otherwise * * @see #hashCode */ public boolean equals (Object object) { if (object == this) return true; if (!(object instanceof Cursor)) return false; Cursor cursor = (Cursor) object; return device == cursor.device && handle == cursor.handle; } /** * Returns an integer hash code for the receiver. Any two * objects which return true when passed to * equals must return the same value for this * method. * * @return the receiver's hash * * @see #equals */ public int hashCode () { return handle; } /** * Returns true if the cursor has been disposed, * and false otherwise. *

* This method gets the dispose state for the cursor. * When a cursor has been disposed, it is an error to * invoke any other method using the cursor. * * @return true when the cursor is disposed and false otherwise */ public boolean isDisposed() { return handle == -1; } /** * Returns a string containing a concise, human-readable * description of the receiver. * * @return a string representation of the receiver */ public String toString () { if (isDisposed()) return "Cursor {*DISPOSED*}"; return "Cursor {" + handle + "}"; } /** * Invokes platform specific functionality to allocate a new cursor. *

* IMPORTANT: This method is not part of the public * API for Cursor. It is marked public only so that it * can be shared within the packages provided by SWT. It is not * available on all platforms, and should never be called from * application code. *

* * @param device the device on which to allocate the color * @param handle the handle for the cursor * * @private */ public static Cursor carbon_new(Device device, int handle) { if (device == null) device = Device.getDevice(); Cursor cursor = new Cursor(); cursor.handle = handle; cursor.device = device; return cursor; } }