list widget for file selection More...

#include <pqFileListPropertyWidget.h>

Inheritance diagram for pqFileListPropertyWidget:

Collaboration diagram for pqFileListPropertyWidget:

Signals
void	fileNamesChanged ()
	Signal fired when filenames are changed. More...

Signals inherited from pqPropertyWidget
void	viewChanged (pqView *view)
	This signal is emitted when the current view changes. More...

void	changeAvailable ()
	This signal is fired as soon as the user starts editing in the widget. More...

void	changeFinished ()
	This signal is fired as soon as the user is done with making an atomic change. More...

void	restartRequired ()
	Indicates that a restart of the program is required for the setting to take effect. More...

Public Member Functions
	pqFileListPropertyWidget (vtkSMProxy smproxy, vtkSMProperty smproperty, QWidget *parent=nullptr)

	~pqFileListPropertyWidget () override


const QStringList &	fileNames () const
	Get/Set the filenames. More...

void	setFileNames (const QStringList &filenames)
	Get/Set the filenames. More...

Public Member Functions inherited from pqPropertyWidget
	pqPropertyWidget (vtkSMProxy proxy, QWidget parent=nullptr)

	~pqPropertyWidget () override

virtual void	apply ()

virtual void	reset ()

virtual void	updateWidget (bool showing_advanced_properties)

pqView *	view () const

vtkSMProxy *	proxy () const

vtkSMProperty *	property () const

virtual char *	panelVisibility () const
	Forward calls to vtkSMProperty. More...

virtual void	setPanelVisibility (const char *vis)

virtual bool	isSingleRowItem () const
	Determines if the PropertyWidget must be constructed using a single row. More...

bool	showLabel () const

const QList< QPointer< pqPropertyWidgetDecorator > > &	decorators () const
	Provides access to the decorators for this widget. More...

void	setProperty (vtkSMProperty *property)

virtual void	select ()
	These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...

virtual void	selectPort (int portIndex)
	These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...

virtual void	deselect ()
	These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...

bool	isSelected () const
	These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...

Properties
QStringList	fileNames

Additional Inherited Members
Public Slots inherited from pqPropertyWidget
virtual void	setView (pqView *)
	called to set the active view. More...

Static Public Member Functions inherited from pqPropertyWidget
template<class T >
static QString	getXMLName (T *object)
	Description: This static utility method returns the XML name for an object as a QString. More...

static QString	getTooltip (vtkSMProperty *property)
	Returns the tooltip to use for the property. More...

static int	hintsWidgetHeightNumberOfRows (vtkPVXMLElement *hints, int defaultValue=10)
	Helper method to return value from WidgetHeight XML hint, if any. More...

static std::vector< std::string >	parseComponentLabels (vtkPVXMLElement *hints, unsigned int elemCount=0)
	Parse a XML element as a list of label to use for this widget. More...

Protected Member Functions inherited from pqPropertyWidget
void	addPropertyLink (QObject qobject, const char qproperty, const char qsignal, vtkSMProperty smproperty, int smindex=-1)

void	addPropertyLink (QObject qobject, const char qproperty, const char qsignal, vtkSMProxy smproxy, vtkSMProperty *smproperty, int smindex=-1)

void	removePropertyLink (QObject qobject, const char qproperty, const char qsignal, vtkSMProperty smproperty, int smindex=-1)

void	removePropertyLink (QObject qobject, const char qproperty, const char qsignal, vtkSMProxy smproxy, vtkSMProperty *smproperty, int smindex=-1)

void	setShowLabel (bool show)

void	setChangeAvailableAsChangeFinished (bool status)
	For most pqPropertyWidget subclasses a changeAvailable() signal, corresponds to a changeFinished() signal. More...

void	addDecorator (pqPropertyWidgetDecorator *)
	Register a decorator. More...

void	removeDecorator (pqPropertyWidgetDecorator *)
	Unregisters a decorator. More...

pqPropertyLinks &	links ()
	Provides access to the pqPropertyLinks instance. More...

Detailed Description

list widget for file selection

pqFileListPropertyWidget is intended to be used with properties that allow users to select files (or directories). Instead of showing a single input widget, which is the case by default (see pqStringVectorPropertyWidget), this custom widget shows a list (rather a table) with all the selected filenames. Users can add/remove files.

To use this widget on your string-vector property, set the panel widget to "file_list".

For example:

<SourceProxy name="TestSource" >
  <StringVectorProperty name="Files"
        command="..."
        default_values="/tmp/test.txt"
        number_of_elements="1"
        repeatable="1"
        number_of_elements_per_command="1"
        panel_widget="file_list">
        <FileListDomain name="files"/>
  </StringVectorProperty>
</SourceProxy>

Definition at line 43 of file pqFileListPropertyWidget.h.

Constructor & Destructor Documentation

◆ pqFileListPropertyWidget()

pqFileListPropertyWidget::pqFileListPropertyWidget	(	vtkSMProxy *	smproxy,
		vtkSMProperty *	smproperty,
		QWidget *	parent = `nullptr`
	)

explicit

◆ ~pqFileListPropertyWidget()

pqFileListPropertyWidget::~pqFileListPropertyWidget ( )

override

Member Function Documentation

◆ fileNames()

const QStringList& pqFileListPropertyWidget::fileNames ( ) const

Get/Set the filenames.

◆ setFileNames()

void pqFileListPropertyWidget::setFileNames ( const QStringList & filenames )

Get/Set the filenames.

◆ fileNamesChanged

void pqFileListPropertyWidget::fileNamesChanged ( )

signal

Signal fired when filenames are changed.

Property Documentation

◆ fileNames

QStringList pqFileListPropertyWidget::fileNames

readwrite

Definition at line 47 of file pqFileListPropertyWidget.h.

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

/builds/gitlab-kitware-sciviz-ci/Qt/ApplicationComponents/pqFileListPropertyWidget.h

Signals

Public Member Functions

Properties

Additional Inherited Members