vtkKWApplication Class Reference

an application class More...

#include <vtkKWApplication.h>

Inheritance diagram for vtkKWApplication:

[legend]Collaboration diagram for vtkKWApplication:

[legend]List of all members.

[NOHEADER]
virtual void	SetPrettyName (const char *)
char *	Name
char *	VersionName
char *	ReleaseName
int	MajorVersion
int	MinorVersion
char *	PrettyName
[NOHEADER]
virtual void	FindInstallationDirectory ()
char *	InstallationDirectory
[NOHEADER]
virtual void	AddEmailFeedbackBody (ostream &)
virtual void	AddEmailFeedbackSubject (ostream &)
char *	EmailFeedbackAddress
[NOHEADER]
virtual void	CreateSplashScreen ()
int	SupportSplashScreen
int	SplashScreenVisibility
[NOHEADER]
virtual void	ConfigureAboutDialog ()
virtual void	AddAboutText (ostream &)
virtual void	AddAboutCopyrights (ostream &)
vtkKWMessageDialog *	AboutDialog
vtkKWLabel *	AboutDialogImage
vtkKWTextWithScrollbars *	AboutRuntimeInfo
Public Member Functions
	vtkTypeRevisionMacro (vtkKWApplication, vtkKWObject)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	Exit ()
virtual const char *	GetPrettyName ()
virtual void	SetLimitedEditionMode (int arg)
virtual void	LimitedEditionModeOn ()
virtual void	LimitedEditionModeOff ()
virtual int	GetLimitedEditionMode ()
virtual int	GetLimitedEditionModeAndWarn (const char *feature)
virtual void	SetLimitedEditionModeName (const char *)
virtual const char *	GetLimitedEditionModeName ()
virtual int	LoadScript (const char *filename)
virtual void	RestoreApplicationSettingsFromRegistry ()
virtual void	SaveApplicationSettingsToRegistry ()
virtual vtkKWSplashScreen *	GetSplashScreen ()
virtual void	DisplayHelpDialog (vtkKWWindowBase *master)
virtual void	DisplayAboutDialog (vtkKWWindowBase *master)
vtkKWBalloonHelpManager *	GetBalloonHelpManager ()
Tcl_Interp *	GetMainInterp ()
virtual vtkKWApplication *	GetApplication ()
virtual void	SetApplication (vtkKWApplication *)
virtual void	Start ()
virtual void	Start (int argc, char *argv[])
virtual void	SetPromptBeforeExit (int)
virtual int	GetPromptBeforeExit ()
virtual void	PromptBeforeExitOn ()
virtual void	PromptBeforeExitOff ()
virtual void	SetExitStatus (int)
virtual int	GetExitStatus ()
virtual int	GetInExit ()
virtual int	AddWindow (vtkKWWindowBase *w)
virtual int	RemoveWindow (vtkKWWindowBase *)
virtual int	GetNumberOfWindows ()
virtual vtkKWWindowBase *	GetNthWindow (int rank)
virtual void	SetName (const char *)
virtual char *	GetName ()
virtual void	SetMajorVersion (int)
virtual int	GetMajorVersion ()
virtual void	SetMinorVersion (int)
virtual int	GetMinorVersion ()
virtual void	SetVersionName (const char *)
virtual const char *	GetVersionName ()
virtual void	SetReleaseName (const char *)
virtual char *	GetReleaseName ()
virtual char *	GetInstallationDirectory ()
virtual void	SetInstallationDirectory (const char *)
virtual char *	GetUserDataDirectory ()
virtual void	SetUserDataDirectory (const char *)
virtual void	SetExitAfterLoadScript (int)
virtual void	ExitAfterLoadScriptOn ()
virtual void	ExitAfterLoadScriptOff ()
virtual int	GetExitAfterLoadScript ()
virtual double	GetPrintTargetDPI ()
virtual void	SetPrintTargetDPI (double)
vtkKWRegistryHelper *	GetRegistryHelper ()
virtual void	SetRegistryLevel (int)
virtual int	GetRegistryLevel ()
virtual int	SetRegistryValue (int level, const char *subkey, const char *key, const char *format,...)
virtual int	GetRegistryValue (int level, const char *subkey, const char *key, char *value)
virtual int	DeleteRegistryValue (int level, const char *subkey, const char *key)
virtual int	HasRegistryValue (int level, const char *subkey, const char *key)
virtual float	GetFloatRegistryValue (int level, const char *subkey, const char *key)
virtual int	GetIntRegistryValue (int level, const char *subkey, const char *key)
virtual int	GetBooleanRegistryValue (int level, const char *subkey, const char *key, const char *trueval)
virtual void	SaveColorRegistryValue (int level, const char *key, double rgb[3])
virtual int	RetrieveColorRegistryValue (int level, const char *key, double rgb[3])
virtual void	SaveDialogLastPathRegistryValue (vtkKWLoadSaveDialog *dlg, const char *key)
virtual void	RetrieveDialogLastPathRegistryValue (vtkKWLoadSaveDialog *dlg, const char *key)
virtual void	SetSupportSplashScreen (int)
virtual int	GetSupportSplashScreen ()
virtual void	SupportSplashScreenOn ()
virtual void	SupportSplashScreenOff ()
virtual int	GetSplashScreenVisibility ()
virtual void	SetSplashScreenVisibility (int)
virtual void	SplashScreenVisibilityOn ()
virtual void	SplashScreenVisibilityOff ()
virtual int	GetSaveUserInterfaceGeometry ()
virtual void	SetSaveUserInterfaceGeometry (int)
virtual void	SaveUserInterfaceGeometryOn ()
virtual void	SaveUserInterfaceGeometryOff ()
virtual void	SetCharacterEncoding (int val)
virtual int	GetCharacterEncoding ()
virtual int	HasCheckForUpdates ()
virtual void	CheckForUpdates ()
virtual int	CanEmailFeedback ()
virtual void	EmailFeedback ()
virtual void	SetEmailFeedbackAddress (const char *)
virtual char *	GetEmailFeedbackAddress ()
virtual char *	GetHelpDialogStartingPage ()
virtual void	SetHelpDialogStartingPage (const char *)
virtual const char *	Script (const char *format,...)
int	EvaluateBooleanExpression (const char *format,...)
virtual void	RegisterDialogUp (vtkKWWidget *ptr)
virtual void	UnRegisterDialogUp (vtkKWWidget *ptr)
virtual int	IsDialogUp ()
Static Public Member Functions
vtkKWApplication *	New ()
int	OpenLink (const char *link)
Tcl_Interp *	InitializeTcl (int argc, char *argv[], ostream *err=0)
Tcl_Interp *	InitializeTcl (Tcl_Interp *interp, ostream *err=0)
Static Public Attributes
const char *	ExitDialogName
const char *	BalloonHelpVisibilityRegKey
const char *	SaveUserInterfaceGeometryRegKey
const char *	SplashScreenVisibilityRegKey
const char *	PrintTargetDPIRegKey
Protected Member Functions
	vtkKWApplication ()
	~vtkKWApplication ()
virtual void	DoOneTclEvent ()
virtual int	DisplayExitDialog (vtkKWWindowBase *master)
virtual int	GetCheckForUpdatesPath (ostream &path)
virtual void	PrepareForDelete ()
Static Protected Member Functions
int	CheckForArgument (int argc, char *argv[], const char *arg, int &index)
int	CheckForValuedArgument (int argc, char *argv[], const char *arg, int &index, int &value_pos)
Protected Attributes
Tk_Window	MainWindow
Tcl_Interp *	MainInterp
char *	UserDataDirectory
char *	HelpDialogStartingPage
int	DialogUp
int	RegistryLevel
int	SaveUserInterfaceGeometry
int	CharacterEncoding
double	PrintTargetDPI
vtkKWApplicationInternals *	Internals
int	ExitStatus
int	InExit
int	ExitAfterLoadScript
int	PromptBeforeExit
int	LimitedEditionMode
char *	LimitedEditionModeName

---

Detailed Description

an application class

vtkKWApplication is the overall class that represents the entire application. It is also responsible for managing the vtkKWWindowBase(s) associated to the application.

Definition at line 42 of file vtkKWApplication.h.

---

Constructor & Destructor Documentation

vtkKWApplication::vtkKWApplication (   )  [protected]

vtkKWApplication::~vtkKWApplication (   )  [protected]

---

Member Function Documentation

vtkKWApplication* vtkKWApplication::New (   )  [static]

Reimplemented from vtkKWObject. Reimplemented in vtkPVApplication.

vtkKWApplication::vtkTypeRevisionMacro (  vtkKWApplication  , vtkKWObject  )

void vtkKWApplication::PrintSelf (  ostream &  os, vtkIndent  indent )

Reimplemented from vtkKWObject. Reimplemented in vtkPVApplication.

virtual vtkKWApplication* vtkKWApplication::GetApplication (   )  [inline, virtual]

Override vtkKWObject's method. A vtkKWObject is associated to a vtkKWApplication. Even if vtkKWApplication is a subclass of vtkKWObject, an application's application is actually 'itself', and it can not be reset. Reimplemented from vtkKWObject. Definition at line 54 of file vtkKWApplication.h.

virtual void vtkKWApplication::SetApplication (  vtkKWApplication *   )  [virtual]

Override vtkKWObject's method. A vtkKWObject is associated to a vtkKWApplication. Even if vtkKWApplication is a subclass of vtkKWObject, an application's application is actually 'itself', and it can not be reset. Reimplemented from vtkKWObject.

virtual void vtkKWApplication::Start (   )  [virtual]

Start running the application, with or without arguments. Reimplemented in vtkPVApplication. Referenced by vtkPVApplication::Start().

virtual void vtkKWApplication::Start (  int  argc, char *  argv[] )  [virtual]

Start running the application, with or without arguments. Reimplemented in vtkPVApplication.

virtual int vtkKWApplication::Exit (   )  [virtual]

This method is invoked when the user exits the app Return 1 if the app exited successfully, 0 otherwise (for example, if some dialogs are still up, or the user did not confirm, etc). Reimplemented in vtkPVApplication.

virtual void vtkKWApplication::SetPromptBeforeExit (  int   )  [virtual]

Set/Get if a confirmation dialog should be displayed before the application is exited.

virtual int vtkKWApplication::GetPromptBeforeExit (   )  [virtual]

Set/Get if a confirmation dialog should be displayed before the application is exited.

virtual void vtkKWApplication::PromptBeforeExitOn (   )  [virtual]

Set/Get if a confirmation dialog should be displayed before the application is exited.

virtual void vtkKWApplication::PromptBeforeExitOff (   )  [virtual]

Set/Get if a confirmation dialog should be displayed before the application is exited.

virtual void vtkKWApplication::SetExitStatus (  int   )  [virtual]

Set/Get the value returned by the application at exit. This can be used from scripts to set an error status

virtual int vtkKWApplication::GetExitStatus (   )  [virtual]

Set/Get the value returned by the application at exit. This can be used from scripts to set an error status

virtual int vtkKWApplication::GetInExit (   )  [virtual]

Get when application is exiting (set to 1 as soon as Exit() is called).

virtual int vtkKWApplication::AddWindow (  vtkKWWindowBase *  w  )  [virtual]

Add/Close a window to/of this application. Note that AddWindow() will increase the reference count of the window that is added, RemoveWindow() will decrease it. Once the last window is closed, Exit() is called. Return 1 if successful, 0 otherwise

virtual int vtkKWApplication::RemoveWindow (  vtkKWWindowBase *   )  [virtual]

Add/Close a window to/of this application. Note that AddWindow() will increase the reference count of the window that is added, RemoveWindow() will decrease it. Once the last window is closed, Exit() is called. Return 1 if successful, 0 otherwise Reimplemented in vtkPVApplication.

virtual int vtkKWApplication::GetNumberOfWindows (   )  [virtual]

Get the number of windows, retrieve a window

virtual vtkKWWindowBase* vtkKWApplication::GetNthWindow (  int  rank  )  [virtual]

Get the number of windows, retrieve a window

virtual void vtkKWApplication::SetName (  const char *   )  [virtual]

Set/Get the application name. Also check the LimitedEditionModeName variable if you plan on running the application in limited edition mode.

virtual char* vtkKWApplication::GetName (   )  [virtual]

Set/Get the application name. Also check the LimitedEditionModeName variable if you plan on running the application in limited edition mode.

virtual void vtkKWApplication::SetMajorVersion (  int   )  [virtual]

Get the major and minor application version.

virtual int vtkKWApplication::GetMajorVersion (   )  [virtual]

Get the major and minor application version.

virtual void vtkKWApplication::SetMinorVersion (  int   )  [virtual]

Get the major and minor application version.

virtual int vtkKWApplication::GetMinorVersion (   )  [virtual]

Get the major and minor application version.

virtual void vtkKWApplication::SetVersionName (  const char *   )  [virtual]

Set/Get the application version name - this usually is the application name postfixed with the version number (major/minor). It is typically used as the master key to store registry settings (ex: VolView 3.0, ParaView1.1, etc.) If it has not been set, it will use the value of Name and append the major/minor version.

virtual const char* vtkKWApplication::GetVersionName (   )  [virtual]

Set/Get the application version name - this usually is the application name postfixed with the version number (major/minor). It is typically used as the master key to store registry settings (ex: VolView 3.0, ParaView1.1, etc.) If it has not been set, it will use the value of Name and append the major/minor version.

virtual void vtkKWApplication::SetReleaseName (  const char *   )  [virtual]

Set/Get the application release name - this is the release of the application version (if any), typically: beta1, beta2, final, patch1, etc.

virtual char* vtkKWApplication::GetReleaseName (   )  [virtual]

Set/Get the application release name - this is the release of the application version (if any), typically: beta1, beta2, final, patch1, etc.

virtual const char* vtkKWApplication::GetPrettyName (   )  [virtual]

Convenience method to get the "pretty" name of the application. This is typically used for windows or dialogs title, About boxes, etc. It combines the application name, its version, and other relevant informations (like its limited edition mode).

virtual void vtkKWApplication::SetLimitedEditionMode (  int  arg  )  [virtual]

virtual void vtkKWApplication::LimitedEditionModeOn (   )  [virtual]

virtual void vtkKWApplication::LimitedEditionModeOff (   )  [virtual]

virtual int vtkKWApplication::GetLimitedEditionMode (   )  [virtual]

virtual int vtkKWApplication::GetLimitedEditionModeAndWarn (  const char *  feature  )  [virtual]

virtual void vtkKWApplication::SetLimitedEditionModeName (  const char *   )  [virtual]

virtual const char* vtkKWApplication::GetLimitedEditionModeName (   )  [virtual]

virtual char* vtkKWApplication::GetInstallationDirectory (   )  [virtual]

Set/Get the directory in which the current application is supposed to be installed.

virtual void vtkKWApplication::SetInstallationDirectory (  const char *   )  [virtual]

Set/Get the directory in which the current application is supposed to be installed.

virtual char* vtkKWApplication::GetUserDataDirectory (   )  [virtual]

Set/Get the directory in which the current application can store user data.

virtual void vtkKWApplication::SetUserDataDirectory (  const char *   )  [virtual]

Set/Get the directory in which the current application can store user data.

virtual int vtkKWApplication::LoadScript (  const char *  filename  )  [virtual]

Load and evaluate a Tcl script from a file. Return 1 if successful, 0 otherwise

virtual void vtkKWApplication::SetExitAfterLoadScript (  int   )  [virtual]

Set/Get the "exit after load script" flag. If this flag is set, then the application will automatically Exit() after a call to LoadScript(). This is mainly used for testing purposes. Even though a Tcl script can end with an explicit call to Exit on the application Tcl object, this call may never be reached it the script contains an error. Setting this variable will make sure the application will exit anyway.

virtual void vtkKWApplication::ExitAfterLoadScriptOn (   )  [virtual]

Set/Get the "exit after load script" flag. If this flag is set, then the application will automatically Exit() after a call to LoadScript(). This is mainly used for testing purposes. Even though a Tcl script can end with an explicit call to Exit on the application Tcl object, this call may never be reached it the script contains an error. Setting this variable will make sure the application will exit anyway.

virtual void vtkKWApplication::ExitAfterLoadScriptOff (   )  [virtual]

Set/Get the "exit after load script" flag. If this flag is set, then the application will automatically Exit() after a call to LoadScript(). This is mainly used for testing purposes. Even though a Tcl script can end with an explicit call to Exit on the application Tcl object, this call may never be reached it the script contains an error. Setting this variable will make sure the application will exit anyway.

virtual int vtkKWApplication::GetExitAfterLoadScript (   )  [virtual]

Set/Get the "exit after load script" flag. If this flag is set, then the application will automatically Exit() after a call to LoadScript(). This is mainly used for testing purposes. Even though a Tcl script can end with an explicit call to Exit on the application Tcl object, this call may never be reached it the script contains an error. Setting this variable will make sure the application will exit anyway.

virtual double vtkKWApplication::GetPrintTargetDPI (   )  [virtual]

Set/Get the print quality.

virtual void vtkKWApplication::SetPrintTargetDPI (  double   )  [virtual]

Set/Get the print quality.

vtkKWRegistryHelper* vtkKWApplication::GetRegistryHelper (   )

Get the Registry object. BTX

virtual void vtkKWApplication::SetRegistryLevel (  int   )  [virtual]

Set/Get the current registry level. When setting/retrieving a value in/from the registry a 'level' has to be provided as part of the parameters. If this level is greater than the current registry level, the operation will be ignored. Set the registry level to -1 means to ignore all the registry operations.

virtual int vtkKWApplication::GetRegistryLevel (   )  [virtual]

Set/Get the current registry level. When setting/retrieving a value in/from the registry a 'level' has to be provided as part of the parameters. If this level is greater than the current registry level, the operation will be ignored. Set the registry level to -1 means to ignore all the registry operations.

virtual int vtkKWApplication::SetRegistryValue (  int  level, const char *  subkey, const char *  key, const char *  format, ...  )  [virtual]

Set/get/delete/query a registry value for the application. When storing multiple arguments, separate them with spaces. Note that if the 'level' is greater than the current registry level, the operation will be ignored. BTX

virtual int vtkKWApplication::GetRegistryValue (  int  level, const char *  subkey, const char *  key, char *  value )  [virtual]

Set/get/delete/query a registry value for the application. When storing multiple arguments, separate them with spaces. Note that if the 'level' is greater than the current registry level, the operation will be ignored. BTX

virtual int vtkKWApplication::DeleteRegistryValue (  int  level, const char *  subkey, const char *  key )  [virtual]

Set/get/delete/query a registry value for the application. When storing multiple arguments, separate them with spaces. Note that if the 'level' is greater than the current registry level, the operation will be ignored. BTX

virtual int vtkKWApplication::HasRegistryValue (  int  level, const char *  subkey, const char *  key )  [virtual]

Set/get/delete/query a registry value for the application. When storing multiple arguments, separate them with spaces. Note that if the 'level' is greater than the current registry level, the operation will be ignored. BTX

virtual float vtkKWApplication::GetFloatRegistryValue (  int  level, const char *  subkey, const char *  key )  [virtual]

Convenience methods to retrieve a value from the registry and convert it to a type (boolean, float, int). Return 0 if the value was not found. For GetBooleanRegistryValue(), perform a boolean check of the value in the registry. If the value at the key is equal to 'trueval', then return true, otherwise return false.

virtual int vtkKWApplication::GetIntRegistryValue (  int  level, const char *  subkey, const char *  key )  [virtual]

Convenience methods to retrieve a value from the registry and convert it to a type (boolean, float, int). Return 0 if the value was not found. For GetBooleanRegistryValue(), perform a boolean check of the value in the registry. If the value at the key is equal to 'trueval', then return true, otherwise return false.

virtual int vtkKWApplication::GetBooleanRegistryValue (  int  level, const char *  subkey, const char *  key, const char *  trueval )  [virtual]

Convenience methods to retrieve a value from the registry and convert it to a type (boolean, float, int). Return 0 if the value was not found. For GetBooleanRegistryValue(), perform a boolean check of the value in the registry. If the value at the key is equal to 'trueval', then return true, otherwise return false.

virtual void vtkKWApplication::SaveColorRegistryValue (  int  level, const char *  key, double  rgb[3] )  [virtual]

Convenience methods to save/retrieve color to/from the registry. If the color does not exist, it will retrieve -1, -1 ,-1 and return 0 (1 if success). Note that the subkey used here is "Colors".

virtual int vtkKWApplication::RetrieveColorRegistryValue (  int  level, const char *  key, double  rgb[3] )  [virtual]

Convenience methods to save/retrieve color to/from the registry. If the color does not exist, it will retrieve -1, -1 ,-1 and return 0 (1 if success). Note that the subkey used here is "Colors".

virtual void vtkKWApplication::SaveDialogLastPathRegistryValue (  vtkKWLoadSaveDialog *  dlg, const char *  key )  [virtual]

Convenience methods to save/retrieve the last path of a dialog to/from the registry. Note that the subkey used here is "RunTime".

virtual void vtkKWApplication::RetrieveDialogLastPathRegistryValue (  vtkKWLoadSaveDialog *  dlg, const char *  key )  [virtual]

Convenience methods to save/retrieve the last path of a dialog to/from the registry. Note that the subkey used here is "RunTime".

virtual void vtkKWApplication::RestoreApplicationSettingsFromRegistry (   )  [virtual]

Reimplemented in vtkPVApplication.

virtual void vtkKWApplication::SaveApplicationSettingsToRegistry (   )  [virtual]

virtual void vtkKWApplication::SetSupportSplashScreen (  int   )  [virtual]

Set/Get if this application supports a splash screen

virtual int vtkKWApplication::GetSupportSplashScreen (   )  [virtual]

Set/Get if this application supports a splash screen

virtual void vtkKWApplication::SupportSplashScreenOn (   )  [virtual]

Set/Get if this application supports a splash screen

virtual void vtkKWApplication::SupportSplashScreenOff (   )  [virtual]

Set/Get if this application supports a splash screen

virtual int vtkKWApplication::GetSplashScreenVisibility (   )  [virtual]

Set/Get if this application should show the splash screen at startup

virtual void vtkKWApplication::SetSplashScreenVisibility (  int   )  [virtual]

Set/Get if this application should show the splash screen at startup

virtual void vtkKWApplication::SplashScreenVisibilityOn (   )  [virtual]

Set/Get if this application should show the splash screen at startup

virtual void vtkKWApplication::SplashScreenVisibilityOff (   )  [virtual]

Set/Get if this application should show the splash screen at startup

virtual vtkKWSplashScreen* vtkKWApplication::GetSplashScreen (   )  [virtual]

Retrieve the splash screen object As a convenience, this will also call vtkKWSplashScreen::Create() to create the splash screen widget itself.

virtual int vtkKWApplication::GetSaveUserInterfaceGeometry (   )  [virtual]

Set/Get if the user interface geometry should be saved (to the registry, for example). This is more like a hint that many widgets can query to check if they should save their own geometry (and restore it on startup). See vtkKWWindowBase for example.

virtual void vtkKWApplication::SetSaveUserInterfaceGeometry (  int   )  [virtual]

Set/Get if the user interface geometry should be saved (to the registry, for example). This is more like a hint that many widgets can query to check if they should save their own geometry (and restore it on startup). See vtkKWWindowBase for example.

virtual void vtkKWApplication::SaveUserInterfaceGeometryOn (   )  [virtual]

Set/Get if the user interface geometry should be saved (to the registry, for example). This is more like a hint that many widgets can query to check if they should save their own geometry (and restore it on startup). See vtkKWWindowBase for example.

virtual void vtkKWApplication::SaveUserInterfaceGeometryOff (   )  [virtual]

Set/Get if the user interface geometry should be saved (to the registry, for example). This is more like a hint that many widgets can query to check if they should save their own geometry (and restore it on startup). See vtkKWWindowBase for example.

virtual void vtkKWApplication::SetCharacterEncoding (  int  val  )  [virtual]

Get/Set the internal character encoding of the application.

virtual int vtkKWApplication::GetCharacterEncoding (   )  [virtual]

Get/Set the internal character encoding of the application.

virtual int vtkKWApplication::HasCheckForUpdates (   )  [virtual]

Get if we have some logic to check for application update online and perform that check.

virtual void vtkKWApplication::CheckForUpdates (   )  [virtual]

Get if we have some logic to check for application update online and perform that check.

virtual int vtkKWApplication::CanEmailFeedback (   )  [virtual]

Get if we have some logic to report feedback by email and email that feedback. Set/Get the email address to send that feedback to.

virtual void vtkKWApplication::EmailFeedback (   )  [virtual]

Get if we have some logic to report feedback by email and email that feedback. Set/Get the email address to send that feedback to.

virtual void vtkKWApplication::SetEmailFeedbackAddress (  const char *   )  [virtual]

Get if we have some logic to report feedback by email and email that feedback. Set/Get the email address to send that feedback to.

virtual char* vtkKWApplication::GetEmailFeedbackAddress (   )  [virtual]

Get if we have some logic to report feedback by email and email that feedback. Set/Get the email address to send that feedback to.

virtual void vtkKWApplication::DisplayHelpDialog (  vtkKWWindowBase *  master  )  [virtual]

Display the on-line help for this application. Optionally provide a master window this dialog should be the slave of. Reimplemented in vtkPVApplication.

virtual char* vtkKWApplication::GetHelpDialogStartingPage (   )  [virtual]

Set/Get the help starting page. If set to a CHM/HTML page, it will be opened automatically on Windows.

virtual void vtkKWApplication::SetHelpDialogStartingPage (  const char *   )  [virtual]

Set/Get the help starting page. If set to a CHM/HTML page, it will be opened automatically on Windows.

virtual void vtkKWApplication::DisplayAboutDialog (  vtkKWWindowBase *  master  )  [virtual]

Display the about dialog for this application. Optionally provide a master window this dialog should be the slave of.

vtkKWBalloonHelpManager* vtkKWApplication::GetBalloonHelpManager (   )

Return the Balloon Help helper object.

virtual const char* vtkKWApplication::Script (  const char *  format, ...  )  [virtual]

Convenience methods to evaluate Tcl script/code and perform argument substitutions. BTX Reimplemented from vtkKWObject.

int vtkKWApplication::EvaluateBooleanExpression (  const char *  format, ...  )

Convenience methods to evaluate Tcl script/code and perform argument substitutions. BTX

Tcl_Interp* vtkKWApplication::GetMainInterp (   )  [inline]

Get the interpreter being used by this application Definition at line 358 of file vtkKWApplication.h.

Tcl_Interp* vtkKWApplication::InitializeTcl (  int  argc, char *  argv[], ostream *  err = 0 )  [static]

Initialize Tcl/Tk Return NULL on error (eventually provides an ostream where detailed error messages will be stored). One method takes argc/argv and will create an internal Tcl interpreter on the fly, the other takes a Tcl interpreter and uses it afterward (this is mainly intended for initialization as a Tcl package) BTX Reimplemented in vtkPVApplication.

Tcl_Interp* vtkKWApplication::InitializeTcl (  Tcl_Interp *  interp, ostream *  err = 0 )  [static]

Initialize Tcl/Tk Return NULL on error (eventually provides an ostream where detailed error messages will be stored). One method takes argc/argv and will create an internal Tcl interpreter on the fly, the other takes a Tcl interpreter and uses it afterward (this is mainly intended for initialization as a Tcl package) BTX

virtual void vtkKWApplication::RegisterDialogUp (  vtkKWWidget *  ptr  )  [virtual]

Call RegisterDialogUp to notify the application that a modal dialog is up, and UnRegisterDialogUp when it is not anymore. IsDialogUp will return if any dialog is up. The parameter to pass is a pointer to the dialog/toplevel/widget that is being registered/unregistered. If there is no such widget (say, if you are calling a builtin Tk function that creates and pops-up a dialog), pass the adress of the class that is invoking that call. This is used to help preventing a window or an application to exit while a dialog is still up. This is usually not a problem on Win32, since a modal dialog will prevent the user from interacting with the window and exit it, but this is not the case for other operating system where the window manager is independent from the window contents itself. In any case, inheriting from a vtkKWTopLevel or vtkKWDialog should take care of calling this function for you.

virtual void vtkKWApplication::UnRegisterDialogUp (  vtkKWWidget *  ptr  )  [virtual]

Call RegisterDialogUp to notify the application that a modal dialog is up, and UnRegisterDialogUp when it is not anymore. IsDialogUp will return if any dialog is up. The parameter to pass is a pointer to the dialog/toplevel/widget that is being registered/unregistered. If there is no such widget (say, if you are calling a builtin Tk function that creates and pops-up a dialog), pass the adress of the class that is invoking that call. This is used to help preventing a window or an application to exit while a dialog is still up. This is usually not a problem on Win32, since a modal dialog will prevent the user from interacting with the window and exit it, but this is not the case for other operating system where the window manager is independent from the window contents itself. In any case, inheriting from a vtkKWTopLevel or vtkKWDialog should take care of calling this function for you.

virtual int vtkKWApplication::IsDialogUp (   )  [virtual]

Call RegisterDialogUp to notify the application that a modal dialog is up, and UnRegisterDialogUp when it is not anymore. IsDialogUp will return if any dialog is up. The parameter to pass is a pointer to the dialog/toplevel/widget that is being registered/unregistered. If there is no such widget (say, if you are calling a builtin Tk function that creates and pops-up a dialog), pass the adress of the class that is invoking that call. This is used to help preventing a window or an application to exit while a dialog is still up. This is usually not a problem on Win32, since a modal dialog will prevent the user from interacting with the window and exit it, but this is not the case for other operating system where the window manager is independent from the window contents itself. In any case, inheriting from a vtkKWTopLevel or vtkKWDialog should take care of calling this function for you.

int vtkKWApplication::OpenLink (  const char *  link  )  [static]

Open a link (media).On Win32, use ShellExecute to trigger the default viewers.

virtual void vtkKWApplication::DoOneTclEvent (   )  [protected, virtual]

Do one tcl event and enter the event loop, allowing the application interface to actually run.

virtual void vtkKWApplication::SetPrettyName (  const char *   )  [protected, virtual]

virtual void vtkKWApplication::FindInstallationDirectory (   )  [protected, virtual]

Reimplemented in vtkPVApplication.

virtual void vtkKWApplication::AddEmailFeedbackBody (  ostream &   )  [protected, virtual]

Add email feedback body and subject to output stream. Override this function in subclasses (and/or call the superclass) to add more information.

virtual void vtkKWApplication::AddEmailFeedbackSubject (  ostream &   )  [protected, virtual]

Add email feedback body and subject to output stream. Override this function in subclasses (and/or call the superclass) to add more information.

virtual int vtkKWApplication::DisplayExitDialog (  vtkKWWindowBase *  master  )  [protected, virtual]

Display the exit dialog. Optionally provide a master window this dialog should be the slave of. Return 1 if the user wants to exit, 0 otherwise

virtual void vtkKWApplication::CreateSplashScreen (   )  [inline, protected, virtual]

Reimplemented in vtkPVApplication. Definition at line 480 of file vtkKWApplication.h.

virtual void vtkKWApplication::ConfigureAboutDialog (   )  [protected, virtual]

About dialog, add text and copyrights to the about dialog. Override this function in subclasses (and/or call the superclass) to add more information. Reimplemented in vtkPVApplication.

virtual void vtkKWApplication::AddAboutText (  ostream &   )  [protected, virtual]

About dialog, add text and copyrights to the about dialog. Override this function in subclasses (and/or call the superclass) to add more information. Reimplemented in vtkPVApplication.

virtual void vtkKWApplication::AddAboutCopyrights (  ostream &   )  [protected, virtual]

About dialog, add text and copyrights to the about dialog. Override this function in subclasses (and/or call the superclass) to add more information.

int vtkKWApplication::CheckForArgument (  int  argc, char *  argv[], const char *  arg, int &  index )  [static, protected]

Check for an argument (example: --foo, /C, -bar, etc). Return VTK_OK if found and set 'index' to the position of the argument in argv[]. Return VTK_ERROR if not found.

int vtkKWApplication::CheckForValuedArgument (  int  argc, char *  argv[], const char *  arg, int &  index, int &  value_pos )  [static, protected]

Check for a valued argument (example: --foo=bar, /C=bar, -bar=foo, etc). Return VTK_OK if found and set 'index' to the position of the argument in argv[], 'value_pos' to the position right after the '=' in that argument. Return VTK_ERROR if not found.

virtual int vtkKWApplication::GetCheckForUpdatesPath (  ostream &  path  )  [protected, virtual]

Try to find the path to the online updater (for example, WiseUpdt.exe) and output that path to the ostream passed as parameter.

virtual void vtkKWApplication::PrepareForDelete (   )  [protected, virtual]

Deallocate/delete/reparent some internal objects in order to solve reference loops that would prevent this instance from being deleted.

---

Member Data Documentation

const char* vtkKWApplication::ExitDialogName [static]

Some constants BTX Definition at line 397 of file vtkKWApplication.h.

const char* vtkKWApplication::BalloonHelpVisibilityRegKey [static]

Some constants BTX Definition at line 398 of file vtkKWApplication.h.

const char* vtkKWApplication::SaveUserInterfaceGeometryRegKey [static]

Some constants BTX Definition at line 399 of file vtkKWApplication.h.

const char* vtkKWApplication::SplashScreenVisibilityRegKey [static]

Some constants BTX Definition at line 400 of file vtkKWApplication.h.

const char* vtkKWApplication::PrintTargetDPIRegKey [static]

Some constants BTX Definition at line 401 of file vtkKWApplication.h.

Tk_Window vtkKWApplication::MainWindow [protected]

Definition at line 409 of file vtkKWApplication.h.

Tcl_Interp* vtkKWApplication::MainInterp [protected]

Definition at line 410 of file vtkKWApplication.h.

char* vtkKWApplication::Name [protected]

Application name and version Definition at line 418 of file vtkKWApplication.h.

char* vtkKWApplication::VersionName [protected]

Definition at line 419 of file vtkKWApplication.h.

char* vtkKWApplication::ReleaseName [protected]

Definition at line 420 of file vtkKWApplication.h.

int vtkKWApplication::MajorVersion [protected]

Definition at line 421 of file vtkKWApplication.h.

int vtkKWApplication::MinorVersion [protected]

Definition at line 422 of file vtkKWApplication.h.

char* vtkKWApplication::PrettyName [protected]

Definition at line 423 of file vtkKWApplication.h.

char* vtkKWApplication::InstallationDirectory [protected]

Application installation directory Definition at line 429 of file vtkKWApplication.h.

char* vtkKWApplication::UserDataDirectory [protected]

User data directory Definition at line 434 of file vtkKWApplication.h.

char* vtkKWApplication::EmailFeedbackAddress [protected]

Add email feedback body and subject to output stream. Override this function in subclasses (and/or call the superclass) to add more information. Definition at line 442 of file vtkKWApplication.h.

char* vtkKWApplication::HelpDialogStartingPage [protected]

On-line help starting page Definition at line 446 of file vtkKWApplication.h.

int vtkKWApplication::ExitStatus [protected]

Value that is set after exit (status), flag stating that Exit was called, flag stating if application should exit after load script Definition at line 456 of file vtkKWApplication.h.

int vtkKWApplication::InExit [protected]

Value that is set after exit (status), flag stating that Exit was called, flag stating if application should exit after load script Definition at line 457 of file vtkKWApplication.h.

int vtkKWApplication::ExitAfterLoadScript [protected]

Value that is set after exit (status), flag stating that Exit was called, flag stating if application should exit after load script Definition at line 458 of file vtkKWApplication.h.

int vtkKWApplication::PromptBeforeExit [protected]

Value that is set after exit (status), flag stating that Exit was called, flag stating if application should exit after load script Definition at line 459 of file vtkKWApplication.h.

int vtkKWApplication::DialogUp [protected]

Number of dialog that are up. See Un/RegisterDialogUp(). Definition at line 463 of file vtkKWApplication.h.

int vtkKWApplication::LimitedEditionMode [protected]

Limited edition mode, name of the application when in limited edition mode Definition at line 468 of file vtkKWApplication.h.

char* vtkKWApplication::LimitedEditionModeName [protected]

Limited edition mode, name of the application when in limited edition mode Definition at line 469 of file vtkKWApplication.h.

int vtkKWApplication::RegistryLevel [protected]

Registry level. If a call to Set/GetRegistryValue uses a level above this ivar, the operation is ignored. Definition at line 474 of file vtkKWApplication.h.

int vtkKWApplication::SupportSplashScreen [protected]

Flag stating if application supports splash screen, and shows it Definition at line 478 of file vtkKWApplication.h.

int vtkKWApplication::SplashScreenVisibility [protected]

Definition at line 479 of file vtkKWApplication.h.

int vtkKWApplication::SaveUserInterfaceGeometry [protected]

Flag stating if the UI geometry should be saved before exiting Definition at line 484 of file vtkKWApplication.h.

vtkKWMessageDialog* vtkKWApplication::AboutDialog [protected]

About dialog, add text and copyrights to the about dialog. Override this function in subclasses (and/or call the superclass) to add more information. Definition at line 493 of file vtkKWApplication.h.

vtkKWLabel* vtkKWApplication::AboutDialogImage [protected]

About dialog, add text and copyrights to the about dialog. Override this function in subclasses (and/or call the superclass) to add more information. Definition at line 494 of file vtkKWApplication.h.

vtkKWTextWithScrollbars* vtkKWApplication::AboutRuntimeInfo [protected]

About dialog, add text and copyrights to the about dialog. Override this function in subclasses (and/or call the superclass) to add more information. Definition at line 495 of file vtkKWApplication.h.

int vtkKWApplication::CharacterEncoding [protected]

Character encoding (is passed to Tcl) Definition at line 499 of file vtkKWApplication.h.

double vtkKWApplication::PrintTargetDPI [protected]

Print DPI Definition at line 502 of file vtkKWApplication.h.

vtkKWApplicationInternals* vtkKWApplication::Internals [protected]

Definition at line 532 of file vtkKWApplication.h.

---

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

• GUI/Widgets/vtkKWApplication.h

---