Class to register Extension GUI in IvTune More...
#include <IvTune/IvTuneExtender/IvtShell.h>
Public Member Functions | |
virtual void | registerDock (QDockWidget *dock, Qt::DockWidgetArea area)=0 |
Register the provided dock widget and sets it to the designated area. | |
virtual void | unregisterDock (QDockWidget *dock)=0 |
Unregister the provided dock widget. | |
virtual std::vector< QMenu * > | getContextualMenus (const SoType &type)=0 |
Returns the list of menus that are registered with the provided type and its derived types. | |
virtual void | registerContextualMenu (const SoType &type, bool strict, QMenu *newMenu)=0 |
Register the menu and add it before the help menu of IvTune. | |
virtual void | registerMenu (QMenu *newMenu)=0 |
Register the menu and add it before the help menu of IvTune. | |
virtual void | registerViewMenu (IvtExtension *extension, SbBool visibilityOnActivate=true)=0 |
Register an extension in the view menu of IvTune. | |
virtual void | unregisterContextualMenu (QMenu *menu)=0 |
Unregister the context menu given as parameter. | |
virtual void | unregisterMenu (QMenu *menu)=0 |
Unregister the specified menu. | |
virtual void | unregisterViewMenu (IvtExtension *extension)=0 |
Unregister the extension from the view menu. | |
virtual void | registerPreferencePanel (IvtExtension *extension, QWidget *panel, const char *slotInitialized, const char *slotAccept)=0 |
Register the extension with the specified panel and add an entry to the preferences menu. | |
virtual void | unregisterPreferencePanel (IvtExtension *extension)=0 |
Unregister the extension from the the panel and remove the associated entry in the preferences menu. | |
virtual void | clearStatusBarMessage ()=0 |
Clear the message in the status bar. | |
virtual void | regiterStatusBarWidget (QWidget *widget, SbBool isPermanent=false, int stretch=0)=0 |
Register a widget in the status bar of IvTune. | |
virtual void | showStatusBarMessage (const SbString &newMessage, int timeout=2000)=0 |
Show a messsage in the Status bar. | |
virtual void | unregiterStatusBarWidget (QWidget *widget)=0 |
Unregister a widget from the status bar. | |
virtual void | registerToolBar (QToolBar *tb, Qt::ToolBarArea area=Qt::TopToolBarArea)=0 |
Register the provided dock widget and set it in the designated area. | |
virtual void | unregisterToolBar (QToolBar *tb)=0 |
Unregister a tool bar from the main window. | |
Static Public Member Functions | |
static IvtShell * | getInstance () |
Returns an instance of this class. | |
Class to register Extension GUI in IvTune
This class provides methods to access the different GUI elements of IvTune. Thus it is possible to modify or extend them.
Definition at line 75 of file IvtShell.h.
|
pure virtual |
Clear the message in the status bar.
|
pure virtual |
Returns the list of menus that are registered with the provided type and its derived types.
type | the type of node/field associated with the menus. |
|
static |
Returns an instance of this class.
|
pure virtual |
Register the menu and add it before the help menu of IvTune.
newMenu | the contextual menu to register. |
type | the type of node/field associated with the menus. |
strict | indicates if it is for the exact type or any derived type. |
|
pure virtual |
Register the provided dock widget and sets it to the designated area.
dock | the dock widget to register. |
area | the area where the dock widget should be placed. |
|
pure virtual |
Register the menu and add it before the help menu of IvTune.
newMenu | the menu to register. |
|
pure virtual |
Register the extension with the specified panel and add an entry to the preferences menu.
extension | the extension to register. |
panel | the panel where the extension will be registered. |
slotInitialized | a qt slot called when the prefenrence panel is initialized to be showed to the user. |
slotAccept | a qt slot called when new prefenrences are accepted by the user. |
|
pure virtual |
Register the provided dock widget and set it in the designated area.
tb | the tool bar to register. |
area | the area where the dock widget should be placed. |
|
pure virtual |
Register an extension in the view menu of IvTune.
extension | the extension to register. |
visibilityOnActivate | indicates whether the extension is visible when activated or not. |
|
pure virtual |
Register a widget in the status bar of IvTune.
widget | the widget to register. |
isPermanent | indicates whether the widget may be obscured by messages. A permanent widget is located at the far right of status bar. Otherwise the widget is located at the far left of the first permanent widget. |
stretch | is the factor used to compute a suitable size for the given widget. By default, this factor is set to 0 which indicates giving the widget a minimum of space. |
|
pure virtual |
Show a messsage in the Status bar.
newMessage | the message to display in the status bar. |
timeout | the specified number of milliseconds to display the message in the status bar. |
Note: A timeout of 0 means the message remains displayed until clearStatusBarMessage() is called.
|
pure virtual |
Unregister the context menu given as parameter.
It will be unregistered for strict and derived types.
menu | the contextual menu to unregister. |
|
pure virtual |
Unregister the provided dock widget.
dock | the dock widget to unregister. |
|
pure virtual |
Unregister the specified menu.
menu | the menu to unregister. |
|
pure virtual |
Unregister the extension from the the panel and remove the associated entry in the preferences menu.
extension | the extension to unregister. |
|
pure virtual |
Unregister a tool bar from the main window.
tb | the tool bar to unregister. |
|
pure virtual |
Unregister the extension from the view menu.
extension | the extension to unregister. |
|
pure virtual |
Unregister a widget from the status bar.
widget | the widget to unregister. |