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