vtkKWApplication Class Reference

an application class More...

#include <vtkKWApplication.h>

Inheritance diagram for vtkKWApplication:
Inheritance graph
[legend]
Collaboration diagram for vtkKWApplication:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkKWObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual int Exit ()
virtual const char * GetPrettyName ()
virtual int GetMostRecentVersionLaunched (int *major, int *minor)
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 void SetReleaseMode (int)
virtual void ReleaseModeOn ()
virtual void ReleaseModeOff ()
virtual int GetReleaseMode ()
virtual int LoadScript (const char *filename)
virtual void RestoreApplicationSettingsFromRegistry ()
virtual void SaveApplicationSettingsToRegistry ()
virtual vtkKWSplashScreenGetSplashScreen ()
virtual void DisplayHelpDialog (vtkKWTopLevel *master)
virtual void DisplayTutorial (vtkKWTopLevel *master)
virtual void DisplayAboutDialog (vtkKWTopLevel *master)
virtual vtkKWBalloonHelpManagerGetBalloonHelpManager ()
virtual vtkKWColorPickerDialogGetColorPickerDialog ()
int OpenLink (const char *link)
int ExploreLink (const char *link)
virtual void ProcessPendingEvents ()
virtual void ProcessIdleTasks ()
virtual void InstallTclBgErrorCallback ()
virtual void AddSystemInformation (ostream &)
virtual void TclBgErrorCallback (const char *message)

Static Public Member Functions

static vtkKWApplicationNew ()
static int IsTypeOf (const char *type)
static vtkKWApplicationSafeDownCast (vtkObject *o)
static Tcl_Interp * GetMainInterp ()
static int PutEnv (const char *value)

Protected Member Functions

 vtkKWApplication ()
 ~vtkKWApplication ()
virtual void DoOneTclEvent ()
virtual void DisplayHelpPage (const char *page, vtkKWTopLevel *master)
virtual int DisplayExitDialog (vtkKWTopLevel *master)
virtual int SendErrorLog ()
virtual void ParseCommandLineArguments (int argc, char *argv[])
virtual int GetCheckForUpdatesPath (ostream &path)
virtual void PrepareForDelete ()

Protected Attributes

char * UserDataDirectory
char * EmailFeedbackAddress
char * HelpDialogStartingPage
char * TutorialStartingPage
int DialogUp
int RegistryLevel
int SaveUserInterfaceGeometry
int CharacterEncoding
double PrintTargetDPI
vtkKWThemeTheme
vtkKWApplicationInternals * Internals
vtkKWTclInteractorTclInteractor
vtkKWColorPickerDialogColorPickerDialog



static const char * ExitDialogName
static const char * SendErrorLogDialogName
static const char * BalloonHelpVisibilityRegKey
static const char * SaveUserInterfaceGeometryRegKey
static const char * SplashScreenVisibilityRegKey
static const char * PrintTargetDPIRegKey
static const char * MostRecentVersionLaunchedRegKey
int ExitStatus
int InExit
int ExitAfterLoadScript
int PromptBeforeExit
int SendErrorLogBeforeExit
int SupportSplashScreen
int SplashScreenVisibility
vtkKWMessageDialogAboutDialog
vtkKWLabelAboutDialogImage
vtkKWTextWithScrollbarsAboutRuntimeInfo
vtkKWLogDialogLogDialog
static Tcl_Interp * InitializeTcl (int argc, char *argv[], ostream *err=0)
static Tcl_Interp * InitializeTcl (Tcl_Interp *interp, ostream *err=0)
virtual vtkKWApplicationGetApplication ()
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 void SetSendErrorLogBeforeExit (int)
virtual int GetSendErrorLogBeforeExit ()
virtual void SendErrorLogBeforeExitOn ()
virtual void SendErrorLogBeforeExitOff ()
virtual int AddWindow (vtkKWWindowBase *w)
virtual int RemoveWindow (vtkKWWindowBase *)
virtual vtkKWWindowBaseGetNthWindow (int rank)
virtual int GetNumberOfWindows ()
virtual int GetNumberOfWindowsMapped ()
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 const char * GetInstallationDirectory ()
virtual void SetInstallationDirectory (const char *)
virtual const 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)
vtkKWRegistryHelperGetRegistryHelper ()
virtual void SetRegistryVersionName (const char *)
virtual const char * GetRegistryVersionName ()
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])
vtkKWOptionDataBaseGetOptionDataBase ()
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 void SetTheme (vtkKWTheme *theme)
virtual vtkKWThemeGetTheme ()
virtual int CanEmailFeedback ()
virtual void EmailFeedback ()
virtual void SetEmailFeedbackAddress (const char *)
virtual char * GetEmailFeedbackAddress ()
virtual int SendEmail (const char *to, const char *subject, const char *message, const char *attachment_filename, const char *extra_error_msg=NULL)
virtual void AddEmailFeedbackBody (ostream &)
virtual void AddEmailFeedbackSubject (ostream &)
virtual char * GetHelpDialogStartingPage ()
virtual void SetHelpDialogStartingPage (const char *)
virtual char * GetTutorialStartingPage ()
virtual void SetTutorialStartingPage (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 ()
virtual void WarningMessage (const char *message)
virtual void ErrorMessage (const char *message)
virtual void DebugMessage (const char *message)
virtual void InformationMessage (const char *message)
virtual void DisplayLogDialog (vtkKWTopLevel *master)
virtual vtkKWLogDialogGetLogDialog ()
virtual void DisplayTclInteractor (vtkKWTopLevel *master)
virtual vtkKWTclInteractorGetTclInteractor ()
virtual void CreateEmailMessageDialog (vtkKWMessageDialog *dlg, const char *to, const char *subject, const char *message, const char *attachment_filename)
virtual void CreateSplashScreen ()
virtual void ConfigureAboutDialog ()
virtual void AddAboutText (ostream &)
virtual void AddAboutCopyrights (ostream &)
virtual int CreateLogDialog ()
virtual void InstallOutputWindow ()
virtual void RestoreOutputWindow ()
static int CheckForArgument (int argc, char *argv[], const char *arg, int &index)
static int CheckForValuedArgument (int argc, char *argv[], const char *arg, int &index, int &value_pos)
static Tcl_Interp * InitializeVTK (Tcl_Interp *interp, ostream *err=0)

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.

Events:
vtkKWEvent::WarningMessageEvent vtkKWEvent::DebugMessageEvent vtkKWEvent::ErrorMessageEvent vtkKWEvent::InformationMessageEvent

Definition at line 49 of file vtkKWApplication.h.


Member Typedef Documentation

Reimplemented from vtkKWObject.

Definition at line 54 of file vtkKWApplication.h.


Constructor & Destructor Documentation

vtkKWApplication::vtkKWApplication (  )  [protected]
vtkKWApplication::~vtkKWApplication (  )  [protected]

Member Function Documentation

static vtkKWApplication* vtkKWApplication::New (  )  [static]

Reimplemented from vtkKWObject.

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

Reimplemented from vtkKWObject.

static int vtkKWApplication::IsTypeOf ( const char *  type  )  [static]

Reimplemented from vtkKWObject.

virtual int vtkKWApplication::IsA ( const char *  type  )  [virtual]

Reimplemented from vtkKWObject.

static vtkKWApplication* vtkKWApplication::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkKWObject.

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

Reimplemented from vtkKWObject.

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 62 of file vtkKWApplication.h.

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

Some constants BTX

virtual void vtkKWApplication::Start (  )  [virtual]

Start running the application, with or without arguments, and enter the event loop. The application will exit the event loop once every windows has been closed. As a convenience, if one (or more) window has been added to the application (using AddWindow()), and none of them has been mapped on the screen yet, the application will automatically display the first window by calling its Display() method.

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

Some constants BTX

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

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

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

virtual int vtkKWApplication::GetPromptBeforeExit (  )  [virtual]

Some constants BTX

virtual void vtkKWApplication::PromptBeforeExitOn (  )  [virtual]

Some constants BTX

virtual void vtkKWApplication::PromptBeforeExitOff (  )  [virtual]

Some constants BTX

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]

Some constants BTX

virtual int vtkKWApplication::GetInExit (  )  [virtual]

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

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

Set/Get if the error log should be sent.emailed before application exits.

virtual int vtkKWApplication::GetSendErrorLogBeforeExit (  )  [virtual]

Some constants BTX

virtual void vtkKWApplication::SendErrorLogBeforeExitOn (  )  [virtual]

Some constants BTX

virtual void vtkKWApplication::SendErrorLogBeforeExitOff (  )  [virtual]

Some constants BTX

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

Add, remove (i.e. close), or retrieve a window to/from 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]

Some constants BTX

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

Some constants BTX

virtual int vtkKWApplication::GetNumberOfWindows (  )  [virtual]

Get the number of windows, the number of windows mapped on screen.

virtual int vtkKWApplication::GetNumberOfWindowsMapped (  )  [virtual]

Some constants BTX

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]

Some constants BTX

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

Get the major and minor application version.

virtual int vtkKWApplication::GetMajorVersion (  )  [virtual]

Some constants BTX

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

Some constants BTX

virtual int vtkKWApplication::GetMinorVersion (  )  [virtual]

Some constants BTX

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

Some constants BTX

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]

Some constants BTX

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

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 int vtkKWApplication::GetMostRecentVersionLaunched ( int *  major,
int *  minor 
) [virtual]

Get the most recent version this application was ever launched, if known. Each time this application is closed, its version is automatically saved to the registry (provided that this version is the most recent). Use this method to retrieve which most recent version was ever launched by your user. This can be used by newer application to detect if some migration is needed to upgrade from an older version. Returns 0 if no most recent version was ever recorded, or if it can not be parsed.

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 void vtkKWApplication::SetReleaseMode ( int   )  [virtual]
virtual void vtkKWApplication::ReleaseModeOn (  )  [virtual]
virtual void vtkKWApplication::ReleaseModeOff (  )  [virtual]
virtual int vtkKWApplication::GetReleaseMode (  )  [virtual]
virtual const char* vtkKWApplication::GetInstallationDirectory (  )  [virtual]

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

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

Some constants BTX

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

Set/Get the directory in which the application can store user data. On Windows, this is usually: C: and Settings<username> Documents On Unix/MacOSX, this is usually: $HOME/.NameOfTheApplication (ex: /users/barre/.VolView)

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

Some constants BTX

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]

Run an AppleScript provided as a string (don't forget to escape the quotes). Only on Apple platforms. Return 1 if successful, 0 otherwise

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]

Some constants BTX

virtual void vtkKWApplication::ExitAfterLoadScriptOff (  )  [virtual]

Some constants BTX

virtual int vtkKWApplication::GetExitAfterLoadScript (  )  [virtual]

Some constants BTX

virtual double vtkKWApplication::GetPrintTargetDPI (  )  [virtual]

Set/Get the print quality.

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

Some constants BTX

vtkKWRegistryHelper* vtkKWApplication::GetRegistryHelper (  ) 

Get the Registry object. BTX

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

Set/Get the registry application version name - this usually is the application name postfixed with the *major* version number. The minor version is not used so that application settings are maintained between minor version changes. It is typically used as the master key to store registry settings (ex: VolView 3, ParaView1, etc.)

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

Some constants 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]

Some constants BTX

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]

Some constants BTX

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

Some constants BTX

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

Some constants BTX

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

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]

Some constants BTX

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

Some constants BTX

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

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]

Some constants BTX

virtual void vtkKWApplication::RestoreApplicationSettingsFromRegistry (  )  [virtual]
virtual void vtkKWApplication::SaveApplicationSettingsToRegistry (  )  [virtual]
vtkKWOptionDataBase* vtkKWApplication::GetOptionDataBase (  ) 

Get the database option object. BTX

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

Set/Get if this application supports a splash screen

virtual int vtkKWApplication::GetSupportSplashScreen (  )  [virtual]

Some constants BTX

virtual void vtkKWApplication::SupportSplashScreenOn (  )  [virtual]

Some constants BTX

virtual void vtkKWApplication::SupportSplashScreenOff (  )  [virtual]

Some constants BTX

virtual int vtkKWApplication::GetSplashScreenVisibility (  )  [virtual]

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

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

Some constants BTX

virtual void vtkKWApplication::SplashScreenVisibilityOn (  )  [virtual]

Some constants BTX

virtual void vtkKWApplication::SplashScreenVisibilityOff (  )  [virtual]

Some constants BTX

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

Retrieve the splash screen object This will also 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).

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

Some constants BTX

virtual void vtkKWApplication::SaveUserInterfaceGeometryOn (  )  [virtual]

Some constants BTX

virtual void vtkKWApplication::SaveUserInterfaceGeometryOff (  )  [virtual]

Some constants BTX

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

Get/Set the internal character encoding of the application.

virtual int vtkKWApplication::GetCharacterEncoding (  )  [virtual]

Some constants BTX

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]

Some constants BTX

virtual void vtkKWApplication::SetTheme ( vtkKWTheme theme  )  [virtual]

Get/Set the current theme. This will install the theme automatically.

virtual vtkKWTheme* vtkKWApplication::GetTheme (  )  [virtual]

Some constants BTX

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]

Some constants BTX

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

Some constants BTX

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

Some constants BTX

virtual int vtkKWApplication::SendEmail ( const char *  to,
const char *  subject,
const char *  message,
const char *  attachment_filename,
const char *  extra_error_msg = NULL 
) [virtual]

Send email (win32 only for the moment, use MAPI).

virtual void vtkKWApplication::AddEmailFeedbackBody ( ostream &   )  [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 &   )  [virtual]

Some constants BTX

virtual void vtkKWApplication::DisplayHelpDialog ( vtkKWTopLevel master  )  [virtual]

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

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]

Some constants BTX

virtual void vtkKWApplication::DisplayTutorial ( vtkKWTopLevel master  )  [virtual]

Display the on-line tutorial for this application. Optionally provide a master window this dialog should be the slave of.

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

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

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

Some constants BTX

virtual void vtkKWApplication::DisplayAboutDialog ( vtkKWTopLevel master  )  [virtual]

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

virtual vtkKWBalloonHelpManager* vtkKWApplication::GetBalloonHelpManager (  )  [virtual]

Return the Balloon Help helper object.

virtual vtkKWColorPickerDialog* vtkKWApplication::GetColorPickerDialog (  )  [virtual]

Return the appplication-wide color picker dialog. Redefine this method in your application sub-class to provide a customized color picker.

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

Evaluate Tcl script/code and perform argument substitutions. BTX

Reimplemented from vtkKWObject.

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

Some constants BTX

static Tcl_Interp* vtkKWApplication::GetMainInterp (  )  [static]

Get the interpreter being used by this application

static 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

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

Some constants 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]

Some constants BTX

virtual int vtkKWApplication::IsDialogUp (  )  [virtual]

Some constants BTX

int vtkKWApplication::OpenLink ( const char *  link  ) 

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

int vtkKWApplication::ExploreLink ( const char *  link  ) 

Explore link. On Win32, this will launch the Explorer, open it in the directory of the link, and eventually select that link itself in the directory.

virtual void vtkKWApplication::ProcessPendingEvents (  )  [virtual]

Process/update pending events. This method brings the application "up to date" by entering the event loop repeatedly until all pending events (including idle callbacks) have been processed.

virtual void vtkKWApplication::ProcessIdleTasks (  )  [virtual]

Process/update idle tasks. This causes operations that are normally deferred, such as display updates and window layout calculations, to be performed immediately.

virtual void vtkKWApplication::InstallTclBgErrorCallback (  )  [virtual]

Install the Tcl background error callback. Individual applications can define a background error command if they wish to handle background errors. A background error is one that occurs in an event handler or some other command that didn't originate with the application. For example, if an error occurs while executing a command specified with asynchronously. The default implementation is to feed the Tcl error message to a vtkErrorMacro.

virtual void vtkKWApplication::WarningMessage ( const char *  message  )  [virtual]

Popup a warning/error/information/debug message.

virtual void vtkKWApplication::ErrorMessage ( const char *  message  )  [virtual]

Some constants BTX

virtual void vtkKWApplication::DebugMessage ( const char *  message  )  [virtual]

Some constants BTX

virtual void vtkKWApplication::InformationMessage ( const char *  message  )  [virtual]

Some constants BTX

virtual void vtkKWApplication::DisplayLogDialog ( vtkKWTopLevel master  )  [virtual]

Display the warning/error/information/debug message log dialog. Optionally provide a master window this dialog should be the slave of.

virtual vtkKWLogDialog* vtkKWApplication::GetLogDialog (  )  [virtual]

Some constants BTX

virtual void vtkKWApplication::DisplayTclInteractor ( vtkKWTopLevel master  )  [virtual]

Get/display the tcl interactor. Optionally provide a master window this dialog should be the slave of.

virtual vtkKWTclInteractor* vtkKWApplication::GetTclInteractor (  )  [virtual]

Some constants BTX

virtual void vtkKWApplication::AddSystemInformation ( ostream &   )  [virtual]

Add system information to a stream. Will be used to report system info in the About dialog, or the Feedback email...

virtual void vtkKWApplication::TclBgErrorCallback ( const char *  message  )  [virtual]

Callbacks. Internal, do not use.

static int vtkKWApplication::PutEnv ( const char *  value  )  [static]

Put a string into the environment of the form var=value

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::CreateEmailMessageDialog ( vtkKWMessageDialog dlg,
const char *  to,
const char *  subject,
const char *  message,
const char *  attachment_filename 
) [protected, virtual]

Create email message dialog (in case of error).

virtual void vtkKWApplication::DisplayHelpPage ( const char *  page,
vtkKWTopLevel master 
) [protected, virtual]

Display an on-line help page. Used by DisplayHelpDialog() and DisplayTutorial() Optionally provide a master window this dialog should be the slave of.

virtual int vtkKWApplication::DisplayExitDialog ( vtkKWTopLevel 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 int vtkKWApplication::SendErrorLog (  )  [protected, virtual]

Send the error log (prompt first).

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

Some constants BTX

Definition at line 631 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.

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

Some constants BTX

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

Some constants BTX

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

Give a change to the application to parse the command-line arguments and set some variables accordingly. Subclasses that do not intend to call their super's Start(argc, argv) should make sure they call their super's ParseCommandLineArguments.

static 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.

static 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.

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

Initialize VTK's Tcl packages Return NULL on error (eventually provides an ostream where detailed error messages will be stored). BTX

virtual int vtkKWApplication::CreateLogDialog (  )  [protected, virtual]

Some constants BTX

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

Install/restore output window

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

Some constants BTX


Member Data Documentation

const char* vtkKWApplication::ExitDialogName [static]

Some constants BTX

Definition at line 550 of file vtkKWApplication.h.

Some constants BTX

Definition at line 551 of file vtkKWApplication.h.

Some constants BTX

Definition at line 552 of file vtkKWApplication.h.

Some constants BTX

Definition at line 553 of file vtkKWApplication.h.

Some constants BTX

Definition at line 554 of file vtkKWApplication.h.

Some constants BTX

Definition at line 555 of file vtkKWApplication.h.

Some constants BTX

Definition at line 556 of file vtkKWApplication.h.

User data directory

Definition at line 577 of file vtkKWApplication.h.

Definition at line 579 of file vtkKWApplication.h.

Help starting page

Definition at line 592 of file vtkKWApplication.h.

Tutorial starting page

Definition at line 595 of file vtkKWApplication.h.

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 610 of file vtkKWApplication.h.

int vtkKWApplication::InExit [protected]

Some constants BTX

Definition at line 611 of file vtkKWApplication.h.

Some constants BTX

Definition at line 612 of file vtkKWApplication.h.

Some constants BTX

Definition at line 613 of file vtkKWApplication.h.

Some constants BTX

Definition at line 614 of file vtkKWApplication.h.

int vtkKWApplication::DialogUp [protected]

Number of dialog that are up. See Un/RegisterDialogUp().

Definition at line 621 of file vtkKWApplication.h.

Registry level. If a call to Set/GetRegistryValue uses a level above this ivar, the operation is ignored.

Definition at line 625 of file vtkKWApplication.h.

Flag stating if application supports splash screen, and shows it

Definition at line 629 of file vtkKWApplication.h.

Some constants BTX

Definition at line 630 of file vtkKWApplication.h.

Flag stating if the UI geometry should be saved before exiting

Definition at line 631 of file vtkKWApplication.h.

Some constants BTX

Definition at line 644 of file vtkKWApplication.h.

Some constants BTX

Definition at line 645 of file vtkKWApplication.h.

Some constants BTX

Definition at line 646 of file vtkKWApplication.h.

Character encoding (is passed to Tcl)

Definition at line 650 of file vtkKWApplication.h.

Print DPI

Definition at line 653 of file vtkKWApplication.h.

Current theme

Definition at line 656 of file vtkKWApplication.h.

vtkKWApplicationInternals* vtkKWApplication::Internals [protected]

Definition at line 692 of file vtkKWApplication.h.

Log dialog

Definition at line 704 of file vtkKWApplication.h.

Tcl interactor.

Definition at line 715 of file vtkKWApplication.h.

Color picker dialog

Definition at line 718 of file vtkKWApplication.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on Tue Apr 27 02:33:20 2010 for KWWidgets by  doxygen 1.6.1