diff options
author | dkf <donal.k.fellows@manchester.ac.uk> | 2010-01-12 15:38:49 (GMT) |
---|---|---|
committer | dkf <donal.k.fellows@manchester.ac.uk> | 2010-01-12 15:38:49 (GMT) |
commit | ee409c7d9f84bddd96e5ebfc08e12b1dbbc0a153 (patch) | |
tree | 9bb30d1b90850fa2c6708032d1faa9c065ed153d /doc | |
parent | 410442d9449a71f236beec703d0f00ecb3117aad (diff) | |
download | tk-ee409c7d9f84bddd96e5ebfc08e12b1dbbc0a153.zip tk-ee409c7d9f84bddd96e5ebfc08e12b1dbbc0a153.tar.gz tk-ee409c7d9f84bddd96e5ebfc08e12b1dbbc0a153.tar.bz2 |
Small improvements in language use, added cross-links
Diffstat (limited to 'doc')
-rw-r--r-- | doc/GetDash.3 | 40 |
1 files changed, 23 insertions, 17 deletions
diff --git a/doc/GetDash.3 b/doc/GetDash.3 index d93c622..67b0830 100644 --- a/doc/GetDash.3 +++ b/doc/GetDash.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetDash.3,v 1.8 2008/06/30 22:57:01 dkf Exp $ +'\" RCS: @(#) $Id: GetDash.3,v 1.9 2010/01/12 15:38:49 dkf Exp $ '\" .so man.macros .TH Tk_GetDash 3 8.3 Tk "Tk Library Procedures" @@ -15,27 +15,30 @@ Tk_GetDash \- convert from string to valid dash structure. .SH SYNOPSIS .nf \fB#include <tk.h>\fR -.sp + int \fBTk_GetDash\fR(\fIinterp, string, dashPtr\fR) +.fi .SH ARGUMENTS .AS Tk_Dash *dashPtr .AP Tcl_Interp *interp in Interpreter to use for error reporting. -.AP "const char *" string in +.AP "const char" *string in Textual value to be converted. .AP Tk_Dash *dashPtr out Points to place to store the dash pattern -value converted from \fIstring\fR. +value converted from \fIstring\fR. Must not be NULL. .BE .SH DESCRIPTION .PP These procedure parses the string and fills in the result in the Tk_Dash structure. The string can be a list of integers or a character string containing only -.QW \fB.,\-_\fR -or spaces. If all -goes well, \fBTCL_OK\fR is returned. If \fIstring\fR does not have the +.QW \fB.,-_\fR +and spaces. If all +goes well, \fBTCL_OK\fR is returned and a dash descriptor is stored +in the variable pointed to by \fIdashPtr\fR. +If \fIstring\fR does not have the proper syntax then \fBTCL_ERROR\fR is returned, an error message is left in the interpreter's result, and nothing is stored at *\fIdashPtr\fR. .PP @@ -47,32 +50,35 @@ color. The other segments are drawn transparent. .PP The second possible syntax is a character list containing only 5 possible characters -.QW "\fB.,\-_ \fR" . +.QW "\fB.,-_ \fR" . The space can be used to enlarge the space between other line elements, and can not -occur as the first position in the string. Some examples: +occur in the first position of the string. Some examples: +.PP .CS \-dash . = \-dash {2 4} - \-dash \- = \-dash {6 4} - \-dash \-. = \-dash {6 4 2 4} - \-dash \-.. = \-dash {6 4 2 4 2 4} + \-dash - = \-dash {6 4} + \-dash -. = \-dash {6 4 2 4} + \-dash -.. = \-dash {6 4 2 4 2 4} \-dash {. } = \-dash {2 8} \-dash , = \-dash {4 4} .CE .PP -The main difference of this syntax with the previous is that it +The main difference between this syntax and the numeric is that it is shape-conserving. This means that all values in the dash list will be multiplied by the line width before display. This -assures that +ensures that .QW . will always be displayed as a dot and -.QW \- +.QW - always as a dash regardless of the line width. .PP On systems where only a limited set of dash patterns, the dash pattern will be displayed as the most close dash pattern that is available. For example, on Windows only the first 4 of the -above examples are available. The last 2 examples will be -displayed identically as the first one. +above examples are available; the last 2 examples will be +displayed identically to the first one. +.SH "SEE ALSO" +canvas(n), Tk_CreateItemType(3) .SH KEYWORDS dash, conversion |