A VTK view based on a Qt tree view. More...

#include <vtkQtTreeView.h>

Inheritance diagram for vtkQtTreeView:

Collaboration diagram for vtkQtTreeView:

Public Types
typedef vtkQtView	Superclass

Public Types inherited from vtkQtView
typedef vtkView	Superclass

Public Types inherited from vtkView
typedef vtkObject	Superclass

Signals
void	expanded (const QModelIndex &)

void	collapsed (const QModelIndex &)

void	updatePreviewWidget (const QModelIndex &)

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkQtTreeView *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

QWidget *	GetWidget () override
	Get the main container of this view (a QWidget).

void	SetShowHeaders (bool)
	Have the view show/hide its column headers (default is ON)

void	SetAlternatingRowColors (bool)
	Have the view alternate its row colors (default is OFF)

void	SetEnableDragDrop (bool)
	Have the view alternate its row colors (default is OFF)

void	SetShowRootNode (bool)
	Show the root node of the tree (default is OFF)

void	HideColumn (int i)
	Hide the column of the given index from being shown in the view.

void	ShowColumn (int i)
	Show the column of the given index in the view.

void	HideAllButFirstColumn ()
	Hide all but the first column in the view.

void	SetFilterColumn (int i)
	The column used to filter on.

void	SetFilterRegExp (const QRegularExpression &pattern)
	The column used to filter on.

void	SetFilterTreeLevel (int level)
	The column used to filter on.

void	Collapse (const QModelIndex &index)
	Collapses the model item specified by the index.

void	CollapseAll ()
	Collapses all expanded items.

void	Expand (const QModelIndex &index)
	Expands the model item specified by the index.

void	ExpandAll ()
	Expands all expandable items.

void	ExpandToDepth (int depth)
	Expands all expandable items to the given depth.

void	ResizeColumnToContents (int column)
	Resizes the column given to the size of its contents.

void	SetUseColumnView (int state)
	Set whether to use a QColumnView (QTreeView is the default)

void	Update () override
	Updates the view.

void	SetItemDelegate (QAbstractItemDelegate *delegate)
	Set item delegate to something custom.

void	ApplyViewTheme (vtkViewTheme *theme) override


void	SetColorArrayName (const char *name)
	The array to use for coloring items in view.

const char *	GetColorArrayName ()
	The array to use for coloring items in view.


void	SetColorByArray (bool vis)
	Whether to color vertices.

bool	GetColorByArray ()
	Whether to color vertices.

virtual void	ColorByArrayOn ()
	Whether to color vertices.

virtual void	ColorByArrayOff ()
	Whether to color vertices.

Public Member Functions inherited from vtkQtView
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkQtView *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual QWidget *	GetWidget ()=0
	Get the main container of this view (a QWidget).

virtual void	ProcessQtEvents ()
	Calls QApplication::processEvents().

virtual void	ProcessQtEventsNoUserInput ()
	Calls QApplication::processEvents(QEventLoop::ExcludeUserInputEvents).

virtual bool	SaveImage (VTK_FILEPATH const char *fileName)
	Save an image.

Public Member Functions inherited from vtkView
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkView *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	AddRepresentation (vtkDataRepresentation *rep)
	Adds the representation to the view.

void	SetRepresentation (vtkDataRepresentation *rep)
	Set the representation to the view.

vtkDataRepresentation *	AddRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
	Convenience method which creates a simple representation with the connection and adds it to the view.

vtkDataRepresentation *	SetRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
	Convenience method which sets the representation with the connection and adds it to the view.

vtkDataRepresentation *	AddRepresentationFromInput (vtkDataObject *input)
	Convenience method which creates a simple representation with the specified input and adds it to the view.

vtkDataRepresentation *	SetRepresentationFromInput (vtkDataObject *input)
	Convenience method which sets the representation to the specified input and adds it to the view.

void	RemoveRepresentation (vtkDataRepresentation *rep)
	Removes the representation from the view.

void	RemoveRepresentation (vtkAlgorithmOutput *rep)
	Removes any representation with this connection from the view.

void	RemoveAllRepresentations ()
	Removes all representations from the view.

int	GetNumberOfRepresentations ()
	Returns the number of representations from first port(0) in this view.

vtkDataRepresentation *	GetRepresentation (int index=0)
	The representation at a specified index.

bool	IsRepresentationPresent (vtkDataRepresentation *rep)
	Check to see if a representation is present in the view.

virtual void	Update ()
	Update the view.

virtual void	ApplyViewTheme (vtkViewTheme *vtkNotUsed(theme))
	Apply a theme to the view.

vtkCommand *	GetObserver ()
	Returns the observer that the subclasses can use to listen to additional events.

void	RegisterProgress (vtkObject algorithm, const char message=nullptr)
	Meant for use by subclasses and vtkRepresentation subclasses.

void	UnRegisterProgress (vtkObject *algorithm)
	Unregister objects previously registered with RegisterProgress.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkQtTreeView *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkQtTreeView *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkQtView
static vtkTypeBool	IsTypeOf (const char *type)

static vtkQtView *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkView
static vtkView *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkView *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkQtTreeView ()

	~vtkQtTreeView () override

void	AddRepresentationInternal (vtkDataRepresentation *rep) override

void	RemoveRepresentationInternal (vtkDataRepresentation *rep) override

Protected Member Functions inherited from vtkQtView
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkQtView ()

	~vtkQtView () override

Protected Member Functions inherited from vtkView
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkView ()
	Meant for use by subclasses and vtkRepresentation subclasses.

	~vtkView () override
	Meant for use by subclasses and vtkRepresentation subclasses.

virtual void	ProcessEvents (vtkObject caller, unsigned long eventId, void callData)
	Called to process events.

virtual vtkDataRepresentation *	CreateDefaultRepresentation (vtkAlgorithmOutput *conn)
	Create a default vtkDataRepresentation for the given vtkAlgorithmOutput.

virtual void	AddRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
	Subclass "hooks" for notifying subclasses of vtkView when representations are added or removed.

virtual void	RemoveRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
	Meant for use by subclasses and vtkRepresentation subclasses.

virtual void	SetReuseSingleRepresentation (bool)
	True if the view takes a single representation that should be reused on Add/SetRepresentationFromInput(Connection) calls.

virtual bool	GetReuseSingleRepresentation ()
	Meant for use by subclasses and vtkRepresentation subclasses.

virtual void	ReuseSingleRepresentationOn ()
	Meant for use by subclasses and vtkRepresentation subclasses.

virtual void	ReuseSingleRepresentationOff ()
	Meant for use by subclasses and vtkRepresentation subclasses.

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes inherited from vtkView
bool	ReuseSingleRepresentation
	Meant for use by subclasses and vtkRepresentation subclasses.

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

A VTK view based on a Qt tree view.

vtkQtTreeView is a VTK view using an underlying QTreeView.

Thanks:: Thanks to Brian Wylie from Sandia National Laboratories for implementing this class

Definition at line 54 of file vtkQtTreeView.h.

Member Typedef Documentation

◆ Superclass

typedef vtkQtView vtkQtTreeView::Superclass

Definition at line 65 of file vtkQtTreeView.h.

Constructor & Destructor Documentation

◆ vtkQtTreeView()

vtkQtTreeView::vtkQtTreeView ( )

protected

◆ ~vtkQtTreeView()

vtkQtTreeView::~vtkQtTreeView ( )

overrideprotected

Member Function Documentation

◆ expanded

void vtkQtTreeView::expanded ( const QModelIndex & )

signal

◆ collapsed

void vtkQtTreeView::collapsed ( const QModelIndex & )

signal

◆ updatePreviewWidget

void vtkQtTreeView::updatePreviewWidget ( const QModelIndex & )

signal

◆ New()

static vtkQtTreeView * vtkQtTreeView::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkQtTreeView::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkQtTreeView::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkQtView.

◆ SafeDownCast()

static vtkQtTreeView * vtkQtTreeView::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkQtTreeView::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkQtView.

◆ NewInstance()

vtkQtTreeView * vtkQtTreeView::NewInstance ( ) const

◆ PrintSelf()

void vtkQtTreeView::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkView.

◆ GetWidget()

QWidget * vtkQtTreeView::GetWidget ( )

overridevirtual

Get the main container of this view (a QWidget).

The application typically places the view with a call to GetWidget(): something like this this->ui->box->layout()->addWidget(this->View->GetWidget());

Implements vtkQtView.

◆ SetShowHeaders()

void vtkQtTreeView::SetShowHeaders ( bool )

Have the view show/hide its column headers (default is ON)

◆ SetAlternatingRowColors()

void vtkQtTreeView::SetAlternatingRowColors ( bool )

Have the view alternate its row colors (default is OFF)

◆ SetEnableDragDrop()

void vtkQtTreeView::SetEnableDragDrop ( bool )

Have the view alternate its row colors (default is OFF)

◆ SetShowRootNode()

void vtkQtTreeView::SetShowRootNode ( bool )

Show the root node of the tree (default is OFF)

◆ HideColumn()

void vtkQtTreeView::HideColumn ( int i )

Hide the column of the given index from being shown in the view.

◆ ShowColumn()

void vtkQtTreeView::ShowColumn ( int i )

Show the column of the given index in the view.

◆ HideAllButFirstColumn()

void vtkQtTreeView::HideAllButFirstColumn ( )

Hide all but the first column in the view.

◆ SetFilterColumn()

void vtkQtTreeView::SetFilterColumn ( int i )

The column used to filter on.

◆ SetFilterRegExp()

void vtkQtTreeView::SetFilterRegExp ( const QRegularExpression & pattern )

The column used to filter on.

◆ SetFilterTreeLevel()

void vtkQtTreeView::SetFilterTreeLevel ( int level )

The column used to filter on.

◆ Collapse()

void vtkQtTreeView::Collapse ( const QModelIndex & index )

Collapses the model item specified by the index.

◆ CollapseAll()

void vtkQtTreeView::CollapseAll ( )

Collapses all expanded items.

◆ Expand()

void vtkQtTreeView::Expand ( const QModelIndex & index )

Expands the model item specified by the index.

◆ ExpandAll()

void vtkQtTreeView::ExpandAll ( )

Expands all expandable items.

Warning: if the model contains a large number of items, this function will take some time to execute.

◆ ExpandToDepth()

void vtkQtTreeView::ExpandToDepth ( int depth )

Expands all expandable items to the given depth.

◆ ResizeColumnToContents()

void vtkQtTreeView::ResizeColumnToContents ( int column )

Resizes the column given to the size of its contents.

◆ SetUseColumnView()

void vtkQtTreeView::SetUseColumnView ( int state )

Set whether to use a QColumnView (QTreeView is the default)

◆ Update()

void vtkQtTreeView::Update ( )

overridevirtual

Updates the view.

Reimplemented from vtkView.

◆ SetItemDelegate()

void vtkQtTreeView::SetItemDelegate ( QAbstractItemDelegate * delegate )

Set item delegate to something custom.

◆ SetColorArrayName()

void vtkQtTreeView::SetColorArrayName ( const char * name )

The array to use for coloring items in view.

Default is "color".

◆ GetColorArrayName()

const char * vtkQtTreeView::GetColorArrayName ( )

The array to use for coloring items in view.

Default is "color".

◆ SetColorByArray()

void vtkQtTreeView::SetColorByArray ( bool vis )

Whether to color vertices.

Default is off.

◆ GetColorByArray()

bool vtkQtTreeView::GetColorByArray ( )

Whether to color vertices.

Default is off.

◆ ColorByArrayOn()

virtual void vtkQtTreeView::ColorByArrayOn ( )

virtual

Whether to color vertices.

Default is off.

◆ ColorByArrayOff()

virtual void vtkQtTreeView::ColorByArrayOff ( )

virtual

Whether to color vertices.

Default is off.

◆ ApplyViewTheme()

void vtkQtTreeView::ApplyViewTheme ( vtkViewTheme * theme )

override

◆ AddRepresentationInternal()

void vtkQtTreeView::AddRepresentationInternal ( vtkDataRepresentation * rep )

overrideprotected

◆ RemoveRepresentationInternal()

void vtkQtTreeView::RemoveRepresentationInternal ( vtkDataRepresentation * rep )

overrideprotected

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

Views/Qt/vtkQtTreeView.h

Public Types

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkQtTreeView()

◆ ~vtkQtTreeView()

Member Function Documentation

◆ expanded

◆ collapsed

◆ updatePreviewWidget

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetWidget()

◆ SetShowHeaders()

◆ SetAlternatingRowColors()

◆ SetEnableDragDrop()

◆ SetShowRootNode()

◆ HideColumn()

◆ ShowColumn()

◆ HideAllButFirstColumn()

◆ SetFilterColumn()

◆ SetFilterRegExp()

◆ SetFilterTreeLevel()

◆ Collapse()

◆ CollapseAll()

◆ Expand()

◆ ExpandAll()

◆ ExpandToDepth()

◆ ResizeColumnToContents()

◆ SetUseColumnView()

◆ Update()

◆ SetItemDelegate()

◆ SetColorArrayName()

◆ GetColorArrayName()

◆ SetColorByArray()

◆ GetColorByArray()

◆ ColorByArrayOn()

◆ ColorByArrayOff()

◆ ApplyViewTheme()

◆ AddRepresentationInternal()

◆ RemoveRepresentationInternal()