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