A pure virtual class specifying the common properties of all the parameter tabs in the VAPOR GUI.
More...
#include <eventrouter.h>
A pure virtual class specifying the common properties of all the parameter tabs in the VAPOR GUI.
- Author
- Alan Norton
- Version
- $Revision$
- Date
- $Date$ The EventRouter class manages communication between tabs in the GUI, visualizers, and params. Includes support for some elements that are common in these tabs
Definition at line 55 of file eventrouter.h.
| virtual void VAPoR::EventRouter::captureMouseDown |
( |
int |
mouseNum | ) |
|
|
inlinevirtual |
Method for classes that capture mouse event events (i.e. have manipulators) This must be reimplemented to respond when the mouse is pressed
Definition at line 139 of file eventrouter.h.
| virtual void VAPoR::EventRouter::captureMouseUp |
( |
| ) |
|
|
inlinevirtual |
Method for classes that capture mouse event events (i.e. have manipulators) This must be reimplemented to respond when the mouse is released.
Definition at line 135 of file eventrouter.h.
| virtual void VAPoR::EventRouter::confirmText |
( |
bool |
| ) |
|
|
pure virtual |
Pure virtual method to confirm any change in a text box. The render argument is true if this requires updateRenderer(). This method is called whenever user presses enter, or changes the state of a widget (other than a textEdit) in the tab.
| virtual void VAPoR::EventRouter::guiSetEnabled |
( |
bool |
On, |
|
|
int |
instance, |
|
|
bool |
undoredo = false |
|
) |
| |
|
inlinevirtual |
Method that must be reimplemented in any EventRouter that is associated with a RenderParams. It is invoked whenever the user checks or un-checks the enable checkbox in the instance selector.
- Parameters
-
| [in] | bool | Turns on (true) or off the instance. |
| [in] | int | Instance that is being enabled or disabled. |
Definition at line 131 of file eventrouter.h.
| void VAPoR::EventRouter::guiSetTextChanged |
( |
bool |
on | ) |
|
|
inline |
Set theTextChanged flag. The flag should be turned on whenever any textbox (affecting the state of the Params) changes in the tab. The change will not take effect until confirmText() is called. The flag will be turned off when confirmText() or updateTab() is called.
- Parameters
-
| [in] | bool | on : true indicates the flag is set. |
Definition at line 112 of file eventrouter.h.
| virtual void VAPoR::EventRouter::hookUpTab |
( |
| ) |
|
|
pure virtual |
Pure virtual method where all the Qt signals and slots associated with the tab are connected. Must include connections that send signals when any QTextEdit box is changed and when enter is pressed.
| virtual void VAPoR::EventRouter::makeCurrent |
( |
Params * |
prevParams, |
|
|
Params * |
newParams, |
|
|
bool |
newWin, |
|
|
int |
instance = -1, |
|
|
bool |
reEnable = false |
|
) |
| |
|
pure virtual |
Pure virtual method that installs a new params instance during undo and redo.
- Parameters
-
| [in] | Params* | prevParams Params instance that is being replaced |
| [in] | Params* | newParams New Params instance being installed. |
| [in] | bool | newWin Indicates whether this is a new window. |
| [in] | int | instance Indicates the instance index to replace. Default -1 indicates current instance. Instance is -1 for non-render params. |
| [in] | bool | reEnable Indicates that the rendering should be disabled and re-enabled. |
| virtual void VAPoR::EventRouter::performGuiChangeInstance |
( |
int |
newCurrent, |
|
|
bool |
undoredo = true |
|
) |
| |
|
virtual |
Method to change the current instance index, and perform associated undo/redo capture. Child classes can use this to respond to instance selection in the instance selector.
- Parameters
-
| [in] | int | newCurrent specifies new current index |
| [in] | bool | undoredo specifies whether or not the event will be put on the undo/redo queue. |
| virtual void VAPoR::EventRouter::performGuiCopyInstance |
( |
| ) |
|
|
virtual |
Method to make a copy of the current instance with the same visualizer, and perform associated undo/redo capture. Child classes can use this to respond to user requests to copy instance to current visualizer.
| virtual void VAPoR::EventRouter::performGuiCopyInstanceToViz |
( |
int |
vizwin | ) |
|
|
virtual |
Method to make a copy of the current instance into another visualizer, and perform associated undo/redo capture. Child classes can use this to respond to user requests to copy instance to another visualizer.
- Parameters
-
| [in] | int | vizwin Visualizer number of other visualizer |
| virtual void VAPoR::EventRouter::performGuiDeleteInstance |
( |
| ) |
|
|
virtual |
Method to delete the current instance, and perform associated undo/redo capture. Child classes can use this to respond to clicks on the "delete" instance selector.
| virtual void VAPoR::EventRouter::performGuiNewInstance |
( |
| ) |
|
|
virtual |
Method to create a new instance, and perform associated undo/redo capture. Child classes can use this to respond to clicks on the "new" instance button.
| virtual void VAPoR::EventRouter::reinitTab |
( |
bool |
doOverride | ) |
|
|
pure virtual |
Pure virtual method to set up the content in a tab based on a change in the DataMgr. Any widgets that are data-specific, such as variable selectors, must be initialized in this method. The doOverride argument indicates that the user has requested default settings, so any previous setup can be overridden.
| virtual void VAPoR::EventRouter::updateTab |
( |
| ) |
|
|
pure virtual |
Pure virtual method to set the values of all the gui elements in the tab based on current params state. This is invoked whenever the user changes the tab or whenever the values in the tab need to be refreshed.
| virtual void VAPoR::EventRouter::updateUrgentTabState |
( |
| ) |
|
|
inlinevirtual |
Virtual method to update only tab state that is most urgent after an error message. In particular, don't update any GL widgets in this method! This is to deal with error messages coming from the rendering thread that are trapped by the gui thread. Default does nothing.
Definition at line 74 of file eventrouter.h.
The documentation for this class was generated from the following file:
