~ubuntu-branches/debian/sid/itcl4/sid

« back to all changes in this revision

Viewing changes to doc/find.n

  • Committer: Package Import Robot
  • Author(s): Sergei Golovan
  • Date: 2018-03-06 11:36:54 UTC
  • Revision ID: package-import@ubuntu.com-20180306113654-w3oht8cjhtftrxby
Tags: upstream-4.1.1
ImportĀ upstreamĀ versionĀ 4.1.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
'\"
 
2
'\" Copyright (c) 1993-1998  Lucent Technologies, Inc.
 
3
'\"
 
4
'\" See the file "license.terms" for information on usage and redistribution
 
5
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 
6
'\"
 
7
.TH find n 3.0 itcl "[incr\ Tcl]"
 
8
.so man.macros
 
9
.BS
 
10
'\" Note:  do not modify the .SH NAME line immediately below!
 
11
.SH NAME
 
12
itcl::find \- search for classes and objects
 
13
.SH SYNOPSIS
 
14
\fBitcl::find \fIoption\fR ?\fIarg arg ...\fR?
 
15
.BE
 
16
 
 
17
.SH DESCRIPTION
 
18
.PP
 
19
The \fBfind\fR command is used to find classes and objects
 
20
that are available in the current interpreter.  Classes and objects
 
21
are reported first in the active namespace, then in all other
 
22
namespaces in the interpreter.
 
23
.PP
 
24
The \fIoption\fR argument determines what action is carried out
 
25
by the command.  The legal \fIoptions\fR (which may be abbreviated)
 
26
are:
 
27
.TP
 
28
\fBfind classes ?\fIpattern\fR?
 
29
.
 
30
Returns a list of [incr Tcl] classes.  Classes in the current
 
31
namespace are listed first, followed by classes in all other
 
32
namespaces in the interpreter.  If the optional \fIpattern\fR
 
33
is specified, then the reported names are compared using the rules
 
34
of the "\fBstring match\fR" command, and only matching names are
 
35
reported.
 
36
.RS
 
37
.PP
 
38
If a class resides in the current namespace context, this command
 
39
reports its simple name--without any qualifiers.  However, if the
 
40
\fIpattern\fR contains \fB::\fR qualifiers, or if the class resides
 
41
in another context, this command reports its fully-qualified name.
 
42
Therefore, you can use the following command to obtain a list where
 
43
all names are fully-qualified:
 
44
.PP
 
45
.CS
 
46
itcl::find classes ::*
 
47
.CE
 
48
.RE
 
49
.TP
 
50
\fBfind objects ?\fIpattern\fR? ?\fB-class \fIclassName\fR? ?\fB-isa \fIclassName\fR?
 
51
.
 
52
Returns a list of [incr Tcl] objects.  Objects in the current
 
53
namespace are listed first, followed by objects in all other
 
54
namespaces in the interpreter.  If the optional \fIpattern\fR is
 
55
specified, then the reported names are compared using the rules
 
56
of the "\fBstring match\fR" command, and only matching names are
 
57
reported.
 
58
If the optional "\fB-class\fR" parameter is specified, this list is
 
59
restricted to objects whose most-specific class is \fIclassName\fR.
 
60
If the optional "\fB-isa\fR" parameter is specified, this list is
 
61
further restricted to objects having the given \fIclassName\fR
 
62
anywhere in their heritage.
 
63
.RS
 
64
.PP
 
65
If an object resides in the current namespace context, this command
 
66
reports its simple name--without any qualifiers.  However, if the
 
67
\fIpattern\fR contains \fB::\fR qualifiers, or if the object resides
 
68
in another context, this command reports its fully-qualified name.
 
69
Therefore, you can use the following command to obtain a list where
 
70
all names are fully-qualified:
 
71
.PP
 
72
.CS
 
73
itcl::find objects ::*
 
74
.CE
 
75
.RE
 
76
.SH KEYWORDS
 
77
class, object, search, import