File 'lib/distInterface.cls' (part of 'AutoDOC')

Home | Packages | Files | Procedures | Classes | Namespaces | Keywords | External packages

Description (short)
Internal interface to distribution
Written by
Andreas Kupries
Description
Internal interface to the global distribution object
Keywords
distribution interface, internal interface to distribution

Class 'distInterface'

Description
All classes wishing to use the global distribution object have to derive from this class to get the necessary functionality for accessing it.
Options
dist
Methods
public
Dist (args)
TrackDist (o oldValue)
distInterface ()
Membervariables
public
dist

Options

-dist
Reference to the global distribution object managing the documentation tree. Automatically transfered into an internal variable for hopefully faster access (one hash lookup, not two).

Methods

Dist (args)
Method for accessing the functionality of the distribution object. Added because I like '$dist do_something ...' better than '$dist do_something ...' or '$opt(-dist) do_something'.
Argument: args The arguments given to the distribution object

TrackDist (o oldValue)
Internal method. Called by the generic option tracking mechanism for any change made to dist. Propagates the new value to the internal shadow.
Argument: o The name of the changed option, here always -dist.
Argument: oldValue The value of the option before the change. Ignored here.

distInterface ()
Constructor, initializes the option and its shadow.

Membervariables

dist
Internal shadow of option dist.

Home | Packages | Files | Procedures | Classes | Namespaces | Keywords | External packages

Generated by AutoDoc 2.4 at 09/28/2001, invoked by Andreas Kupries,,,