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

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

#include <vtkQtTableView.h>

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

Public Types

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

Public Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkQtTableViewNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
QWidget * GetWidget () override
 Get the main container of this view (a QWidget). More...
 
void SetShowVerticalHeaders (bool)
 Have the view show/hide its column headers. More...
 
void SetShowHorizontalHeaders (bool)
 Have the view show/hide its row headers. More...
 
void SetEnableDragDrop (bool)
 Enable drag and drop on this widget. More...
 
void SetSortingEnabled (bool)
 Whether the table allows individual columns to be sorted upon Sorting is enabled by default (turn off for large tables);. More...
 
void SetColumnVisibility (const QString &name, bool status)
 
void SetSplitMultiComponentColumns (bool value)
 Set whether or not the table view should split multi-component columns into multiple single-component columns. More...
 
bool GetSplitMultiComponentColumns ()
 Get whether or not the table view splits multi-component columns into multiple single-component columns. More...
 
void Update () override
 Updates the view. More...
 
void ApplyViewTheme (vtkViewTheme *theme) override
 Apply a view theme to this view. More...
 
virtual void GetSelectedItems (vtkIdTypeArray *arr)
 Fills the array with the selected items of the view. More...
 
virtual int GetFieldType ()
 The field type to copy into the output table. More...
 
void SetFieldType (int)
 The field type to copy into the output table. More...
 
void SetShowAll (bool)
 Whether or not to display all columns from the input table or to use the ColumnName provided. More...
 
virtual bool GetShowAll ()
 Whether or not to display all columns from the input table or to use the ColumnName provided. More...
 
virtual void SetColumnName (const char *)
 The name of a single column to display. More...
 
virtual char * GetColumnName ()
 The name of a single column to display. More...
 
void SetSortSelectionToTop (bool value)
 Whether or not to sort selections that the view receives to the top. More...
 
virtual bool GetSortSelectionToTop ()
 Whether or not to sort selections that the view receives to the top. More...
 
void SetApplyRowColors (bool value)
 Whether or not to add an icon to the row header denoting the color of an annotated row. More...
 
virtual bool GetApplyRowColors ()
 Whether or not to add an icon to the row header denoting the color of an annotated row. More...
 
void SetColorArrayName (const char *name)
 The array to use for coloring items in view. More...
 
const char * GetColorArrayName ()
 The array to use for coloring items in view. More...
 
void SetColorByArray (bool vis)
 Whether to color vertices. More...
 
bool GetColorByArray ()
 Whether to color vertices. More...
 
virtual void ColorByArrayOn ()
 Whether to color vertices. More...
 
virtual void ColorByArrayOff ()
 Whether to color vertices. More...
 
virtual void SetSelectionBehavior (int type)
 The selection mode for this view. More...
 
virtual int GetSelectionBehavior ()
 The selection mode for this view. More...
 
- Public Member Functions inherited from vtkQtView
vtkQtViewNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void ProcessQtEvents ()
 Calls QApplication::processEvents(). More...
 
virtual void ProcessQtEventsNoUserInput ()
 Calls QApplication::processEvents(QEventLoop::ExcludeUserInputEvents). More...
 
virtual bool SaveImage (const char *fileName)
 Save an image. More...
 
- Public Member Functions inherited from vtkView
vtkViewNewInstance () const
 
void AddRepresentation (vtkDataRepresentation *rep)
 Adds the representation to the view. More...
 
void SetRepresentation (vtkDataRepresentation *rep)
 Set the representation to the view. More...
 
vtkDataRepresentationAddRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
 Convenience method which creates a simple representation with the connection and adds it to the view. More...
 
vtkDataRepresentationSetRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
 Convenience method which sets the representation with the connection and adds it to the view. More...
 
vtkDataRepresentationAddRepresentationFromInput (vtkDataObject *input)
 Convenience method which creates a simple representation with the specified input and adds it to the view. More...
 
vtkDataRepresentationSetRepresentationFromInput (vtkDataObject *input)
 Convenience method which sets the representation to the specified input and adds it to the view. More...
 
void RemoveRepresentation (vtkDataRepresentation *rep)
 Removes the representation from the view. More...
 
void RemoveRepresentation (vtkAlgorithmOutput *rep)
 Removes any representation with this connection from the view. More...
 
void RemoveAllRepresentations ()
 Removes all representations from the view. More...
 
int GetNumberOfRepresentations ()
 Returns the number of representations from first port(0) in this view. More...
 
vtkDataRepresentationGetRepresentation (int index=0)
 The representation at a specified index. More...
 
bool IsRepresentationPresent (vtkDataRepresentation *rep)
 Check to see if a representation is present in the view. More...
 
virtual void ApplyViewTheme (vtkViewTheme *vtkNotUsed(theme))
 Apply a theme to the view. More...
 
vtkCommandGetObserver ()
 Returns the observer that the subclasses can use to listen to additional events. More...
 
void RegisterProgress (vtkObject *algorithm, const char *message=NULL)
 Meant for use by subclasses and vtkRepresentation subclasses. More...
 
void UnRegisterProgress (vtkObject *algorithm)
 Unregister objects previously registered with RegisterProgress. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int 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. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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. More...
 
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. More...
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkQtTableViewNew ()
 
static int IsTypeOf (const char *type)
 
static vtkQtTableViewSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkQtView
static int IsTypeOf (const char *type)
 
static vtkQtViewSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkView
static vtkViewNew ()
 
static int 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. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkQtTableView ()
 
 ~vtkQtTableView () override
 
void AddRepresentationInternal (vtkDataRepresentation *rep) override
 
void RemoveRepresentationInternal (vtkDataRepresentation *rep) override
 
- Protected Member Functions inherited from vtkQtView
 vtkQtView ()
 
 ~vtkQtView () override
 
- Protected Member Functions inherited from vtkView
 vtkView ()
 Meant for use by subclasses and vtkRepresentation subclasses. More...
 
 ~vtkView () override
 Meant for use by subclasses and vtkRepresentation subclasses. More...
 
virtual void ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)
 Called to process events. More...
 
virtual vtkDataRepresentationCreateDefaultRepresentation (vtkAlgorithmOutput *conn)
 Create a default vtkDataRepresentation for the given vtkAlgorithmOutput. More...
 
virtual void AddRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
 Subclass "hooks" for notifying subclasses of vtkView when representations are added or removed. More...
 
virtual void RemoveRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
 Meant for use by subclasses and vtkRepresentation subclasses. More...
 
virtual void SetReuseSingleRepresentation (bool)
 True if the view takes a single representation that should be reused on Add/SetRepresentationFromInput(Connection) calls. More...
 
virtual bool GetReuseSingleRepresentation ()
 Meant for use by subclasses and vtkRepresentation subclasses. More...
 
virtual void ReuseSingleRepresentationOn ()
 Meant for use by subclasses and vtkRepresentation subclasses. More...
 
virtual void ReuseSingleRepresentationOff ()
 Meant for use by subclasses and vtkRepresentation subclasses. More...
 
- 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=NULL)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkView
bool ReuseSingleRepresentation
 Meant for use by subclasses and vtkRepresentation subclasses. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

A VTK view based on a Qt Table view.

vtkQtTableView is a VTK view using an underlying QTableView.

Thanks:
Thanks to Brian Wylie from Sandia National Laboratories for implementing this class
Examples:
vtkQtTableView (Examples)
Tests:
vtkQtTableView (Tests)

Definition at line 56 of file vtkQtTableView.h.

Member Typedef Documentation

Definition at line 62 of file vtkQtTableView.h.

Member Enumeration Documentation

anonymous enum
Enumerator
FIELD_DATA 
POINT_DATA 
CELL_DATA 
VERTEX_DATA 
EDGE_DATA 
ROW_DATA 

Definition at line 83 of file vtkQtTableView.h.

anonymous enum
Enumerator
SELECT_ITEMS 
SELECT_ROWS 
SELECT_COLUMNS 

Definition at line 190 of file vtkQtTableView.h.

Constructor & Destructor Documentation

vtkQtTableView::vtkQtTableView ( )
protected
vtkQtTableView::~vtkQtTableView ( )
overrideprotected

Member Function Documentation

static vtkQtTableView* vtkQtTableView::New ( )
static
static int vtkQtTableView::IsTypeOf ( const char *  type)
static
virtual int vtkQtTableView::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.

static vtkQtTableView* vtkQtTableView::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkQtTableView::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkQtView.

vtkQtTableView* vtkQtTableView::NewInstance ( ) const
void vtkQtTableView::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.

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

void vtkQtTableView::SetShowVerticalHeaders ( bool  )

Have the view show/hide its column headers.

void vtkQtTableView::SetShowHorizontalHeaders ( bool  )

Have the view show/hide its row headers.

virtual int vtkQtTableView::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.

void vtkQtTableView::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.

void vtkQtTableView::SetEnableDragDrop ( bool  )

Enable drag and drop on this widget.

void vtkQtTableView::SetSortingEnabled ( bool  )

Whether the table allows individual columns to be sorted upon Sorting is enabled by default (turn off for large tables);.

void vtkQtTableView::SetShowAll ( bool  )

Whether or not to display all columns from the input table or to use the ColumnName provided.

FIXME: This should be replaced with an Add/Remove column API.

virtual bool vtkQtTableView::GetShowAll ( )
virtual

Whether or not to display all columns from the input table or to use the ColumnName provided.

FIXME: This should be replaced with an Add/Remove column API.

virtual void vtkQtTableView::SetColumnName ( const char *  )
virtual

The name of a single column to display.

FIXME: This should be replaced with an Add/Remove column API.

virtual char* vtkQtTableView::GetColumnName ( )
virtual

The name of a single column to display.

FIXME: This should be replaced with an Add/Remove column API.

void vtkQtTableView::SetColumnVisibility ( const QString &  name,
bool  status 
)
void vtkQtTableView::SetSplitMultiComponentColumns ( bool  value)

Set whether or not the table view should split multi-component columns into multiple single-component columns.

bool vtkQtTableView::GetSplitMultiComponentColumns ( )

Get whether or not the table view splits multi-component columns into multiple single-component columns.

void vtkQtTableView::SetSortSelectionToTop ( bool  value)

Whether or not to sort selections that the view receives to the top.

virtual bool vtkQtTableView::GetSortSelectionToTop ( )
virtual

Whether or not to sort selections that the view receives to the top.

void vtkQtTableView::SetApplyRowColors ( bool  value)

Whether or not to add an icon to the row header denoting the color of an annotated row.

virtual bool vtkQtTableView::GetApplyRowColors ( )
virtual

Whether or not to add an icon to the row header denoting the color of an annotated row.

void vtkQtTableView::Update ( )
overridevirtual

Updates the view.

Reimplemented from vtkView.

void vtkQtTableView::SetColorArrayName ( const char *  name)

The array to use for coloring items in view.

Default is "color".

const char* vtkQtTableView::GetColorArrayName ( )

The array to use for coloring items in view.

Default is "color".

void vtkQtTableView::SetColorByArray ( bool  vis)

Whether to color vertices.

Default is off.

bool vtkQtTableView::GetColorByArray ( )

Whether to color vertices.

Default is off.

virtual void vtkQtTableView::ColorByArrayOn ( )
virtual

Whether to color vertices.

Default is off.

virtual void vtkQtTableView::ColorByArrayOff ( )
virtual

Whether to color vertices.

Default is off.

void vtkQtTableView::ApplyViewTheme ( vtkViewTheme theme)
override

Apply a view theme to this view.

virtual void vtkQtTableView::SetSelectionBehavior ( int  type)
virtual

The selection mode for this view.

SELECT_ITEMS (0) selects single items. SELECT_ROWS (1) selects rows. SELECT_COLUMNS (2) selects columns. Linked selection only works when in the default mode SELECT_ROWS. Selections from other modes may be retrieved using GetSelectedItems().

virtual int vtkQtTableView::GetSelectionBehavior ( )
virtual

The selection mode for this view.

SELECT_ITEMS (0) selects single items. SELECT_ROWS (1) selects rows. SELECT_COLUMNS (2) selects columns. Linked selection only works when in the default mode SELECT_ROWS. Selections from other modes may be retrieved using GetSelectedItems().

virtual void vtkQtTableView::GetSelectedItems ( vtkIdTypeArray arr)
virtual

Fills the array with the selected items of the view.

If the selection behavior is SELECT_ITEMS, arr will be a 2-component array containing (row,column) for each selected item. If the selection behavior is SELECT_ROWS or SELECT_COLUMNS, arr will contain a list of row or column indices.

void vtkQtTableView::AddRepresentationInternal ( vtkDataRepresentation rep)
overrideprotected
void vtkQtTableView::RemoveRepresentationInternal ( vtkDataRepresentation rep)
overrideprotected

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