util/src/TclTk/tk8.6.12/doc/ImgChanged.3

   1 '\"
   2 '\" Copyright (c) 1994 The Regents of the University of California.
   3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
   4 '\"
   5 '\" See the file "license.terms" for information on usage and redistribution
   6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   7 '\"
   8 .TH Tk_ImageChanged 3 4.0 Tk "Tk Library Procedures"
   9 .so man.macros
  10 .BS
  11 .SH NAME
  12 Tk_ImageChanged \- notify widgets that image needs to be redrawn
  13 .SH SYNOPSIS
  14 .nf
  15 \fB#include <tk.h>\fR
  16 .sp
  17 \fBTk_ImageChanged\fR(\fImodel, x, y, width, height, imageWidth, imageHeight\fR)
  18 .SH ARGUMENTS
  19 .AS Tk_ImageMaster imageHeight
  20 .AP Tk_ImageMaster model in
  21 Token for image, which was passed to image's \fIcreateProc\fR when
  22 the image was created.
  23 .AP int x in
  24 X-coordinate of upper-left corner of region that needs redisplay (measured
  25 from upper-left corner of image).
  26 .AP int y in
  27 Y-coordinate of upper-left corner of region that needs redisplay (measured
  28 from upper-left corner of image).
  29 .AP "int" width in
  30 Width of region that needs to be redrawn, in pixels.
  31 .AP "int" height in
  32 Height of region that needs to be redrawn, in pixels.
  33 .AP "int" imageWidth in
  34 Current width of image, in pixels.
  35 .AP "int" imageHeight in
  36 Current height of image, in pixels.
  37 .BE
  38 .SH DESCRIPTION
  39 .PP
  40 An image manager calls \fBTk_ImageChanged\fR for an image
  41 whenever anything happens that requires the image to be redrawn.
  42 As a result of calling \fBTk_ImageChanged\fR, any widgets using
  43 the image are notified so that they can redisplay themselves
  44 appropriately.
  45 The \fImodel\fR argument identifies the image, and
  46 \fIx\fR, \fIy\fR, \fIwidth\fR, and \fIheight\fR
  47 specify a rectangular region within the image that needs to
  48 be redrawn.
  49 \fIimageWidth\fR and \fIimageHeight\fR specify the image's (new) size.
  50 .PP
  51 .VS "TIP 581"
  52 \fITk_ImageModel\fR is synonym for \fITk_ImageMaster\fR
  53 .VE "TIP 581"
  54 .PP
  55 An image manager should call \fBTk_ImageChanged\fR during
  56 its \fIcreateProc\fR to specify the image's initial size and to
  57 force redisplay if there are existing instances for the image.
  58 If any of the pixel values in the image should change later on,
  59 \fBTk_ImageChanged\fR should be called again with \fIx\fR, \fIy\fR,
  60 \fIwidth\fR, and \fIheight\fR values that cover all the pixels
  61 that changed.
  62 If the size of the image should change, then \fBTk_ImageChanged\fR
  63 must be called to indicate the new size, even if no pixels
  64 need to be redisplayed.
  65 .SH "SEE ALSO"
  66 Tk_CreateImageType
  67 .SH KEYWORDS
  68 images, redisplay, image size changes