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

   1 '\"
   2 '\" Copyright (c) 1995-1996 Sun Microsystems, Inc.
   3 '\"
   4 '\" See the file "license.terms" for information on usage and redistribution
   5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   6 '\"
   7 .TH Tk_DrawFocusHighlight 3 4.0 Tk "Tk Library Procedures"
   8 .so man.macros
   9 .BS
  10 .SH NAME
  11 Tk_DrawFocusHighlight \- draw the traversal highlight ring for a widget
  12 .SH SYNOPSIS
  13 .nf
  14 \fB#include <tk.h>\fR
  15 .sp
  16 \fBTk_DrawFocusHighlight(\fItkwin, gc, width, drawable\fB)\fR
  17 .SH ARGUMENTS
  18 .AS "Tcl_Interp" *joinPtr
  19 .AP Tk_Window tkwin in
  20 Window for which the highlight is being drawn.  Used to retrieve
  21 the window's dimensions, among other things.
  22 .AP GC gc in
  23 Graphics context to use for drawing the highlight.
  24 .AP int width in
  25 Width of the highlight ring, in pixels.
  26 .AP Drawable drawable in
  27 Drawable in which to draw the highlight;  usually an offscreen
  28 pixmap for double buffering.
  29 .BE
  30 .SH DESCRIPTION
  31 .PP
  32 \fBTk_DrawFocusHighlight\fR is a utility procedure that draws the
  33 traversal highlight ring for a widget.
  34 It is typically invoked by widgets during redisplay.
  35 .SH KEYWORDS
  36 focus, traversal highlight