From 78c38d42b650e635115db1ef637f5327749b6015 Mon Sep 17 00:00:00 2001 From: Matthew Flatt Date: Sun, 9 Oct 2011 09:45:42 -0600 Subject: [PATCH] docs and release notes for `set-icon' change Merge to 5.2 (cherry picked from commit 8f0fa96d699fd304b32e9cb00db8cc18220f58ee) --- collects/scribblings/gui/frame-class.scrbl | 38 ------------------- .../gui/top-level-window-intf.scrbl | 38 +++++++++++++++++++ doc/release-notes/racket/HISTORY.txt | 2 + 3 files changed, 40 insertions(+), 38 deletions(-) diff --git a/collects/scribblings/gui/frame-class.scrbl b/collects/scribblings/gui/frame-class.scrbl index ce2eaec33d..515305f9be 100644 --- a/collects/scribblings/gui/frame-class.scrbl +++ b/collects/scribblings/gui/frame-class.scrbl @@ -227,44 +227,6 @@ On Mac OS X, called when the user clicks the toolbar button on a } -@defmethod[(set-icon [icon (is-a?/c bitmap%)] - [mask (is-a?/c bitmap%) #f] - [which (one-of/c 'small 'large 'both) 'both]) - void?]{ - -Sets the large or small icon bitmap for this frame. Future changes to - the bitmap do not affect the frame's icon. - -The icon is used in a platform-specific way: - -@itemize[ - - @item{Windows --- the small icon is used for the frame's icon (in the - top-left) and in the task bar, and the large icon is used for - the Alt-Tab task switcher.} - - @item{Mac OS X --- both icons are ignored.} - - @item{Unix --- many window managers use the small icon in the same way - as Windows, and others use the small icon when iconifying the - frame; the large icon is ignored.} - -] - -The bitmap for either icon can be any size, but most platforms scale - the small bitmap to 16 by 16 pixels and the large bitmap to 32 by 32 - pixels. - -If a mask bitmap is not provided, then the entire (rectangular) bitmap - is used as an icon. - -If a mask bitmap is provided, the mask must be monochrome. In the mask - bitmap, use black pixels to indicate the icon's region and use white - pixels outside the icon's region. In the icon bitmap, use black - pixels for the region outside the icon. - -} - @defmethod[(set-status-text [text string?]) void?]{ diff --git a/collects/scribblings/gui/top-level-window-intf.scrbl b/collects/scribblings/gui/top-level-window-intf.scrbl index 8825ced005..d097f85a43 100644 --- a/collects/scribblings/gui/top-level-window-intf.scrbl +++ b/collects/scribblings/gui/top-level-window-intf.scrbl @@ -312,6 +312,44 @@ Sets the size of the window (in pixels), but only if the given size is } + +@defmethod[(set-icon [icon (is-a?/c bitmap%)] + [mask (is-a?/c bitmap%) #f] + [which (one-of/c 'small 'large 'both) 'both]) + void?]{ + +Sets the large or small icon bitmap for the window. Future changes to + the bitmap do not affect the window's icon. + +The icon is used in a platform-specific way: + +@itemize[ + + @item{Windows --- the small icon is used for the window's icon (in the + top-left) and in the task bar, and the large icon is used for + the Alt-Tab task switcher.} + + @item{Mac OS X --- both icons are ignored.} + + @item{Unix --- many window managers use the small icon in the same way + as Windows, and others use the small icon when iconifying the + frame; the large icon is ignored.} + +] + +The bitmap for either icon can be any size, but most platforms scale + the small bitmap to 16 by 16 pixels and the large bitmap to 32 by 32 + pixels. + +If a mask bitmap is not provided, then the entire (rectangular) bitmap + is used as an icon. + +If a mask bitmap is provided, the mask must be monochrome. In the mask + bitmap, use black pixels to indicate the icon's region and use white + pixels outside the icon's region. In the icon bitmap, use black + pixels for the region outside the icon.} + + @defmethod[(show [show any/c]) void?]{ diff --git a/doc/release-notes/racket/HISTORY.txt b/doc/release-notes/racket/HISTORY.txt index cbbc486823..cc8550b0c0 100644 --- a/doc/release-notes/racket/HISTORY.txt +++ b/doc/release-notes/racket/HISTORY.txt @@ -1,5 +1,7 @@ Version 5.1.3.12 Removed built-in support for Honu reading and printing +racket/gui: moved set-icon method from frame% to + top-level-window<%> Version 5.1.3.11 Added exn:fail:syntax:unbound