diff options
author | donal.k.fellows@manchester.ac.uk <dkf> | 2008-06-30 22:57:00 (GMT) |
---|---|---|
committer | donal.k.fellows@manchester.ac.uk <dkf> | 2008-06-30 22:57:00 (GMT) |
commit | de1abdbdf2e06c4777b7b724c98a2d2f11c96a0a (patch) | |
tree | d6714c53bb2368a4c8befd4c7dc0085d88b31a15 /doc/ImgChanged.3 | |
parent | 5ef3b95cc52bce163b63c0595626a035bdb9876d (diff) | |
download | tk-de1abdbdf2e06c4777b7b724c98a2d2f11c96a0a.zip tk-de1abdbdf2e06c4777b7b724c98a2d2f11c96a0a.tar.gz tk-de1abdbdf2e06c4777b7b724c98a2d2f11c96a0a.tar.bz2 |
Minor doc updates (removing out of date changebars, improving typedef formatting,
etc.)
Diffstat (limited to 'doc/ImgChanged.3')
-rw-r--r-- | doc/ImgChanged.3 | 135 |
1 files changed, 66 insertions, 69 deletions
diff --git a/doc/ImgChanged.3 b/doc/ImgChanged.3 index bc4f9a4..99f24fd 100644 --- a/doc/ImgChanged.3 +++ b/doc/ImgChanged.3 @@ -1,69 +1,66 @@ -'\" -'\" Copyright (c) 1994 The Regents of the University of California. -'\" Copyright (c) 1994-1996 Sun Microsystems, Inc. -'\" -'\" See the file "license.terms" for information on usage and redistribution -'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. -'\" -'\" RCS: @(#) $Id: ImgChanged.3,v 1.2 1998/09/14 18:22:52 stanton Exp $ -'\" -.so man.macros -.TH Tk_ImageChanged 3 4.0 Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_ImageChanged \- notify widgets that image needs to be redrawn -.SH SYNOPSIS -.nf -\fB#include <tk.h>\fR -.sp -\fBTk_ImageChanged\fR(\fIimageMaster, x, y, width, height, imageWidth, imageHeight\fR) -.SH ARGUMENTS -.AS Tk_ImageMaster imageHeight -.AP Tk_ImageMaster imageMaster in -Token for image, which was passed to image's \fIcreateProc\fR when -the image was created. -.AP int x in -X-coordinate of upper-left corner of region that needs redisplay (measured -from upper-left corner of image). -.AP int y in -Y-coordinate of upper-left corner of region that needs redisplay (measured -from upper-left corner of image). -.AP "int" width in -Width of region that needs to be redrawn, in pixels. -.AP "int" height in -Height of region that needs to be redrawn, in pixels. -.AP "int" imageWidth in -Current width of image, in pixels. -.AP "int" imageHeight in -Current height of image, in pixels. -.BE - -.SH DESCRIPTION -.PP -An image manager calls \fBTk_ImageChanged\fR for an image -whenever anything happens that requires the image to be redrawn. -As a result of calling \fBTk_ImageChanged\fR, any widgets using -the image are notified so that they can redisplay themselves -appropriately. -The \fIimageMaster\fR argument identifies the image, and -\fIx\fR, \fIy\fR, \fIwidth\fR, and \fIheight\fR -specify a rectangular region within the image that needs to -be redrawn. -\fIimageWidth\fR and \fIimageHeight\fR specify the image's (new) size. -.PP -An image manager should call \fBTk_ImageChanged\fR during -its \fIcreateProc\fR to specify the image's initial size and to -force redisplay if there are existing instances for the image. -If any of the pixel values in the image should change later on, -\fBTk_ImageChanged\fR should be called again with \fIx\fR, \fIy\fR, -\fIwidth\fR, and \fIheight\fR values that cover all the pixels -that changed. -If the size of the image should change, then \fBTk_ImageChanged\fR -must be called to indicate the new size, even if no pixels -need to be redisplayed. - -.SH "SEE ALSO" -Tk_CreateImageType - -.SH KEYWORDS -images, redisplay, image size changes +'\"
+'\" Copyright (c) 1994 The Regents of the University of California.
+'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
+'\"
+'\" See the file "license.terms" for information on usage and redistribution
+'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+'\"
+'\" RCS: @(#) $Id: ImgChanged.3,v 1.3 2008/06/30 22:57:01 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_ImageChanged 3 4.0 Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_ImageChanged \- notify widgets that image needs to be redrawn
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+\fBTk_ImageChanged\fR(\fIimageMaster, x, y, width, height, imageWidth, imageHeight\fR)
+.SH ARGUMENTS
+.AS Tk_ImageMaster imageHeight
+.AP Tk_ImageMaster imageMaster in
+Token for image, which was passed to image's \fIcreateProc\fR when
+the image was created.
+.AP int x in
+X-coordinate of upper-left corner of region that needs redisplay (measured
+from upper-left corner of image).
+.AP int y in
+Y-coordinate of upper-left corner of region that needs redisplay (measured
+from upper-left corner of image).
+.AP "int" width in
+Width of region that needs to be redrawn, in pixels.
+.AP "int" height in
+Height of region that needs to be redrawn, in pixels.
+.AP "int" imageWidth in
+Current width of image, in pixels.
+.AP "int" imageHeight in
+Current height of image, in pixels.
+.BE
+.SH DESCRIPTION
+.PP
+An image manager calls \fBTk_ImageChanged\fR for an image
+whenever anything happens that requires the image to be redrawn.
+As a result of calling \fBTk_ImageChanged\fR, any widgets using
+the image are notified so that they can redisplay themselves
+appropriately.
+The \fIimageMaster\fR argument identifies the image, and
+\fIx\fR, \fIy\fR, \fIwidth\fR, and \fIheight\fR
+specify a rectangular region within the image that needs to
+be redrawn.
+\fIimageWidth\fR and \fIimageHeight\fR specify the image's (new) size.
+.PP
+An image manager should call \fBTk_ImageChanged\fR during
+its \fIcreateProc\fR to specify the image's initial size and to
+force redisplay if there are existing instances for the image.
+If any of the pixel values in the image should change later on,
+\fBTk_ImageChanged\fR should be called again with \fIx\fR, \fIy\fR,
+\fIwidth\fR, and \fIheight\fR values that cover all the pixels
+that changed.
+If the size of the image should change, then \fBTk_ImageChanged\fR
+must be called to indicate the new size, even if no pixels
+need to be redisplayed.
+.SH "SEE ALSO"
+Tk_CreateImageType
+.SH KEYWORDS
+images, redisplay, image size changes
|