diff options
Diffstat (limited to 'doc/GetDash.3')
| -rw-r--r-- | doc/GetDash.3 | 42 |
1 files changed, 26 insertions, 16 deletions
diff --git a/doc/GetDash.3 b/doc/GetDash.3 index ce25b31..cc54c5a 100644 --- a/doc/GetDash.3 +++ b/doc/GetDash.3 @@ -20,7 +20,7 @@ int .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 @@ -31,31 +31,41 @@ value converted from \fIstring\fR. .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 \fB[.,-_]\fR or spaces. If all -goes well, TCL_OK is returned. If \fIstring\fR doesn't have the -proper syntax then TCL_ERROR is returned, an error message is left +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 +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 The first possible syntax is a list of integers. Each element represents the number of pixels of a line segment. Only the odd -segments are drawn using the "outline" color. The other segments -are drawn transparent. +segments are drawn using the +.QW outline +color. The other segments are drawn transparent. .PP The second possible syntax is a character list containing only -5 possible characters \fB[.,-_ ]\fR. The space can be used +5 possible characters +.QW "\fB.,\-_ \fR" . +The space can be used to enlarge the space between other line elements, and can not -occur as the first posibion in the string. Some examples: - -dash . = -dash {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} +occur as the first position in the string. Some examples: +.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 {2 8} + \-dash , = \-dash {4 4} +.CE .PP The main difference of this syntax with the previous is that it -it shape-conserving. This means that all values in the dash +is shape-conserving. This means that all values in the dash list will be multiplied by the line width before display. This -assures that "." will always be displayed as a dot and "-" +assures that +.QW . +will always be displayed as a dot and +.QW \- always as a dash regardless of the line width. .PP On systems where only a limited set of dash patterns, the dash |