suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs and release notes for `set-icon' change

Browse Source 
Merge to 5.2
(cherry picked from commit 8f0fa96d69)
This commit is contained in:
Matthew Flatt 2011-10-09 09:45:42 -06:00 committed by Eli Barzilay
parent 74846d0684
commit 78c38d42b6
3 changed files with 40 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
collects/scribblings/gui/frame-class.scrbl
View File

@ -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?]) @defmethod[(set-status-text [text string?])
void?]{ void?]{

38
collects/scribblings/gui/top-level-window-intf.scrbl
View File

@ -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]) @defmethod[(show [show any/c])
void?]{ void?]{

2
doc/release-notes/racket/HISTORY.txt
View File

@ -1,5 +1,7 @@
Version 5.1.3.12 Version 5.1.3.12
Removed built-in support for Honu reading and printing 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 Version 5.1.3.11
Added exn:fail:syntax:unbound Added exn:fail:syntax:unbound