vtkKWWindow Class Reference

a window superclass which holds splittable panels. More...

#include <vtkKWWindow.h>

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

List of all members.

Public Types

typedef vtkKWWindowBase Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual vtkKWFrameGetViewFrame ()
virtual vtkKWToolbarSetGetSecondaryToolbarSet ()
virtual void Render ()
virtual void Update ()
virtual void UpdateToolbarState ()
virtual void PrepareForDelete ()

Static Public Member Functions

static vtkKWWindowNew ()
static int IsTypeOf (const char *type)
static vtkKWWindowSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkKWWindow ()
 ~vtkKWWindow ()
virtual void CreateWidget ()
virtual void Pack ()

Protected Attributes

int PanelLayout
vtkKWSplitFrameMainSplitFrame
vtkKWSplitFrameSecondarySplitFrame
vtkKWApplicationSettingsInterfaceApplicationSettingsInterface
int StatusFramePosition



enum  { PanelLayoutSecondaryBelowView = 0, PanelLayoutSecondaryBelowMain, PanelLayoutSecondaryBelowMainAndView }
enum  { ViewPanelPositionLeft = 0, ViewPanelPositionRight }
enum  {
  StatusFramePositionWindow = 0, StatusFramePositionMainPanel, StatusFramePositionSecondaryPanel, StatusFramePositionViewPanel,
  StatusFramePositionLeftOfDivider, StatusFramePositionRightOfDivider
}
virtual vtkKWFrameGetMainPanelFrame ()
virtual int GetMainPanelVisibility ()
virtual void SetMainPanelVisibility (int)
virtual void MainPanelVisibilityOn ()
virtual void MainPanelVisibilityOff ()
virtual vtkKWNotebookGetMainNotebook ()
virtual int HasMainUserInterfaceManager ()
virtual vtkKWUserInterfaceManagerGetMainUserInterfaceManager ()
virtual void ShowMainUserInterface (const char *name)
virtual vtkKWSplitFrameGetMainSplitFrame ()
virtual vtkKWFrameGetSecondaryPanelFrame ()
virtual int GetSecondaryPanelVisibility ()
virtual void SetSecondaryPanelVisibility (int)
virtual void SecondaryPanelVisibilityOn ()
virtual void SecondaryPanelVisibilityOff ()
virtual vtkKWNotebookGetSecondaryNotebook ()
virtual int HasSecondaryUserInterfaceManager ()
virtual vtkKWUserInterfaceManagerGetSecondaryUserInterfaceManager ()
virtual void ShowSecondaryUserInterface (const char *name)
virtual vtkKWSplitFrameGetSecondarySplitFrame ()
virtual void SetPanelLayout (int)
virtual int GetPanelLayout ()
virtual void SetPanelLayoutToSecondaryBelowView ()
virtual void SetPanelLayoutToSecondaryBelowMain ()
virtual void SetPanelLayoutToSecondaryBelowMainAndView ()
virtual void SetViewPanelPosition (int)
virtual int GetViewPanelPosition ()
virtual void SetViewPanelPositionToLeft ()
virtual void SetViewPanelPositionToRight ()
virtual vtkKWNotebookGetViewNotebook ()
virtual int HasViewUserInterfaceManager ()
virtual vtkKWUserInterfaceManagerGetViewUserInterfaceManager ()
virtual void ShowViewUserInterface (const char *name)
virtual vtkKWFrameGetViewPanelFrame ()
virtual int GetStatusFramePosition ()
virtual void SetStatusFramePosition (int)
virtual void SetStatusFramePositionToWindow ()
virtual void SetStatusFramePositionToMainPanel ()
virtual void SetStatusFramePositionToSecondaryPanel ()
virtual void SetStatusFramePositionToViewPanel ()
virtual void SetStatusFramePositionToLeftOfDivider ()
virtual void SetStatusFramePositionToRightOfDivider ()
virtual vtkKWUserInterfaceManagerGetApplicationSettingsUserInterfaceManager ()
virtual void ShowApplicationSettingsUserInterface (const char *name)
virtual
vtkKWApplicationSettingsInterface
GetApplicationSettingsInterface ()
virtual void UpdateEnableState ()
virtual void UpdateMenuState ()
virtual void MainPanelVisibilityCallback ()
virtual void SecondaryPanelVisibilityCallback ()
virtual void PrintSettingsCallback ()
virtual void ToolbarVisibilityChangedCallback (vtkKWToolbar *)
virtual void NumberOfToolbarsChangedCallback ()
virtual char * GetMainPanelSizeRegKey ()
virtual char * GetMainPanelVisibilityRegKey ()
virtual char * GetMainPanelVisibilityKeyAccelerator ()
virtual char * GetHideMainPanelMenuLabel ()
virtual char * GetShowMainPanelMenuLabel ()
virtual char * GetSecondaryPanelSizeRegKey ()
virtual char * GetSecondaryPanelVisibilityRegKey ()
virtual char * GetSecondaryPanelVisibilityKeyAccelerator ()
virtual char * GetHideSecondaryPanelMenuLabel ()
virtual char * GetShowSecondaryPanelMenuLabel ()
virtual char * GetDefaultViewPanelName ()
virtual char * GetTclInteractorMenuLabel ()
virtual char * GetViewPanelPositionRegKey ()
virtual char * GetLogDialogMenuLabel ()
virtual void AddCallbackCommandObservers ()
virtual void RemoveCallbackCommandObservers ()
virtual void SaveWindowGeometryToRegistry ()
virtual void RestoreWindowGeometryFromRegistry ()
virtual void ShowMainUserInterface (vtkKWUserInterfacePanel *panel)
virtual void ShowSecondaryUserInterface (vtkKWUserInterfacePanel *panel)
virtual void ShowViewUserInterface (vtkKWUserInterfacePanel *panel)
virtual void ShowApplicationSettingsUserInterface (vtkKWUserInterfacePanel *panel)
virtual void SetMainPanelSizeRegKey (const char *)
virtual void SetMainPanelVisibilityRegKey (const char *)
virtual void SetMainPanelVisibilityKeyAccelerator (const char *)
virtual void SetHideMainPanelMenuLabel (const char *)
virtual void SetShowMainPanelMenuLabel (const char *)
virtual void SetSecondaryPanelSizeRegKey (const char *)
virtual void SetSecondaryPanelVisibilityRegKey (const char *)
virtual void SetSecondaryPanelVisibilityKeyAccelerator (const char *)
virtual void SetHideSecondaryPanelMenuLabel (const char *)
virtual void SetShowSecondaryPanelMenuLabel (const char *)
virtual void SetDefaultViewPanelName (const char *)
virtual void SetTclInteractorMenuLabel (const char *)
virtual void SetViewPanelPositionRegKey (const char *)
virtual void SetLogDialogMenuLabel (const char *)
virtual void ProcessCallbackCommandEvents (vtkObject *caller, unsigned long event, void *calldata)
virtual void PopulateWindowMenu ()
virtual void PopulateViewMenu ()

Detailed Description

a window superclass which holds splittable panels.

This class represents a top level window with a menu bar, a status line (as per vtkKWWindowBase) and user interface panels that can be resized and/or collapsed.

Here is the layout of the whole window. Remember that the superclass "view frame" (as returned by GetViewFrame()) was the whole usable space between the menu bar on top (and eventually toolbars) and the status bar at the bottom.

This old "view frame" is now further divided horizontally into two parts by a split frame instance. The first part (on the left) is called the "main panel" area, and can be hidden or shown using the SetMainPanelVisibility() method. A convenience method GetMainPanelFrame() can be used to retrieve that "main panel area" frame, even if it is currently entirely allocated to the main notebook, MainNotebook. The MainNotebook element is packed in the main panel and is used to display interface elements organized as *pages* inside *panels*.

Note that the proper way to do so is to create "user interface panels" (UIP, subclasses of vtkKWUserInterfacePanel), and set their "user interface manager" (UIM) to the main user interface manager, as returned by GetMainUserInterfaceManager(). Since the main UIM is itself attached to the main notebook, it will display the UIP automatically inside the notebook and take care of showing/raising/hiding the pages properly. The ShowMainUserInterface() method can be used to show a main interface panel given its name. The name is typically the string returned by the GetName() method of a vtkKWUserInterfacePanel (UIP). The ShowMainUserInterface() method will query the main UIM to check if it is indeed managing a panel (UIP) with that name, and show/raise that UIP accordingly. If you do not know which user interface manager is used by the panel, just call Show() or Raise() on the panel itself !

Note that by following such framework, a subclass will be free of using a totally different type of UIM, while the UIP implementation and manipulation will remain exactly the same. One just has to focus on creating simple panels to pack user interface components, and the UIM will be responsible for mapping them into a higher-level interface, like a notebook. It will also take care of show/hiding conflicting interfaces, provide some cross-panels features like drag and drop, serialize the UI state, etc.

In the same way, the right part of the MainSplitFrame (i.e., not the main panel itself, but the remaining space on the right side of the separator) is also divided vertically into two parts by a split frame instance. The same methods as described above are available for this secondary subdivision, i.e. SetSecondaryPanelVisibility() can be used to show/hide the secondary panel, GetSecondaryPanelFrame() can be used to retrieve the secondary panel frame, a SecondaryNotebook is packed inside the secondary panel, and GetMainUserInterfaceManager() can be used to retrieve the corresponding UIM.

Below the SecondarySplitFrame is a second toolbar set (SecondaryToolbarSet) available for extra toolbars.

The space available for "viewing", or packing 3D scenes, is returned by GetViewFrame(). Under the hood, a third user interface manager, the ViewUserInterfaceManager is coupled to a ViewNotebook and packed inside the top part of the secondary split frame (i.e. the large part that is not considered a user interface panel). A default page is added to that notebook to provide the frame for GetViewFrame(). Since there is only one page, the tab is not shown by default, leaving all the notebook space available for viewing. This notebook and its user interface manager are likely not be manipulated as often as the other panels and UIM, but can be used to provide multiple "views" for example. As a convenience, a GetViewPanelFrame() method returns the parent of the notebook, i.e. the space into which the notebook was packed, so that other elements can be packed below or before the notebook itself.

A fourth user interface manager is used to display and group all panels related to application settings (i.e. "Preferences"). It is not part of the layout as it will popup as a dialog instead. Note that the panels do not have to bother about that, the manager will parse each panel and create the dialog accordingly. If you have more application settings parameters, just create your own panels and set their UIM to the ApplicationSettingsUserInterfaceManager.

This describes the default layout so far, where the secondary panel is located below the view frame. The PanelLayout ivar can be set to change this layout to different configurations where:

MB: GetMenu() (see vtkKWTopLevel) MTBS: GetMainToolbarSet() (see superclass) MPF: GetMainPanelFrame() MNB: MainNotebook VNB: ViewNotebook VPF: GetViewPanelFrame() VF: GetViewFrame() (first page of the VNB) SPF: GetSecondaryPanelFrame() SNB: SecondaryNotebook STBS: GetSecondaryToolbarSet() SF: GetStatusFrame() (see superclass)

 +----------------------+  +----------------------+  +----------------------+
 |           MB         |  |        MB            |  |        MB            |
 +----------------------+  +----------------------+  +----------------------+
 |           MTBS       |  |           MTBS       |  |           MTBS       |
 +--------+-------------+  +--------+-------------+  +--------+-------------+
 |+--+ MPF|+--+ VPF     |  |+--+ MPF|+--+  VPF    |  |+--+ MPF|+--+    VPF  |
 ||  +---+||  +--------+|  ||  +---+||  +--------+|  ||  +---+||  +--------+|
 ||      |||           ||  ||      |||           ||  ||      |||           ||
 ||      ||| VNB (VF)  ||  ||      |||           ||  ||      |||           ||
 ||      |||           ||  ||      |||           ||  ||      ||| VNB (VF)  ||
 ||      |||           ||  || MNB  |||           ||  || MNB  |||           ||
 ||      ||+-----------+|  ||      |||           ||  ||      |||           ||
 || MNB  |+-------------+  |+------+|| VNB (VF)  ||  ||      |||           ||
 ||      ||+--+  SPF    |  +--------+|           ||  ||      ||+-----------+|
 ||      |||  +--------+|  |+--+ SPF||           ||  |+------+|   STBS      |
 ||      |||           ||  ||  +---+||           ||  +--------+-------------+
 ||      |||  SNB      ||  ||      |||           ||  |+--+ SPF              |
 ||      |||           ||  ||      |||           ||  ||  +-----------------+|
 ||      |||           ||  || SNB  |||           ||  || SNB                ||
 ||      ||+-----------+|  ||      ||+-----------+|  ||                    ||
 |+------+|    STBS     |  |+------+|      STBS   |  |+--------------------+|
 +--------+-------------+  +--------+-------------+  +----------------------+
 |            SF        |  |            SF        |  |            SF        |
 +----------------------+  +----------------------+  +----------------------+
   Secondary below View      Secondary below Main      Secondary below Both
 

Definition at line 160 of file vtkKWWindow.h.


Member Typedef Documentation

Reimplemented from vtkKWWindowBase.

Definition at line 166 of file vtkKWWindow.h.


Member Enumeration Documentation

anonymous enum

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

Enumerator:
PanelLayoutSecondaryBelowView 
PanelLayoutSecondaryBelowMain 
PanelLayoutSecondaryBelowMainAndView 

Definition at line 202 of file vtkKWWindow.h.

anonymous enum

Set the view panel position. Default is on the right of the window. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

Enumerator:
ViewPanelPositionLeft 
ViewPanelPositionRight 

Definition at line 225 of file vtkKWWindow.h.

anonymous enum

Set the status frame position. The default position is at the bottom of the window, but this object can also be displayed at the bottom of the main panel (MainPanel), at the bottom of the secondary panel (SecondaryPanel) or at the bottom of the view panel (ViewPanel). Note that if any of the above is used, the status bar will actually be hidden if the corresponding panel visibility is changed, since the status bar is actually packed in the panel frame itself. Set the position to LeftOfDivider or RightOfDivider to place the status bar out of the panel, but either of the left or the right of the main vertical divider. BTX

Enumerator:
StatusFramePositionWindow 
StatusFramePositionMainPanel 
StatusFramePositionSecondaryPanel 
StatusFramePositionViewPanel 
StatusFramePositionLeftOfDivider 
StatusFramePositionRightOfDivider 

Definition at line 278 of file vtkKWWindow.h.


Constructor & Destructor Documentation

vtkKWWindow::vtkKWWindow (  )  [protected]
vtkKWWindow::~vtkKWWindow (  )  [protected]

Member Function Documentation

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

Reimplemented from vtkKWWindowBase.

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

Reimplemented from vtkKWWindowBase.

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

Reimplemented from vtkKWWindowBase.

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

Reimplemented from vtkKWWindowBase.

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

Reimplemented from vtkKWWindowBase.

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

Reimplemented from vtkKWWindowBase.

virtual vtkKWFrame* vtkKWWindow::GetMainPanelFrame (  )  [virtual]

Main panel. The whole layout of the window is described at length at the beginning of this document.

virtual int vtkKWWindow::GetMainPanelVisibility (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::SetMainPanelVisibility ( int   )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::MainPanelVisibilityOn (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::MainPanelVisibilityOff (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual vtkKWNotebook* vtkKWWindow::GetMainNotebook (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual int vtkKWWindow::HasMainUserInterfaceManager (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual vtkKWUserInterfaceManager* vtkKWWindow::GetMainUserInterfaceManager (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::ShowMainUserInterface ( const char *  name  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual vtkKWSplitFrame* vtkKWWindow::GetMainSplitFrame (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual vtkKWFrame* vtkKWWindow::GetSecondaryPanelFrame (  )  [virtual]

Secondary panel. The whole layout of the window is described at length at the beginning of this document.

virtual int vtkKWWindow::GetSecondaryPanelVisibility (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::SetSecondaryPanelVisibility ( int   )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::SecondaryPanelVisibilityOn (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::SecondaryPanelVisibilityOff (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual vtkKWNotebook* vtkKWWindow::GetSecondaryNotebook (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual int vtkKWWindow::HasSecondaryUserInterfaceManager (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual vtkKWUserInterfaceManager* vtkKWWindow::GetSecondaryUserInterfaceManager (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::ShowSecondaryUserInterface ( const char *  name  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual vtkKWSplitFrame* vtkKWWindow::GetSecondarySplitFrame (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::SetPanelLayout ( int   )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual int vtkKWWindow::GetPanelLayout (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::SetPanelLayoutToSecondaryBelowView (  )  [inline, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

Definition at line 213 of file vtkKWWindow.h.

virtual void vtkKWWindow::SetPanelLayoutToSecondaryBelowMain (  )  [inline, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

Definition at line 215 of file vtkKWWindow.h.

virtual void vtkKWWindow::SetPanelLayoutToSecondaryBelowMainAndView (  )  [inline, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

Definition at line 217 of file vtkKWWindow.h.

virtual void vtkKWWindow::SetViewPanelPosition ( int   )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual int vtkKWWindow::GetViewPanelPosition (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::SetViewPanelPositionToLeft (  )  [inline, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

Definition at line 233 of file vtkKWWindow.h.

virtual void vtkKWWindow::SetViewPanelPositionToRight (  )  [inline, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

Definition at line 235 of file vtkKWWindow.h.

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

Get the frame available for "viewing". Override the superclass to return a page in the notebook of the view user interface manager (located in the first part of the SecondarySplitFrame). This method should be used instead of GetViewPanelFrame(), unless you really need to have both multiple notebook pages and common UI elements on top or below the notebook. 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 from vtkKWWindowBase.

virtual vtkKWNotebook* vtkKWWindow::GetViewNotebook (  )  [virtual]

View panel. The whole layout of the window is described at length at the beginning of this document. This panel is probably not going to be used much, by default it creates a single page in the notebook, which frame is returned by GetViewFrame(). The GetViewPanelFrame() method returns the parent of the notebook, if one really need to pack something out of the GetViewFrame().

virtual int vtkKWWindow::HasViewUserInterfaceManager (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual vtkKWUserInterfaceManager* vtkKWWindow::GetViewUserInterfaceManager (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::ShowViewUserInterface ( const char *  name  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual vtkKWFrame* vtkKWWindow::GetViewPanelFrame (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual vtkKWToolbarSet* vtkKWWindow::GetSecondaryToolbarSet (  )  [virtual]

Get the secondary toolbar set.

virtual int vtkKWWindow::GetStatusFramePosition (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::SetStatusFramePosition ( int   )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::SetStatusFramePositionToWindow (  )  [inline, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

Definition at line 290 of file vtkKWWindow.h.

virtual void vtkKWWindow::SetStatusFramePositionToMainPanel (  )  [inline, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

Definition at line 293 of file vtkKWWindow.h.

virtual void vtkKWWindow::SetStatusFramePositionToSecondaryPanel (  )  [inline, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

Definition at line 296 of file vtkKWWindow.h.

virtual void vtkKWWindow::SetStatusFramePositionToViewPanel (  )  [inline, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

Definition at line 299 of file vtkKWWindow.h.

virtual void vtkKWWindow::SetStatusFramePositionToLeftOfDivider (  )  [inline, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

Definition at line 302 of file vtkKWWindow.h.

virtual void vtkKWWindow::SetStatusFramePositionToRightOfDivider (  )  [inline, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

Definition at line 305 of file vtkKWWindow.h.

virtual void vtkKWWindow::Render (  )  [virtual]

Call render on all widgets and elements that support that functionality

virtual vtkKWUserInterfaceManager* vtkKWWindow::GetApplicationSettingsUserInterfaceManager (  )  [virtual]

Get the Application Settings Interface as well as the Application Settings User Interface Manager.

virtual void vtkKWWindow::ShowApplicationSettingsUserInterface ( const char *  name  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual vtkKWApplicationSettingsInterface* vtkKWWindow::GetApplicationSettingsInterface (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::Update (  )  [virtual]

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

Reimplemented from vtkKWWindowBase.

virtual void vtkKWWindow::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 vtkKWWindowBase.

virtual void vtkKWWindow::UpdateMenuState (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

Reimplemented from vtkKWWindowBase.

virtual void vtkKWWindow::UpdateToolbarState (  )  [virtual]

Update the toolbar state

Reimplemented from vtkKWWindowBase.

virtual void vtkKWWindow::PrepareForDelete (  )  [virtual]

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

Reimplemented from vtkKWWindowBase.

virtual void vtkKWWindow::MainPanelVisibilityCallback (  )  [virtual]

Callbacks. Internal, do not use.

virtual void vtkKWWindow::SecondaryPanelVisibilityCallback (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::PrintSettingsCallback (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

Reimplemented from vtkKWWindowBase.

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

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

Reimplemented from vtkKWWindowBase.

virtual void vtkKWWindow::NumberOfToolbarsChangedCallback (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

Reimplemented from vtkKWWindowBase.

virtual char* vtkKWWindow::GetMainPanelSizeRegKey (  )  [virtual]

Some constants

virtual char* vtkKWWindow::GetMainPanelVisibilityRegKey (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual char* vtkKWWindow::GetMainPanelVisibilityKeyAccelerator (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual char* vtkKWWindow::GetHideMainPanelMenuLabel (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual char* vtkKWWindow::GetShowMainPanelMenuLabel (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual char* vtkKWWindow::GetSecondaryPanelSizeRegKey (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual char* vtkKWWindow::GetSecondaryPanelVisibilityRegKey (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual char* vtkKWWindow::GetSecondaryPanelVisibilityKeyAccelerator (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual char* vtkKWWindow::GetHideSecondaryPanelMenuLabel (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual char* vtkKWWindow::GetShowSecondaryPanelMenuLabel (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual char* vtkKWWindow::GetDefaultViewPanelName (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual char* vtkKWWindow::GetTclInteractorMenuLabel (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual char* vtkKWWindow::GetViewPanelPositionRegKey (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual char* vtkKWWindow::GetLogDialogMenuLabel (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::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 vtkKWWindowBase.

virtual void vtkKWWindow::RemoveCallbackCommandObservers (  )  [virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

Reimplemented from vtkKWWindowBase.

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

Create the widget.

Reimplemented from vtkKWWindowBase.

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

Save/Restore window geometry

Reimplemented from vtkKWWindowBase.

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

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

Reimplemented from vtkKWWindowBase.

virtual void vtkKWWindow::ShowMainUserInterface ( vtkKWUserInterfacePanel panel  )  [protected, virtual]

Show a main or secondary user interface panel. The ShowMainUserInterface() method will query the main UserInterfaceManager (UIM) to check if it is indeed managing the UIP, and show/raise that UIP accordingly. The ShowSecondaryUserInterface will do the same on the secondary UIM. The ShowViewUserInterface will do the same on the view UIM. The ShowApplicationSettingsUserInterface will do the same on the app settings UIM.

virtual void vtkKWWindow::ShowSecondaryUserInterface ( vtkKWUserInterfacePanel panel  )  [protected, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::ShowViewUserInterface ( vtkKWUserInterfacePanel panel  )  [protected, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::ShowApplicationSettingsUserInterface ( vtkKWUserInterfacePanel panel  )  [protected, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

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

Pack/repack the UI

Reimplemented from vtkKWWindowBase.

virtual void vtkKWWindow::SetMainPanelSizeRegKey ( const char *   )  [protected, virtual]

Some constants

virtual void vtkKWWindow::SetMainPanelVisibilityRegKey ( const char *   )  [protected, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::SetMainPanelVisibilityKeyAccelerator ( const char *   )  [protected, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::SetHideMainPanelMenuLabel ( const char *   )  [protected, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::SetShowMainPanelMenuLabel ( const char *   )  [protected, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::SetSecondaryPanelSizeRegKey ( const char *   )  [protected, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::SetSecondaryPanelVisibilityRegKey ( const char *   )  [protected, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::SetSecondaryPanelVisibilityKeyAccelerator ( const char *   )  [protected, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::SetHideSecondaryPanelMenuLabel ( const char *   )  [protected, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::SetShowSecondaryPanelMenuLabel ( const char *   )  [protected, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::SetDefaultViewPanelName ( const char *   )  [protected, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::SetTclInteractorMenuLabel ( const char *   )  [protected, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::SetViewPanelPositionRegKey ( const char *   )  [protected, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::SetLogDialogMenuLabel ( const char *   )  [protected, virtual]

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

virtual void vtkKWWindow::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 vtkKWWindowBase.

virtual void vtkKWWindow::PopulateWindowMenu (  )  [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.

Reimplemented from vtkKWWindowBase.

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

Set the panel layout type. The whole layout of the window is described at length at the beginning of this document. IMPORTANT: this ivar has to be set before calling Create(), and can not be changed afterwards. BTX

Reimplemented from vtkKWWindowBase.


Member Data Documentation

int vtkKWWindow::PanelLayout [protected]

Definition at line 416 of file vtkKWWindow.h.

Definition at line 418 of file vtkKWWindow.h.

Definition at line 420 of file vtkKWWindow.h.

Definition at line 422 of file vtkKWWindow.h.

Definition at line 424 of file vtkKWWindow.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:18 2010 for KWWidgets by  doxygen 1.6.1