clay-yggdrasil(n) 0.1 clay-yggdrasil "Yggdrasil Object Template"

Name

clay-yggdrasil - A design pattern for modular objects

Table Of Contents

Synopsis

Description

Classes

Class clay::yggdrasil

Variable

variable css

Methods

method child method ?args?

A public method to expose the private Child_ methods

method Child_add object
method Child_clear_all

Destroy all children

method Child_count

Return a count of the number of child objects

method Child_config

Parameters to confer to newly formed children. Should be in the form of a key/value list

method Child_delegate

Delegates to confer to children. Should be in the form of STUB object

method Child_remove ?args?

Remove a child object from indexing

method Child_index childidx ?args?

Return the child at index specified. If multiple argments are specified the call is projected to calls to the children returned by the higher argument. In the example FOO looks up its 0th child, and asks it for its 1st child, who then asks its 1st child for its own 2nd child, and the result of that us returned.

Example:

  FOO child_index 0 1 2
method Child_last

Return the last child in the internal list of children

method Child_list

Return the internal list of children

method css method ?args?

Ensemble to access the Css private methods

method CSS_class ?args?

Set the CSS class of the node

method CSS_dump

Dump the contents of the css settings for this node

method CSS_exists field

Dump the contents of the css settings for this node

method CSS_get field

Retrieve a single value from the CSS configuration of this node

method CSS_set ?args?

Set a single value in the CSS configuration of this node

method eval ?args?

Evaluate a tcl expression in within the namespace of an object

method link method ?args?

A public method to access the Link private methods

method Link_add linktype object

Add a link to an object. Links are indexed by type, and objects can have multiple relationships across multiple types. But object can have only one relationship to another object across on type.

method Link_dump

Return the contents of the internal link array

method Link_list ?linktype *?

Returns a list of links of the given type. If no list given, the result is the same as Link_dump

method Link_types

Return a list of what types of links this object possesses

method Link_object ?args?
method Link_remove object ?linktype *?

Remove a link to an object. If linktype is not specified, or is *, all links are severed.

method linktype

Assumed link types this object would share with any object who invokes Link_object

method source ?args?

Evaluate a script in a text file in the namespace of the object

method uuid

Return the global ID of the object

Keywords

TclOO, clay, oo

Category

Programming tools