diff options
author | Carolyn MacLeod <carolyn> | 2004-05-11 07:57:52 +0000 |
---|---|---|
committer | Carolyn MacLeod <carolyn> | 2004-05-11 07:57:52 +0000 |
commit | 524d79ea9ecd8197dab8f8d1b2841285c04ec9f7 (patch) | |
tree | 30c7b8e86d504488a801c042869ad6fcbad6dcb6 /bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/Region.java | |
parent | f429db6e57773ce96e34f2fa05fa073db3cdc6c7 (diff) | |
download | eclipse.platform.swt-524d79ea9ecd8197dab8f8d1b2841285c04ec9f7.tar.gz eclipse.platform.swt-524d79ea9ecd8197dab8f8d1b2841285c04ec9f7.tar.xz eclipse.platform.swt-524d79ea9ecd8197dab8f8d1b2841285c04ec9f7.zip |
Javadoc Basher output pre M9AFTER_JAVADOC_BASH_FOR_30M9
Diffstat (limited to 'bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/Region.java')
-rw-r--r-- | bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/Region.java | 87 |
1 files changed, 86 insertions, 1 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/Region.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/Region.java index e73a975283..a9e77a66ab 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/Region.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/Region.java @@ -47,6 +47,25 @@ public Region() { this(null); } +/** + * Constructs a new empty region. + * <p> + * You must dispose the region when it is no longer required. + * </p> + * + * @param device the device on which to allocate the region + * +* @exception SWTError <ul> + * <li>ERROR_NO_HANDLES if a handle could not be obtained for region creation</li> + * </ul> + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if device is null and there is no current device</li> + * </ul> + * + * @see #dispose + * + * @since 3.0 + */ public Region(Device device) { if (device == null) device = Device.getDevice(); if (device == null) SWT.error(SWT.ERROR_NULL_ARGUMENT); @@ -240,6 +259,22 @@ public int hashCode() { return (int)/*64*/handle; } +/** + * Intersects the given rectangle to the collection of rectangles + * the receiver maintains to describe its area. + * + * @param rect the rectangle to intersect with the receiver + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the argument is null</li> + * <li>ERROR_INVALID_ARGUMENT - if the rectangle's width or height is negative</li> + * </ul> + * @exception SWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + * + * @since 3.0 + */ public void intersect(Rectangle rect) { if (isDisposed()) SWT.error(SWT.ERROR_GRAPHIC_DISPOSED); if (rect == null) SWT.error(SWT.ERROR_NULL_ARGUMENT); @@ -254,6 +289,23 @@ public void intersect(Rectangle rect) { OS.gdk_region_destroy(rectRgn); } +/** + * Intersects all of the rectangles which make up the area covered + * by the argument to the collection of rectangles the receiver + * maintains to describe its area. + * + * @param region the region to intersect + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the argument is null</li> + * <li>ERROR_INVALID_ARGUMENT - if the argument has been disposed</li> + * </ul> + * @exception SWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + * + * @since 3.0 + */ public void intersect(Region region) { if (isDisposed()) SWT.error(SWT.ERROR_GRAPHIC_DISPOSED); if (region == null) SWT.error(SWT.ERROR_NULL_ARGUMENT); @@ -343,7 +395,7 @@ public boolean isEmpty() { * Subtracts the given polygon from the collection of rectangles * the receiver maintains to describe its area. * - * param pointArray points that describe the polygon to merge with the receiver + * @param pointArray points that describe the polygon to merge with the receiver * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the argument is null</li> @@ -362,6 +414,22 @@ public void subtract (int[] pointArray) { OS.gdk_region_destroy(polyRgn); } +/** + * Subtracts the given rectangle from the collection of rectangles + * the receiver maintains to describe its area. + * + * @param rect the rectangle to subtract from the receiver + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the argument is null</li> + * <li>ERROR_INVALID_ARGUMENT - if the rectangle's width or height is negative</li> + * </ul> + * @exception SWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + * + * @since 3.0 + */ public void subtract(Rectangle rect) { if (isDisposed()) SWT.error(SWT.ERROR_GRAPHIC_DISPOSED); if (rect == null) SWT.error(SWT.ERROR_NULL_ARGUMENT); @@ -376,6 +444,23 @@ public void subtract(Rectangle rect) { OS.gdk_region_destroy(rectRgn); } +/** + * Subtracts all of the rectangles which make up the area covered + * by the argument from the collection of rectangles the receiver + * maintains to describe its area. + * + * @param region the region to subtract + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the argument is null</li> + * <li>ERROR_INVALID_ARGUMENT - if the argument has been disposed</li> + * </ul> + * @exception SWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + * + * @since 3.0 + */ public void subtract(Region region) { if (isDisposed()) SWT.error(SWT.ERROR_GRAPHIC_DISPOSED); if (region == null) SWT.error(SWT.ERROR_NULL_ARGUMENT); |