[OpenSPARC-T2-SAM] / sam-t2 / devtools / v9 / man / mann / tk_chooseDirectory.n

'\"
'\" Copyright (c) 1998-2000 by Scriptics Corporation.
'\" All rights reserved.
'\" 
'\" RCS: @(#) $Id: chooseDirectory.n,v 1.1.10.1 2004/10/28 10:19:29 dkf Exp $
'\" 
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",
'\"	or "in/out" to describe whether procedure reads or modifies arg,
'\"	and indent is equivalent to second arg of .IP (shouldn't ever be
'\"	needed;  use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\"	Give maximum sizes of arguments for setting tab stops.  Type and
'\"	name are examples of largest possible arguments that will be passed
'\"	to .AP later.  If args are omitted, default tab stops are used.
'\"
'\" .BS
'\"	Start box enclosure.  From here until next .BE, everything will be
'\"	enclosed in one large box.
'\"
'\" .BE
'\"	End of box enclosure.
'\"
'\" .CS
'\"	Begin code excerpt.
'\"
'\" .CE
'\"	End code excerpt.
'\"
'\" .VS ?version? ?br?
'\"	Begin vertical sidebar, for use in marking newly-changed parts
'\"	of man pages.  The first argument is ignored and used for recording
'\"	the version when the .VS was added, so that the sidebars can be
'\"	found and removed when they reach a certain age.  If another argument
'\"	is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\"	End of vertical sidebar.
'\"
'\" .DS
'\"	Begin an indented unfilled display.
'\"
'\" .DE
'\"	End of indented unfilled display.
'\"
'\" .SO
'\"	Start of list of standard options for a Tk widget.  The
'\"	options follow on successive lines, in four columns separated
'\"	by tabs.
'\"
'\" .SE
'\"	End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\"	Start of description of a specific option.  cmdName gives the
'\"	option's name as specified in the class command, dbName gives
'\"	the option's name in the option database, and dbClass gives
'\"	the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\"	Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
'\"
'\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.if t .wh -1.3i ^B
.nr ^l \n(.l
.ad b
'\"	# Start an argument description
.de AP
.ie !"\\$4"" .TP \\$4
.el \{\
.   ie !"\\$2"" .TP \\n()Cu
.   el          .TP 15
.\}
.ta \\n()Au \\n()Bu
.ie !"\\$3"" \{\
\&\\$1	\\fI\\$2\\fP	(\\$3)
.\".b
.\}
.el \{\
.br
.ie !"\\$2"" \{\
\&\\$1	\\fI\\$2\\fP
.\}
.el \{\
\&\\fI\\$1\\fP
.\}
.\}
..
'\"	# define tabbing values for .AP
.de AS
.nr )A 10n
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.nr )B \\n()Au+15n
.\"
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
.AS Tcl_Interp Tcl_CreateInterp in/out
'\"	# BS - start boxed text
'\"	# ^y = starting y location
'\"	# ^b = 1
.de BS
.br
.mk ^y
.nr ^b 1u
.if n .nf
.if n .ti 0
.if n \l'\\n(.lu\(ul'
.if n .fi
..
'\"	# BE - end boxed text (draw box now)
.de BE
.nf
.ti 0
.mk ^t
.ie n \l'\\n(^lu\(ul'
.el \{\
.\"	Draw four-sided box normally, but don't draw top of
.\"	box if the box started on an earlier page.
.ie !\\n(^b-1 \{\
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.el \}\
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.\}
.fi
.br
.nr ^b 0
..
'\"	# VS - start vertical sidebar
'\"	# ^Y = starting y location
'\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
.de VS
.if !"\\$2"" .br
.mk ^Y
.ie n 'mc \s12\(br\s0
.el .nr ^v 1u
..
'\"	# VE - end of vertical sidebar
.de VE
.ie n 'mc
.el \{\
.ev 2
.nf
.ti 0
.mk ^t
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
.sp -1
.fi
.ev
.\}
.nr ^v 0
..
'\"	# Special macro to handle page bottom:  finish off current
'\"	# box/sidebar if in box/sidebar mode, then invoked standard
'\"	# page bottom macro.
.de ^B
.ev 2
'ti 0
'nf
.mk ^t
.if \\n(^b \{\
.\"	Draw three-sided box if this is the box's first page,
.\"	draw two sides but no top otherwise.
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.\}
.if \\n(^v \{\
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
.if \\n(^b \{\
.mk ^y
.nr ^b 2
.\}
.if \\n(^v \{\
.mk ^Y
.\}
..
'\"	# DS - begin display
.de DS
.RS
.nf
.sp
..
'\"	# DE - end display
.de DE
.fi
.RE
.sp
..
'\"	# SO - start of list of standard options
.de SO
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 5.5c 11c
.ft B
..
'\"	# SE - end of list of standard options
.de SE
.fi
.ft R
.LP
See the \\fBoptions\\fR manual entry for details on the standard options.
..
'\"	# OP - start of full description for a single option
.de OP
.LP
.nf
.ta 4c
Command-Line Name:	\\fB\\$1\\fR
Database Name:	\\fB\\$2\\fR
Database Class:	\\fB\\$3\\fR
.fi
.IP
..
'\"	# CS - begin code excerpt
.de CS
.RS
.nf
.ta .25i .5i .75i 1i
..
'\"	# CE - end code excerpt
.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH tk_chooseDirectory n 8.3 Tk "Tk Built-In Commands"
.BS
'\" Note:  do not modify the .SH NAME line immediately below!
.SH NAME
tk_chooseDirectory \- pops up a dialog box for the user to select a directory.
.PP
.SH SYNOPSIS
\fBtk_chooseDirectory \fR?\fIoption value ...\fR?
.BE

.SH DESCRIPTION
.PP
The procedure \fBtk_chooseDirectory\fR pops up a dialog box for the
user to select a directory. The following \fIoption\-value\fR pairs are
possible as command line arguments:
.TP
\fB\-initialdir\fR \fIdirname\fR
Specifies that the directories in \fIdirectory\fR should be displayed
when the dialog pops up. If this parameter is not specified, then
the directories in the current working directory are displayed. If the
parameter specifies a relative path, the return value will convert the
relative path to an absolute path.  This option may not always work on
the Macintosh.  This is not a bug. Rather, the \fIGeneral Controls\fR
control panel on the Mac allows the end user to override the
application default directory.
.TP
\fB\-parent\fR \fIwindow\fR
Makes \fIwindow\fR the logical parent of the dialog. The dialog
is displayed on top of its parent window.
.TP
\fB\-title\fR \fItitleString\fR
Specifies a string to display as the title of the dialog box. If this
option is not specified, then a default title will be displayed.
.TP
\fB\-mustexist\fR \fIboolean\fR
Specifies whether the user may specify non-existent directories.  If
this parameter is true, then the user may only select directories that
already exist.  The default value is \fIfalse\fR.
.SH EXAMPLE
.CS
set dir [\fBtk_chooseDirectory\fR \\
        \-initialdir ~ \-title "Choose a directory"]
if {$dir eq ""} {
   label .l -text "No directory selected"
} else {
   label .l -text "Selected $dir"
}
.CE

.SH "SEE ALSO"
tk_getOpenFile(n), tk_getSaveFile(n)
.SH KEYWORDS
directory, selection, dialog, platform-specific
Commit	Line	Data
920dae64 AT	1	'\"
	2	'\" Copyright (c) 1998-2000 by Scriptics Corporation.
	3	'\" All rights reserved.
	4	'\"
	5	'\" RCS: @(#) $Id: chooseDirectory.n,v 1.1.10.1 2004/10/28 10:19:29 dkf Exp $
	6	'\"
	7	'\" The definitions below are for supplemental macros used in Tcl/Tk
	8	'\" manual entries.
	9	'\"
	10	'\" .AP type name in/out ?indent?
	11	'\" Start paragraph describing an argument to a library procedure.
	12	'\" type is type of argument (int, etc.), in/out is either "in", "out",
	13	'\" or "in/out" to describe whether procedure reads or modifies arg,
	14	'\" and indent is equivalent to second arg of .IP (shouldn't ever be
	15	'\" needed; use .AS below instead)
	16	'\"
	17	'\" .AS ?type? ?name?
	18	'\" Give maximum sizes of arguments for setting tab stops. Type and
	19	'\" name are examples of largest possible arguments that will be passed
	20	'\" to .AP later. If args are omitted, default tab stops are used.
	21	'\"
	22	'\" .BS
	23	'\" Start box enclosure. From here until next .BE, everything will be
	24	'\" enclosed in one large box.
	25	'\"
	26	'\" .BE
	27	'\" End of box enclosure.
	28	'\"
	29	'\" .CS
	30	'\" Begin code excerpt.
	31	'\"
	32	'\" .CE
	33	'\" End code excerpt.
	34	'\"
	35	'\" .VS ?version? ?br?
	36	'\" Begin vertical sidebar, for use in marking newly-changed parts
	37	'\" of man pages. The first argument is ignored and used for recording
	38	'\" the version when the .VS was added, so that the sidebars can be
	39	'\" found and removed when they reach a certain age. If another argument
	40	'\" is present, then a line break is forced before starting the sidebar.
	41	'\"
	42	'\" .VE
	43	'\" End of vertical sidebar.
	44	'\"
	45	'\" .DS
	46	'\" Begin an indented unfilled display.
	47	'\"
	48	'\" .DE
	49	'\" End of indented unfilled display.
	50	'\"
	51	'\" .SO
	52	'\" Start of list of standard options for a Tk widget. The
	53	'\" options follow on successive lines, in four columns separated
	54	'\" by tabs.
	55	'\"
	56	'\" .SE
	57	'\" End of list of standard options for a Tk widget.
	58	'\"
	59	'\" .OP cmdName dbName dbClass
	60	'\" Start of description of a specific option. cmdName gives the
	61	'\" option's name as specified in the class command, dbName gives
	62	'\" the option's name in the option database, and dbClass gives
	63	'\" the option's class in the option database.
	64	'\"
65	'\" .UL arg1 arg2
66	'\" Print arg1 underlined, then print arg2 normally.
67	'\"
68	'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
69	'\"
70	'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
71	.if t .wh -1.3i ^B
72	.nr ^l \n(.l
73	.ad b
74	'\" # Start an argument description
75	.de AP
76	.ie !"\\$4"" .TP \\$4
77	.el \{\
78	. ie !"\\$2"" .TP \\n()Cu
79	. el .TP 15
80	.\}
81	.ta \\n()Au \\n()Bu
82	.ie !"\\$3"" \{\
83	\&\\$1 \\fI\\$2\\fP (\\$3)
84	.\".b
85	.\}
86	.el \{\
87	.br
88	.ie !"\\$2"" \{\
89	\&\\$1 \\fI\\$2\\fP
90	.\}
91	.el \{\
92	\&\\fI\\$1\\fP
93	.\}
94	.\}
95	..
96	'\" # define tabbing values for .AP
97	.de AS
98	.nr )A 10n
99	.if !"\\$1"" .nr )A \\w'\\$1'u+3n
100	.nr )B \\n()Au+15n
101	.\"
102	.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
103	.nr )C \\n()Bu+\\w'(in/out)'u+2n
104	..
105	.AS Tcl_Interp Tcl_CreateInterp in/out
106	'\" # BS - start boxed text
107	'\" # ^y = starting y location
108	'\" # ^b = 1
109	.de BS
110	.br
111	.mk ^y
112	.nr ^b 1u
113	.if n .nf
114	.if n .ti 0
115	.if n \l'\\n(.lu\(ul'
116	.if n .fi
117	..
118	'\" # BE - end boxed text (draw box now)
119	.de BE
120	.nf
121	.ti 0
122	.mk ^t
123	.ie n \l'\\n(^lu\(ul'
124	.el \{\
125	.\" Draw four-sided box normally, but don't draw top of
126	.\" box if the box started on an earlier page.
127	.ie !\\n(^b-1 \{\
128	\h'-1.5n'\L'\|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
129	.\}
130	.el \}\
131	\h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
132	.\}
133	.\}
134	.fi
135	.br
136	.nr ^b 0
137	..
138	'\" # VS - start vertical sidebar
139	'\" # ^Y = starting y location
140	'\" # ^v = 1 (for troff; for nroff this doesn't matter)
141	.de VS
142	.if !"\\$2"" .br
143	.mk ^Y
144	.ie n 'mc \s12\(br\s0
145	.el .nr ^v 1u
146	..
147	'\" # VE - end of vertical sidebar
148	.de VE
149	.ie n 'mc
150	.el \{\
151	.ev 2
152	.nf
153	.ti 0
154	.mk ^t
155	\h'\|\\n(^lu+3n'\L'\|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-\|\\n(^lu+3n'
156	.sp -1
157	.fi
158	.ev
159	.\}
160	.nr ^v 0
161	..
162	'\" # Special macro to handle page bottom: finish off current
163	'\" # box/sidebar if in box/sidebar mode, then invoked standard
164	'\" # page bottom macro.
165	.de ^B
166	.ev 2
167	'ti 0
168	'nf
169	.mk ^t
170	.if \\n(^b \{\
171	.\" Draw three-sided box if this is the box's first page,
172	.\" draw two sides but no top otherwise.
173	.ie !\\n(^b-1 \h'-1.5n'\L'\|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'\|0u'\c
174	.el \h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'\|0u'\c
175	.\}
176	.if \\n(^v \{\
177	.nr ^x \\n(^tu+1v-\\n(^Yu
178	\kx\h'-\\nxu'\h'\|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'\|0u'\c
179	.\}
180	.bp
181	'fi
182	.ev
183	.if \\n(^b \{\
184	.mk ^y
185	.nr ^b 2
186	.\}
187	.if \\n(^v \{\
188	.mk ^Y
189	.\}
190	..
191	'\" # DS - begin display
192	.de DS
193	.RS
194	.nf
195	.sp
196	..
197	'\" # DE - end display
198	.de DE
199	.fi
200	.RE
201	.sp
202	..
203	'\" # SO - start of list of standard options
204	.de SO
205	.SH "STANDARD OPTIONS"
206	.LP
207	.nf
208	.ta 5.5c 11c
209	.ft B
210	..
211	'\" # SE - end of list of standard options
212	.de SE
213	.fi
214	.ft R
215	.LP
216	See the \\fBoptions\\fR manual entry for details on the standard options.
217	..
218	'\" # OP - start of full description for a single option
219	.de OP
220	.LP
221	.nf
222	.ta 4c
223	Command-Line Name: \\fB\\$1\\fR
224	Database Name: \\fB\\$2\\fR
225	Database Class: \\fB\\$3\\fR
226	.fi
227	.IP
228	..
229	'\" # CS - begin code excerpt
230	.de CS
231	.RS
232	.nf
233	.ta .25i .5i .75i 1i
234	..
235	'\" # CE - end code excerpt
236	.de CE
237	.fi
238	.RE
239	..
240	.de UL
241	\\$1\l'\|0\(ul'\\$2
242	..
243	.TH tk_chooseDirectory n 8.3 Tk "Tk Built-In Commands"
244	.BS
245	'\" Note: do not modify the .SH NAME line immediately below!
246	.SH NAME
247	tk_chooseDirectory \- pops up a dialog box for the user to select a directory.
248	.PP
249	.SH SYNOPSIS
250	\fBtk_chooseDirectory \fR?\fIoption value ...\fR?
251	.BE
252
253	.SH DESCRIPTION
254	.PP
255	The procedure \fBtk_chooseDirectory\fR pops up a dialog box for the
256	user to select a directory. The following \fIoption\-value\fR pairs are
257	possible as command line arguments:
258	.TP
259	\fB\-initialdir\fR \fIdirname\fR
260	Specifies that the directories in \fIdirectory\fR should be displayed
261	when the dialog pops up. If this parameter is not specified, then
262	the directories in the current working directory are displayed. If the
263	parameter specifies a relative path, the return value will convert the
264	relative path to an absolute path. This option may not always work on
265	the Macintosh. This is not a bug. Rather, the \fIGeneral Controls\fR
266	control panel on the Mac allows the end user to override the
267	application default directory.
268	.TP
269	\fB\-parent\fR \fIwindow\fR
270	Makes \fIwindow\fR the logical parent of the dialog. The dialog
271	is displayed on top of its parent window.
272	.TP
273	\fB\-title\fR \fItitleString\fR
274	Specifies a string to display as the title of the dialog box. If this
275	option is not specified, then a default title will be displayed.
276	.TP
277	\fB\-mustexist\fR \fIboolean\fR
278	Specifies whether the user may specify non-existent directories. If
279	this parameter is true, then the user may only select directories that
280	already exist. The default value is \fIfalse\fR.
281	.SH EXAMPLE
282	.CS
283	set dir [\fBtk_chooseDirectory\fR \\
284	\-initialdir ~ \-title "Choose a directory"]
285	if {$dir eq ""} {
286	label .l -text "No directory selected"
287	} else {
288	label .l -text "Selected $dir"
289	}
290	.CE
291
292	.SH "SEE ALSO"
293	tk_getOpenFile(n), tk_getSaveFile(n)
294	.SH KEYWORDS
295	directory, selection, dialog, platform-specific