Seth Woolley's Man Viewer

Tk_GetCapStyle(3)            Tk Library Procedures           Tk_GetCapStyle(3)



______________________________________________________________________________

NAME
       Tk_GetCapStyle,  Tk_NameOfCapStyle  - translate between strings and cap
       styles

SYNOPSIS
       #include <tk.h>

       int
       Tk_GetCapStyle(interp, string(3,n), capPtr)

       CONST char *
       Tk_NameOfCapStyle(cap)

ARGUMENTS
       Tcl_Interp   *interp   (in(1,8))      Interpreter to use for  error(8,n)  report-
                                        ing.

       CONST char   *string(3,n)   (in(1,8))      String  containing  name of cap style:
                                        one of ```butt'',  ``projecting'',  or
                                        ``round''.

       int          *capPtr   (out)     Pointer  to location in(1,8) which to store
                                        X cap style corresponding to string(3,n).

       int          cap       (in(1,8))      Cap style: one of CapButt, CapProject-
                                        ing, or CapRound.
_________________________________________________________________


DESCRIPTION
       Tk_GetCapStyle  places  in(1,8)  *capPtr  the  X  cap style corresponding to
       string(3,n).  This will be one of  the  values  CapButt,  CapProjecting,  or
       CapRound.   Cap  styles  are  typically  used in(1,8) X graphics contexts to
       indicate how the end-points of lines should be capped.  See the X docu-
       mentation for information on what each style implies.

       Under  normal  circumstances  the  return value is TCL_OK and interp is
       unused.  If string(3,n) doesn't contain a valid cap style or an abbreviation
       of   one   of   these  names,  then  an  error(8,n)  message  is  stored  in(1,8)
       interp->result, TCL_ERROR is returned, and *capPtr is unmodified.

       Tk_NameOfCapStyle is the logical inverse of  Tk_GetCapStyle.   Given  a
       cap style such as CapButt it returns a statically-allocated string(3,n) cor-
       responding to cap.  If cap isn't a legal cap style, then ``unknown  cap
       style'' is returned.


KEYWORDS
       butt, cap style, projecting, round



Tk                                                           Tk_GetCapStyle(3)