Diffpack Documentation

---

              Search  

---

BtGuiTkInterpreter Class Reference

C++ wrapper for the Tcl/Tk interpreter. More...

#include <BtGuiTkInterpreter.h>

Inheritance diagram for BtGuiTkInterpreter::

List of all members.

Public Methods
	BtGuiTkInterpreter ()
	~BtGuiTkInterpreter ()
virtual bool	init (int &argc, const char **argv)
Tcl_Interp*	getInterpreter () const
virtual bool	evaluateCommand (String command)
virtual bool	evaluateFile (String filename)
String	getResult () const
virtual void	registerWidget (const BtGuiWidget &widget)
virtual void	unregisterWidget (const String &name)
virtual void	finish ()
virtual void	mainLoop ()
String	expandFileName (const String &path)

---

Detailed Description

C++ wrapper for the Tcl/Tk interpreter.

NAME: BtGuiTkInterpreter - C++ wrapper for the Tcl/Tk interpreter

DESCRIPTION:

This class is a C++ wrapper of the Tcl/Tk interpreter, designed to work with the GUI classes.

---

Constructor & Destructor Documentation

BtGuiTkInterpreter::BtGuiTkInterpreter ( )

There is only one constructor, without arguments. The "init" function needs to be called to fully initialize the object.

BtGuiTkInterpreter::~BtGuiTkInterpreter ( )

---

Member Function Documentation

bool BtGuiTkInterpreter::evaluateCommand ( String command ) [virtual]

evaluate and execute the Tcl/Tk command contained in the input string. return true of the command was successful, otherwise return false.

bool BtGuiTkInterpreter::evaluateFile ( String filename ) [virtual]

evaluate and execute the Tcl/Tk script file given by the file name contained in the input string.

String BtGuiTkInterpreter::expandFileName ( const String & path )

expand file names containing Unix-style environment variables, e.g. "$NOR/etc/myfile.tcl".

void BtGuiTkInterpreter::finish ( ) [virtual]

flag that we are finished using this Tcl/Tk interpreter.

Tcl_Interp * BtGuiTkInterpreter::getInterpreter ( ) const

get direct access to the underlying Tcl/Tk interpreter.

String BtGuiTkInterpreter::getResult ( ) const

get the return value from the last executed Tcl/Tk command.

bool BtGuiTkInterpreter::init ( int & argc, const char ** argv ) [virtual]

initialize the Tcl/Tk interpreter. Must be called prior to any other use of the object. Reimplemented in BtGuiTixInterpreter.

void BtGuiTkInterpreter::mainLoop ( ) [virtual]

start the main event loop.

void BtGuiTkInterpreter::registerWidget ( const BtGuiWidget & widget ) [virtual]

add a "BtGuiWidget" widget to the list of widgets.

void BtGuiTkInterpreter::unregisterWidget ( const String & name ) [virtual]

remove a widget with specified name from the list of widgets. If the widget to be removed is the top-level widget, call "finish" to tell the interpreter that we are finished using it.

---

The documentation for this class was generated from the following file:

• BtGuiTkInterpreter.h

---