Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

YadaConfigDocument Class Reference
[YadaConfiguration - managing configurations]

Inheritance diagram for YadaConfigDocument:

Inheritance graph
[legend]
Collaboration diagram for YadaConfigDocument:

Collaboration graph
[legend]
List of all members.

Detailed Description

YadaConfigDocument - abstract base class for all configure documents.

Author:
Michael Daum
Id
YadaConfigDocument.tcl,v 1.10 2004/02/26 14:23:36 ddreyer Exp

Definition at line 19 of file YadaConfigDocument.tcl.

Public Member Functions

 activationHandle ()
virtual deActivationHandle ()
 displayTitle ()
 fromDOM (domNode node)
 getAllItemNames (TclList args)
 getAllItems (TclList args)
 getCurrentItem ()
 getItem (TclString name)
 getItemNo (TclString name)
 getPersistanceFileName ()
 hasSavedState ()
 init ()
 isModified ()
 lastChanged ()
 load ()
 resetModified ()
 save ()
 setCurrentItem (YadaConfigItem item)
 setItem (YadaConfigItem item)
 setModified ()
 setToggle (TclString name, TclRef value="")
 toDOM ()
 unsetItem (YadaConfigItem item)
 YadaConfigDocument (TclList args)
 ~YadaConfigDocument ()

Public Attributes

TclString hasView = "true"
TclString name = ""

Protected Member Functions

 _askChange ()
 _commit ()
 _defaults (TclString fileName="")
virtual _delete ()=0
 _getMarked ()
 _mark (TclString aspect, TclString newData="undef", TclString oldData="undef")
virtual _new ()=0
 _select (TclString itemName="")
 _unmark (TclString aspect="")
 _validateCommand (TclString aspect, TclString newValue, TclString oldValue="")
 isValidPersistanceFile (TclString fileName)
 updateModificationTime ()

Protected Attributes

TclString _allAspects = ""
TclNumber _isInitialized = 0
TclNumber _lastModificationTime = 0
TclNumber _modified = 0
TclString _oldItem = "<none>"

Private Member Functions

 _next ()
 _prev ()
 _selectCommand ()
 _setCounter ()
 _undo ()

Private Attributes

TclArray _allItems
TclString _counter = "0/0"
TclString _currentItem = ""
TclNumber _currentItemNo = 0


Constructor & Destructor Documentation

YadaConfigDocument::YadaConfigDocument TclList  args  ) 
 

constructor

create submenu entry "New"

add file menu entries Definition at line 78 of file YadaConfigDocument.tcl.

YadaConfigDocument::~YadaConfigDocument  ) 
 

destructor

Definition at line 299 of file YadaConfigDocument.tcl.


Member Function Documentation

YadaConfigDocument::_askChange  )  [protected]
 

_askChange

Definition at line 342 of file YadaConfigDocument.tcl.

Referenced by _selectCommand().

YadaConfigDocument::_commit  )  [protected]
 

_commit

Reimplemented in YadaMethods, YadaExperiments, YadaGrammars, and YadaMachines.

Definition at line 627 of file YadaConfigDocument.tcl.

YadaConfigDocument::_getMarked  )  [protected]
 

_getMarked

Definition at line 427 of file YadaConfigDocument.tcl.

YadaConfigDocument::_mark TclString  aspect,
TclString  newData = "undef",
TclString  oldData = "undef"
[protected]
 

_mark

Definition at line 402 of file YadaConfigDocument.tcl.

YadaConfigDocument::_next  )  [private]
 

_next

Definition at line 472 of file YadaConfigDocument.tcl.

YadaConfigDocument::_prev  )  [private]
 

_prev

Definition at line 485 of file YadaConfigDocument.tcl.

YadaConfigDocument::_selectCommand  )  [private]
 

_selectCommand

Definition at line 334 of file YadaConfigDocument.tcl.

References _askChange().

YadaConfigDocument::_setCounter  )  [private]
 

update the counter label. This method sets the _counter to reflect the number of items in this document. Definition at line 507 of file YadaConfigDocument.tcl.

Referenced by getCurrentItem().

YadaConfigDocument::_undo  )  [private]
 

_undo

Definition at line 441 of file YadaConfigDocument.tcl.

YadaConfigDocument::_unmark TclString  aspect = ""  )  [protected]
 

_unmark

Definition at line 389 of file YadaConfigDocument.tcl.

YadaConfigDocument::_validateCommand TclString  aspect,
TclString  newValue,
TclString  oldValue = ""
[protected]
 

_validateCommand

Definition at line 450 of file YadaConfigDocument.tcl.

YadaConfigDocument::activationHandle  )  [virtual]
 

activationHandle

activate custom file menu

Reimplemented from YadaPlainDocument.

Reimplemented in YadaMethods, and YadaExperiments.

Definition at line 372 of file YadaConfigDocument.tcl.

YadaPlainDocument::deActivationHandle  )  [virtual, inherited]
 

deActivationHandle

Reimplemented in YadaConfig.

Definition at line 91 of file YadaPlainDocument.tcl.

References YadaPlainDocument::init().

Referenced by YadaPlainDocument::activationHandle().

YadaConfigDocument::displayTitle  ) 
 

Update toolbar, menubar and titlebar.

Reimplemented from YadaPlainDocument.

Definition at line 668 of file YadaConfigDocument.tcl.

YadaConfigDocument::getAllItemNames TclList  args  ) 
 

getAllItemNames

Returns:
a list of all known names of YadaConfigItems in this document
Definition at line 605 of file YadaConfigDocument.tcl.

YadaConfigDocument::getAllItems TclList  args  ) 
 

getAllItems

Returns:
a list of all known YadaConfigItems in this document
Definition at line 591 of file YadaConfigDocument.tcl.

YadaConfigDocument::getCurrentItem  ) 
 

getCurrentItem

Returns:
the currently displayed YadaConfigItem
Definition at line 499 of file YadaConfigDocument.tcl.

References _setCounter().

YadaConfigDocument::getItem TclString  name  ) 
 

getItem

Definition at line 579 of file YadaConfigDocument.tcl.

Referenced by getItemNo().

YadaConfigDocument::getItemNo TclString  name  ) 
 

getItemNo

Definition at line 571 of file YadaConfigDocument.tcl.

References getItem().

YadaPlainDocument::hasSavedState  )  [inherited]
 

Predicate returning 1, if file containing persistant state of YadaGrammar exists, otherwise 0 Definition at line 192 of file YadaPlainDocument.tcl.

Referenced by YadaPlainDocument::resetModified().

YadaConfigDocument::init  )  [virtual]
 

init

Reimplemented from YadaPlainDocument.

Reimplemented in YadaMethods, YadaExperiments, YadaGrammars, and YadaMachines.

Definition at line 308 of file YadaConfigDocument.tcl.

YadaPlainDocument::isModified  )  [inherited]
 

Predicate returning 1, if configuration data has changed, 0 otherwise.

Definition at line 168 of file YadaPlainDocument.tcl.

References YadaPlainDocument::setModified().

YadaPlainDocument::lastChanged  )  [inherited]
 

Returns time of last update to document XML file or an empty string, if there is no such file Definition at line 219 of file YadaPlainDocument.tcl.

YadaPlainDocument::load  )  [inherited]
 

Loads current document from file (file name depends on document name).

reset in case there is some value left from last load operation;

Modified state may be changed by overridden fromDOM methods

Reimplemented in YadaConfig, YadaExperiments, YadaGrammars, YadaMachines, and YadaRunner.

Definition at line 113 of file YadaPlainDocument.tcl.

Referenced by YadaPlainDocument::setToggle().

YadaPlainDocument::resetModified  )  [inherited]
 

Removes modification mark.

Definition at line 183 of file YadaPlainDocument.tcl.

References YadaPlainDocument::hasSavedState().

Referenced by YadaPlainDocument::setModified().

YadaPlainDocument::save  )  [inherited]
 

Saves current document to file (file name depends on document name).

Reimplemented in YadaConfig, YadaExperiments, YadaGrammars, YadaMachines, and YadaRunnableDocument.

Definition at line 140 of file YadaPlainDocument.tcl.

YadaConfigDocument::setCurrentItem YadaConfigItem  item  ) 
 

setCurrentItem

Definition at line 519 of file YadaConfigDocument.tcl.

YadaConfigDocument::setItem YadaConfigItem  item  ) 
 

setItem

Definition at line 558 of file YadaConfigDocument.tcl.

YadaPlainDocument::setModified  )  [inherited]
 

Marks item as modified.

Definition at line 175 of file YadaPlainDocument.tcl.

References YadaPlainDocument::resetModified().

Referenced by YadaPlainDocument::isModified().

YadaPlainDocument::setToggle TclString  name,
TclRef  value = ""
[inherited]
 

setToggle

Reimplemented in YadaDocument, and YadaRunnableDocument.

Definition at line 106 of file YadaPlainDocument.tcl.

References YadaPlainDocument::load().

YadaConfigDocument::unsetItem YadaConfigItem  item  ) 
 

unsetItem

Definition at line 540 of file YadaConfigDocument.tcl.

YadaPlainDocument::updateModificationTime  )  [protected, inherited]
 

Synchronizes internal modification attribute with modification time of document's XML file Definition at line 234 of file YadaPlainDocument.tcl.


Member Data Documentation

TclNumber YadaPlainDocument::_isInitialized = 0 [protected, inherited]
 

flag indicating initialization. Possible falues are 0 and 1. init() sets this to 1 when it is called in the init chain calls of inheriting classes, i.e. YadaConfigDocument::init() or YadaRunnableDocument::init(). Definition at line 36 of file YadaPlainDocument.tcl.

TclNumber YadaPlainDocument::_lastModificationTime = 0 [protected, inherited]
 

Denotes time of most recent modification of document's XML file CAUSED by this object. This allows recognizing cases where a second object modifies the same file concurrently, in which case the need may arise to synchronize the object with the new file contents. Definition at line 44 of file YadaPlainDocument.tcl.

TclString YadaPlainDocument::hasView = "true" [inherited]
 

flag indicating whether this object functions as combined model-view object (value "true"), or as a pure model object (value "false": has to be set explicitly when instantiating object) Definition at line 29 of file YadaPlainDocument.tcl.

TclString YadaPlainDocument::name = "" [inherited]
 

name of the document

Definition at line 25 of file YadaPlainDocument.tcl.


The documentation for this class was generated from the following file:
YADA 2.0-alpha (20 Oct 2004)