Class Cursor
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.
-
Field Summary
Modifier and TypeFieldDescriptionlong
the handle to the OS cursor resource (Warning: This field is platform dependent) -
Constructor Summary
ConstructorDescriptionConstructs a new cursor given a device and a style constant describing the desired cursor appearance.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").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"). -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.int
hashCode()
Returns an integer hash code for the receiver.boolean
Returnstrue
if the cursor has been disposed, andfalse
otherwise.toString()
Returns a string containing a concise, human-readable description of the receiver.static Cursor
Invokes platform specific functionality to allocate a new cursor.Methods inherited from class org.eclipse.swt.graphics.Resource
dispose, getDevice, setNonDisposeHandler
-
Field Details
-
handle
public long handlethe handle to the OS cursor resource (Warning: This field is platform dependent)IMPORTANT: This field is not part of the SWT public API. 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 accessed from application code.
- Restriction:
- This field is not intended to be referenced by clients.
-
-
Constructor Details
-
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.
NOTE: It is recommended to useDisplay.getSystemCursor(int)
instead of using this constructor. This way you can avoid the overhead of disposing the Cursor resource.- Parameters:
device
- the device on which to allocate the cursorstyle
- the style of cursor to allocate- Throws:
IllegalArgumentException
-- ERROR_NULL_ARGUMENT - if device is null and there is no current device
- ERROR_INVALID_ARGUMENT - when an unknown style is specified
SWTError
-- ERROR_NO_HANDLES - if a handle could not be obtained for cursor creation
- See Also:
-
SWT.CURSOR_ARROW
SWT.CURSOR_WAIT
SWT.CURSOR_CROSS
SWT.CURSOR_APPSTARTING
SWT.CURSOR_HELP
SWT.CURSOR_SIZEALL
SWT.CURSOR_SIZENESW
SWT.CURSOR_SIZENS
SWT.CURSOR_SIZENWSE
SWT.CURSOR_SIZEWE
SWT.CURSOR_SIZEN
SWT.CURSOR_SIZES
SWT.CURSOR_SIZEE
SWT.CURSOR_SIZEW
SWT.CURSOR_SIZENE
SWT.CURSOR_SIZESE
SWT.CURSOR_SIZESW
SWT.CURSOR_SIZENW
SWT.CURSOR_UPARROW
SWT.CURSOR_IBEAM
SWT.CURSOR_NO
SWT.CURSOR_HAND
Resource.dispose()
-
Cursor
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.
- Parameters:
device
- the device on which to allocate the cursorsource
- the color data for the cursormask
- the mask data for the cursor (or null)hotspotX
- the x coordinate of the cursor's hotspothotspotY
- the y coordinate of the cursor's hotspot- Throws:
IllegalArgumentException
-- ERROR_NULL_ARGUMENT - if device is null and there is no current device
- ERROR_NULL_ARGUMENT - if the source is null
- ERROR_NULL_ARGUMENT - if the mask is null and the source does not have a mask
- ERROR_INVALID_ARGUMENT - if the source and the mask are not the same size, or if the hotspot is outside the bounds of the image
SWTError
-- ERROR_NO_HANDLES - if a handle could not be obtained for cursor creation
- See Also:
-
Cursor
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.
- Parameters:
device
- the device on which to allocate the cursorsource
- the image data for the cursorhotspotX
- the x coordinate of the cursor's hotspothotspotY
- the y coordinate of the cursor's hotspot- Throws:
IllegalArgumentException
-- ERROR_NULL_ARGUMENT - if device is null and there is no current device
- ERROR_NULL_ARGUMENT - if the image is null
- ERROR_INVALID_ARGUMENT - if the hotspot is outside the bounds of the image
SWTError
-- ERROR_NO_HANDLES - if a handle could not be obtained for cursor creation
- Since:
- 3.0
- See Also:
-
-
Method Details
-
equals
Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison. -
hashCode
public int hashCode()Returns an integer hash code for the receiver. Any two objects that returntrue
when passed toequals
must return the same value for this method. -
isDisposed
public boolean isDisposed()Returnstrue
if the cursor has been disposed, andfalse
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 (except
Resource.dispose()
) using the cursor.- Specified by:
isDisposed
in classResource
- Returns:
true
when the cursor is disposed andfalse
otherwise
-
toString
Returns a string containing a concise, human-readable description of the receiver. -
win32_new
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.- Parameters:
device
- the device on which to allocate the colorhandle
- the handle for the cursor- Returns:
- a new cursor object containing the specified device and handle
- Restriction:
- This method is not intended to be referenced by clients.
-