Public Member Functions | Static Public Member Functions | List of all members
pqParaViewBehaviors Class Reference
ParaView Behaviors

creates all standard ParaView behaviourspqParaViewBehaviors creates all the behaviors used by ParaView. More...

#include <pqParaViewBehaviors.h>

Inherits QObject.

Public Member Functions

 pqParaViewBehaviors (QMainWindow *window, QObject *parent=nullptr)
 
 ~pqParaViewBehaviors () override
 

Static Public Member Functions

static void setEnableStandardPropertyWidgets (bool val)
 
static bool enableStandardPropertyWidgets ()
 
static void setEnableStandardViewFrameActions (bool val)
 
static bool enableStandardViewFrameActions ()
 
static void setEnableStandardRecentlyUsedResourceLoader (bool val)
 
static bool enableStandardRecentlyUsedResourceLoader ()
 
static void setEnableDataTimeStepBehavior (bool val)
 
static bool enableDataTimeStepBehavior ()
 
static void setEnableSpreadSheetVisibilityBehavior (bool val)
 
static bool enableSpreadSheetVisibilityBehavior ()
 
static void setEnablePipelineContextMenuBehavior (bool val)
 
static bool enablePipelineContextMenuBehavior ()
 
static void setEnableBlockContentMenu (bool val)
 
static bool enableBlockContentMenu ()
 
static void setEnableObjectPickingBehavior (bool val)
 
static bool enableObjectPickingBehavior ()
 
static void setEnableDefaultViewBehavior (bool val)
 
static bool enableDefaultViewBehavior ()
 
static void setEnableUndoRedoBehavior (bool val)
 
static bool enableUndoRedoBehavior ()
 
static void setEnableAlwaysConnectedBehavior (bool val)
 
static bool enableAlwaysConnectedBehavior ()
 
static void setEnableCrashRecoveryBehavior (bool val)
 
static bool enableCrashRecoveryBehavior ()
 
static void setEnableAutoLoadPluginXMLBehavior (bool val)
 
static bool enableAutoLoadPluginXMLBehavior ()
 
static void setEnablePluginDockWidgetsBehavior (bool val)
 
static bool enablePluginDockWidgetsBehavior ()
 
static void setEnableVerifyRequiredPluginBehavior (bool val)
 
static bool enableVerifyRequiredPluginBehavior ()
 
static void setEnablePluginActionGroupBehavior (bool val)
 
static bool enablePluginActionGroupBehavior ()
 
static void setEnablePluginToolBarBehavior (bool val)
 
static bool enablePluginToolBarBehavior ()
 
static void setEnableCommandLineOptionsBehavior (bool val)
 
static bool enableCommandLineOptionsBehavior ()
 
static void setEnablePersistentMainWindowStateBehavior (bool val)
 
static bool enablePersistentMainWindowStateBehavior ()
 
static void setEnableCollaborationBehavior (bool val)
 
static bool enableCollaborationBehavior ()
 
static void setEnableViewStreamingBehavior (bool val)
 
static bool enableViewStreamingBehavior ()
 
static void setEnablePluginSettingsBehavior (bool val)
 
static bool enablePluginSettingsBehavior ()
 
static void setEnableApplyBehavior (bool val)
 
static bool enableApplyBehavior ()
 
static void setEnableQuickLaunchShortcuts (bool val)
 
static bool enableQuickLaunchShortcuts ()
 
static void setEnableLockPanelsBehavior (bool val)
 
static bool enableLockPanelsBehavior ()
 
static void setEnablePythonShellResetBehavior (bool val)
 
static bool enablePythonShellResetBehavior ()
 
static void setEnableCustomShortcutBehavior (bool val)
 
static bool enableCustomShortcutBehavior ()
 
static void setEnableMainWindowEventBehavior (bool val)
 
static bool enableMainWindowEventBehavior ()
 
static void setEnableUsageLoggingBehavior (bool val)
 Controls whether pqUsageLoggingBehavior is created. More...
 
static bool enableUsageLoggingBehavior ()
 Controls whether pqUsageLoggingBehavior is created. More...
 
static void setEnableLiveSourceBehavior (bool val)
 Controls whether pqLiveSourceBehavior is created. More...
 
static bool enableLiveSourceBehavior ()
 Controls whether pqLiveSourceBehavior is created. More...
 
static void setEnableWheelNeedsFocusBehavior (bool val)
 By default, widgets like QComboBox, QSlider handle wheel event even when the widget doesn't have the focus. More...
 
static bool enableWheelNeedsFocusBehavior ()
 By default, widgets like QComboBox, QSlider handle wheel event even when the widget doesn't have the focus. More...
 

Detailed Description

creates all standard ParaView behaviours

pqParaViewBehaviors creates all the behaviors used by ParaView.

If your client is merely a branded version of ParaView, then you may want to simply use this behavior. You can also enable/disable behaviors created by pqParaViewBehaviors before instantiating the pqParaViewBehaviors instance by using static methods of the form pqParaViewBehaviors::setEnable<behavior name>(bool) e.g. pqParaViewBehaviors::setEnableStandardPropertyWidgets(false).

Since ParaView 5.1, ObjectPickingBehavior is disabled by default in ParaView.

Definition at line 51 of file pqParaViewBehaviors.h.

Constructor & Destructor Documentation

◆ pqParaViewBehaviors()

pqParaViewBehaviors::pqParaViewBehaviors ( QMainWindow *  window,
QObject *  parent = nullptr 
)

◆ ~pqParaViewBehaviors()

pqParaViewBehaviors::~pqParaViewBehaviors ( )
override

Member Function Documentation

◆ setEnableStandardPropertyWidgets()

static void pqParaViewBehaviors::setEnableStandardPropertyWidgets ( bool  val)
inlinestatic

Definition at line 57 of file pqParaViewBehaviors.h.

◆ enableStandardPropertyWidgets()

static bool pqParaViewBehaviors::enableStandardPropertyWidgets ( )
inlinestatic

Definition at line 57 of file pqParaViewBehaviors.h.

◆ setEnableStandardViewFrameActions()

static void pqParaViewBehaviors::setEnableStandardViewFrameActions ( bool  val)
inlinestatic

Definition at line 58 of file pqParaViewBehaviors.h.

◆ enableStandardViewFrameActions()

static bool pqParaViewBehaviors::enableStandardViewFrameActions ( )
inlinestatic

Definition at line 58 of file pqParaViewBehaviors.h.

◆ setEnableStandardRecentlyUsedResourceLoader()

static void pqParaViewBehaviors::setEnableStandardRecentlyUsedResourceLoader ( bool  val)
inlinestatic

Definition at line 59 of file pqParaViewBehaviors.h.

◆ enableStandardRecentlyUsedResourceLoader()

static bool pqParaViewBehaviors::enableStandardRecentlyUsedResourceLoader ( )
inlinestatic

Definition at line 59 of file pqParaViewBehaviors.h.

◆ setEnableDataTimeStepBehavior()

static void pqParaViewBehaviors::setEnableDataTimeStepBehavior ( bool  val)
inlinestatic

Definition at line 60 of file pqParaViewBehaviors.h.

◆ enableDataTimeStepBehavior()

static bool pqParaViewBehaviors::enableDataTimeStepBehavior ( )
inlinestatic

Definition at line 60 of file pqParaViewBehaviors.h.

◆ setEnableSpreadSheetVisibilityBehavior()

static void pqParaViewBehaviors::setEnableSpreadSheetVisibilityBehavior ( bool  val)
inlinestatic

Definition at line 61 of file pqParaViewBehaviors.h.

◆ enableSpreadSheetVisibilityBehavior()

static bool pqParaViewBehaviors::enableSpreadSheetVisibilityBehavior ( )
inlinestatic

Definition at line 61 of file pqParaViewBehaviors.h.

◆ setEnablePipelineContextMenuBehavior()

static void pqParaViewBehaviors::setEnablePipelineContextMenuBehavior ( bool  val)
inlinestatic

Definition at line 62 of file pqParaViewBehaviors.h.

◆ enablePipelineContextMenuBehavior()

static bool pqParaViewBehaviors::enablePipelineContextMenuBehavior ( )
inlinestatic

Definition at line 62 of file pqParaViewBehaviors.h.

◆ setEnableBlockContentMenu()

static void pqParaViewBehaviors::setEnableBlockContentMenu ( bool  val)
inlinestatic

Definition at line 63 of file pqParaViewBehaviors.h.

◆ enableBlockContentMenu()

static bool pqParaViewBehaviors::enableBlockContentMenu ( )
inlinestatic

Definition at line 63 of file pqParaViewBehaviors.h.

◆ setEnableObjectPickingBehavior()

static void pqParaViewBehaviors::setEnableObjectPickingBehavior ( bool  val)
inlinestatic

Definition at line 64 of file pqParaViewBehaviors.h.

◆ enableObjectPickingBehavior()

static bool pqParaViewBehaviors::enableObjectPickingBehavior ( )
inlinestatic

Definition at line 64 of file pqParaViewBehaviors.h.

◆ setEnableDefaultViewBehavior()

static void pqParaViewBehaviors::setEnableDefaultViewBehavior ( bool  val)
inlinestatic

Definition at line 65 of file pqParaViewBehaviors.h.

◆ enableDefaultViewBehavior()

static bool pqParaViewBehaviors::enableDefaultViewBehavior ( )
inlinestatic

Definition at line 65 of file pqParaViewBehaviors.h.

◆ setEnableUndoRedoBehavior()

static void pqParaViewBehaviors::setEnableUndoRedoBehavior ( bool  val)
inlinestatic

Definition at line 66 of file pqParaViewBehaviors.h.

◆ enableUndoRedoBehavior()

static bool pqParaViewBehaviors::enableUndoRedoBehavior ( )
inlinestatic

Definition at line 66 of file pqParaViewBehaviors.h.

◆ setEnableAlwaysConnectedBehavior()

static void pqParaViewBehaviors::setEnableAlwaysConnectedBehavior ( bool  val)
inlinestatic

Definition at line 67 of file pqParaViewBehaviors.h.

◆ enableAlwaysConnectedBehavior()

static bool pqParaViewBehaviors::enableAlwaysConnectedBehavior ( )
inlinestatic

Definition at line 67 of file pqParaViewBehaviors.h.

◆ setEnableCrashRecoveryBehavior()

static void pqParaViewBehaviors::setEnableCrashRecoveryBehavior ( bool  val)
inlinestatic

Definition at line 68 of file pqParaViewBehaviors.h.

◆ enableCrashRecoveryBehavior()

static bool pqParaViewBehaviors::enableCrashRecoveryBehavior ( )
inlinestatic

Definition at line 68 of file pqParaViewBehaviors.h.

◆ setEnableAutoLoadPluginXMLBehavior()

static void pqParaViewBehaviors::setEnableAutoLoadPluginXMLBehavior ( bool  val)
inlinestatic

Definition at line 69 of file pqParaViewBehaviors.h.

◆ enableAutoLoadPluginXMLBehavior()

static bool pqParaViewBehaviors::enableAutoLoadPluginXMLBehavior ( )
inlinestatic

Definition at line 69 of file pqParaViewBehaviors.h.

◆ setEnablePluginDockWidgetsBehavior()

static void pqParaViewBehaviors::setEnablePluginDockWidgetsBehavior ( bool  val)
inlinestatic

Definition at line 70 of file pqParaViewBehaviors.h.

◆ enablePluginDockWidgetsBehavior()

static bool pqParaViewBehaviors::enablePluginDockWidgetsBehavior ( )
inlinestatic

Definition at line 70 of file pqParaViewBehaviors.h.

◆ setEnableVerifyRequiredPluginBehavior()

static void pqParaViewBehaviors::setEnableVerifyRequiredPluginBehavior ( bool  val)
inlinestatic

Definition at line 71 of file pqParaViewBehaviors.h.

◆ enableVerifyRequiredPluginBehavior()

static bool pqParaViewBehaviors::enableVerifyRequiredPluginBehavior ( )
inlinestatic

Definition at line 71 of file pqParaViewBehaviors.h.

◆ setEnablePluginActionGroupBehavior()

static void pqParaViewBehaviors::setEnablePluginActionGroupBehavior ( bool  val)
inlinestatic

Definition at line 72 of file pqParaViewBehaviors.h.

◆ enablePluginActionGroupBehavior()

static bool pqParaViewBehaviors::enablePluginActionGroupBehavior ( )
inlinestatic

Definition at line 72 of file pqParaViewBehaviors.h.

◆ setEnablePluginToolBarBehavior()

static void pqParaViewBehaviors::setEnablePluginToolBarBehavior ( bool  val)
inlinestatic

Definition at line 73 of file pqParaViewBehaviors.h.

◆ enablePluginToolBarBehavior()

static bool pqParaViewBehaviors::enablePluginToolBarBehavior ( )
inlinestatic

Definition at line 73 of file pqParaViewBehaviors.h.

◆ setEnableCommandLineOptionsBehavior()

static void pqParaViewBehaviors::setEnableCommandLineOptionsBehavior ( bool  val)
inlinestatic

Definition at line 74 of file pqParaViewBehaviors.h.

◆ enableCommandLineOptionsBehavior()

static bool pqParaViewBehaviors::enableCommandLineOptionsBehavior ( )
inlinestatic

Definition at line 74 of file pqParaViewBehaviors.h.

◆ setEnablePersistentMainWindowStateBehavior()

static void pqParaViewBehaviors::setEnablePersistentMainWindowStateBehavior ( bool  val)
inlinestatic

Definition at line 75 of file pqParaViewBehaviors.h.

◆ enablePersistentMainWindowStateBehavior()

static bool pqParaViewBehaviors::enablePersistentMainWindowStateBehavior ( )
inlinestatic

Definition at line 75 of file pqParaViewBehaviors.h.

◆ setEnableCollaborationBehavior()

static void pqParaViewBehaviors::setEnableCollaborationBehavior ( bool  val)
inlinestatic

Definition at line 76 of file pqParaViewBehaviors.h.

◆ enableCollaborationBehavior()

static bool pqParaViewBehaviors::enableCollaborationBehavior ( )
inlinestatic

Definition at line 76 of file pqParaViewBehaviors.h.

◆ setEnableViewStreamingBehavior()

static void pqParaViewBehaviors::setEnableViewStreamingBehavior ( bool  val)
inlinestatic

Definition at line 77 of file pqParaViewBehaviors.h.

◆ enableViewStreamingBehavior()

static bool pqParaViewBehaviors::enableViewStreamingBehavior ( )
inlinestatic

Definition at line 77 of file pqParaViewBehaviors.h.

◆ setEnablePluginSettingsBehavior()

static void pqParaViewBehaviors::setEnablePluginSettingsBehavior ( bool  val)
inlinestatic

Definition at line 78 of file pqParaViewBehaviors.h.

◆ enablePluginSettingsBehavior()

static bool pqParaViewBehaviors::enablePluginSettingsBehavior ( )
inlinestatic

Definition at line 78 of file pqParaViewBehaviors.h.

◆ setEnableApplyBehavior()

static void pqParaViewBehaviors::setEnableApplyBehavior ( bool  val)
inlinestatic

Definition at line 79 of file pqParaViewBehaviors.h.

◆ enableApplyBehavior()

static bool pqParaViewBehaviors::enableApplyBehavior ( )
inlinestatic

Definition at line 79 of file pqParaViewBehaviors.h.

◆ setEnableQuickLaunchShortcuts()

static void pqParaViewBehaviors::setEnableQuickLaunchShortcuts ( bool  val)
inlinestatic

Definition at line 80 of file pqParaViewBehaviors.h.

◆ enableQuickLaunchShortcuts()

static bool pqParaViewBehaviors::enableQuickLaunchShortcuts ( )
inlinestatic

Definition at line 80 of file pqParaViewBehaviors.h.

◆ setEnableLockPanelsBehavior()

static void pqParaViewBehaviors::setEnableLockPanelsBehavior ( bool  val)
inlinestatic

Definition at line 81 of file pqParaViewBehaviors.h.

◆ enableLockPanelsBehavior()

static bool pqParaViewBehaviors::enableLockPanelsBehavior ( )
inlinestatic

Definition at line 81 of file pqParaViewBehaviors.h.

◆ setEnablePythonShellResetBehavior()

static void pqParaViewBehaviors::setEnablePythonShellResetBehavior ( bool  val)
inlinestatic

Definition at line 82 of file pqParaViewBehaviors.h.

◆ enablePythonShellResetBehavior()

static bool pqParaViewBehaviors::enablePythonShellResetBehavior ( )
inlinestatic

Definition at line 82 of file pqParaViewBehaviors.h.

◆ setEnableCustomShortcutBehavior()

static void pqParaViewBehaviors::setEnableCustomShortcutBehavior ( bool  val)
inlinestatic

Definition at line 83 of file pqParaViewBehaviors.h.

◆ enableCustomShortcutBehavior()

static bool pqParaViewBehaviors::enableCustomShortcutBehavior ( )
inlinestatic

Definition at line 83 of file pqParaViewBehaviors.h.

◆ setEnableMainWindowEventBehavior()

static void pqParaViewBehaviors::setEnableMainWindowEventBehavior ( bool  val)
inlinestatic

Definition at line 84 of file pqParaViewBehaviors.h.

◆ enableMainWindowEventBehavior()

static bool pqParaViewBehaviors::enableMainWindowEventBehavior ( )
inlinestatic

Definition at line 84 of file pqParaViewBehaviors.h.

◆ setEnableUsageLoggingBehavior()

static void pqParaViewBehaviors::setEnableUsageLoggingBehavior ( bool  val)
inlinestatic

Controls whether pqUsageLoggingBehavior is created.

Disabled by default (except in the ParaView application itself).

See also
pqUsageLoggingBehavior.

Definition at line 92 of file pqParaViewBehaviors.h.

◆ enableUsageLoggingBehavior()

static bool pqParaViewBehaviors::enableUsageLoggingBehavior ( )
inlinestatic

Controls whether pqUsageLoggingBehavior is created.

Disabled by default (except in the ParaView application itself).

See also
pqUsageLoggingBehavior.

Definition at line 92 of file pqParaViewBehaviors.h.

◆ setEnableLiveSourceBehavior()

static void pqParaViewBehaviors::setEnableLiveSourceBehavior ( bool  val)
inlinestatic

Controls whether pqLiveSourceBehavior is created.

See also
pqLiveSourceBehavior

Definition at line 100 of file pqParaViewBehaviors.h.

◆ enableLiveSourceBehavior()

static bool pqParaViewBehaviors::enableLiveSourceBehavior ( )
inlinestatic

Controls whether pqLiveSourceBehavior is created.

See also
pqLiveSourceBehavior

Definition at line 100 of file pqParaViewBehaviors.h.

◆ setEnableWheelNeedsFocusBehavior()

static void pqParaViewBehaviors::setEnableWheelNeedsFocusBehavior ( bool  val)
inlinestatic

By default, widgets like QComboBox, QSlider handle wheel event even when the widget doesn't have the focus.

While that's handy, in many use-cases, in several where these are embedded in scrollable panels, they can interrupt the scrolling of the panel. Hence, this behavior has been added since ParaView 5.5 default. When enabled, this is enabled for QComboBox, QSlider, QAbstractSpinBox and subclasses.

Definition at line 112 of file pqParaViewBehaviors.h.

◆ enableWheelNeedsFocusBehavior()

static bool pqParaViewBehaviors::enableWheelNeedsFocusBehavior ( )
inlinestatic

By default, widgets like QComboBox, QSlider handle wheel event even when the widget doesn't have the focus.

While that's handy, in many use-cases, in several where these are embedded in scrollable panels, they can interrupt the scrolling of the panel. Hence, this behavior has been added since ParaView 5.5 default. When enabled, this is enabled for QComboBox, QSlider, QAbstractSpinBox and subclasses.

Definition at line 112 of file pqParaViewBehaviors.h.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.13 on Tue Oct 1 2024