ParaView: vtkKWWindow class Reference

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

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

Enumeration values:

PanelLayoutSecondaryBelowView
PanelLayoutSecondaryBelowMain
PanelLayoutSecondaryBelowMainAndView

Definition at line 203 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

Enumeration values:

ViewPanelPositionLeft
ViewPanelPositionRight

Definition at line 226 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

Enumeration values:

StatusFramePositionWindow
StatusFramePositionMainPanel
StatusFramePositionSecondaryPanel
StatusFramePositionViewPanel
StatusFramePositionLeftOfDivider
StatusFramePositionRightOfDivider

Definition at line 280 of file vtkKWWindow.h.

Constructor & Destructor Documentation

Member Function Documentation

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

Reimplemented from vtkKWWindowBase.

Reimplemented in vtkPVWindow.

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