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

YadaProc.tcl File Reference


Detailed Description

Bunch of small helper functions. This module collects all helpers that don't fit in a proper class for themselves. Actually for those cases the YadaMain might be taken, but ...

Author:
Michael Daum
$Id YadaProc.tcl$

Definition in file YadaProc.tcl.

Go to the source code of this file.

Functions

 getAllNotifications (DomDocument document, TclString severity="")
 getIndexOfName (TclCommand listBox, TclString entry)
 printMessage (TclString message, TclString image="info")
 resetBusy (TclList listPrevSettings)
 setBusy ()
 timeToString (TclNumber time)


Function Documentation

getAllNotifications DomDocument  document,
TclString  severity = ""
 

extract notifications. This helper extracts all notifications in a cdgp DomDocument. That is, it searches for \<notify ...\> nodes and gets the desc attribute from it.

Parameters:
document the DomDocument that we are interested in
severity optionally specify the type attribute of the notification that we want to extract
Returns:
the TclList of all messages in all notifications
Definition at line 108 of file YadaProc.tcl.

References getAllNotifications().

Referenced by getAllNotifications().

getIndexOfName TclCommand  listBox,
TclString  entry
 

get the index of an entry in a listbox.

Parameters:
listBox the tcl command of the list box
entry an entry in the listBox
Returns:
the index > 0 if the entry exists, -1 if not so
Definition at line 70 of file YadaProc.tcl.

References getIndexOfName().

Referenced by getIndexOfName().

printMessage TclString  message,
TclString  image = "info"
 

open a message dialog with a given text.

Parameters:
message the notification text
image an image name, see YadaImages for possible values
Definition at line 81 of file YadaProc.tcl.

References printMessage().

Referenced by YadaRunnableDocument::breakJob(), and printMessage().

resetBusy TclList  listPrevSettings  ) 
 

Restores mouse cursor settings for widget hierarchy corresponding to saved settings in first argument (should be identical to return value of proc setBusy) Definition at line 170 of file YadaProc.tcl.

References resetBusy().

Referenced by resetBusy().

setBusy  ) 
 

Sets mouse cursor to indicate busy processing

Returns:
list of changed widgets and previous cursor settings ({<widget> <cursor> ....})
Definition at line 135 of file YadaProc.tcl.

References setBusy().

Referenced by YadaRunner::load(), and setBusy().

timeToString TclNumber  time  ) 
 

convert a time in numerical format to a human readeable format.

Parameters:
time time in milliseconds
Returns:
a string representation
Definition at line 27 of file YadaProc.tcl.

References timeToString().

Referenced by timeToString().


YADA 2.0-alpha (20 Oct 2004)