The pqCustomFilterDefinitionWizard class is used to create a compound proxy definition one step at a time. More...

#include <pqCustomFilterDefinitionWizard.h>

Inherits QDialog.

Public Slots
void	createCustomFilter ()
	Creates a compound proxy definition. More...

Public Member Functions
	pqCustomFilterDefinitionWizard (pqCustomFilterDefinitionModel model, QWidget parent=nullptr)
	Creates a custom filter definition wizard. More...

	~pqCustomFilterDefinitionWizard () override

pqCustomFilterDefinitionModel *	getModel () const
	Gets the custom filter definition model used by the wizard. More...

QString	getCustomFilterName () const
	Gets the name of the compound proxy created by the wizard. More...

Detailed Description

The pqCustomFilterDefinitionWizard class is used to create a compound proxy definition one step at a time.

The wizard should be created with a pqCustomFilterDefinitionModel. The model stores the sources that will be placed in the custom filter. The model is also used when selecting the exposed properties.

The following is an example of how to use the wizard:

pqCustomFilterDefinitionModel filter(this);
filter.setContents(
  pqApplicationCore::instance()->getSelectionModel()->selectedItems());
pqCustomFilterDefinitionWizard wizard(&filter, this);
if(wizard.exec() == QDialog::Accepted)
  {
  wizard.createCustomFilter();
  }

The custom filter definition model is filled out using the selected pipeline sources. After setting the custom filter definition model's contents, you can check to see if any sources were added. The wizard can make a compound proxy without any sources, but you may not want to allow it. After the createCustomFilter call, you can get the name of the newly created compound proxy.

Definition at line 54 of file pqCustomFilterDefinitionWizard.h.

Constructor & Destructor Documentation

◆ pqCustomFilterDefinitionWizard()

pqCustomFilterDefinitionWizard::pqCustomFilterDefinitionWizard	(	pqCustomFilterDefinitionModel *	model,
		QWidget *	parent = `nullptr`
	)

Creates a custom filter definition wizard.

Parameters

model	The custom filter definition model to use. The model should not be null.
parent	The parent widget for the wizard.

◆ ~pqCustomFilterDefinitionWizard()

pqCustomFilterDefinitionWizard::~pqCustomFilterDefinitionWizard ( )

override

Member Function Documentation

◆ getModel()

pqCustomFilterDefinitionModel* pqCustomFilterDefinitionWizard::getModel ( ) const

inline

Gets the custom filter definition model used by the wizard.

Returns: A pointer to the custom filter definition model.

Definition at line 75 of file pqCustomFilterDefinitionWizard.h.

◆ getCustomFilterName()

QString pqCustomFilterDefinitionWizard::getCustomFilterName ( ) const

Gets the name of the compound proxy created by the wizard.

Returns: The name of the new compound proxy definition. The name will be empty if the compound proxy has not been created.

See also: pqCustomFilterDefinitionWizard::createCustomFilter();

◆ createCustomFilter

void pqCustomFilterDefinitionWizard::createCustomFilter ( )

slot

Creates a compound proxy definition.

The compound proxy definition is created using the custom filter definition model and the parameters entered by the user. The new definition is registered with the server manager.

See also: pqCustomFilterDefinitionWizard::getCustomFilterName()

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

/builds/gitlab-kitware-sciviz-ci/Qt/Components/pqCustomFilterDefinitionWizard.h

Public Slots

Public Member Functions