vtkKWWindowBase Class Reference

a window superclass More...

#include <vtkKWWindowBase.h>

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

List of all members.

Public Types

typedef vtkKWTopLevel Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual int Close ()
virtual vtkKWFrameGetViewFrame ()
virtual void InsertRecentFilesMenu (int pos, vtkObject *target)
virtual char * GetTitle ()
virtual void Update ()
virtual void UpdateToolbarState ()
virtual void PrepareForDelete ()

Static Public Member Functions

static vtkKWWindowBaseNew ()
static int IsTypeOf (const char *type)
static vtkKWWindowBaseSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkKWWindowBase ()
 ~vtkKWWindowBase ()
virtual void CreateWidget ()
virtual int DisplayCloseDialog ()
virtual void Pack ()

Protected Attributes

vtkKWMostRecentFilesManagerMostRecentFilesManager
vtkKWKeyBindingsManagerKeyBindingsManager
vtkKWSeparatorMenuBarSeparator
vtkKWFrameMainFrame
vtkKWSeparatorStatusFrameSeparator
vtkKWFrameStatusFrame
vtkKWLabelStatusImage
vtkKWLabelStatusLabel
vtkKWProgressGaugeProgressGauge
int ProgressGaugePosition
vtkKWFrameTrayFrame
vtkKWLabelTrayImageError
int TrayFramePosition
vtkKWToolbarSetMainToolbarSet
vtkKWToolbarStatusToolbar
char * ScriptExtension
char * ScriptType
int SupportHelp
int SupportPrint
int PromptBeforeClose
int StatusFrameVisibility
vtkKWMenuFileMenu
vtkKWMenuEditMenu
vtkKWMenuViewMenu
vtkKWMenuWindowMenu
vtkKWMenuHelpMenu
vtkKWMenuToolbarsVisibilityMenu
vtkKWTclInteractorTclInteractor



enum  { ErrorIconNone = 0, ErrorIconBlack, ErrorIconRed }
enum  { ProgressGaugePositionStatusFrame = 0, ProgressGaugePositionToolbar }
enum  { TrayFramePositionStatusFrame = 0, TrayFramePositionToolbar }
enum  { WindowClosingEvent = 10000 }
virtual void SetPromptBeforeClose (int)
virtual int GetPromptBeforeClose ()
virtual void PromptBeforeCloseOn ()
virtual void PromptBeforeCloseOff ()
virtual void LoadScript ()
virtual void LoadScript (const char *filename)
virtual void SetScriptExtension (const char *)
virtual char * GetScriptExtension ()
virtual void SetScriptType (const char *)
virtual char * GetScriptType ()
virtual void SetStatusText (const char *)
virtual const char * GetStatusText ()
virtual void SetErrorIcon (int)
virtual void SetErrorIconToNone ()
virtual void SetErrorIconToBlack ()
virtual void SetErrorIconToRed ()
virtual vtkKWToolbarSetGetMainToolbarSet ()
virtual vtkKWFrameGetStatusFrame ()
virtual void SetStatusFrameVisibility (int flag)
virtual int GetStatusFrameVisibility ()
virtual void StatusFrameVisibilityOn ()
virtual void StatusFrameVisibilityOff ()
virtual vtkKWProgressGaugeGetProgressGauge ()
virtual void SetProgressGaugePosition (int)
virtual void SetProgressGaugePositionToStatusFrame ()
virtual void SetProgressGaugePositionToToolbar ()
virtual vtkKWFrameGetTrayFrame ()
virtual int GetTrayFramePosition ()
virtual void SetTrayFramePosition (int)
virtual void SetTrayFramePositionToStatusFrame ()
virtual void SetTrayFramePositionToToolbar ()
vtkKWMenuGetFileMenu ()
vtkKWMenuGetEditMenu ()
vtkKWMenuGetViewMenu ()
vtkKWMenuGetWindowMenu ()
vtkKWMenuGetHelpMenu ()
vtkKWMenuGetToolbarsVisibilityMenu ()
virtual vtkKWSeparatorGetMenuBarSeparator ()
virtual int GetFileMenuInsertPosition ()
virtual int GetHelpMenuInsertPosition ()
virtual int GetViewMenuInsertPosition ()
virtual void SetSupportHelp (int)
virtual int GetSupportHelp ()
virtual void SupportHelpOn ()
virtual void SupportHelpOff ()
virtual void AddRecentFile (const char *filename, vtkObject *target, const char *command)
virtual void SetSupportPrint (int)
virtual int GetSupportPrint ()
virtual void SupportPrintOn ()
virtual void SupportPrintOff ()
virtual vtkKWKeyBindingsManagerGetKeyBindingsManager ()
virtual void UpdateEnableState ()
virtual void UpdateMenuState ()
virtual char * GetPrintOptionsMenuLabel ()
virtual char * GetFileMenuLabel ()
virtual char * GetFileCloseMenuLabel ()
virtual char * GetFileExitMenuLabel ()
virtual char * GetOpenRecentFileMenuLabel ()
virtual char * GetEditMenuLabel ()
virtual char * GetViewMenuLabel ()
virtual char * GetWindowMenuLabel ()
virtual char * GetHelpMenuLabel ()
virtual char * GetHelpAboutMenuLabel ()
virtual char * GetHelpTopicsMenuLabel ()
virtual char * GetHelpTutorialMenuLabel ()
virtual char * GetHelpKeyBindingsMenuLabel ()
virtual char * GetHelpCheckForUpdatesMenuLabel ()
virtual char * GetToolbarsVisibilityMenuLabel ()
virtual char * GetWindowGeometryRegKey ()
virtual char * GetDefaultGeometry ()
virtual void AddCallbackCommandObservers ()
virtual void RemoveCallbackCommandObservers ()
virtual void AddErrorCallbackCommandObservers ()
virtual void RemoveErrorCallbackCommandObservers ()
virtual void ErrorIconCallback ()
virtual void PrintSettingsCallback ()
virtual void ToolbarVisibilityChangedCallback (vtkKWToolbar *)
virtual void NumberOfToolbarsChangedCallback ()
virtual void DisplayKeyBindingsCallback ()
virtual void UpdateStatusImage ()
virtual vtkKWLabelGetStatusImage ()
virtual void SaveWindowGeometryToRegistry ()
virtual void RestoreWindowGeometryFromRegistry ()
virtual void PopulateFileMenu ()
virtual void PopulateEditMenu ()
virtual void PopulateViewMenu ()
virtual void PopulateWindowMenu ()
virtual void PopulateHelpMenu ()
virtual void SetPrintOptionsMenuLabel (const char *)
virtual void SetFileMenuLabel (const char *)
virtual void SetFileCloseMenuLabel (const char *)
virtual void SetFileExitMenuLabel (const char *)
virtual void SetOpenRecentFileMenuLabel (const char *)
virtual void SetEditMenuLabel (const char *)
virtual void SetViewMenuLabel (const char *)
virtual void SetWindowMenuLabel (const char *)
virtual void SetHelpMenuLabel (const char *)
virtual void SetHelpTopicsMenuLabel (const char *)
virtual void SetHelpTutorialMenuLabel (const char *)
virtual void SetHelpKeyBindingsMenuLabel (const char *)
virtual void SetHelpAboutMenuLabel (const char *)
virtual void SetHelpCheckForUpdatesMenuLabel (const char *)
virtual void SetToolbarsVisibilityMenuLabel (const char *)
virtual void SetWindowGeometryRegKey (const char *)
virtual void SetDefaultGeometry (const char *)
virtual void ProcessCallbackCommandEvents (vtkObject *caller, unsigned long event, void *calldata)

Detailed Description

a window superclass

This class represents a top level window with a menu bar, a status line and a main central frame.

Events:
vtkKWWindowBase::WindowClosingEvent

Definition at line 39 of file vtkKWWindowBase.h.


Member Typedef Documentation

Reimplemented from vtkKWTopLevel.

Reimplemented in vtkKWWindow.

Definition at line 44 of file vtkKWWindowBase.h.


Member Enumeration Documentation

anonymous enum

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

Enumerator:
ErrorIconNone 
ErrorIconBlack 
ErrorIconRed 

Definition at line 93 of file vtkKWWindowBase.h.

anonymous enum

Set the progress gauge position. The default position is in the status frame, but this object can also be displayed in a toolbar, on top of the window. This is useful when StatusFrameVisibility is set to Off. BTX

Enumerator:
ProgressGaugePositionStatusFrame 
ProgressGaugePositionToolbar 

Definition at line 155 of file vtkKWWindowBase.h.

anonymous enum

Set the tray frame position. The default position is in the status frame, but this object can also be displayed in a toolbar, on top of the window. This is useful when StatusFrameVisibility is set to Off. BTX

Enumerator:
TrayFramePositionStatusFrame 
TrayFramePositionToolbar 

Definition at line 182 of file vtkKWWindowBase.h.

anonymous enum

Events. WindowClosedEvent is called when the window is closing. It is triggered right before requesting the application to remove the window instance from its window pool (vtkKWApplication::RemoveWindow). BTX

Enumerator:
WindowClosingEvent 

Definition at line 326 of file vtkKWWindowBase.h.


Constructor & Destructor Documentation

vtkKWWindowBase::vtkKWWindowBase (  )  [protected]
vtkKWWindowBase::~vtkKWWindowBase (  )  [protected]

Member Function Documentation

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

Reimplemented from vtkKWTopLevel.

Reimplemented in vtkKWWindow.

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

Reimplemented from vtkKWTopLevel.

Reimplemented in vtkKWWindow.

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

Reimplemented from vtkKWTopLevel.

Reimplemented in vtkKWWindow.

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

Reimplemented from vtkKWTopLevel.

Reimplemented in vtkKWWindow.

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

Reimplemented from vtkKWTopLevel.

Reimplemented in vtkKWWindow.

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

Reimplemented from vtkKWTopLevel.

Reimplemented in vtkKWWindow.

virtual int vtkKWWindowBase::Close (  )  [virtual]

Close this window, possibly prompting the user. Note that the current vtkKWApplication implementation will exit the application if no more windows are open. Return 1 if the window closed successfully, 0 otherwise (for example, if some dialogs are still up, or the user did not confirm, etc).

virtual void vtkKWWindowBase::SetPromptBeforeClose ( int   )  [virtual]

Set/Get if a confirmation dialog should be displayed before a window is closed. Default to false.

virtual int vtkKWWindowBase::GetPromptBeforeClose (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::PromptBeforeCloseOn (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::PromptBeforeCloseOff (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::LoadScript (  )  [virtual]

Load and evaluate a Tcl based script. If called without an argument it will open a file dialog. This implementation basically forwards the call to vtkKWApplication::LoadScript.

virtual void vtkKWWindowBase::LoadScript ( const char *  filename  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetScriptExtension ( const char *   )  [virtual]

The extension used in LoadScript. Default is .tcl.

virtual char* vtkKWWindowBase::GetScriptExtension (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetScriptType ( const char *   )  [virtual]

The type name used in LoadScript. Default is Tcl.

virtual char* vtkKWWindowBase::GetScriptType (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetStatusText ( const char *   )  [virtual]

Set the text for the status bar of this window.

virtual const char* vtkKWWindowBase::GetStatusText (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetErrorIcon ( int   )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetErrorIconToNone (  )  [inline, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

Definition at line 101 of file vtkKWWindowBase.h.

virtual void vtkKWWindowBase::SetErrorIconToBlack (  )  [inline, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

Definition at line 103 of file vtkKWWindowBase.h.

virtual void vtkKWWindowBase::SetErrorIconToRed (  )  [inline, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

Definition at line 105 of file vtkKWWindowBase.h.

virtual vtkKWFrame* vtkKWWindowBase::GetViewFrame (  )  [virtual]

The window is made of a menu bar (methods are available to access each menus), a separator, a toolbar placeholder, a large main frame called the "view frame", and a status frame (inside which the a progress gauge and some other UI elements can be found). Note that this large frame is likely to be re-allocated by subclasses into a different UI structure involving panels, notebooks, interface managers, etc. therefore GetViewFrame() will be overriden in order to return the most convenient viewing frame. The rational here is that GetViewFrame() always return the frame that can be used by users or developpers to add more "viewing" element (say, renderwidgets, 3D scenes), without knowing about the current layout.

Reimplemented in vtkKWWindow.

virtual vtkKWToolbarSet* vtkKWWindowBase::GetMainToolbarSet (  )  [virtual]

Get the main toolbar set.

virtual vtkKWFrame* vtkKWWindowBase::GetStatusFrame (  )  [virtual]

Get the status frame object.

virtual void vtkKWWindowBase::SetStatusFrameVisibility ( int  flag  )  [virtual]

Set/Get the visibility of the status frame. If set to Off, the status text, as set by SetStatusText(), will not be displayed anymore. Neither will the progress gauge, the application icon, the tray frame and status icons. Both the progress gauge and tray frame position can be changed independently though (see SetProgressGaugePosition and SetTrayFramePosition).

virtual int vtkKWWindowBase::GetStatusFrameVisibility (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::StatusFrameVisibilityOn (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::StatusFrameVisibilityOff (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual vtkKWProgressGauge* vtkKWWindowBase::GetProgressGauge (  )  [virtual]

Get the progress gauge widget. The progress gauge is displayed in the Status frame on the bottom right corner of the window.

virtual void vtkKWWindowBase::SetProgressGaugePosition ( int   )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetProgressGaugePositionToStatusFrame (  )  [inline, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

Definition at line 162 of file vtkKWWindowBase.h.

virtual void vtkKWWindowBase::SetProgressGaugePositionToToolbar (  )  [inline, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

Definition at line 165 of file vtkKWWindowBase.h.

virtual vtkKWFrame* vtkKWWindowBase::GetTrayFrame (  )  [virtual]

Get the tray frame object. A default status icon is already packed in this frame and modified by SetErrorIcon, but other icons can probably fit there.

virtual int vtkKWWindowBase::GetTrayFramePosition (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetTrayFramePosition ( int   )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetTrayFramePositionToStatusFrame (  )  [inline, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

Definition at line 190 of file vtkKWWindowBase.h.

virtual void vtkKWWindowBase::SetTrayFramePositionToToolbar (  )  [inline, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

Definition at line 193 of file vtkKWWindowBase.h.

vtkKWMenu* vtkKWWindowBase::GetFileMenu (  ) 

Get the menu objects. This will allocate and create them on the fly. Several convenience functions are also available to get the position where to safely insert entries in those menus without interferring with entries that should stay at the end of the menus. Note: if you need to enable/disable a menu item conditionally in a subclass, do it so by reimplementing UpdateMenuState(); do not forget to call the parent class's UpdateMenuState() from the subclass as well.

vtkKWMenu* vtkKWWindowBase::GetEditMenu (  ) 

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

vtkKWMenu* vtkKWWindowBase::GetViewMenu (  ) 

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

vtkKWMenu* vtkKWWindowBase::GetWindowMenu (  ) 

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

vtkKWMenu* vtkKWWindowBase::GetHelpMenu (  ) 

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

vtkKWMenu* vtkKWWindowBase::GetToolbarsVisibilityMenu (  ) 

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual vtkKWSeparator* vtkKWWindowBase::GetMenuBarSeparator (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual int vtkKWWindowBase::GetFileMenuInsertPosition (  )  [virtual]

Convenience method that return the position where to safely insert entries in the corresponding menu without interferring with entries that should stay at the end of the menu. At the moment, GetFileMenuInsertPosition() checks for the 'close', 'exit' or 'print setup' commands, GetHelpMenuInsertPosition() checks for the 'about' commands, GetViewMenuInsertPosition() is available for subclasses to be redefined.

virtual int vtkKWWindowBase::GetHelpMenuInsertPosition (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual int vtkKWWindowBase::GetViewMenuInsertPosition (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetSupportHelp ( int   )  [virtual]

Set/Get a hint about help support. Disabled by default. If set to true (programmatically or by a superclass), it will hint the instance about populating the help menu with common entries. For example, an entry invoking the application's DisplayHelpDialog or DisplayTutorial.

virtual int vtkKWWindowBase::GetSupportHelp (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SupportHelpOn (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SupportHelpOff (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::AddRecentFile ( const char *  filename,
vtkObject target,
const char *  command 
) [virtual]

Add a file to the Recent File list, and save the whole list to the registry. If the "Recent files" sub-menu has been inserted at that point (see the InsertRecentFilesMenu method), it will be updated as well.

virtual void vtkKWWindowBase::InsertRecentFilesMenu ( int  pos,
vtkObject target 
) [virtual]

Insert a "Recent Files" sub-menu to the File menu at position 'pos' and fill it with the most recent files stored in the registry. The 'target' parameter is the object against which the command associated to a most recent file will be executed (usually the instance).

virtual void vtkKWWindowBase::SetSupportPrint ( int   )  [virtual]

Set/Get a hint about print support. Disabled by default. If set to true (programmatically or by a superclass), it will hint the instance about populating some menus with common print-related entries. For example, an entry in the file menu to set up print options like the application's PrintTargetDPI.

virtual int vtkKWWindowBase::GetSupportPrint (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SupportPrintOn (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SupportPrintOff (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual vtkKWKeyBindingsManager* vtkKWWindowBase::GetKeyBindingsManager (  )  [virtual]

Get the key bindings manager.

Reimplemented from vtkKWWidget.

virtual char* vtkKWWindowBase::GetTitle (  )  [virtual]

Get title of window. Override the superclass to use app name if the title was not set

Reimplemented from vtkKWTopLevel.

virtual void vtkKWWindowBase::Update (  )  [virtual]

Update the UI. This will call: UpdateToolbarState UpdateEnableState UpdateMenuState Update on all panels belonging to the UserInterfaceManager, if any

Reimplemented in vtkKWWindow.

virtual void vtkKWWindowBase::UpdateToolbarState (  )  [virtual]

Update the toolbar state

Reimplemented in vtkKWWindow.

virtual void vtkKWWindowBase::UpdateEnableState (  )  [virtual]

Update the "enable" state of the object and its internal parts. Depending on different Ivars (this->Enabled, the application's Limited Edition Mode, etc.), the "enable" state of the object is updated and propagated to its internal parts/subwidgets. This will, for example, enable/disable parts of the widget UI, enable/disable the visibility of 3D widgets, etc. Note: if you need to enable/disable a menu item conditionally in a subclass, do it so by reimplementing UpdateMenuState(); do not forget to call the parent class's UpdateMenuState() from the subclass as well.

Reimplemented from vtkKWTopLevel.

Reimplemented in vtkKWWindow.

virtual void vtkKWWindowBase::UpdateMenuState (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

Reimplemented in vtkKWWindow.

virtual void vtkKWWindowBase::PrepareForDelete (  )  [virtual]

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

Reimplemented in vtkKWWindow.

virtual char* vtkKWWindowBase::GetPrintOptionsMenuLabel (  )  [virtual]

Some constants

virtual char* vtkKWWindowBase::GetFileMenuLabel (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual char* vtkKWWindowBase::GetFileCloseMenuLabel (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual char* vtkKWWindowBase::GetFileExitMenuLabel (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual char* vtkKWWindowBase::GetOpenRecentFileMenuLabel (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual char* vtkKWWindowBase::GetEditMenuLabel (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual char* vtkKWWindowBase::GetViewMenuLabel (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual char* vtkKWWindowBase::GetWindowMenuLabel (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual char* vtkKWWindowBase::GetHelpMenuLabel (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual char* vtkKWWindowBase::GetHelpAboutMenuLabel (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual char* vtkKWWindowBase::GetHelpTopicsMenuLabel (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual char* vtkKWWindowBase::GetHelpTutorialMenuLabel (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual char* vtkKWWindowBase::GetHelpKeyBindingsMenuLabel (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual char* vtkKWWindowBase::GetHelpCheckForUpdatesMenuLabel (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual char* vtkKWWindowBase::GetToolbarsVisibilityMenuLabel (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual char* vtkKWWindowBase::GetWindowGeometryRegKey (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual char* vtkKWWindowBase::GetDefaultGeometry (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::AddCallbackCommandObservers (  )  [virtual]

Add all the default observers needed by that object, or remove all the observers that were added through AddCallbackCommandObserver. Subclasses can override these methods to add/remove their own default observers, but should call the superclass too.

Reimplemented from vtkKWObject.

Reimplemented in vtkKWWindow.

virtual void vtkKWWindowBase::RemoveCallbackCommandObservers (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

Reimplemented from vtkKWObject.

Reimplemented in vtkKWWindow.

virtual void vtkKWWindowBase::AddErrorCallbackCommandObservers (  )  [virtual]

Add observers required to propagate error messages. Note that they were not put in AddCallbackCommandObservers on purpose, so that they do not get accidentally removed by RemoveCallbackCommandObservers: propagation of error messages, after all, should never be disabled.

virtual void vtkKWWindowBase::RemoveErrorCallbackCommandObservers (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::ErrorIconCallback (  )  [virtual]

Callbacks. Internal, do not use.

virtual void vtkKWWindowBase::PrintSettingsCallback (  )  [inline, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

Reimplemented in vtkKWWindow.

Definition at line 354 of file vtkKWWindowBase.h.

virtual void vtkKWWindowBase::ToolbarVisibilityChangedCallback ( vtkKWToolbar  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

Reimplemented in vtkKWWindow.

virtual void vtkKWWindowBase::NumberOfToolbarsChangedCallback (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

Reimplemented in vtkKWWindow.

virtual void vtkKWWindowBase::DisplayKeyBindingsCallback (  )  [virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::CreateWidget (  )  [protected, virtual]

Create the widget.

Reimplemented from vtkKWTopLevel.

Reimplemented in vtkKWWindow.

virtual int vtkKWWindowBase::DisplayCloseDialog (  )  [protected, virtual]

Display the close dialog. Return 1 if the user wants to close the window, 0 otherwise

virtual void vtkKWWindowBase::UpdateStatusImage (  )  [protected, virtual]

Update the image in the status frame. Usually a logo of some sort. Override this function to include your own application logo

virtual vtkKWLabel* vtkKWWindowBase::GetStatusImage (  )  [protected, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SaveWindowGeometryToRegistry (  )  [protected, virtual]

Save/Restore window geometry

Reimplemented in vtkKWWindow.

virtual void vtkKWWindowBase::RestoreWindowGeometryFromRegistry (  )  [protected, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

Reimplemented in vtkKWWindow.

virtual void vtkKWWindowBase::Pack (  )  [protected, virtual]

Pack/repack the UI

Reimplemented in vtkKWWindow.

virtual void vtkKWWindowBase::PopulateFileMenu (  )  [protected, virtual]

Populate the menus. Note: if you need to enable/disable a menu item conditionally in a subclass, do it so by reimplementing UpdateMenuState(); do not forget to call the parent class's UpdateMenuState() from the subclass as well.

virtual void vtkKWWindowBase::PopulateEditMenu (  )  [protected, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::PopulateViewMenu (  )  [protected, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

Reimplemented in vtkKWWindow.

virtual void vtkKWWindowBase::PopulateWindowMenu (  )  [protected, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

Reimplemented in vtkKWWindow.

virtual void vtkKWWindowBase::PopulateHelpMenu (  )  [protected, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetPrintOptionsMenuLabel ( const char *   )  [protected, virtual]

Some constants

virtual void vtkKWWindowBase::SetFileMenuLabel ( const char *   )  [protected, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetFileCloseMenuLabel ( const char *   )  [protected, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetFileExitMenuLabel ( const char *   )  [protected, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetOpenRecentFileMenuLabel ( const char *   )  [protected, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetEditMenuLabel ( const char *   )  [protected, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetViewMenuLabel ( const char *   )  [protected, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetWindowMenuLabel ( const char *   )  [protected, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetHelpMenuLabel ( const char *   )  [protected, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetHelpTopicsMenuLabel ( const char *   )  [protected, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetHelpTutorialMenuLabel ( const char *   )  [protected, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetHelpKeyBindingsMenuLabel ( const char *   )  [protected, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetHelpAboutMenuLabel ( const char *   )  [protected, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetHelpCheckForUpdatesMenuLabel ( const char *   )  [protected, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetToolbarsVisibilityMenuLabel ( const char *   )  [protected, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetWindowGeometryRegKey ( const char *   )  [protected, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::SetDefaultGeometry ( const char *   )  [protected, virtual]

Set the error/warning icon in the tray. Note that if StatusFrameVisibility is Off, you may want to move the tray frame to a different position (say, in a toolbar), using the SetTrayFramePosition() method. BTX

virtual void vtkKWWindowBase::ProcessCallbackCommandEvents ( vtkObject caller,
unsigned long  event,
void *  calldata 
) [protected, virtual]

Processes the events that are passed through CallbackCommand (or others). Subclasses can oberride this method to process their own events, but should call the superclass too.

Reimplemented from vtkKWObject.

Reimplemented in vtkKWWindow.


Member Data Documentation

Recent files manager

Definition at line 381 of file vtkKWWindowBase.h.

Key bindings manager

Definition at line 384 of file vtkKWWindowBase.h.

Definition at line 395 of file vtkKWWindowBase.h.

Definition at line 396 of file vtkKWWindowBase.h.

Definition at line 398 of file vtkKWWindowBase.h.

Definition at line 399 of file vtkKWWindowBase.h.

Definition at line 400 of file vtkKWWindowBase.h.

Definition at line 401 of file vtkKWWindowBase.h.

Definition at line 403 of file vtkKWWindowBase.h.

Definition at line 404 of file vtkKWWindowBase.h.

Definition at line 406 of file vtkKWWindowBase.h.

Definition at line 407 of file vtkKWWindowBase.h.

Definition at line 408 of file vtkKWWindowBase.h.

Definition at line 410 of file vtkKWWindowBase.h.

Definition at line 411 of file vtkKWWindowBase.h.

Definition at line 413 of file vtkKWWindowBase.h.

char* vtkKWWindowBase::ScriptType [protected]

Definition at line 414 of file vtkKWWindowBase.h.

Definition at line 415 of file vtkKWWindowBase.h.

Definition at line 416 of file vtkKWWindowBase.h.

Definition at line 417 of file vtkKWWindowBase.h.

Definition at line 418 of file vtkKWWindowBase.h.

Definition at line 422 of file vtkKWWindowBase.h.

Definition at line 423 of file vtkKWWindowBase.h.

Definition at line 424 of file vtkKWWindowBase.h.

Definition at line 425 of file vtkKWWindowBase.h.

Definition at line 426 of file vtkKWWindowBase.h.

Definition at line 427 of file vtkKWWindowBase.h.

Definition at line 441 of file vtkKWWindowBase.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:39:21 2010 for KWWidgets by  doxygen 1.6.1