Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Tk_GetCapStyle (3tk)

Name

Tk_GetCapStyle - translate between strings and cap styles

Synopsis

#include <tk.h>

int
Tk_GetCapStyle(interp, string, capPtr)

const char *
Tk_NameOfCapStyle(cap)

Description

Tk_GetCapStyle(3tk)          Tk Library Procedures         Tk_GetCapStyle(3tk)



______________________________________________________________________________

NAME
       Tk_GetCapStyle,  Tk_NameOfCapStyle  - translate between strings and cap
       styles

SYNOPSIS
       #include <tk.h>

       int
       Tk_GetCapStyle(interp, string, capPtr)

       const char *
       Tk_NameOfCapStyle(cap)

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

       const char *string (in)          String  containing name of cap style -
                                        one  of   "butt",   "projecting",   or
                                        "round"  - or a unique abbreviation of
                                        one.

       int *capPtr (out)                Pointer to location in which to  store
                                        X cap style corresponding to string.

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

DESCRIPTION
       Tk_GetCapStyle places in *capPtr  the  X  cap  style  corresponding  to
       string.   This  will  be  one  of the values CapButt, CapProjecting, or
       CapRound.  Cap styles are typically used  in  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 does not contain a valid cap style or an abbrevia-
       tion of one of these names, then an error message is stored  in  inter-
       preter  interp's  result, TCL_ERROR is returned, and *capPtr is unmodi-
       fied.

       Tk_NameOfCapStyle is the logical inverse of  Tk_GetCapStyle.   Given  a
       cap style such as CapButt it returns a statically-allocated string cor-
       responding to cap.  If cap is not a legal cap style, then "unknown  cap
       style" is returned.

KEYWORDS
       butt, cap style, projecting, round



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | runtime/tk-8     |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source        was        downloaded        from         https://source-
       forge.net/projects/tcl/files/Tcl/8.6.7/tk8.6.7-src.tar.gz/download.

       Further information about this software can be found on the open source
       community website at https://www.tcl.tk/.



Tk                                                         Tk_GetCapStyle(3tk)