pqReloadFilesReaction Class Reference

pqReloadFilesReaction adds handler code to reload the active reader or all readers depending on the ReloadMode passed in the constructor. More...

#include <pqReloadFilesReaction.h>

Inheritance diagram for pqReloadFilesReaction:

Collaboration diagram for pqReloadFilesReaction:

Public Types
enum	ReloadModes { ActiveSource, AllSources }

Public Member Functions
	pqReloadFilesReaction (QAction *parent=nullptr, ReloadModes reloadMode=ActiveSource)
	~pqReloadFilesReaction () override
bool	reloadSources ()
	reload the active source or all sources if they support reload. More...
Public Member Functions inherited from pqReaction
	pqReaction (QAction *parent, Qt::ConnectionType type=Qt::AutoConnection)
	Constructor. More...
	~pqReaction () override
QAction *	parentAction () const
	Provides access to the parent action. More...

Static Public Member Functions
static bool	reload ()
	reload the active proxy if it supports reload. More...
static bool	reload (vtkSMSourceProxy *proxy)
	reload the proxy if it supports reload. More...

Protected Member Functions
void	onTriggered () override
	Called when the action is triggered. More...
void	updateEnableState () override

Additional Inherited Members
Protected Slots inherited from pqReaction
virtual void	updateMasterEnableState (bool)
Protected Attributes inherited from pqReaction
bool	IsMaster

Detailed Description

pqReloadFilesReaction adds handler code to reload the active reader or all readers depending on the ReloadMode passed in the constructor.

It calls the "reload" property, identified by hints, if present, or calls vtkSMProxy::RecreateVTKObjects().

Definition at line 19 of file pqReloadFilesReaction.h.

Member Enumeration Documentation

ReloadModes

enum pqReloadFilesReaction::ReloadModes

Enumerator
ActiveSource
AllSources

Definition at line 25 of file pqReloadFilesReaction.h.

Constructor & Destructor Documentation

pqReloadFilesReaction()

pqReloadFilesReaction::pqReloadFilesReaction	(	QAction *	parent = nullptr,
		ReloadModes	reloadMode = ActiveSource
	)

~pqReloadFilesReaction()

pqReloadFilesReaction::~pqReloadFilesReaction ( )

override

Member Function Documentation

reload() [1/2]

static bool pqReloadFilesReaction::reload ( )

static

reload the active proxy if it supports reload.

Returns true on success.

reloadSources()

bool pqReloadFilesReaction::reloadSources

(

)

reload the active source or all sources if they support reload.

Returns true on success.

reload() [2/2]

static bool pqReloadFilesReaction::reload ( vtkSMSourceProxy *  proxy )

static

reload the proxy if it supports reload.

Returns true on success.

onTriggered()

void pqReloadFilesReaction::onTriggered ( )

inlineoverrideprotectedvirtual

Called when the action is triggered.

Reimplemented from pqReaction.

Definition at line 51 of file pqReloadFilesReaction.h.

updateEnableState()

void pqReloadFilesReaction::updateEnableState ( )

overrideprotectedvirtual

Reimplemented from pqReaction.

---

The documentation for this class was generated from the following file:

• /builds/gitlab-kitware-sciviz-ci/Qt/ApplicationComponents/pqReloadFilesReaction.h