nsf

Clone
Stefan Sobernig <stefan.sobernig@wu.ac.at>
committed
4bfe0ad
on 05 Oct 16
Object.man: Include missing doc in 'info lookup parameters' and 'info lookup syntax'
2-1-0-rc + 40 more
doc/Object.3 (+15 -2)
927 927 expressions, if any, are also reported for each filter as a three-element list: \fImethodHandle\fR -guard \fIguardExpr\fR\&. The returned filters can be limited to
928 928 those whose names match \fInamePattern\fR (see \fBstring match\fR)\&.
929 929 .TP
930 930 \fIobj\fR \fBinfo lookup method\fR \fIname\fR
931 931 Returns the method handle for a method \fIname\fR if a
932 932 so-named method can be invoked on \fIobj\fR\&. If there is no method
933 933 \fIname\fR, an empty string is returned\&.
934 934 .TP
935 935 \fIobj\fR \fBinfo lookup methods\fR ?\fInamePattern\fR?
936 936 Returns the names of all methods (including aliases and forwarders)
937 937 which can be invoked on \fIobj\fR\&. The returned methods can be limited
938 938 to those whose names match \fInamePattern\fR (see \fBstring match\fR)\&.
939 939 .TP
940 940 \fIobj\fR \fBinfo lookup mixins\fR ?\fB-guards\fR? ?\fInamePattern\fR?
941 941 Returns the object names of all mixin classes which are
942 942 currently active on \fIobj\fR\&. By turning on the switch \fB-guards\fR, the corresponding guard expressions, if any, are also reported as a
943 943 three-element list for each mixin class: \fIclassName\fR
944 944 -guard \fIguardExpr\fR\&. The returned mixin classes can be
945 945 limited to those whose names match \fInamePattern\fR (see \fBstring match\fR)\&.
946 946 .TP
  947 \fIobj\fR \fBinfo lookup parameters\fR \fImethodName\fR ?\fInamePattern\fR?
  948 Returns the parameter specification of the method \fImethodName\fR callable
  949 on \fIobj\fR as a list of parameter names and type specifications\&. The
  950 resulting parameter specification can be limited to those
  951 parameters whose names match \fInamePattern\fR (see \fBstring match\fR)\&.
  952 .TP
947 953 \fIobj\fR \fBinfo lookup slots\fR ?\fB-type\fR \fIclassName\fR? ?\fB-source\fR all | application | system? ?\fInamePattern\fR?
948 954 Returns the command names of all slot objects responsible for
949 955 managing properties, variables, and relations of \fIobj\fR\&. The
950 956 returned slot objects can be limited according to any or a
951 957 combination of the following criteria: First, slot objects
952   can be filtered based on their command names matching \fInamePattern\fR (see \fBstring
953   match\fR)\&. Second, \fB-type\fR allows one to select
  958 can be filtered based on their command names matching \fInamePattern\fR (see
  959 \fBstring match\fR)\&. Second, \fB-type\fR allows one to select
954 960 slot objects which are instantiated from a subclass \fIclassName\fR of \fBnx::Slot\fR (default: \fBnx::Slot\fR) \&. Third, \fB-source\fR restricts slot objects returned according to their provenance in either the NX \fIsystem\fR classes or the \fIapplication\fR classes present in the linearisation list of \fIobj\fR (default: \fIall\fR)\&.
955 961 .sp
956 962 To extract details of each slot object, use the \fBinfo\fR
957 963 submethods available for each slot object\&.
958 964 .TP
  965 \fIobj\fR \fBinfo lookup syntax\fR \fImethodName\fR ?\fInamePattern\fR?
  966 Returns the method parameters of the method \fImethodName\fR callable
  967 on \fIobj\fR as a concrete-syntax description to be used in
  968 human-understandable messages (e\&.g\&., errors or warnings, documentation
  969 strings)\&. The result can be limited to those parameters matching the
  970 \fInamePattern\fR (see \fBstring match\fR)\&.
  971 .TP
959 972 \fIobj\fR \fBinfo lookup variables\fR
960 973 Returns the command names of all slot objects responsible for
961 974 managing properties and variables of \fIobj\fR, if provided by \fIobj\fR or the classes in the linearisation list of \fIobj\fR\&.
962 975 .sp
963 976 This is equivalent to calling: \fIobj\fR \fBinfo lookup slots\fR -type ::nx::VariableSlot -source all ?\fInamePattern\fR?\&.
964 977 .sp
965 978 To extract details of each slot object, use the \fBinfo\fR
966 979 submethods available for each slot object\&.
967 980 .RE
968 981 .TP
969 982 \fIobj\fR \fBinfo name\fR
970 983 Returns the unqualified name of an object, i\&.e\&., the object name
971 984 without any namespace qualifiers\&.
972 985 .TP
973 986 \fIobj\fR \fBinfo info\fR ?\fB-asList\fR?
974 987 Returns the available submethods of the \fBinfo\fR method ensemble for
975 988 \fIobj\fR, either as a pretty-printed string or as a
976 989 Tcl list (if the switch \fB-asList\fR is set) for further
977 990 processing\&.
978 991 .TP