Signals | Public Member Functions | Protected Slots | Protected Member Functions | List of all members
pqArrayListWidget Class Reference

A widget for array labeling. More...

#include <pqArrayListWidget.h>

Inherits QWidget.

Signals

void widgetModified ()
 fired whenever the state has been modified. More...
 

Public Member Functions

 pqArrayListWidget (QWidget *parent=nullptr)
 
 ~pqArrayListWidget () override=default
 
bool event (QEvent *e) override
 overridden to handle QDynamicPropertyChangeEvent events. More...
 
void setHeaderLabel (const QString &label)
 Set table header label. More...
 
void setMaximumRowCountBeforeScrolling (int size)
 Set the maximum number of visible rows. More...
 
void setIconType (const QString &icon_type)
 Set the icon type corresponding to the arrays. More...
 

Protected Slots

void updateProperty ()
 

Protected Member Functions

void propertyChanged (const QString &pname)
 called in event() to handle change in a dynamic property with the given name. More...
 

Detailed Description

A widget for array labeling.

pqArrayListWidget is intended to be used with 2-elements string properties. It creates a two-columns string table. First column is readonly, the second is editable.

It is useful to associate an editable label to each array, for array renaming for instance.

Definition at line 25 of file pqArrayListWidget.h.

Constructor & Destructor Documentation

◆ pqArrayListWidget()

pqArrayListWidget::pqArrayListWidget ( QWidget *  parent = nullptr)

◆ ~pqArrayListWidget()

pqArrayListWidget::~pqArrayListWidget ( )
overridedefault

Member Function Documentation

◆ event()

bool pqArrayListWidget::event ( QEvent *  e)
override

overridden to handle QDynamicPropertyChangeEvent events.

◆ setHeaderLabel()

void pqArrayListWidget::setHeaderLabel ( const QString &  label)

Set table header label.

It should match the Property name.

◆ setMaximumRowCountBeforeScrolling()

void pqArrayListWidget::setMaximumRowCountBeforeScrolling ( int  size)

Set the maximum number of visible rows.

Beyond this threshold, a scrollbar is added. Forwarded to the inner pqTableView.

◆ setIconType()

void pqArrayListWidget::setIconType ( const QString &  icon_type)

Set the icon type corresponding to the arrays.

◆ widgetModified

void pqArrayListWidget::widgetModified ( )
signal

fired whenever the state has been modified.

◆ propertyChanged()

void pqArrayListWidget::propertyChanged ( const QString &  pname)
protected

called in event() to handle change in a dynamic property with the given name.

◆ updateProperty

void pqArrayListWidget::updateProperty ( )
protectedslot

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