menu-form-control

String or nil. Maps to HTML form control attribute of the same name. Default is nil.

String or nil. Maps to HTML form control attribute of the same name. Default is nil.

GDL Instance. In an element of a sequence, this is the container object which holds all elements.

Boolean. If set to non-nil, this field's value will be sent to server upon change. Default is nil.

Boolean. If set to non-nil, this field's value will be sent to server upon enter. Default is nil.

String or nil. Maps to HTML form control attribute of the same name. Default is nil.

List of Symbols. Lists all the superclasses of the type of this object.

Boolean. If non-nil, then values which fail the type test will still be allowed to be the value. Default is nil.

Boolean. If non-nil, then values which fail the type or validation test will still be allowed to be the value. Default is t.

Boolean. Regardless of :domain, if this is non-nil, nil values will be accepted. Defaults to t if (the default) is nil, otherwise defaults to nil.

String or nil. Maps to HTML form control attribute of the same name. Default is nil.

Boolean. Determines whether a default error string is appended to string ouput-function for html-format (and therefore html-string computed-slot as well). Defaults to t.

String. Hint to browser regarding autocomplete. Default is nil.

GDL Object. Object to have its settable computed-slots and/or query-plist set from the fields on the form upon submission. Defaults to self.

List of GDL Instances. All objects from the :objects specification, including elements of sequences as flat lists.

List of GDL Instances. All objects from the :objects specification, including elements of sequences as flat lists.

List. Display values, also used as return values, for selection list. Specify this or choice-plist, not both.

Plist. Keywords and display values for the selection list. Specify this or choice-list, not both.

Plist. Keywords and CSS style for display of each choice. The keys should correspond to the keys in choice-plist, or the items in choice-list if no choice-plist is given.

String. You can use this to specify a user-defined class for the form-control. Defaults to nil, which means no class attribute will be generated.

Lisp value of a type compatible with (the domain). This is the initial default value for the control. This must be specified by user code, or an error will result.

List of Symbols. Lists the direct superclasses of the type of this object.

List of keyword symbols. Each of these should match a key in the choice-plist, and where there is a match, that key will be disabled in the rendering.

Boolean. Maps to HTML form control attribute of the same name. Default is nil.

Plist. Returns the :documentation plist which has been specified the specific part type of this instance.

String. This is the auto-computed dom-id which should be used for rendering this section. If you use the main-div HTML string for rendering this object as a page section, then you do not have to generate the :div tag yourself - the main-div will be a string of HTML which is wrapped in the correct :div tag already.

Keyword symbol, one of :number, :keyword, :list-of-strings, :list-of-anything, or :string. This specifies the expected and acceptable type for the submitted form value. If possible, the submitted value will be coerced into the specified type. The default is based upon the Lisp type of (the default) provided as input to this object. If the default is nil, the domain will default to :string

String or error object. This will be set to a validation error if any, and cleared when the error is gone.

List of GDL objects. All the form-controls which do not pass validation.

Lisp value. The value which was attempted to be set but failed validation.

Keyword symbol. The name of this field. Computed from the object name within the tree.

Boolean. For elements of sequences, T iff there is no previous element.

GDL Instance. Using this instance as the root, follow the reference chain represented by the given path. :arguments (path "List of Symbols or Pairs of Symbol and Integer")

List of GDL objects of type form-control. The validation-function will be forced on these objects when a form is submitted, even if the object's html form-control does not happen to be included in the values submitted with the form. Defaults to nil.

String of valid HTML. This is the default HTML which can be included in a form in a web page to display this form control. Previously known as form-control-string. Default is the form-control-string.

String of valid HTML. Also known as simply form-control. This is the default HTML which can be included in a form in a web page to display this form control. Default is the output from form-control method of the lens for html-format and the specific type of this object, returned as a string.

List of GDL objects. All the children or hidden-children of type base-form-control.

String of HTML. The value of the computed-slot named by KEY (a keyword) wrapped in a div carrying the fragment's auto dom-id, so a gdlAjax call can replace its innerHTML without the content living in a base-html-div child section. List KEY in html-fragments to participate in ajax responses. [gornskew 2026-07-20]

String.

This function returns a string of Javascript, appropriate to use for events such as :onclick, :onchange, etc, which will invoke an Ajax request to the server, which will respond by replacing the innerHTML of affected :div's, and running the Javascript interpreter to evaluate (the js-to-eval), if any.

:examples "

 FLAG -- Fill in!!!

"

:&key ((bashee (the bashee)) "GDL Object. This object will have the function-key called on it, if any." (respondent (the respondent)) "GDL Object. This must be the object which represents the actual web page being used." (function-key nil) "Keyword symbol. This keyword symbol must name a GDL function or method which is to be invoked with the Ajax call." (arguments nil) "List of values. This is the argument list on which the function named by function-key will be applied." (form-controls nil) "List of GDL objects of type base-form-control. Each of the objects in this list will have its current value (as entered by the user) scraped from the web page and its value in the model "bashed" to reflect what has been entered on the page.")

List of GDL Instances. All objects from the :hidden-objects specification, including elements of sequences as flat lists.

Boolean. Indicates whether the object should effectively be a hidden-object even if specified in :objects. Default is nil.

List of keyword symbols, naming computed-slots of this sheet whose values are HTML strings rendered at toplevel via fragment-div. Usually UNNECESSARY: fragment-div self-registers each key it renders (monotonically, outside the KB), so this list is only for extra keys not (yet) rendered through fragment-div on this sheet. Any listed fragment whose slot-status is :invalidated at gdlAjax response time gets recomputed and its innerHTML replaced in the browser -- no base-html-div child section required. [gornskew 2026-07-20]

List of HTML sections to be scanned and possibly replaced in response to GDL Ajax calls. Override this slot at your own risk. The default is all sections who are most recently laid out on the respondent sheet, and this is set programmatically every time the sheet section's main-div is demanded.

List of valid HTML sections to be scanned and possibly replaced in response to GDL Ajax calls. Override this slot at your own risk. The default is all sections who are most recently laid out on the respondent sheet, and this is set programmatically every time the sheet section's main-div is demanded.

String of valid HTML. This is the default HTML which can be included in a form in a web page to display this form control, wrapped with labels and table cells.

Keyword symbol. The ID attribute for this tag. Defaults to (the field-name).

Integer. Sequential index number for elements of a sequence, NIL for singular objects.

String. This can be used with (str ...) [in cl-who] or (:princ ...) [in htmlGen] to output this section of the page, without the wrapping :div tag [so if you use this, your code would be responsible for wrapping the :div tag with :id (the dom-id).]

Boolean. Maps to HTML form control attribute of the same name. Default is nil.

String of valid Javascript. This Javascript will be send with the Ajax response, and evaluated after the innerHTML for this section has been replaced.

Keyword symbol or nil. Specifies where the label tag goes, if any. Can be :table-td (label goes in a td before the form control), :table-td-append (label goes in a td after the form control), :prepend (label tag wraps around form control and label text comes before form control),
:append (label tag wraps around form control and label text comes after form control), :table-with-class (like :table-td, but adds a class "form-control" to the table), or :as-div (puts label and control inside a div of class "form-control").

Default is :as-div

String or nil. Maps to HTML form control attribute of the same name. Default is nil.

Boolean. For elements of sequences, T iff there is no next element.

Boolean. T if this object has no children, NIL otherwise.

List of GDL Objects. A Collection of the leaf nodes of the given object.

List of GDL Objects. A Collection of the leaf nodes of the given object.

String. This should be used with (str ...) [in cl-who] or (:princ ...) [in htmlGen] to output this section of the page, including the wrapping :div tag.

Number or nil. Maps to HTML form control attribute of the same name. Default is nil.

String. This is synonymous with slot-documentation

List of Keyword Symbols. Returns the messages (slots, objects, and functions) of this object, according to the filtering criteria as specified by the arguments. :&key ((category :all) "Keyword. Either :all or the individual category of messages to be returned. This can be one of:

• :computed-slots

• :settable-computed-slots

• :required-input-slots

• :optional-input-slots

• :defaulted-input-slots

• :query-slots

• :functions

• :objects

• :quantified-objects

• :hidden-objects

• :quantified-hidden-objects

" (message-type :global) "Keyword Symbol, :local or :global. Indicates whether to return messages only from the local specific part type, or from all superclasses (mixins) as well." (return-category? nil) "Boolean. Indicates whether or not the category of each message should be returned before each message in the returned list." (base-part-type nil) "Symbol naming a GDL Part Type. Indicates a "base" part from which no messages should be returned, nor should messages be returned from superclasses (mixins) of this base part. If NIL (the default), messages are considered from all superclasses." (sort-order :unsorted) "Keyword Symbol. One of: :unsorted, :by-category, or :by-name." (filter :normal) "Function Object of two arguments or :normal. If a function object, applies this function to each returned category and message keyword, and filters out all pairs for which the function returns NIL. If :normal (the default), then no filtering is done.")

List of Symbols. Returns the names of the immediate superclasses of this object.

:&key ((local? t) "Boolean. Indicates whether to give only direct mixins or all mixins from the entire inheritance hierarchy.")

Boolean. Are multiple selections allowed? Default is nil.

Keyword symbol. The part's simple name, derived from its object specification in the parent or from the type name if this is the root instance.

GDL Instance. For elements of sequences, returns the next part in the sequence.

Boolean. Regardless of :domain, if this is non-nil, empty strings will convert to nil. Defaults to (the allow-nil?)

String or nil. Maps to HTML form control attribute of the same name. Default is nil.

String or nil. Maps to HTML form control attribute of the same name. Default is nil, unless ajax-submit-on-change? is non-nil, in which case it calls ajax to set current form value.

String or nil. Maps to HTML form control attribute of the same name. Default is nil.

String or nil. Maps to HTML form control attribute of the same name. Default is nil.

String or nil. Maps to HTML form control attribute of the same name. Default is nil, unless ajax-submit-on-enter? is non-nil, in which case it calls ajax to set current form value.

String or nil. Maps to HTML form control attribute of the same name. Default is nil.

String or nil. Maps to HTML form control attribute of the same name. Default is nil.

String or nil. Maps to HTML form control attribute of the same name. Default is nil.

String or nil. Maps to HTML form control attribute of the same name. Default is nil.

String or nil. Maps to HTML form control attribute of the same name. Default is nil.

String or nil. Maps to HTML form control attribute of the same name. Default is nil.

String or nil. Maps to HTML form control attribute of the same name. Default is nil.

String or nil. Maps to HTML form control attribute of the same name. Default is nil.

String or nil. Maps to HTML form control attribute of the same name. Default is nil.

String or nil. Maps to HTML form control attribute of the same name. Default is nil.

List of GDL objects, which should be of type 'base-form-control.

[Note -- this slot is not really necessary for protecting out-of-bounds sequence references anymore, the form-control processor protects against this by itself now].

These objects are validated and bashed first, in the order given. If the cardinality of one form-control depends on another as in the example below, then you should list those dependent objects first. Default is nil.

:examples

 
...
  
  :computed-slots ((number-of-nozzles (the number-of-nozzles-form value))
        (ordered-form-controls 
         (append (list-elements (the inner-flange-form))
             (list (the number-of-nozzles-form)))))
  
  :objects
  ((inner-flange-form
    :type 'menu-form-control 
    :choice-plist (list :hey "hey" :now "now")
    :default :hey
    :sequence (:size (the number-of-nozzles)))

   (number-of-nozzles-form
    :type 'text-form-control 
    :prompt "Number of Shell Nozzles Required: "
    :domain :number     
    :default 0)

GDL Instance. The parent of this object, or NIL if this is the root object.

String. Text to place in the field by default, overwritten as soon as the field is selected. Works only in HTML5. Default is nil.

Boolean. Indicates whether this should be included in possible-nils. Defaults to (the multiple?)

List of keyword symbols. Messages corresponding to form fields which could be missing from form submission (e.g. checkbox fields). Defaults to the names of any children or hidden-children of type menu-form-control or checkbox-form-control.

Boolean. This switch determines whether all form-controls should be preset before the final setting, in order to allow any interdependencies to be detected for validation or detecting changed values. If this is specified as a non-nil value, then any nil values of (the preset?) on individual form controls will be ignored. If this is specified as nil, then (the preset?) of individual form-controls (default of these is also nil) will be respected. Default is nil.

Boolean. This switch determines whether this form-control should be preset before the final setting, in order to allow any interdependencies to be detected for validation or detecting changed values. Default is nil.

GDL Instance. For elements of sequences, returns the previous part in the sequence.

Boolean. Set this to t if the form-control should always occur first in an outputted snapshot file. Defaults to nil.

String. The prompt used in the label.

Boolean. Maps to HTML form control attribute of the same name. Default is nil.

GDL Object. Object to respond to the form submission. Defaults to self.

Void. Restores all settable-slots in this instance to their default values.

Void. Restores the default for the value, the failed-value, and the error.

Multiple Values: Total root-paths affected and total slots affected. Reverts any "remembered" bashed slots, starting from the root, to their default values. Note that any call to set-slot! or set-slots! or any use of web form-controls will result in "remembered values". Note that there is a :remember? keyword argument to set-slot! which defaults to t but if you specify it as nil, you can bash values without having them "remembered" and such slots would not be affected by this function.

NIL. Restores the value of the given slot to its default, thus "undoing" any forcibly set value in the slot. Any dependent slots in the tree will respond accordingly when they are next demanded. Note that the slot must be specified as a keyword symbol (i.e. prepended with a colon (":")), otherwise it will be evaluated as a variable according to normal Lisp functional evaluation rules. :arguments (slot "Keyword Symbol") :key (force? "Boolean. Specify as t if you want to force non-settable slots to recompute (e.g. reading from databases or external files). Defaults to nil.")

nil. Restores the value of the given slots to their defaults, thus "undoing" any forcibly set values in the slots. Any dependent slots in the tree will respond accordingly when they are next demanded. Note that the slots must be specified as keyword symbols (i.e. prepended with colons (":")), otherwise they will be evaluated as variables according to normal Lisp functional evaluation rules.

:arguments (slots "List of Keyword Symbols")

:&key ((force? force-restore-slot-default?) "Boolean. Indicates whether the slot values should be unbound, regardless of whether it had actually been bashed previously.")

Void. Restores all settable-slots in this instance, and recursively in all descendant instances, to their default values.

GDL Instance. The root-level node in this object's "tree" (instance hierarchy).

List of Symbols or of Pairs of Symbol and Integer. Indicates the path through the instance hierarchy from the root to this object. Can be used in conjunction with the follow-root-path GDL function to return the actual instance.

List of Symbols or of Pairs of Symbol and Integer. Indicates the path through the instance hierarchy from the local root to this object. Can be used in conjunction with the follow-root-path GDL function to return the actual instance.

Boolean. T iff this part has NIL as its parent and therefore is the root node.

List of GDL Instances. All objects from the :objects specification, including elements of sequences as flat lists. Any children which throw errors come back as a plist with error information

List of GDL Instances. All objects from the :hidden-objects specification, including elements of sequences as flat lists. Any children which throw errors come back as a plist with error information

NIL. Forcibly sets the value of the given slot to the given value. The slot must be defined as :settable for this to work properly. Any dependent slots in the tree will respond accordingly when they are next demanded. Note that the slot must be specified as a keyword symbol (i.e. prepended with a colon (":")), otherwise it will be evaluated as a variable according to normal Lisp functional evaluation rules.

Note also that this must not be called (either directly or indirectly) from within the body of a Gendl computed-slot. The caching and dependency tracking mechanism in Gendl will not work properly if this is called from the body of a computed-slot, and furthermore a runtime error will be generated.

:arguments (slot "Keyword Symbol" value "Lisp Object. (e.g. Number, String, List, etc.)")

:&key ((remember? t) "Boolean. Determines whether to save in current version-tree." (warn-on-non-toplevel? t) "Boolean. Determines whether to warn if this is called from the body of a cached slot." )

NIL. Forcibly sets the value of the given slots to the given values. The slots must be defined as :settable for this to work properly. Any dependent slots in the tree will respond accordingly when they are next demanded. Note that the slots must be specified as a keyword symbols (i.e. prepended with a colon (":")), otherwise they will be evaluated as variables according to normal Lisp functional evaluation rules. :arguments (slots-and-values "Plist. Contains alternating slots and values to which they are to be set." warn-on-non-toplevel? "Boolean. Indicates whether a warning should be issued for calling from inside the body of a cached slot. Default is t.")

Number. How many choices to display

Plist of Symbols and Strings. Returns the part types and slot documentation which has been specified for the given slot, from most specific to least specific in the CLOS inheritance order. Note that the slot must be specified as a keyword symbol (i.e. prepended with a colon (":")), otherwise it will be evaluated as a variable according to normal Lisp functional evaluation rules. :arguments (slot "Keyword Symbol. Names the slot for which documentation is being requested.")

Body of GDL code, in list form.

:arguments (slot "Keyword Symbol. Names the slot for which documentation is being requested.")

Keyword symbol. Describes the current status of the requested slot:

• :unbound: it has never been demanded.

• :invalidated: it was demanded at some point, but something it depends on has been modified since; it is currently unbound and will be re-evaluated on next demand.

• :evaluated: it has been demanded and it is currently bound to the default value based on the code.

• :set: (for :settable slots only, which includes all required :input-slots) it has been modified and is currently bound to the value to which it was explicitly set.

• :toplevel: (for root-level object only) its value was passed into the root-level object as a toplevel input at the time of object instantiation.

String or nil. Maps to HTML form control attribute of the same name. Default is nil.

String or List of Strings. Determines how the name of objects of this type will be printed in most places. This defaults to the name-for-display (generally the part's name as specified in its parent), followed by an index number if the part is an element of a sequence.

String or nil. Maps to HTML form control attribute of the same name. Default is nil.

Integer or nil. Maps to HTML form control attribute of the same name. Default is nil.

Predicate function of two arguments. Defaults based on type of first in choice-plist: eql for keywords, string-equal for strings, and equalp otherwise.

String or nil. Maps to HTML form control attribute of the same name. Default is nil.

Void. Sets giving slot to its boolean opposite. &args (slot "Keyword symbol. Name of the slot as a keyword symbol.")

Symbol. The GDL Type of this object.

Void. Uncaches all cached data in slots and objects throughout the instance tree from this node, forcing all code to run again the next time values are demanded. This is useful for updating an existing model or part of an existing model after making changes and recompiling/reloading the code of the underlying definitions. Any set (modified) slot values will, however, be preserved by the update.

String or nil. Maps to HTML form control attribute of the same name. Default is nil.

Function of one argument. The argument will be the submitted form value converted to the proper type. The return value from this function can be nil, any non-nil value, or a plist with keys :validated-value and :error. The following behavior applies:

• If the function returns nil, error is set to :unspecified-validation-fail.

• If the function returns a plist with keys :validated-value and :error, and if :error is non-nil, it means the value is not acceptable, the form-controls error message is set to this error (usually a keyword symbol), and the error string will be appended to the html-string by default.

• If the function returns any other value, then the properly typed submitted form value is considered valid and is used.

In the case of an error, the form-control's failed-value message is set to the properly typed submitted form value. If allow-invalid? is non-nil, then the form-control's value message is also set to this value (i.e. the invalid value is still accepted, even though a non-nil error is present).

Default is (list :validated-value value :error nil).

Lisp value. The current value of this form control.

List of GDL Instances. Additional objects to display in Tatu tree. Typically this would be a subset of hidden-children. Defaults to NIL.

Void. Writes a file containing the toplevel inputs and modified settable-slots starting from the root of the current instance. Typically this file can be read back into the system using the read-snapshot function.

:&key ((filename "/tmp/snap.gdl") "String or pathname. The target file to be written." (root-paths-to-ignore nil) "List of root-paths or nil. Any objects with matching root-path will be ignored for the snapshot write." )