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

   1 '\"
   2 '\" Copyright (c) 1990 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_GetJoinStyle 3 "" Tk "Tk Library Procedures"
   9 .so man.macros
  10 .BS
  11 .SH NAME
  12 Tk_GetJoinStyle, Tk_NameOfJoinStyle \- translate between strings and join styles
  13 .SH SYNOPSIS
  14 .nf
  15 \fB#include <tk.h>\fR
  16 .sp
  17 int
  18 \fBTk_GetJoinStyle(\fIinterp, string, joinPtr\fB)\fR
  19 .sp
  20 const char *
  21 \fBTk_NameOfJoinStyle(\fIjoin\fB)\fR
  22 .SH ARGUMENTS
  23 .AS "Tcl_Interp" *joinPtr
  24 .AP Tcl_Interp *interp in
  25 Interpreter to use for error reporting.
  26 .AP "const char" *string in
  27 String containing name of join style \- one of
  28 .QW \fBbevel\fR ,
  29 .QW \fBmiter\fR ,
  30 or
  31 .QW \fBround\fR
  32 \- or a unique abbreviation of one.
  33 .AP int *joinPtr out
  34 Pointer to location in which to store X join style corresponding to
  35 \fIstring\fR.
  36 .AP int join in
  37 Join style: one of \fBJoinBevel\fR, \fBJoinMiter\fR, \fBJoinRound\fR.
  38 .BE
  39 .SH DESCRIPTION
  40 .PP
  41 \fBTk_GetJoinStyle\fR places in \fI*joinPtr\fR the X join style
  42 corresponding to \fIstring\fR, which will be one of
  43 \fBJoinBevel\fR, \fBJoinMiter\fR, or \fBJoinRound\fR.
  44 Join styles are typically used in X graphics contexts to indicate
  45 how adjacent line segments should be joined together.
  46 See the X documentation for information on what each style
  47 implies.
  48 .PP
  49 Under normal circumstances the return value is \fBTCL_OK\fR and
  50 \fIinterp\fR is unused.
  51 If \fIstring\fR does not contain a valid join style
  52 or an abbreviation of one of these names, then an error message is
  53 stored in interpreter \fIinterp\fR's result, \fBTCL_ERROR\fR is returned, and
  54 \fI*joinPtr\fR is unmodified.
  55 .PP
  56 \fBTk_NameOfJoinStyle\fR is the logical inverse of \fBTk_GetJoinStyle\fR.
  57 Given a join style such as \fBJoinBevel\fR it returns a
  58 statically-allocated string corresponding to \fIjoin\fR.
  59 If \fIjoin\fR is not a legal join style, then
  60 .QW "unknown join style"
  61 is returned.
  62 .SH KEYWORDS
  63 bevel, join style, miter, round