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

YadaGenerals Class Reference

Inheritance diagram for YadaGenerals:

Inheritance graph
[legend]
Collaboration diagram for YadaGenerals:

Collaboration graph
[legend]
List of all members.

Detailed Description

YadaGenerals - stuff that didn't fit anywhere else til now. This class just offers a gui for some settings that we'd like to access but no special gui like the YadaExperiments or the YadaGrammars are done yet. That is there is no YadaConfigItems that we deal with here. Therefore The YadaGenerals don't inherit YadaConfigDocument.

Author:
Michael Daum
Id
YadaGenerals.tcl,v 1.14 2004/09/06 13:41:13 micha Exp

Definition at line 23 of file YadaGenerals.tcl.

Public Member Functions

 activationHandle ()
virtual deActivationHandle ()
 displayTitle ()
 fromDOM (domNode rootNode)
virtual getPersistanceFileName ()
 hasSavedState ()
 init ()
 isModified ()
 lastChanged ()
 load ()
 resetModified ()
 save ()
 setModified ()
 setToggle (TclString name, TclRef value="")
 toDOM ()
 YadaGenerals (TclList args)

Public Attributes

TclString editor = ""
TclString hasView = "true"
TclString name = ""
TclNumber significance = 1.1
TclNumber timeTolerance = 500
TclNumber weirdness = 1

Protected Member Functions

 updateModificationTime ()

Protected Attributes

TclNumber _isInitialized = 0
TclNumber _lastModificationTime = 0
TclNumber _modified = 0

Private Member Functions

 _commit ()


Constructor & Destructor Documentation

YadaGenerals::YadaGenerals TclList  args  ) 
 

constructor

create submenu entry "New"

add file menu entries Definition at line 59 of file YadaGenerals.tcl.


Member Function Documentation

YadaGenerals::_commit  )  [private]
 

_commit

Definition at line 233 of file YadaGenerals.tcl.

YadaGenerals::activationHandle  )  [virtual]
 

called whenever this document gets activated

activate custom file menu

Reimplemented from YadaPlainDocument.

Definition at line 326 of file YadaGenerals.tcl.

YadaPlainDocument::deActivationHandle  )  [virtual, inherited]
 

deActivationHandle

Reimplemented in YadaConfig.

Definition at line 91 of file YadaPlainDocument.tcl.

References YadaPlainDocument::init().

Referenced by YadaPlainDocument::activationHandle().

YadaGenerals::displayTitle  ) 
 

Update toolbar, menubar and titlebar.

Reimplemented from YadaPlainDocument.

Definition at line 292 of file YadaGenerals.tcl.

YadaGenerals::fromDOM domNode  rootNode  ) 
 

Initialize Object with DOM node (that has saved the object state)

Parameters:
rootNode root DOM-Node (Tag <yada>)

Reimplemented from YadaPlainDocument.

Definition at line 274 of file YadaGenerals.tcl.

YadaGenerals::getPersistanceFileName  )  [virtual]
 

Getting unique file name from registry.

Reimplemented from YadaPlainDocument.

Definition at line 319 of file YadaGenerals.tcl.

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().

YadaGenerals::init  )  [virtual]
 

init

Reimplemented from YadaPlainDocument.

Definition at line 218 of file YadaGenerals.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.

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().

YadaGenerals::toDOM  ) 
 

Serializes Object into a DOM-XML-Node

Returns:
root DOM node representing the YadaGenerals-Object (root tag <yada>)

Reimplemented from YadaPlainDocument.

Definition at line 248 of file YadaGenerals.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 YadaGenerals::editor = ""
 

the name of an editor to launch when we want to edit something

Definition at line 36 of file YadaGenerals.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.

TclNumber YadaGenerals::significance = 1.1
 

percentage indicating a significant difference in a quotient of two numbers.

Definition at line 30 of file YadaGenerals.tcl.

TclNumber YadaGenerals::timeTolerance = 500
 

tolerated time difference which isn't significant for a profiling distinction

Definition at line 33 of file YadaGenerals.tcl.

TclNumber YadaGenerals::weirdness = 1
 

flag indicating how to compute weirdness in the YadaRunnableDocument s.

Definition at line 39 of file YadaGenerals.tcl.


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