a user interface panel. More...
#include <vtkKWUserInterfacePanel.h>
Public Types | |
| typedef vtkKWObject | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual vtkKWWidget * | GetPagesParentWidget () |
| virtual void | Update () |
| virtual void | UpdateEnableState () |
| virtual void | SetUserInterfaceManager (vtkKWUserInterfaceManager *) |
| virtual vtkKWUserInterfaceManager * | GetUserInterfaceManager () |
| virtual char * | GetName () |
| virtual void | SetName (const char *) |
| virtual void | Create () |
| virtual int | IsCreated () |
| virtual void | SetEnabled (int) |
| virtual void | EnabledOn () |
| virtual void | EnabledOff () |
| virtual int | GetEnabled () |
| virtual int | AddPage (const char *title, const char *balloon=0, vtkKWIcon *icon=0) |
| virtual int | RemovePage (const char *title) |
| virtual void | SetPageTitle (int id, const char *title) |
| virtual void | SetPageBalloonHelpString (int id, const char *str) |
| virtual void | SetPageIcon (int id, vtkKWIcon *icon) |
| virtual void | SetPageIconToPredefinedIcon (int id, int icon_index) |
| virtual vtkKWWidget * | GetPageWidget (int id) |
| virtual vtkKWWidget * | GetPageWidget (const char *title) |
| virtual void | RaisePage (int id) |
| virtual void | RaisePage (const char *title) |
| virtual int | Show () |
| virtual int | Raise () |
| virtual int | IsVisible () |
Static Public Member Functions | |
| static vtkKWUserInterfacePanel * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkKWUserInterfacePanel * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkKWUserInterfacePanel () | |
| ~vtkKWUserInterfacePanel () | |
Protected Attributes | |
| vtkKWUserInterfaceManager * | UserInterfaceManager |
| char * | Name |
a user interface panel.
This class is used to abstract the way an interface "panel" can be subdivided into "pages" (i.e. "sections"). It allows specific GUI parts of an application to be encapsulated inside independent panels. Panels are then associated to a user interface manager (see vtkKWUserInterfaceManager) which is responsible for grouping them inside a widget and handling user interaction so that panels and their pages can be selected in more or less fancy ways. If the user interface manager uses a notebook under the hood, then this class is likely to receive a notebook's page when it will request for a page from the manager. If the manager chooses for a flat GUI, then this class is likely to receive a simple frame that will be stacked by the manager on top of other pages. This class is not a widget, it can not be mapped, the manager is the place where a concrete widget is set and used as the root of all panels (see vtkKWUserInterfaceManagerNotebook for example). What you need to do is to set the UserInterfaceManager's Ivar to a manager, and the rest should be taken care of (i.e. the panel is automatically added to the manager, and if the panel is not created the first time one if its pages is shown or raised, the panel's Create() method is automatically called by the manager, allowing the creation of the panel to be delayed until it is really needed). You should not use the manager's API to add the panel, add or raise pages, etc, just use this panel's API and calls will be propagated to the right manager with the proper arguments).
Definition at line 52 of file vtkKWUserInterfacePanel.h.
Reimplemented from vtkKWObject.
Reimplemented in vtkKWApplicationSettingsInterface.
Definition at line 57 of file vtkKWUserInterfacePanel.h.
| vtkKWUserInterfacePanel::vtkKWUserInterfacePanel | ( | ) | [protected] |
| vtkKWUserInterfacePanel::~vtkKWUserInterfacePanel | ( | ) | [protected] |
| static vtkKWUserInterfacePanel* vtkKWUserInterfacePanel::New | ( | ) | [static] |
Reimplemented from vtkKWObject.
Reimplemented in vtkKWApplicationSettingsInterface.
| virtual const char* vtkKWUserInterfacePanel::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkKWObject.
Reimplemented in vtkKWApplicationSettingsInterface.
| static int vtkKWUserInterfacePanel::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkKWObject.
Reimplemented in vtkKWApplicationSettingsInterface.
| virtual int vtkKWUserInterfacePanel::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkKWObject.
Reimplemented in vtkKWApplicationSettingsInterface.
| static vtkKWUserInterfacePanel* vtkKWUserInterfacePanel::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkKWObject.
Reimplemented in vtkKWApplicationSettingsInterface.
| void vtkKWUserInterfacePanel::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
Reimplemented from vtkKWObject.
Reimplemented in vtkKWApplicationSettingsInterface.
| virtual void vtkKWUserInterfacePanel::SetUserInterfaceManager | ( | vtkKWUserInterfaceManager * | ) | [virtual] |
Set the user interface manager. This automatically adds the panel to the manager. If you want to remove this panel from the manager, set the manager to NULL (it is done automatically by the destructor), or call RemovePanel from the manager so that you can add it back later. Note that ownership is transferred to the manager by incrementing (and decrementing later on) the ref count of the panel in vtkKWUserInterfaceManager's AddPanel and RemovePanel methods.
| virtual vtkKWUserInterfaceManager* vtkKWUserInterfacePanel::GetUserInterfaceManager | ( | ) | [virtual] |
Set the user interface manager. This automatically adds the panel to the manager. If you want to remove this panel from the manager, set the manager to NULL (it is done automatically by the destructor), or call RemovePanel from the manager so that you can add it back later. Note that ownership is transferred to the manager by incrementing (and decrementing later on) the ref count of the panel in vtkKWUserInterfaceManager's AddPanel and RemovePanel methods.
| virtual char* vtkKWUserInterfacePanel::GetName | ( | ) | [virtual] |
Set the panel name. Can be used to add the panel to a menu, etc.
| virtual void vtkKWUserInterfacePanel::SetName | ( | const char * | ) | [virtual] |
Set the user interface manager. This automatically adds the panel to the manager. If you want to remove this panel from the manager, set the manager to NULL (it is done automatically by the destructor), or call RemovePanel from the manager so that you can add it back later. Note that ownership is transferred to the manager by incrementing (and decrementing later on) the ref count of the panel in vtkKWUserInterfaceManager's AddPanel and RemovePanel methods.
| virtual void vtkKWUserInterfacePanel::Create | ( | ) | [virtual] |
Create the interface objects. Note that if the panel is not created the first time one if its pages is shown or raised, this method is automatically called by the manager, allowing the creation of the panel to be delayed until it is really needed. In the same way, if the user interface manager has not been created at this point, it is automatically created now (see vtkKWUserInterfaceManager::Create()).
Reimplemented in vtkKWApplicationSettingsInterface.
| virtual int vtkKWUserInterfacePanel::IsCreated | ( | ) | [virtual] |
Set the user interface manager. This automatically adds the panel to the manager. If you want to remove this panel from the manager, set the manager to NULL (it is done automatically by the destructor), or call RemovePanel from the manager so that you can add it back later. Note that ownership is transferred to the manager by incrementing (and decrementing later on) the ref count of the panel in vtkKWUserInterfaceManager's AddPanel and RemovePanel methods.
| virtual void vtkKWUserInterfacePanel::SetEnabled | ( | int | ) | [virtual] |
Enable/Disable this panel. This should propagate SetEnabled() calls to the internal widgets.
| virtual void vtkKWUserInterfacePanel::EnabledOn | ( | ) | [virtual] |
Set the user interface manager. This automatically adds the panel to the manager. If you want to remove this panel from the manager, set the manager to NULL (it is done automatically by the destructor), or call RemovePanel from the manager so that you can add it back later. Note that ownership is transferred to the manager by incrementing (and decrementing later on) the ref count of the panel in vtkKWUserInterfaceManager's AddPanel and RemovePanel methods.
| virtual void vtkKWUserInterfacePanel::EnabledOff | ( | ) | [virtual] |
Set the user interface manager. This automatically adds the panel to the manager. If you want to remove this panel from the manager, set the manager to NULL (it is done automatically by the destructor), or call RemovePanel from the manager so that you can add it back later. Note that ownership is transferred to the manager by incrementing (and decrementing later on) the ref count of the panel in vtkKWUserInterfaceManager's AddPanel and RemovePanel methods.
| virtual int vtkKWUserInterfacePanel::GetEnabled | ( | ) | [virtual] |
Set the user interface manager. This automatically adds the panel to the manager. If you want to remove this panel from the manager, set the manager to NULL (it is done automatically by the destructor), or call RemovePanel from the manager so that you can add it back later. Note that ownership is transferred to the manager by incrementing (and decrementing later on) the ref count of the panel in vtkKWUserInterfaceManager's AddPanel and RemovePanel methods.
| virtual int vtkKWUserInterfacePanel::AddPage | ( | const char * | title, | |
| const char * | balloon = 0, |
|||
| vtkKWIcon * | icon = 0 | |||
| ) | [virtual] |
Add/remove a page to/from the panel (this will, in turn, instructs the manager to reserve or remove a page for this given panel). balloon specifies the balloon help for that page, icon is an optional icon in case it is supported by the manager later on. Return a unique positive ID for the page that was reserved/removed, or < 0 on error.
| virtual int vtkKWUserInterfacePanel::RemovePage | ( | const char * | title | ) | [virtual] |
Set the user interface manager. This automatically adds the panel to the manager. If you want to remove this panel from the manager, set the manager to NULL (it is done automatically by the destructor), or call RemovePanel from the manager so that you can add it back later. Note that ownership is transferred to the manager by incrementing (and decrementing later on) the ref count of the panel in vtkKWUserInterfaceManager's AddPanel and RemovePanel methods.
| virtual void vtkKWUserInterfacePanel::SetPageTitle | ( | int | id, | |
| const char * | title | |||
| ) | [virtual] |
Set a page's title, balloon help and icon.
| virtual void vtkKWUserInterfacePanel::SetPageBalloonHelpString | ( | int | id, | |
| const char * | str | |||
| ) | [virtual] |
Set the user interface manager. This automatically adds the panel to the manager. If you want to remove this panel from the manager, set the manager to NULL (it is done automatically by the destructor), or call RemovePanel from the manager so that you can add it back later. Note that ownership is transferred to the manager by incrementing (and decrementing later on) the ref count of the panel in vtkKWUserInterfaceManager's AddPanel and RemovePanel methods.
| virtual void vtkKWUserInterfacePanel::SetPageIcon | ( | int | id, | |
| vtkKWIcon * | icon | |||
| ) | [virtual] |
Set the user interface manager. This automatically adds the panel to the manager. If you want to remove this panel from the manager, set the manager to NULL (it is done automatically by the destructor), or call RemovePanel from the manager so that you can add it back later. Note that ownership is transferred to the manager by incrementing (and decrementing later on) the ref count of the panel in vtkKWUserInterfaceManager's AddPanel and RemovePanel methods.
| virtual void vtkKWUserInterfacePanel::SetPageIconToPredefinedIcon | ( | int | id, | |
| int | icon_index | |||
| ) | [virtual] |
Set the user interface manager. This automatically adds the panel to the manager. If you want to remove this panel from the manager, set the manager to NULL (it is done automatically by the destructor), or call RemovePanel from the manager so that you can add it back later. Note that ownership is transferred to the manager by incrementing (and decrementing later on) the ref count of the panel in vtkKWUserInterfaceManager's AddPanel and RemovePanel methods.
| virtual vtkKWWidget* vtkKWUserInterfacePanel::GetPageWidget | ( | int | id | ) | [virtual] |
Retrieve the widget corresponding to a given page added to the panel. This can be done through the unique page ID, or using the page title. The user UI components should be inserted into this widget. Return NULL on error.
| virtual vtkKWWidget* vtkKWUserInterfacePanel::GetPageWidget | ( | const char * | title | ) | [virtual] |
Set the user interface manager. This automatically adds the panel to the manager. If you want to remove this panel from the manager, set the manager to NULL (it is done automatically by the destructor), or call RemovePanel from the manager so that you can add it back later. Note that ownership is transferred to the manager by incrementing (and decrementing later on) the ref count of the panel in vtkKWUserInterfaceManager's AddPanel and RemovePanel methods.
| virtual vtkKWWidget* vtkKWUserInterfacePanel::GetPagesParentWidget | ( | ) | [virtual] |
Retrieve the parent widget of the pages associated to the panel. It is the unique widget that is common to all pages in the chain of parents.
| virtual void vtkKWUserInterfacePanel::RaisePage | ( | int | id | ) | [virtual] |
Raise a page added to the panel. This can be done through the unique page ID, or using the page title. Note that if the panel has not been created at this point, the manager will call the panel's Create() method automatically, allowing the creation of the panel to be delayed until it is really needed.
| virtual void vtkKWUserInterfacePanel::RaisePage | ( | const char * | title | ) | [virtual] |
Set the user interface manager. This automatically adds the panel to the manager. If you want to remove this panel from the manager, set the manager to NULL (it is done automatically by the destructor), or call RemovePanel from the manager so that you can add it back later. Note that ownership is transferred to the manager by incrementing (and decrementing later on) the ref count of the panel in vtkKWUserInterfaceManager's AddPanel and RemovePanel methods.
| virtual int vtkKWUserInterfacePanel::Show | ( | ) | [virtual] |
Show a panel. It will make sure the pages added to this panel are shown. Note that if the panel has not been created at this point, the manager will call the panel's Create() method automatically, allowing the creation of the panel to be delayed until it is really needed. Raise() behaves like Show(), but it will also instruct the manager to bring up the first page of the panel to the front. IsVisible() will check if the pages of this panel are visible/shown. Return 1 on success, 0 on error.
| virtual int vtkKWUserInterfacePanel::Raise | ( | ) | [virtual] |
Set the user interface manager. This automatically adds the panel to the manager. If you want to remove this panel from the manager, set the manager to NULL (it is done automatically by the destructor), or call RemovePanel from the manager so that you can add it back later. Note that ownership is transferred to the manager by incrementing (and decrementing later on) the ref count of the panel in vtkKWUserInterfaceManager's AddPanel and RemovePanel methods.
| virtual int vtkKWUserInterfacePanel::IsVisible | ( | ) | [virtual] |
Set the user interface manager. This automatically adds the panel to the manager. If you want to remove this panel from the manager, set the manager to NULL (it is done automatically by the destructor), or call RemovePanel from the manager so that you can add it back later. Note that ownership is transferred to the manager by incrementing (and decrementing later on) the ref count of the panel in vtkKWUserInterfaceManager's AddPanel and RemovePanel methods.
| virtual void vtkKWUserInterfacePanel::Update | ( | ) | [virtual] |
Refresh the interface.
Reimplemented in vtkKWApplicationSettingsInterface.
| virtual void vtkKWUserInterfacePanel::UpdateEnableState | ( | ) | [inline, 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.
Reimplemented in vtkKWApplicationSettingsInterface.
Definition at line 164 of file vtkKWUserInterfacePanel.h.
Definition at line 172 of file vtkKWUserInterfacePanel.h.
char* vtkKWUserInterfacePanel::Name [protected] |
Definition at line 174 of file vtkKWUserInterfacePanel.h.
1.6.1
