diff options
author | dkf <donal.k.fellows@manchester.ac.uk> | 2005-04-06 21:11:49 (GMT) |
---|---|---|
committer | dkf <donal.k.fellows@manchester.ac.uk> | 2005-04-06 21:11:49 (GMT) |
commit | af0c6996b5dd46e602fa5da6542a4ccb4e45656c (patch) | |
tree | 4703569bae4ea9053243ae2a3bd9823280c478ec /doc/GetBitmap.3 | |
parent | 19b266b312edc253fa16d04f6fab6c7a6e2c0494 (diff) | |
download | tk-af0c6996b5dd46e602fa5da6542a4ccb4e45656c.zip tk-af0c6996b5dd46e602fa5da6542a4ccb4e45656c.tar.gz tk-af0c6996b5dd46e602fa5da6542a4ccb4e45656c.tar.bz2 |
Purge old and inaccurate .VS/.VE macros.
Diffstat (limited to 'doc/GetBitmap.3')
-rw-r--r-- | doc/GetBitmap.3 | 22 |
1 files changed, 1 insertions, 21 deletions
diff --git a/doc/GetBitmap.3 b/doc/GetBitmap.3 index f092b7a..3007d93 100644 --- a/doc/GetBitmap.3 +++ b/doc/GetBitmap.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetBitmap.3,v 1.7 2004/09/19 16:05:36 dkf Exp $ +'\" RCS: @(#) $Id: GetBitmap.3,v 1.8 2005/04/06 21:11:53 dkf Exp $ '\" .so man.macros .TH Tk_AllocBitmapFromObj 3 8.1 Tk "Tk Library Procedures" @@ -16,7 +16,6 @@ Tk_AllocBitmapFromObj, Tk_GetBitmap, Tk_GetBitmapFromObj, Tk_DefineBitmap, Tk_Na .nf \fB#include <tk.h>\fR .sp -.VS 8.1 Pixmap \fBTk_GetBitmapFromObj(\fIinterp, tkwin, objPtr\fB)\fR .sp @@ -25,7 +24,6 @@ Pixmap .sp Pixmap \fBTk_GetBitmapFromObj(\fItkwin, objPtr\fB)\fR -.VE .sp int \fBTk_DefineBitmap(\fIinterp, name, source, width, height\fB)\fR @@ -35,9 +33,7 @@ CONST char * .sp \fBTk_SizeOfBitmap(\fIdisplay, bitmap, widthPtr, heightPtr\fB)\fR .sp -.VS 8.1 \fBTk_FreeBitmapFromObj(\fItkwin, objPtr\fB)\fR -.VE .sp \fBTk_FreeBitmap(\fIdisplay, bitmap\fB)\fR .SH ARGUMENTS @@ -47,14 +43,12 @@ Interpreter to use for error reporting; if NULL then no error message is left after errors. .AP Tk_Window tkwin in Token for window in which the bitmap will be used. -.VS 8.1 br .AP Tcl_Obj *objPtr in/out String value describes desired bitmap; internal rep will be modified to cache pointer to corresponding Pixmap. .AP "CONST char" *info in Same as \fIobjPtr\fR except description of bitmap is passed as a string and resulting Pixmap isn't cached. -.VE .AP "CONST char" *name in Name for new bitmap to be defined. .AP "CONST char" *source in @@ -82,13 +76,11 @@ being used by an application. The procedures allow bitmaps to be re-used efficiently, thereby avoiding server overhead, and also allow bitmaps to be named with character strings. .PP -.VS 8.1 \fBTk_AllocBitmapFromObj\fR returns a Pixmap identifier for a bitmap that matches the description in \fIobjPtr\fR and is suitable for use in \fItkwin\fR. It re-uses an existing bitmap, if possible, and creates a new one otherwise. \fIObjPtr\fR's value must have one of the following forms: -.VE .TP 20 \fB@\fIfileName\fR \fIFileName\fR must be the name of a file containing a bitmap @@ -103,19 +95,15 @@ by Tk: \fBerror\fR The international "don't" symbol: a circle with a diagonal line across it. -.VS "" br .TP 12 \fBgray75\fR 75% gray: a checkerboard pattern where three out of four bits are on. -.VE .TP 12 \fBgray50\fR 50% gray: a checkerboard pattern where every other bit is on. -.VS "" br .TP 12 \fBgray25\fR 25% gray: a checkerboard pattern where one out of every four bits is on. -.VE .TP 12 \fBgray12\fR 12.5% gray: a pattern where one-eighth of the bits are on, consisting of @@ -188,7 +176,6 @@ A face with balloon words. A triangle with an exclamation point. .RE .LP -.VS 8.1 Under normal conditions, \fBTk_AllocBitmapFromObj\fR returns an identifier for the requested bitmap. If an error occurs in creating the bitmap, such as when \fIobjPtr\fR refers @@ -212,7 +199,6 @@ must already have been created with a previous call to value is cached in \fIobjPtr\fR, which speeds up future calls to \fBTk_GetBitmapFromObj\fR with the same \fIobjPtr\fR and \fItkwin\fR. -.VE .PP \fBTk_DefineBitmap\fR associates a name with in-memory bitmap data so that the name can be used in later @@ -239,7 +225,6 @@ which was created by the \fBbitmap\fR program and contains a stipple pattern. The following code uses \fBTk_DefineBitmap\fR to define a new bitmap named \fBfoo\fR: -.VS .CS Pixmap bitmap; #include "stip.bitmap" @@ -248,17 +233,14 @@ Tk_DefineBitmap(interp, "foo", stip_bits, \&... bitmap = Tk_GetBitmap(interp, tkwin, "foo"); .CE -.VE This code causes the bitmap file to be read at compile-time and incorporates the bitmap information into the program's executable image. The same bitmap file could be read at run-time using \fBTk_GetBitmap\fR: -.VS .CS Pixmap bitmap; bitmap = Tk_GetBitmap(interp, tkwin, "@stip.bitmap"); .CE -.VE The second form is a bit more flexible (the file could be modified after the program has been compiled, or a different string could be provided to read a different file), but it is a little slower and @@ -291,7 +273,6 @@ argument in the words pointed to by the \fIwidthPtr\fR and \fIbitmap\fR must have been created by \fBTk_AllocBitmapFromObj\fR or \fBTk_GetBitmap\fR. .PP -.VS 8.1 When a bitmap is no longer needed, \fBTk_FreeBitmapFromObj\fR or \fBTk_FreeBitmap\fR should be called to release it. For \fBTk_FreeBitmapFromObj\fR the bitmap to release is specified @@ -301,7 +282,6 @@ with its Pixmap token. There should be exactly one call to \fBTk_FreeBitmapFromObj\fR or \fBTk_FreeBitmap\fR for each call to \fBTk_AllocBitmapFromObj\fR or \fBTk_GetBitmap\fR. -.VE .SH BUGS In determining whether an existing bitmap can be used to satisfy |