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/widgets/Decorations.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/widgets/Decorations.java')
-rw-r--r-- | bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Decorations.java | 61 |
1 files changed, 58 insertions, 3 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Decorations.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Decorations.java index 69aa44923f..21c21901ae 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Decorations.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Decorations.java @@ -21,6 +21,11 @@ import org.eclipse.swt.graphics.*; * shares a significant amount of code with this class, * and is a subclass. * <p> + * IMPORTANT: This class was intended to be abstract and + * should <em>never</em> be referenced or instantiated. + * Instead, the class <code>Shell</code> should be used. + * </p> + * <p> * Instances are always displayed in one of the maximized, * minimized or normal states: * <ul> @@ -312,6 +317,33 @@ public Image getImage () { return image; } +/** + * Returns the receiver's images if they had previously been + * set using <code>setImages()</code>. Images are typically + * displayed by the window manager when the instance is + * marked as iconified, and may also be displayed somewhere + * in the trim when the instance is in normal or maximized + * states. Depending where the icon is displayed, the platform + * chooses the icon with the "best" size. It is expected that + * the array will contain the same icon rendered at different + * resolutions. + * + * <p> + * Note: This method will return an empty array if called before + * <code>setImages()</code> is called. It does not provide + * access to a window manager provided, "default" image + * even if one exists. + * </p> + * + * @return the images + * + * @exception SWTException <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> + * + * @since 3.0 + */ public Image [] getImages () { checkWidget (); return images; @@ -464,7 +496,7 @@ boolean restoreFocus () { * disposed, the receiver's default button will be set to * null. * - * @param the new default button + * @param button the new default button * * @exception IllegalArgumentException <ul> * <li>ERROR_INVALID_ARGUMENT - if the button has been disposed</li> @@ -508,6 +540,29 @@ public void setImage (Image image) { _setImages (image != null ? new Image [] {image} : null); } +/** + * Sets the receiver's images to the argument, which may + * be an empty array. Images are typically displayed by the + * window manager when the instance is marked as iconified, + * and may also be displayed somewhere in the trim when the + * instance is in normal or maximized states. Depending where + * the icon is displayed, the platform chooses the icon with + * the "best" size. It is expected that the array will contain + * the same icon rendered at different resolutions. + * + * @param images the new image array + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the array of images is null</li> + * <li>ERROR_INVALID_ARGUMENT - if one of the images has been disposed</li> + * </ul> + * @exception SWTException <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> + * + * @since 3.0 + */ public void setImages (Image [] images) { checkWidget (); if (images == null) error (SWT.ERROR_INVALID_ARGUMENT); @@ -532,7 +587,7 @@ public void setImages (Image [] images) { * always. This should be avoided if possible. * </p> * - * @param the new maximized state + * @param maximized the new maximized state * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> @@ -585,7 +640,7 @@ public void setMenuBar (Menu menu) { * always. This should be avoided if possible. * </p> * - * @param the new maximized state + * @param minimized the new maximized state * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |