Index: doc/Class.man =================================================================== diff -u -r737566422019b19eddca6e2ab1758019cad02633 -r9594437d3e0d984015f4b0e82f9d96f5ad4266cf --- doc/Class.man (.../Class.man) (revision 737566422019b19eddca6e2ab1758019cad02633) +++ doc/Class.man (.../Class.man) (revision 9594437d3e0d984015f4b0e82f9d96f5ad4266cf) @@ -1,6 +1,9 @@ [comment {-*- tcl -*- nx::Class manpage}] [manpage_begin nx::Class n 2.0b6] +[comment {For the time being, we do not render keywords and the corresponding reverse index}] +[proc keywords args {}] + [keywords base-metaclass] [keywords NX] [keywords "mixin class"] @@ -53,7 +56,7 @@ | |subclass.....(xor)......subclass| | |of +-----------+ of| | |.........| |..........| - | (metaclass) | cls | (application class) + | (metaclass) | /cls/ | (application class) |.............| | instance of +-----------+ }] Index: doc/Object.man =================================================================== diff -u -r737566422019b19eddca6e2ab1758019cad02633 -r9594437d3e0d984015f4b0e82f9d96f5ad4266cf --- doc/Object.man (.../Object.man) (revision 737566422019b19eddca6e2ab1758019cad02633) +++ doc/Object.man (.../Object.man) (revision 9594437d3e0d984015f4b0e82f9d96f5ad4266cf) @@ -57,7 +57,7 @@ [term NX] allows for creating and for using objects (e.g. [emph obj]) which are instantiated from the [term "base class"] [cmd nx::Object] -directly. Typical use cases are singeltons and anonymous, inline +directly. Typical use cases are singletons and anonymous, inline objects. In such use cases, [term NX] does not require creating an intermediate application class (e.g. [emph cls]), which specializes the [term "base class"] [cmd nx::Object] by default, beforehand. @@ -80,7 +80,7 @@ To create a direct instance of [cmd nx::Object] having an explicit name [arg obj], use [method create] on [cmd nx::Object]. Note that [method create] is defined by [cmd nx::Class] and is available to [cmd nx::Object] being -an instance of [cmd nx::Class]. This way, singelton objects can be +an instance of [cmd nx::Class]. This way, singleton objects can be created, for example. [call [cmd nx::Object] [method new] [opt "[option -object-mixins] [arg mixinSpec]"] [opt "[option -class] [arg newClassName]"] [opt "[option -object-filters] [arg filterSpec]"] [opt [arg initBlock]]] @@ -99,25 +99,26 @@ [section {Configuration Options for Instances of nx::Object}] -[para] Configuration options can be used for configuring objects during -their creation by passing the options as non-positional arguments into calls -of [method new] and [method create] (see [cmd nx::Class]). An +[para] Configuration options can be used for configuring objects +during their creation by passing the options as non-positional +arguments into calls of [method new] and [method create] (see [cmd nx::Class]). An existing object can be queried for its current configuration using -[method cget] and it can be re-configured using [method configure]. +[method cget] and it can be re-configured using [method configure]. Legal +configuration options are: [list_begin options] -[opt_def -class [arg className]] +[opt_def -class [opt [arg className]]] Retrieves the current class of the object or sets the object's class to [arg className], if provided. -[opt_def -object-filters [arg filterMethods]] +[opt_def -object-filters [opt [arg filterMethods]]] Retrieves the list of currently active per-object filter methods or sets a list of per-object filter methods, if [arg filterMethods] is provided. -[opt_def -object-mixins [arg mixinSpecs]] +[opt_def -object-mixins [opt [arg mixinSpecs]]] If [arg mixinSpecs] is not specified, retrieves the list of currently active per-object mixin specifications. If [arg mixinSpecs] is @@ -199,7 +200,7 @@ [call [arg obj] [cmd contains] [opt "-withnew [arg trueFalse]"] [opt "-object [arg objectName]"] [opt "-class [arg className]"] [arg cmds]] -This methods acts as a builder for nested object structures. Object +This method acts as a builder for nested object structures. Object and class construction statements passed to this method as its last argument [arg cmds] are evaluated in a way so that the receiver object [arg obj] becomes the parent of the newly constructed objects and @@ -310,7 +311,7 @@ By providing a custom implementation of [method destroy], the destruction procedure of [arg obj] can be customized. Typically, once -the application-specific destruction logic as has completed, a custom +the application-specific destruction logic has completed, a custom [method destroy] will trigger the actual, physical object destruction via [cmd next]. @@ -483,7 +484,7 @@ currently registered. If there is no filter [arg name] registered, an empty string is returned. -[def "[arg obj] [method "info lookup filters"] [option -guards] [opt [arg namePattern]]"] +[def "[arg obj] [method "info lookup filters"] [opt [option -guards]] [opt [arg namePattern]]"] Returns the [term "method handle"]s of all filters which are active on [arg obj]. By turning on the [term switch] [option -guards], the corresponding guard @@ -502,7 +503,7 @@ which can be invoked on [arg obj]. The returned methods can be limited to those whose names match [arg namePattern] (see [cmd "string match"]). -[def "[arg obj] [method "info lookup mixins"] [option -guards] [opt [arg namePattern]]"] +[def "[arg obj] [method "info lookup mixins"] [opt [option -guards]] [opt [arg namePattern]]"] Returns the object names of all [term "mixin class"]es which are currently active on [arg obj]. By turning on the [term switch] [option -guards], the corresponding guard expressions, if any, are also reported as a Index: doc/alias.man.inc =================================================================== diff -u -re5ad7edaed3418723ed31bda80c8639df6b44a7e -r9594437d3e0d984015f4b0e82f9d96f5ad4266cf --- doc/alias.man.inc (.../alias.man.inc) (revision e5ad7edaed3418723ed31bda80c8639df6b44a7e) +++ doc/alias.man.inc (.../alias.man.inc) (revision 9594437d3e0d984015f4b0e82f9d96f5ad4266cf) @@ -21,7 +21,7 @@ [para] When creating an [term "alias method"] for a [emph C-implemented] Tcl command (i.e., command defined using the -Tcl/NX C-API), [opt [option -frame]] sets the scope +Tcl/NX C-API), [option -frame] sets the scope for variable references used in the aliased command. If the provided value is [const object], then variable references will be resolved in the context of the called object, i.e., the object upon which the [term "alias method"] is Index: doc/filter.man.inc =================================================================== diff -u -r54cdf1847245e3d6245a740808d1d6923fb78997 -r9594437d3e0d984015f4b0e82f9d96f5ad4266cf --- doc/filter.man.inc (.../filter.man.inc) (revision 54cdf1847245e3d6245a740808d1d6923fb78997) +++ doc/filter.man.inc (.../filter.man.inc) (revision 9594437d3e0d984015f4b0e82f9d96f5ad4266cf) @@ -19,21 +19,15 @@ is equivalent to passing an empty list for [arg filterSpecList] to [const [vset SCOPE]] [method {filter set}]. -[def "[arg [vset CMD]] [const [vset MODIFIER]] [method {filters delete}] [option -nocomplain] [arg specPattern]"] +[def "[arg [vset CMD]] [const [vset MODIFIER]] [method {filters delete}] [opt [option -nocomplain]] [arg specPattern]"] Removes a single [term "filter"] from the current list of [term "filter"]s of [arg [vset CMD]] whose spec matches [arg specPattern]. [arg specPattern] can contain special matching chars (see [cmd "string match"]). [const [vset SCOPE]] [method "filters delete"] will throw an error if there is no matching [term "filter"], unless [option -nocomplain] is set. -[para] - -If [arg expr] is omitted, returns the guard expression set on the -[term "filter"] [arg methodName] defined for [arg [vset CMD]]. If none -is available, an empty string will be returned. - [def "[arg [vset CMD]] [const [vset MODIFIER]] [method {filters get}]"] -Returns the list of current [term "filter specification"]s registered for [vset CMD]. +Returns the list of current [term "filter specification"]s registered for [arg [vset CMD]]. [def "[arg [vset CMD]] [const [vset MODIFIER]] [method {filters guard}] [arg methodName] [opt [arg expr]]"] @@ -42,6 +36,12 @@ [cmd expr]). An empty string for [arg expr] will clear the currently registered guard expression for filter [arg methodName]. +[para] + +If [arg expr] is omitted, returns the guard expression set on the +[term "filter"] [arg methodName] defined for [arg [vset CMD]]. If none +is available, an empty string will be returned. + [def "[arg [vset CMD]] [const [vset MODIFIER]] [method "filters methods"] [opt [arg pattern]]"] If [arg pattern] is omitted, returns all filter names which are Index: doc/info.man.inc =================================================================== diff -u -rb6d37659171e23799adb1f007ae7993e6fcee429 -r9594437d3e0d984015f4b0e82f9d96f5ad4266cf --- doc/info.man.inc (.../info.man.inc) (revision b6d37659171e23799adb1f007ae7993e6fcee429) +++ doc/info.man.inc (.../info.man.inc) (revision 9594437d3e0d984015f4b0e82f9d96f5ad4266cf) @@ -109,15 +109,15 @@ match [arg patterns] (see [cmd "string match"]). -[call [arg [vset CMD]] [method "info [vset MODIFIER] slots"] [opt "[option -type] [arg className]"] [arg pattern]] +[call [arg [vset CMD]] [method "info [vset MODIFIER] slots"] [opt "[option -type] [arg className]"] [opt [arg pattern]]] If [arg pattern] is not specified, returns the object names of all [term "slot object"]s defined by [arg [vset CMD]]. The returned [term "slot object"]s can be limited according to any or a combination of the following criteria: First, [term "slot object"]s can be filtered based on their command names matching [arg namePattern] (see [cmd "string match"]). Second, [option "-type"] allows to select [term "slot object"]s which are instantiated from a subclass [arg className] of [cmd nx::Slot] (default: [cmd nx::Slot]). -[call [arg [vset CMD]] [method "info [vset MODIFIER] variables"] [arg pattern]] +[call [arg [vset CMD]] [method "info [vset MODIFIER] variables"] [opt [arg pattern]]] If [arg pattern] is omitted, returns the object names of all [term "slot object"]s provided by [arg [vset CMD]] which are responsible for managing properties and variables of [arg [vset CMD]]. Otherwise,