SGI/util/SGI/man/man3/Tk_DrawChars.3

   1 '\"
   2 '\" Copyright (c) 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 '\" SCCS: @(#) MeasureChar.3 1.5 97/06/10 17:33:36
   8 '\"
   9 '\" The definitions below are for supplemental macros used in Tcl/Tk
  10 '\" manual entries.
  11 '\"
  12 '\" .AP type name in/out ?indent?
  13 '\"     Start paragraph describing an argument to a library procedure.
  14 '\"     type is type of argument (int, etc.), in/out is either "in", "out",
  15 '\"     or "in/out" to describe whether procedure reads or modifies arg,
  16 '\"     and indent is equivalent to second arg of .IP (shouldn't ever be
  17 '\"     needed;  use .AS below instead)
  18 '\"
  19 '\" .AS ?type? ?name?
  20 '\"     Give maximum sizes of arguments for setting tab stops.  Type and
  21 '\"     name are examples of largest possible arguments that will be passed
  22 '\"     to .AP later.  If args are omitted, default tab stops are used.
  23 '\"
  24 '\" .BS
  25 '\"     Start box enclosure.  From here until next .BE, everything will be
  26 '\"     enclosed in one large box.
  27 '\"
  28 '\" .BE
  29 '\"     End of box enclosure.
  30 '\"
  31 '\" .CS
  32 '\"     Begin code excerpt.
  33 '\"
  34 '\" .CE
  35 '\"     End code excerpt.
  36 '\"
  37 '\" .VS ?version? ?br?
  38 '\"     Begin vertical sidebar, for use in marking newly-changed parts
  39 '\"     of man pages.  The first argument is ignored and used for recording
  40 '\"     the version when the .VS was added, so that the sidebars can be
  41 '\"     found and removed when they reach a certain age.  If another argument
  42 '\"     is present, then a line break is forced before starting the sidebar.
  43 '\"
  44 '\" .VE
  45 '\"     End of vertical sidebar.
  46 '\"
  47 '\" .DS
  48 '\"     Begin an indented unfilled display.
  49 '\"
  50 '\" .DE
  51 '\"     End of indented unfilled display.
  52 '\"
  53 '\" .SO
  54 '\"     Start of list of standard options for a Tk widget.  The
  55 '\"     options follow on successive lines, in four columns separated
  56 '\"     by tabs.
  57 '\"
  58 '\" .SE
  59 '\"     End of list of standard options for a Tk widget.
  60 '\"
  61 '\" .OP cmdName dbName dbClass
  62 '\"     Start of description of a specific option.  cmdName gives the
  63 '\"     option's name as specified in the class command, dbName gives
  64 '\"     the option's name in the option database, and dbClass gives
  65 '\"     the option's class in the option database.
  66 '\"
  67 '\" .UL arg1 arg2
  68 '\"     Print arg1 underlined, then print arg2 normally.
  69 '\"
  70 '\" SCCS: @(#) man.macros 1.9 97/08/22 18:50:59
  71 '\"
  72 '\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  73 .if t .wh -1.3i ^B
  74 .nr ^l \n(.l
  75 .ad b
  76 '\"     # Start an argument description
  77 .de AP
  78 .ie !"\\$4"" .TP \\$4
  79 .el \{\
  80 .   ie !"\\$2"" .TP \\n()Cu
  81 .   el          .TP 15
  82 .\}
  83 .ie !"\\$3"" \{\
  84 .ta \\n()Au \\n()Bu
  85 \&\\$1  \\fI\\$2\\fP    (\\$3)
  86 .\".b
  87 .\}
  88 .el \{\
  89 .br
  90 .ie !"\\$2"" \{\
  91 \&\\$1  \\fI\\$2\\fP
  92 .\}
  93 .el \{\
  94 \&\\fI\\$1\\fP
  95 .\}
  96 .\}
  97 ..
  98 '\"     # define tabbing values for .AP
  99 .de AS
 100 .nr )A 10n
 101 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 102 .nr )B \\n()Au+15n
 103 .\"
 104 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 105 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 106 ..
 107 .AS Tcl_Interp Tcl_CreateInterp in/out
 108 '\"     # BS - start boxed text
 109 '\"     # ^y = starting y location
 110 '\"     # ^b = 1
 111 .de BS
 112 .br
 113 .mk ^y
 114 .nr ^b 1u
 115 .if n .nf
 116 .if n .ti 0
 117 .if n \l'\\n(.lu\(ul'
 118 .if n .fi
 119 ..
 120 '\"     # BE - end boxed text (draw box now)
 121 .de BE
 122 .nf
 123 .ti 0
 124 .mk ^t
 125 .ie n \l'\\n(^lu\(ul'
 126 .el \{\
 127 .\"     Draw four-sided box normally, but don't draw top of
 128 .\"     box if the box started on an earlier page.
 129 .ie !\\n(^b-1 \{\
 130 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 131 .\}
 132 .el \}\
 133 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 134 .\}
 135 .\}
 136 .fi
 137 .br
 138 .nr ^b 0
 139 ..
 140 '\"     # VS - start vertical sidebar
 141 '\"     # ^Y = starting y location
 142 '\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 143 .de VS
 144 .if !"\\$2"" .br
 145 .mk ^Y
 146 .ie n 'mc \s12\(br\s0
 147 .el .nr ^v 1u
 148 ..
 149 '\"     # VE - end of vertical sidebar
 150 .de VE
 151 .ie n 'mc
 152 .el \{\
 153 .ev 2
 154 .nf
 155 .ti 0
 156 .mk ^t
 157 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 158 .sp -1
 159 .fi
 160 .ev
 161 .\}
 162 .nr ^v 0
 163 ..
 164 '\"     # Special macro to handle page bottom:  finish off current
 165 '\"     # box/sidebar if in box/sidebar mode, then invoked standard
 166 '\"     # page bottom macro.
 167 .de ^B
 168 .ev 2
 169 'ti 0
 170 'nf
 171 .mk ^t
 172 .if \\n(^b \{\
 173 .\"     Draw three-sided box if this is the box's first page,
 174 .\"     draw two sides but no top otherwise.
 175 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 176 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 177 .\}
 178 .if \\n(^v \{\
 179 .nr ^x \\n(^tu+1v-\\n(^Yu
 180 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 181 .\}
 182 .bp
 183 'fi
 184 .ev
 185 .if \\n(^b \{\
 186 .mk ^y
 187 .nr ^b 2
 188 .\}
 189 .if \\n(^v \{\
 190 .mk ^Y
 191 .\}
 192 ..
 193 '\"     # DS - begin display
 194 .de DS
 195 .RS
 196 .nf
 197 .sp
 198 ..
 199 '\"     # DE - end display
 200 .de DE
 201 .fi
 202 .RE
 203 .sp
 204 ..
 205 '\"     # SO - start of list of standard options
 206 .de SO
 207 .SH "STANDARD OPTIONS"
 208 .LP
 209 .nf
 210 .ta 4c 8c 12c
 211 .ft B
 212 ..
 213 '\"     # SE - end of list of standard options
 214 .de SE
 215 .fi
 216 .ft R
 217 .LP
 218 See the \\fBoptions\\fR manual entry for details on the standard options.
 219 ..
 220 '\"     # OP - start of full description for a single option
 221 .de OP
 222 .LP
 223 .nf
 224 .ta 4c
 225 Command-Line Name:      \\fB\\$1\\fR
 226 Database Name:  \\fB\\$2\\fR
 227 Database Class: \\fB\\$3\\fR
 228 .fi
 229 .IP
 230 ..
 231 '\"     # CS - begin code excerpt
 232 .de CS
 233 .RS
 234 .nf
 235 .ta .25i .5i .75i 1i
 236 ..
 237 '\"     # CE - end code excerpt
 238 .de CE
 239 .fi
 240 .RE
 241 ..
 242 .de UL
 243 \\$1\l'|0\(ul'\\$2
 244 ..
 245 .TH Tk_MeasureChars 3 "" Tk "Tk Library Procedures"
 246 .BS
 247 .SH NAME
 248 Tk_MeasureChars, Tk_TextWidth, Tk_DrawChars, Tk_UnderlineChars \- routines to measure and display simple single-line strings.
 249 .SH SYNOPSIS
 250 .nf
 251 \fB#include <tk.h>\fR
 252 .sp
 253 int
 254 \fBTk_MeasureChars(\fItkfont, string, maxChars, maxPixels, flags, lengthPtr\fB)\fR
 255 .sp
 256 int
 257 \fBTk_TextWidth(\fItkfont, string, numChars\fB)\fR
 258 .sp
 259 void
 260 \fBTk_DrawChars(\fIdisplay, drawable, gc, tkfont, string, numChars, x, y\fB)\fR
 261 .sp
 262 void
 263 \fBTk_UnderlineChars(\fIdisplay, drawable, gc, tkfont, string, x, y, firstChar, lastChar\fB)\fR
 264 .sp
 265 .SH ARGUMENTS
 266 .AS "const char" firstChar
 267 .AP Tk_Font tkfont in
 268 Token for font in which text is to be drawn or measured.  Must have been
 269 returned by a previous call to \fBTk_GetFont\fR.
 270 .AP "const char" *string in
 271 Text to be measured or displayed.  Need not be null terminated.  Any
 272 non-printing meta-characters in the string (such as tabs, newlines, and
 273 other control characters) will be measured or displayed in a
 274 platform-dependent manner.
 275 .AP int maxChars in
 276 The maximum number of characters to consider when measuring \fIstring\fR.
 277 Must be greater than or equal to 0.
 278 .AP int maxPixels in
 279 If \fImaxPixels\fR is greater than 0, it specifies the longest permissible
 280 line length in pixels.  Characters from \fIstring\fR are processed only
 281 until this many pixels have been covered.  If \fImaxPixels\fR is <= 0, then
 282 the line length is unbounded and the \fIflags\fR argument is ignored.
 283 .AP int flags in
 284 Various flag bits OR-ed together: TK_PARTIAL_OK means include a character
 285 as long as any part of it fits in the length given by \fImaxPixels\fR;
 286 otherwise, a character must fit completely to be considered.
 287 TK_WHOLE_WORDS means stop on a word boundary, if possible.  If
 288 TK_AT_LEAST_ONE is set, it means return at least one character even if no
 289 characters could fit in the length given by \fImaxPixels\fR.  If
 290 TK_AT_LEAST_ONE is set and TK_WHOLE_WORDS is also set, it means that if
 291 not even one word fits on the line, return the first few letters of the
 292 word that did fit; if not even one letter of the word fit, then the first
 293 letter will still be returned.
 294 .AP int *lengthPtr out
 295 Filled with the number of pixels occupied by the number of characters
 296 returned as the result of \fBTk_MeasureChars\fR.
 297 .AP int numChars in
 298 The total number of characters to measure or draw from \fIstring\fR.  Must
 299 be greater than or equal to 0.
 300 .AP Display *display in
 301 Display on which to draw.
 302 .AP Drawable drawable in
 303 Window or pixmap in which to draw.
 304 .AP GC gc in
 305 Graphics context for drawing characters.  The font selected into this GC
 306 must be the same as the \fItkfont\fR.
 307 .AP int "x, y" in
 308 Coordinates at which to place the left edge of the baseline when displaying
 309 \fIstring\fR.
 310 .AP int firstChar in
 311 The index of the first character to underline in the \fIstring\fR.
 312 Underlining begins at the left edge of this character.
 313 .AP int lastChar in
 314 The index of the last character up to which the underline will
 315 be drawn.  The character specified by \fIlastChar\fR will not itself be
 316 underlined.
 317 .BE
 318
 319 .SH DESCRIPTION
 320 .PP
 321 These routines are for measuring and displaying simple single-font,
 322 single-line, strings.  To measure and display single-font, multi-line,
 323 justified text, refer to the documentation for \fBTk_ComputeTextLayout\fR.
 324 There is no programming interface in the core of Tk that supports
 325 multi-font, multi-line text; support for that behavior must be built on
 326 top of simpler layers.
 327 .PP
 328 A glyph is the displayable picture of a letter, number, or some other
 329 symbol.  Not all character codes in a given font have a glyph.
 330 Characters such as tabs, newlines/returns, and control characters that
 331 have no glyph are measured and displayed by these procedures in a
 332 platform-dependent manner; under X, they are replaced with backslashed
 333 escape sequences, while under Windows and Macintosh hollow or solid boxes
 334 may be substituted.  Refer to the documentation for
 335 \fBTk_ComputeTextLayout\fR for a programming interface that supports the
 336 platform-independent expansion of tab characters into columns and
 337 newlines/returns into multi-line text.
 338 .PP
 339 \fBTk_MeasureChars\fR is used both to compute the length of a given
 340 string and to compute how many characters from a string fit in a given
 341 amount of space.  The return value is the number of characters from
 342 \fIstring\fR that fit in the space specified by \fImaxPixels\fR subject to
 343 the conditions described by \fIflags\fR.  If all characters fit, the return
 344 value will be \fImaxChars\fR.  \fI*lengthPtr\fR is filled with the computed
 345 width, in pixels, of the portion of the string that was measured.  For
 346 example, if the return value is 5, then \fI*lengthPtr\fR is filled with the
 347 distance between the left edge of \fIstring\fR[0] and the right edge of
 348 \fIstring\fR[4].
 349 .PP
 350 \fBTk_TextWidth\fR is a wrapper function that provides a simpler interface
 351 to the \fBTk_MeasureChars\fR function.  The return value is how much
 352 space in pixels the given \fIstring\fR needs.
 353 .PP
 354 \fBTk_DrawChars\fR draws the \fIstring\fR at the given location in the
 355 given \fIdrawable\fR.
 356 .PP
 357 \fBTk_UnderlineChars\fR underlines the given range of characters in the
 358 given \fIstring\fR.  It doesn't draw the characters (which are assumed to
 359 have been displayed previously by \fBTk_DrawChars\fR); it just draws the
 360 underline.  This procedure is used to underline a few characters without
 361 having to construct an underlined font.  To produce natively underlined
 362 text, the appropriate underlined font should be constructed and used.
 363
 364 .SH KEYWORDS
 365 font