VTK  9.3.20240420
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkQtListView Class Reference

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

#include <vtkQtListView.h>

Inheritance diagram for vtkQtListView:
[legend]
Collaboration diagram for vtkQtListView:
[legend]

Public Types

enum  {
  FIELD_DATA = 0 , POINT_DATA = 1 , CELL_DATA = 2 , VERTEX_DATA = 3 ,
  EDGE_DATA = 4 , ROW_DATA = 5
}
 
typedef vtkQtView Superclass
 
- Public Types inherited from vtkQtView
typedef vtkView Superclass
 
- Public Types inherited from vtkView
typedef vtkObject Superclass
 

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.
 
vtkQtListViewNewInstance () 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 SetEnableDragDrop (bool)
 Enable drag and drop on this widget.
 
void SetAlternatingRowColors (bool)
 Have the view alternate its row colors.
 
void SetDecorationStrategy (int)
 The strategy for how to decorate rows.
 
void SetVisibleColumn (int col)
 The column to display.
 
void SetFilterRegExp (const QRegularExpression &pattern)
 The column used to filter on.
 
void ApplyViewTheme (vtkViewTheme *theme) override
 
void Update () override
 Updates the view.
 
virtual int GetFieldType ()
 The field type to copy into the output table.
 
void SetFieldType (int)
 The field type to copy into the output table.
 
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.
 
void SetIconSheet (QImage sheet)
 Set the icon ivars.
 
void SetIconSize (int w, int h)
 Set the icon ivars.
 
void SetIconSheetSize (int w, int h)
 Set the icon ivars.
 
void SetIconArrayName (const char *name)
 Set the icon ivars.
 
- 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.
 
vtkQtViewNewInstance () 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.
 
vtkViewNewInstance () 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.
 
vtkDataRepresentationAddRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
 Convenience method which creates a simple representation with the connection and adds it to the view.
 
vtkDataRepresentationSetRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
 Convenience method which sets the representation with the connection and adds it to the view.
 
vtkDataRepresentationAddRepresentationFromInput (vtkDataObject *input)
 Convenience method which creates a simple representation with the specified input and adds it to the view.
 
vtkDataRepresentationSetRepresentationFromInput (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.
 
vtkDataRepresentationGetRepresentation (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.
 
vtkCommandGetObserver ()
 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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
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.
 
vtkCommandGetCommand (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.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
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.
 
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.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkQtListViewNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkQtListViewSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkQtView
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkQtViewSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkView
static vtkViewNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkViewSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 (vtkTypeBool 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 vtkTypeBool 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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkQtListView ()
 
 ~vtkQtListView () override
 
void AddRepresentationInternal (vtkDataRepresentation *rep) override
 
void RemoveRepresentationInternal (vtkDataRepresentation *rep) override
 
- Protected Member Functions inherited from vtkQtView
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkQtView ()
 
 ~vtkQtView () override
 
- Protected Member Functions inherited from vtkView
virtual vtkObjectBaseNewInstanceInternal () const
 
virtual void ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)
 Called to process events.
 
virtual vtkDataRepresentationCreateDefaultRepresentation (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 *)
 
virtual void ObjectFinalize ()
 
 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
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

A VTK view based on a Qt List view.

vtkQtListView is a VTK view using an underlying QListView.

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

Definition at line 35 of file vtkQtListView.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkQtListView.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
FIELD_DATA 
POINT_DATA 
CELL_DATA 
VERTEX_DATA 
EDGE_DATA 
ROW_DATA 

Definition at line 52 of file vtkQtListView.h.

Constructor & Destructor Documentation

◆ vtkQtListView()

vtkQtListView::vtkQtListView ( )
protected

◆ ~vtkQtListView()

vtkQtListView::~vtkQtListView ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkQtListView * vtkQtListView::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkQtListView::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 vtkQtListView * vtkQtListView::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkQtListView::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkQtView.

◆ NewInstance()

vtkQtListView * vtkQtListView::NewInstance ( ) const

◆ PrintSelf()

void vtkQtListView::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 vtkObject.

◆ GetWidget()

QWidget * vtkQtListView::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.

◆ GetFieldType()

virtual int vtkQtListView::GetFieldType ( )
virtual

The field type to copy into the output table.

Should be one of FIELD_DATA, POINT_DATA, CELL_DATA, VERTEX_DATA, EDGE_DATA.

◆ SetFieldType()

void vtkQtListView::SetFieldType ( int  )

The field type to copy into the output table.

Should be one of FIELD_DATA, POINT_DATA, CELL_DATA, VERTEX_DATA, EDGE_DATA.

◆ SetEnableDragDrop()

void vtkQtListView::SetEnableDragDrop ( bool  )

Enable drag and drop on this widget.

◆ SetAlternatingRowColors()

void vtkQtListView::SetAlternatingRowColors ( bool  )

Have the view alternate its row colors.

◆ SetDecorationStrategy()

void vtkQtListView::SetDecorationStrategy ( int  )

The strategy for how to decorate rows.

Should be one of vtkQtTableModelAdapter::COLORS, vtkQtTableModelAdapter::ICONS, or vtkQtTableModelAdapter::NONE. Default is NONE.

◆ SetColorArrayName()

void vtkQtListView::SetColorArrayName ( const char *  name)

The array to use for coloring items in view.

Default is "color".

◆ GetColorArrayName()

const char * vtkQtListView::GetColorArrayName ( )

The array to use for coloring items in view.

Default is "color".

◆ SetColorByArray()

void vtkQtListView::SetColorByArray ( bool  vis)

Whether to color vertices.

Default is off.

◆ GetColorByArray()

bool vtkQtListView::GetColorByArray ( )

Whether to color vertices.

Default is off.

◆ ColorByArrayOn()

virtual void vtkQtListView::ColorByArrayOn ( )
virtual

Whether to color vertices.

Default is off.

◆ ColorByArrayOff()

virtual void vtkQtListView::ColorByArrayOff ( )
virtual

Whether to color vertices.

Default is off.

◆ SetVisibleColumn()

void vtkQtListView::SetVisibleColumn ( int  col)

The column to display.

◆ SetFilterRegExp()

void vtkQtListView::SetFilterRegExp ( const QRegularExpression &  pattern)

The column used to filter on.

◆ SetIconSheet()

void vtkQtListView::SetIconSheet ( QImage  sheet)

Set the icon ivars.

Only used if the decoration strategy is set to ICONS.

◆ SetIconSize()

void vtkQtListView::SetIconSize ( int  w,
int  h 
)

Set the icon ivars.

Only used if the decoration strategy is set to ICONS.

◆ SetIconSheetSize()

void vtkQtListView::SetIconSheetSize ( int  w,
int  h 
)

Set the icon ivars.

Only used if the decoration strategy is set to ICONS.

◆ SetIconArrayName()

void vtkQtListView::SetIconArrayName ( const char *  name)

Set the icon ivars.

Only used if the decoration strategy is set to ICONS.

◆ ApplyViewTheme()

void vtkQtListView::ApplyViewTheme ( vtkViewTheme theme)
override

◆ Update()

void vtkQtListView::Update ( )
overridevirtual

Updates the view.

Reimplemented from vtkView.

◆ AddRepresentationInternal()

void vtkQtListView::AddRepresentationInternal ( vtkDataRepresentation rep)
overrideprotected

◆ RemoveRepresentationInternal()

void vtkQtListView::RemoveRepresentationInternal ( vtkDataRepresentation rep)
overrideprotected

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