head	1.9;
access;
symbols
	core-8-5-9:1.7
	core-8-5-8:1.7
	macosx-cocoa-merge:1.8
	macosx-cocoa-premerge:1.8
	macosx-carbon-freeze:1.8
	core-8-5-7:1.7
	core-8-5-6:1.7
	core-8-6-b1:1.8
	core-8-6-a3:1.8
	core-8-5-5:1.7
	core-8-6-a2:1.8
	core-8-5-4:1.7
	core-8-5-3:1.7
	core-8-6-a1:1.7
	core-8-4-19:1.2
	core-8-5-branch:1.7.0.2
	core-8-5-2:1.7
	core-8-4-18:1.2
	core-8-5-1:1.7
	core-8-4-17:1.2
	core-8-5-0:1.7
	core-8-5-b3:1.6
	core-8-5-b2:1.5
	core-8-4-16:1.2
	core-8-5-b1:1.5
	core-stablilizer-merge:1.5
	core-stabilizer-branch:1.5.0.2
	core-stabilizer-merge:1.7
	core-8-4-15:1.2
	core-8-5-a6:1.5
	core-8-5-a5:1.4
	core-8-4-14:1.2
	core-8-5-a4:1.4
	core-8-4-13:1.2
	core-8-4-12:1.2
	core-8-4-11:1.2
	core-8-5-a3:1.4
	core-8-4-10:1.2
	core-8-4-9-branch:1.2.0.14
	core-8-5-a2:1.4
	core-8-4-9:1.2
	core-8-4-8:1.2
	core-8-4-7:1.2
	core-8-5-a1:1.2
	core-8-4-6:1.2
	core-8-4-5:1.2
	mistachkin-dev-branch:1.2.0.12
	core-8-4-4:1.2
	core-8-4-3:1.2
	core-8-4-branch:1.2.0.10
	core-8-4-2:1.2
	core-8-4-1:1.2
	core-8-3-5:1.2
	core-8-4-0:1.2
	macosx-8-4-merge-2002-08-31-trunk:1.2
	macosx-8-4-premerge-2002-08-31-branch:1.2
	macosx-8-4-premerge-2002-08-31-trunk:1.2
	macosx-8-4-merge-2002-08-30-branch:1.2
	macosx-8-4-merge-2002-08-30-trunk:1.2
	macosx-8-4-merge-2002-08-20-branch:1.2
	macosx-8-4-merge-2002-08-20-trunk:1.2
	core-8-4-b2:1.2
	core-8-4-b1:1.2
	macosx-premerge-6-9-02:1.2
	core-8-4-a4:1.2
	core-8-3-4:1.2
	macosx-8-4-branch:1.2.0.8
	macosx-8-4-branchpoint:1.2
	core-8-4-a3:1.2
	core-8-3-3:1.2
	dgp-privates-into-namespace:1.2.0.6
	tclpro-1-5-0:1.2
	core-8-4-win-speedup:1.2.0.4
	core-8-4-a2:1.2
	tclpro-1-4-1:1.2
	tclpro-1-4-0:1.2
	core-8-3-2:1.2
	ajuba-ajuba2-2-1-base:1.2
	ajuba-ajuba2-2-0:1.2
	core-8-4-a1:1.2
	core-8-3-1-branch:1.2.0.2
	core-8-3-1:1.2
	scriptics-sc-2-0-b5:1.2
	scriptics-sc-2-0-fixed:1.2
	scriptics-sc-2-0-b2:1.2
	scriptics-sc-2-0-b1:1.2
	core-8-3-0:1.2
	core-8-3-b2:1.2
	core-8-3-b1:1.2;
locks; strict;
comment	@.\" @;


1.9
date	2010.01.12.15.38.49;	author dkf;	state Exp;
branches;
next	1.8;

1.8
date	2008.06.30.22.57.01;	author dkf;	state Exp;
branches;
next	1.7;

1.7
date	2007.12.13.15.23.43;	author dgp;	state Exp;
branches;
next	1.6;

1.6
date	2007.10.29.16.04.12;	author dkf;	state Exp;
branches;
next	1.5;

1.5
date	2007.01.05.00.00.48;	author nijtmans;	state Exp;
branches
	1.5.2.1;
next	1.4;

1.4
date	2004.09.19.16.05.36;	author dkf;	state Exp;
branches;
next	1.3;

1.3
date	2004.08.22.15.43.20;	author dkf;	state Exp;
branches;
next	1.2;

1.2
date	99.12.22.23.01.33;	author hobbs;	state Exp;
branches;
next	1.1;

1.1
date	99.12.14.06.51.43;	author hobbs;	state Exp;
branches;
next	;

1.5.2.1
date	2007.11.01.16.37.12;	author dgp;	state Exp;
branches;
next	;


desc
@@


1.9
log
@Small improvements in language use, added cross-links
@
text
@'\"
'\" Copyright (c) 1989-1993 The Regents of the University of California.
'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
'\"
'\" 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 $
'\" 
.so man.macros
.TH Tk_GetDash 3 8.3 Tk "Tk Library Procedures"
.BS
.SH NAME
Tk_GetDash \- convert from string to valid dash structure.
.SH SYNOPSIS
.nf
\fB#include <tk.h>\fR

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
Textual value to be converted.
.AP Tk_Dash *dashPtr out
Points to place to store the dash pattern
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
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
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
.QW outline
color. The other segments are drawn transparent.
.PP
The second possible syntax is a character list containing only
5 possible characters
.QW "\fB.,-_ \fR" .
The space can be used
to enlarge the space between other line elements, and can not
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 {2 8}
    \-dash ,     = \-dash {4 4}
.CE
.PP
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
ensures 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
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 to the first one.
.SH "SEE ALSO"
canvas(n), Tk_CreateItemType(3)
.SH KEYWORDS
dash, conversion
@


1.8
log
@Minor doc updates (removing out of date changebars, improving typedef formatting,
 etc.)
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetDash.3,v 1.7 2007/12/13 15:23:43 dgp Exp $
d18 1
a18 1
.sp
d21 1
d26 1
a26 1
.AP "const char *" string in
d30 1
a30 1
value converted from \fIstring\fR.
d37 5
a41 3
.QW \fB.,\-_\fR
or spaces. If all
goes well, \fBTCL_OK\fR is returned. If \fIstring\fR does not have the
d53 1
a53 1
.QW "\fB.,\-_ \fR" .
d56 2
a57 1
occur as the first position in the string. Some examples:
d60 3
a62 3
    \-dash \-     = \-dash {6 4}
    \-dash \-.    = \-dash {6 4 2 4}
    \-dash \-..   = \-dash {6 4 2 4 2 4}
d67 1
a67 1
The main difference of this syntax with the previous is that it
d70 1
a70 1
assures that
d73 1
a73 1
.QW \-
d79 4
a82 2
above examples are available. The last 2 examples will be
displayed identically as the first one.
@


1.7
log
@merge stable branch onto HEAD
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetDash.3,v 1.5.2.1 2007/11/01 16:37:12 dgp Exp $
a30 1

a76 1

@


1.6
log
@Lots more GOOBE stuff. Now works with 'make html'!
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetDash.3,v 1.5 2007/01/05 00:00:48 nijtmans Exp $
@


1.5
log
@various "const" additions, in line with TIP #27
fix bug #1627732
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetDash.3,v 1.4 2004/09/19 16:05:36 dkf Exp $
d36 4
a39 2
character string containing only \fB[.,-_]\fR or spaces. If all
goes well, \fBTCL_OK\fR is returned. If \fIstring\fR doesn't have the
d45 3
a47 2
segments are drawn using the "outline" color. The other segments
are drawn transparent.
d50 3
a52 1
5 possible characters \fB[.,-_ ]\fR. The space can be used
d55 8
a62 6
    -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}
d67 4
a70 1
assures that "." will always be displayed as a dot and "-"
@


1.5.2.1
log
@merge updates from HEAD
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetDash.3,v 1.5 2007/01/05 00:00:48 nijtmans Exp $
d36 2
a37 4
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
d43 2
a44 3
segments are drawn using the
.QW outline
color. The other segments are drawn transparent.
d47 1
a47 3
5 possible characters
.QW "\fB.,\-_ \fR" .
The space can be used
d50 6
a55 8
.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
d60 1
a60 4
assures that
.QW .
will always be displayed as a dot and
.QW \-
@


1.4
log
@Standardize style of section refs & public symbols. Remove displayed tabs
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetDash.3,v 1.3 2004/08/22 15:43:20 dkf Exp $
d25 1
a25 1
.AP "CONST char *" string in
@


1.3
log
@More doc fixes from Mikhail Kolesnitchenko. [Patch 1013520]
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetDash.3,v 1.2 1999/12/22 23:01:33 hobbs Exp $
d37 2
a38 2
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
@


1.2
log
@minor doc fixes
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetDash.3,v 1.1 1999/12/14 06:51:43 hobbs Exp $
d49 1
a49 1
occur as the first posibion in the string. Some examples:
d58 1
a58 1
it shape-conserving. This means that all values in the dash
@


1.1
log
@	* doc/canvas.n: added docs for items added by dash patch (-*dash*,
	-state, -active*, -disabled*, -offset, essentially rewrote the
	man patch for completely updated 8.3 canvas widget.
	* doc/entry.n: added docs for entry widget validation
	* doc/event.n: added docs for -warp
	* doc/text.n: doc'ed new -state value 'hidden'
	* doc/GetDash.3: (new file) man page explaining Tk_GetDash
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetDash.3,v $
d25 1
a25 1
.AP CONST char *string in
@

