QAccordion base class. More...

Inheritance diagram for AccordionWidget:

Collaboration diagram for AccordionWidget:

Signals
void	numberOfContentPanesChanged (int number)
	Signals the new number of content panes. More...

Public Member Functions
	AccordionWidget (QWidget *parent=0)
	QAccordion constructor. More...

int	addContentPane (ContentPane *cpane)
	Add content pane. More...

int	addContentPane (QString header)
	Add a new content Pane. More...

int	addContentPane (QString header, QFrame *contentFrame)
	Add a new content Pane. More...

void	getActiveContentPaneIndex (std::vector< int > &indexVector)
	Get the index of the active ContentPane. More...

bool	getCollapsible ()
	Get collapsible status. More...

ContentPane *	getContentPane (uint index)
	Get content pane. More...

int	getContentPaneIndex (ContentPane *contentPane)
	Get the index of a content pane. More...

int	getContentPaneIndex (QFrame *contentFrame)
	Get the index of a content pane. More...

int	getContentPaneIndex (QString header)
	Get the index of a content pane. More...

QString	getError ()
	Get error string. More...

bool	getMultiActive ()
	Check status of multiActive. More...

bool	insertContentPane (uint index, ContentPane *cpane)
	Insert content pane. More...

bool	insertContentPane (uint index, QString header)
	Insert content pane. More...

bool	insertContentPane (uint index, QString header, QFrame *contentFrame)
	Insert content pane. More...

bool	moveContentPane (uint currentIndex, uint newIndex)
	Move content pane. More...

int	numberOfContentPanes ()
	Returns the number of content panes. More...

bool	removeContentPane (bool deleteObject, ContentPane *contentPane)
	Remove a content pane. More...

bool	removeContentPane (bool deleteObject, QFrame *contentframe)
	Remove a content pane. More...

bool	removeContentPane (bool deleteObject, QString header)
	Remove a content pane. More...

bool	removeContentPane (bool deleteObject, uint index)
	Remove a content pane. More...

void	setCollapsible (bool status)
	If collapsible is true you can close all ContentPanes. More...

void	setMultiActive (bool status)
	Allow multiple ContentPane to be open. More...

bool	swapContentPane (uint index, ContentPane *cpane)
	Swap the content pane. More...

Protected Member Functions
void	paintEvent (ATTR_UNUSED QPaintEvent *event)
	paintEvent Reimplement paintEvent to use stylesheets in derived Widgets More...

Private Slots
void	numberOfPanesChanged (int number)

Private Member Functions
bool	checkIndexError (uint index, bool sizeIndexAllowed, const QString &errMessage)

int	findContentPaneIndex (QString name="", QFrame cframe=nullptr, ContentPane cpane=nullptr)

void	handleClickedSignal (ContentPane *cpane)

int	internalAddContentPane (QString header, QFrame cframe=nullptr, ContentPane cpane=nullptr)

bool	internalInsertContentPane (uint index, QString header, QFrame contentFrame=nullptr, ContentPane cpane=nullptr)

bool	internalRemoveContentPane (bool deleteOject, int index=-1, QString name="", QFrame contentFrame=nullptr, ContentPane cpane=nullptr)

Private Attributes
bool	collapsible

std::vector< ContentPane * >	contentPanes

QString	errorString

bool	multiActive

QSpacerItem *	spacer

Detailed Description

QAccordion base class.

This class is the basis of the qAccordion widget. If you want to add a accordion widget to your gui then you have to create an object of this class.

Managing content panes is simpel:

You can either add (addContentPane()) or insert (insertContentPane()) new ContentPanes.
Use removeContentPane() to remove existing ContentPanes.
moveContentPane() allows you to change the order of the ContentPanes.
To change a ContentPane in place use swapContentPane()

Note: Many of the mentioned functions are overloaded, provided for convenience.

The signal numberOfContentPanesChanged() is emitted whenever the number of content panes changed.

In case of an error you may get a more detailed error description with getError().

Warning: Currently Headers have to be unique

Definition at line 77 of file AccordionWidget.h.

Constructor & Destructor Documentation

◆ AccordionWidget()

AccordionWidget::AccordionWidget ( QWidget * parent = 0 )

explicit

QAccordion constructor.

Parameters

parent Optionally provide a parent widget

Definition at line 35 of file AccordionWidget.cpp.

                                                 : QWidget(parent)
 {
     // make sure our resource file gets initialized
     Q_INIT_RESOURCE(accordionwidgeticons);
  
     this->multiActive = true;
     this->collapsible = true;
  
     // set our basic layout
     this->setLayout(new QVBoxLayout());
  
     // add a stretch to the end so all content panes are at the top
     dynamic_cast<QVBoxLayout*>(this->layout())->addStretch();
     this->layout()->setSpacing(1);
     this->layout()->setContentsMargins(QMargins());
     // TODO: Do we need to keep a pointer to the spacer?
     this->spacer = dynamic_cast<QSpacerItem*>(this->layout()->itemAt(0));
  
     // seome things we want to do if the number of panes change
     QObject::connect(this, &AccordionWidget::numberOfContentPanesChanged, this,
                      &AccordionWidget::numberOfPanesChanged);
 }

References collapsible, multiActive, numberOfContentPanesChanged(), numberOfPanesChanged(), and spacer.

Here is the call graph for this function:

Member Function Documentation

◆ addContentPane() [1/3]

int AccordionWidget::addContentPane ( ContentPane * cpane )

Add content pane.

Parameters

cpane New content pane to add

Returns: Content pane index

This is an overloaded method of addContentPane(QString), that allows you to provide your own content pane.

Definition at line 73 of file AccordionWidget.cpp.

 {
     return this->internalAddContentPane("", nullptr, cpane);
 }

References internalAddContentPane().

Here is the call graph for this function:

◆ addContentPane() [2/3]

int AccordionWidget::addContentPane ( QString header )

Add a new content Pane.

Parameters

header Header of the content pane

Returns: Content pane index

Use this method to add a new content pane with the Header header. The method will return the index of the new content pane, or -1 if the pane was not added because header already exists.

Definition at line 63 of file AccordionWidget.cpp.

 {
     return this->internalAddContentPane(std::move(header));
 }

References internalAddContentPane().

Referenced by MaskEditorPropertyPanel::setup_MaskProperties(), MaskEditorPropertyPanel::setup_MaskStack(), MaskEditorPropertyPanel::setup_PlotProperties(), and TestView::test_AccordionWidget().

Here is the call graph for this function:

◆ addContentPane() [3/3]

int AccordionWidget::addContentPane	(	QString	header,
		QFrame *	contentFrame
	)

Add a new content Pane.

Parameters

header	Header of the content pane
contentFrame	The content of the pane

Returns: Content pane index

This is an overloaded method of addContentPane(QString), that allows you to provide your own content frame.

Warning: Headers have to be unique

Definition at line 68 of file AccordionWidget.cpp.

 {
     return this->internalAddContentPane(std::move(header), contentFrame);
 }

References internalAddContentPane().

Here is the call graph for this function:

◆ checkIndexError()

bool AccordionWidget::checkIndexError	(	uint	index,
		bool	sizeIndexAllowed,
		const QString &	errMessage
	)

private

Definition at line 356 of file AccordionWidget.cpp.

 {
     // sizeIndexAllowed is only used by inserting. If there is one pane you will
     // be able to insert a new one before and after.
     // FIXME: Actually there seem to be some bugs hidden here. User may now for
     // example delete index 0 even if there isn't any content pane. I think we
     // excluded checking 0 because of inserting.
     // Update, I removed the 0 exclusion in the second if statement. Really a
     // fix??
     if (sizeIndexAllowed) {
         if (index != 0 && static_cast<int>(index) > numberOfContentPanes()) {
             qDebug() << Q_FUNC_INFO << errMessage;
             this->errorString = errMessage;
             return true;
         }
     } else {
         if (static_cast<int>(index) >= numberOfContentPanes()) {
             qDebug() << Q_FUNC_INFO << errMessage;
             this->errorString = errMessage;
             return true;
         }
     }
     return false;
 }

References errorString, and numberOfContentPanes().

Referenced by internalInsertContentPane(), internalRemoveContentPane(), moveContentPane(), and swapContentPane().

Here is the call graph for this function:

◆ findContentPaneIndex()

int AccordionWidget::findContentPaneIndex	(	QString	name = `""`,
		QFrame *	cframe = `nullptr`,
		ContentPane *	cpane = `nullptr`
	)

private

Definition at line 323 of file AccordionWidget.cpp.

 {
     // simple method that finds the index of a content by Header, content frame
     // or content pane.
     int index = -1;
     if (name != "") {
         auto result =
             std::find_if(this->contentPanes.begin(), this->contentPanes.end(),
                          [&name](ContentPane* pane) { return pane->getHeader() == name; });
         if (result != std::end(this->contentPanes)) {
             // get the index by subtracting begin iterator from result
             // iterator
             // TODO: Is this cast really necessary?
             index = static_cast<int>(result - this->contentPanes.begin());
         }
     }
     if (cframe != nullptr) {
         auto result = std::find_if(
             this->contentPanes.begin(), this->contentPanes.end(),
             [cframe](ContentPane* cpane) { return cpane->getContentFrame() == cframe; });
         if (result != std::end(this->contentPanes)) {
             index = static_cast<int>(result - this->contentPanes.begin());
         }
     }
     if (cpane != nullptr) {
         auto result = std::find(this->contentPanes.begin(), this->contentPanes.end(), cpane);
         if (result != std::end(this->contentPanes)) {
             index = static_cast<int>(result - this->contentPanes.begin());
         }
     }
     return index;
 }

References contentPanes, and RealSpace::Particles::name().

Referenced by getContentPaneIndex(), internalAddContentPane(), internalInsertContentPane(), internalRemoveContentPane(), and swapContentPane().

Here is the call graph for this function:

◆ getActiveContentPaneIndex()

void AccordionWidget::getActiveContentPaneIndex ( std::vector< int > & indexVector )

Get the index of the active ContentPane.

Returns: Vector with indexes of all active ContentPanes

This method will fill a vector with the index of all active ContentPanes. The vector will be empty if no ContentPane is active

Definition at line 192 of file AccordionWidget.cpp.

 {
     // first of all make sure it is empty
     indexVector.clear();
     std::for_each(this->contentPanes.begin(), this->contentPanes.end(),
                   [&indexVector, this](ContentPane* pane) {
                       if (pane->getActive()) {
                           indexVector.push_back(this->findContentPaneIndex("", nullptr, pane));
                       }
                   });
 }

References contentPanes.

Referenced by handleClickedSignal().

◆ getCollapsible()

bool AccordionWidget::getCollapsible ( )

Get collapsible status.

Returns: bool

See also: setCollapsible()

Definition at line 219 of file AccordionWidget.cpp.

 {
     return this->collapsible;
 }

References collapsible.

◆ getContentPane()

ContentPane * AccordionWidget::getContentPane ( uint index )

Get content pane.

Parameters

index Index of the content pane

Returns: QFrame* or nullptr

Get a content pane (QFrame*) with index. This method will return a nullptr if the content pane does not exist.

Definition at line 166 of file AccordionWidget.cpp.

 {
     try {
         return this->contentPanes.at(index);
     } catch (const std::out_of_range& ex) {
         qDebug() << Q_FUNC_INFO << "Can not return Content Pane: " << ex.what();
         this->errorString = "Can not return Content Pane: " + QString(ex.what());
         return nullptr;
     }
 }

References contentPanes, and errorString.

Referenced by MaskEditorPropertyPanel::MaskEditorPropertyPanel(), MaskEditorPropertyPanel::setup_MaskProperties(), MaskEditorPropertyPanel::setup_MaskStack(), MaskEditorPropertyPanel::setup_PlotProperties(), and TestView::test_AccordionWidget().

◆ getContentPaneIndex() [1/3]

int AccordionWidget::getContentPaneIndex ( ContentPane * contentPane )

Get the index of a content pane.

Parameters

contentPane ContentPane*

Returns: Index of the content pane

This is an overloaded function of getContentPaneIndex(QString)

Definition at line 187 of file AccordionWidget.cpp.

 {
     return this->findContentPaneIndex("", nullptr, contentPane);
 }

References findContentPaneIndex().

Here is the call graph for this function:

◆ getContentPaneIndex() [2/3]

int AccordionWidget::getContentPaneIndex ( QFrame * contentFrame )

Get the index of a content pane.

Parameters

contentFrame Content Frame

Returns: Index of the content pane

This is an overloaded function of getContentPaneIndex(QString)

Definition at line 182 of file AccordionWidget.cpp.

 {
     return this->findContentPaneIndex("", contentFrame);
 }

References findContentPaneIndex().

Here is the call graph for this function:

◆ getContentPaneIndex() [3/3]

int AccordionWidget::getContentPaneIndex ( QString header )

Get the index of a content pane.

Parameters

header Header of the Content Pane

Returns: Index of the content pane

Get the index of a ContentPane with header. This method will return -1 if a ContentPane with this header does not exist.

Definition at line 177 of file AccordionWidget.cpp.

 {
     return this->findContentPaneIndex(header);
 }

References findContentPaneIndex().

Here is the call graph for this function:

◆ getError()

QString AccordionWidget::getError ( )

Get error string.

Returns: Error string

Call this method after a function call failed for a detailed error description.

Definition at line 224 of file AccordionWidget.cpp.

 {
     return this->errorString;
 }

References errorString.

◆ getMultiActive()

bool AccordionWidget::getMultiActive ( )

Check status of multiActive.

Returns: bool

See also: setMultiActive()

Definition at line 209 of file AccordionWidget.cpp.

 {
     return this->multiActive;
 }

References multiActive.

Referenced by handleClickedSignal().

◆ handleClickedSignal()

void AccordionWidget::handleClickedSignal ( ContentPane * cpane )

private

Definition at line 381 of file AccordionWidget.cpp.

 {
     // if the clicked content pane is open we simply close it and return
     if (cpane->getActive()) {
         // if collapsible and multiActive are false we are not allowed to close
         // this pane
         if (!this->collapsible && !this->multiActive) {
             return;
         }
         // when multiActive is true we have to check if there is any other open
         // cpane. if so we can close this one
         std::vector<int> activePanes;
         if (!this->collapsible) {
             this->getActiveContentPaneIndex(activePanes);
             if (activePanes.size() == 1)
                 return; // only one active --> good bye :)
         }
         cpane->closeContentPane();
         return;
     }
     // if it is not open we will open it and search our vector for other
     // panes that are already open.
     // TODO: Is it really necessary to search for more than one open cpane?
     if (!cpane->getActive()) {
         // check if multiActive is allowed
         if (!this->getMultiActive()) {
             std::for_each(this->contentPanes.begin(), this->contentPanes.end(),
                           [](ContentPane* pane) {
                               if (pane->getActive())
                                   pane->closeContentPane();
                           });
         }
         cpane->openContentPane();
     }
 }

References ContentPane::closeContentPane(), collapsible, contentPanes, ContentPane::getActive(), getActiveContentPaneIndex(), getMultiActive(), multiActive, and ContentPane::openContentPane().

Referenced by internalAddContentPane(), and internalInsertContentPane().

Here is the call graph for this function:

◆ insertContentPane() [1/3]

bool AccordionWidget::insertContentPane	(	uint	index,
		ContentPane *	cpane
	)

Insert content pane.

Parameters

index	Index of the content pane
cpane	Content Pane to insert

Returns: bool True if insert was successfull

This is an overloaded method of insertContentPane(uint, QString). Use this method when you already created a content pane that you want to insert.

Definition at line 88 of file AccordionWidget.cpp.

 {
     return this->internalInsertContentPane(index, "", nullptr, cpane);
 }

References internalInsertContentPane().

Here is the call graph for this function:

◆ insertContentPane() [2/3]

bool AccordionWidget::insertContentPane	(	uint	index,
		QString	header
	)

Insert content pane.

Parameters

index	Index of the content pane
header	Header of the content pane

Returns: bool True if insert was successfull

You can use this method to insert a new content pane at given index with header defining the Header. An empty content pane will be created that you can get with getContentPane().

Returns true if the insert was successfull.

Definition at line 78 of file AccordionWidget.cpp.

 {
     return this->internalInsertContentPane(index, header);
 }

References internalInsertContentPane().

Here is the call graph for this function:

◆ insertContentPane() [3/3]

bool AccordionWidget::insertContentPane	(	uint	index,
		QString	header,
		QFrame *	contentFrame
	)

Insert content pane.

Parameters

index	Index of the content pane
header	Header of the content pane
contentFrame	Content frame of the content pane

Returns: bool True if insert was successfull

This is an overloaded method of insertContentPane(uint, QString). Use this method when you already created a content frame that you want to insert.

Warning: Headers have to be unique

Definition at line 83 of file AccordionWidget.cpp.

 {
     return this->internalInsertContentPane(index, header, contentFrame);
 }

References internalInsertContentPane().

Here is the call graph for this function:

◆ internalAddContentPane()

int AccordionWidget::internalAddContentPane	(	QString	header,
		QFrame *	cframe = `nullptr`,
		ContentPane *	cpane = `nullptr`
	)

private

Definition at line 229 of file AccordionWidget.cpp.

 {
     if (this->findContentPaneIndex(header, cframe, cpane) != -1) {
         this->errorString = "Can not add content pane as it already exists";
         return -1;
     }
  
     if (cpane == nullptr) {
         if (cframe != nullptr) {
             cpane = new ContentPane(std::move(header), cframe);
         } else {
             cpane = new ContentPane(std::move(header));
         }
     }
     dynamic_cast<QVBoxLayout*>(this->layout())->insertWidget(this->layout()->count() - 1, cpane);
     this->contentPanes.push_back(cpane);
  
     // manage the clicked signal in a lambda expression
     QObject::connect(cpane, &ContentPane::clicked,
                      [this, cpane]() { this->handleClickedSignal(cpane); });
  
     emit numberOfContentPanesChanged(numberOfContentPanes());
  
     return numberOfContentPanes() - 1;
 }

References ContentPane::clicked(), contentPanes, errorString, findContentPaneIndex(), handleClickedSignal(), numberOfContentPanes(), and numberOfContentPanesChanged().

Referenced by addContentPane().

Here is the call graph for this function:

◆ internalInsertContentPane()

bool AccordionWidget::internalInsertContentPane	(	uint	index,
		QString	header,
		QFrame *	contentFrame = `nullptr`,
		ContentPane *	cpane = `nullptr`
	)

private

Definition at line 255 of file AccordionWidget.cpp.

 {
     if (this->checkIndexError(index, true,
                               "Can not insert Content Pane at index " + QString::number(index)
                                   + ". Index out of range")) {
         return false;
     }
  
     if (this->findContentPaneIndex(header, contentFrame, cpane) != -1) {
         return false;
     }
  
     if (cpane == nullptr) {
         if (contentFrame != nullptr) {
             cpane = new ContentPane(std::move(header), contentFrame);
         } else {
             cpane = new ContentPane(std::move(header));
         }
     }
  
     dynamic_cast<QVBoxLayout*>(this->layout())->insertWidget(index, cpane);
  
     this->contentPanes.insert(this->contentPanes.begin() + index, cpane);
  
     // manage the clicked signal in a lambda expression
     QObject::connect(cpane, &ContentPane::clicked,
                      [this, cpane]() { this->handleClickedSignal(cpane); });
  
     emit numberOfContentPanesChanged(numberOfContentPanes());
  
     return true;
 }

References checkIndexError(), ContentPane::clicked(), contentPanes, findContentPaneIndex(), handleClickedSignal(), numberOfContentPanes(), and numberOfContentPanesChanged().

Referenced by insertContentPane().

Here is the call graph for this function:

◆ internalRemoveContentPane()

bool AccordionWidget::internalRemoveContentPane	(	bool	deleteOject,
		int	index = `-1`,
		QString	name = `""`,
		QFrame *	contentFrame = `nullptr`,
		ContentPane *	cpane = `nullptr`
	)

private

Definition at line 289 of file AccordionWidget.cpp.

 {
     if (index != -1
         && this->checkIndexError(index, false,
                                  "Can not remove content pane at index " + QString::number(index)
                                      + ". Index out of range")) {
         return false;
     }
  
     if (index == -1) {
         index = this->findContentPaneIndex(std::move(name), contentFrame, cpane);
         if (index == -1) {
             this->errorString = "Can not remove content pane as it is not part "
                                 "of the accordion widget";
             return false;
         }
     }
  
     dynamic_cast<QVBoxLayout*>(this->layout())->removeWidget(this->contentPanes.at(index));
  
     // only delete the object if user wants to.
     if (deleteOject) {
         delete this->contentPanes.at(index);
         this->contentPanes.at(index) = nullptr;
     }
  
     this->contentPanes.erase(this->contentPanes.begin() + index);
  
     emit numberOfContentPanesChanged(numberOfContentPanes());
  
     return true;
 }

References checkIndexError(), contentPanes, errorString, findContentPaneIndex(), RealSpace::Particles::name(), numberOfContentPanes(), and numberOfContentPanesChanged().

Referenced by removeContentPane().

Here is the call graph for this function:

◆ moveContentPane()

bool AccordionWidget::moveContentPane	(	uint	currentIndex,
		uint	newIndex
	)

Move content pane.

Parameters

currentIndex	The current index of the content pane.
newIndex	The new index of the current pane

Returns: bool

Moves a content from currentIndex to newIndex. Returns true if the content pane was moved, false otherwise.

Definition at line 140 of file AccordionWidget.cpp.

 {
     if (this->checkIndexError(currentIndex, false,
                               "Can not move from " + QString::number(currentIndex)
                                   + ". Index out of range.")
         || this->checkIndexError(newIndex, false,
                                  "Can not move to " + QString::number(newIndex)
                                      + ". Index out of range.")) {
         return false;
     }
  
     QVBoxLayout* layout = dynamic_cast<QVBoxLayout*>(this->layout());
     // get the pane we want to move
     ContentPane* movePane = this->contentPanes.at(currentIndex);
  
     // remove the widget from the layout and insert it at the new position
     layout->removeWidget(movePane);
     layout->insertWidget(newIndex, movePane);
  
     // keep our vector synchronized
     this->contentPanes.erase(this->contentPanes.begin() + currentIndex);
     this->contentPanes.insert(this->contentPanes.begin() + newIndex, movePane);
  
     return true;
 }

References checkIndexError(), and contentPanes.

Here is the call graph for this function:

◆ numberOfContentPanes()

int AccordionWidget::numberOfContentPanes ( )

Returns the number of content panes.

Returns: int

Definition at line 58 of file AccordionWidget.cpp.

 {
     return static_cast<int>(contentPanes.size());
 }

References contentPanes.

Referenced by checkIndexError(), internalAddContentPane(), internalInsertContentPane(), and internalRemoveContentPane().

◆ numberOfContentPanesChanged

void AccordionWidget::numberOfContentPanesChanged ( int number )

signal

Signals the new number of content panes.

Parameters

number Number of content panes

Signal will be emitted if the number of content panes changes

Referenced by AccordionWidget(), internalAddContentPane(), internalInsertContentPane(), and internalRemoveContentPane().

◆ numberOfPanesChanged

void AccordionWidget::numberOfPanesChanged ( int number )

privateslot

Definition at line 417 of file AccordionWidget.cpp.

 {
     // automatically open contentpane if we have only one and collapsible is
     // false
     if (number == 1 && this->collapsible == false) {
         this->contentPanes.at(0)->openContentPane();
     }
 }

References collapsible, and contentPanes.

Referenced by AccordionWidget().

◆ paintEvent()

void AccordionWidget::paintEvent ( ATTR_UNUSED QPaintEvent * event )

protected

paintEvent Reimplement paintEvent to use stylesheets in derived Widgets

Parameters

event

Definition at line 426 of file AccordionWidget.cpp.

 {
     QStyleOption o;
     o.initFrom(this);
     QPainter p(this);
     style()->drawPrimitive(QStyle::PE_Widget, &o, &p, this);
 }

◆ removeContentPane() [1/4]

bool AccordionWidget::removeContentPane	(	bool	deleteObject,
		ContentPane *	contentPane
	)

Remove a content pane.

Parameters

deleteObject	Delete the object and free memory
contentPane	The content pane to remove

Returns: bool

This is an overloaded method of removeContentPane(bool, uint).

Definition at line 135 of file AccordionWidget.cpp.

 {
     return this->internalRemoveContentPane(deleteObject, -1, "", nullptr, contentPane);
 }

References internalRemoveContentPane().

Here is the call graph for this function:

◆ removeContentPane() [2/4]

bool AccordionWidget::removeContentPane	(	bool	deleteObject,
		QFrame *	contentframe
	)

Remove a content pane.

Parameters

deleteObject	Delete the object and free memory
contentframe	Content frame of the content pane

Returns: bool

This is an overloaded method of removeContentPane(bool, uint).

Definition at line 130 of file AccordionWidget.cpp.

 {
     return this->internalRemoveContentPane(deleteObject, -1, "", contentframe);
 }

References internalRemoveContentPane().

Here is the call graph for this function:

◆ removeContentPane() [3/4]

bool AccordionWidget::removeContentPane	(	bool	deleteObject,
		QString	header
	)

Remove a content pane.

Parameters

deleteObject	Delete the object and free memory
header	Header of the content pane

Returns: bool

This is an overloaded method of removeContentPane(bool, uint).

Definition at line 125 of file AccordionWidget.cpp.

 {
     return this->internalRemoveContentPane(deleteObject, -1, header);
 }

References internalRemoveContentPane().

Here is the call graph for this function:

◆ removeContentPane() [4/4]

bool AccordionWidget::removeContentPane	(	bool	deleteObject,
		uint	index
	)

Remove a content pane.

Parameters

deleteObject	Delete the object and free memory
index	Index of the content pane

Returns: bool

Remove a content pane at index. If deleteObject is true the object will be deleted. Otherwise it is up to the user to free the allocated memory.

Returns true if the pane was removed and false otherwise.

Definition at line 120 of file AccordionWidget.cpp.

 {
     return this->internalRemoveContentPane(deleteObject, index);
 }

References internalRemoveContentPane().

Here is the call graph for this function:

◆ setCollapsible()

void AccordionWidget::setCollapsible ( bool status )

If collapsible is true you can close all ContentPanes.

Parameters

status

With the collapsible option you can control if one content pane has to be open and can't be closed.

Definition at line 214 of file AccordionWidget.cpp.

 {
     this->collapsible = status;
 }

References collapsible.

◆ setMultiActive()

void AccordionWidget::setMultiActive ( bool status )

Allow multiple ContentPane to be open.

Parameters

status

This option allows you to open several ContentPane at the same time.

Note: Default value for this option is false.

Definition at line 204 of file AccordionWidget.cpp.

 {
     this->multiActive = status;
 }

References multiActive.

Referenced by TestView::test_AccordionWidget().

◆ swapContentPane()

bool AccordionWidget::swapContentPane	(	uint	index,
		ContentPane *	cpane
	)

Swap the content pane.

Parameters

index	Index of the content pane to swap
cpane	New content pane

Returns: bool True if swap was successfull

With this method you can replace an existing content pane at index with a new one cpane.

Returns true if the swap was successfull.

The old content pane will be deleted.

Definition at line 93 of file AccordionWidget.cpp.

 {
     if (this->checkIndexError(index, false,
                               "Can not swap content pane at index " + QString::number(index)
                                   + ". Index out of range.")) {
         return false;
     }
  
     if (this->findContentPaneIndex("", nullptr, cpane) != -1) {
         this->errorString = "Can not swap content pane as new pane is already "
                             "managed by accordion widget";
         return false;
     }
  
     // remove the old content pane from the accordion layout
     dynamic_cast<QVBoxLayout*>(this->layout())->removeWidget(this->contentPanes.at(index));
     delete this->contentPanes.at(index);
  
     // add the new content pane to the appropriate vector
     this->contentPanes.at(index) = cpane;
  
     // add the new content pane to the layout
     dynamic_cast<QVBoxLayout*>(this->layout())->insertWidget(index, this->contentPanes.at(index));
  
     return true;
 }

References checkIndexError(), contentPanes, errorString, and findContentPaneIndex().

Here is the call graph for this function:

Member Data Documentation

◆ collapsible

bool AccordionWidget::collapsible

private

Definition at line 357 of file AccordionWidget.h.

Referenced by AccordionWidget(), getCollapsible(), handleClickedSignal(), numberOfPanesChanged(), and setCollapsible().

◆ contentPanes

std::vector<ContentPane*> AccordionWidget::contentPanes

private

Definition at line 350 of file AccordionWidget.h.

Referenced by findContentPaneIndex(), getActiveContentPaneIndex(), getContentPane(), handleClickedSignal(), internalAddContentPane(), internalInsertContentPane(), internalRemoveContentPane(), moveContentPane(), numberOfContentPanes(), numberOfPanesChanged(), and swapContentPane().

◆ errorString

QString AccordionWidget::errorString

private

Definition at line 354 of file AccordionWidget.h.

Referenced by checkIndexError(), getContentPane(), getError(), internalAddContentPane(), internalRemoveContentPane(), and swapContentPane().

◆ multiActive

bool AccordionWidget::multiActive

private

Definition at line 356 of file AccordionWidget.h.

Referenced by AccordionWidget(), getMultiActive(), handleClickedSignal(), and setMultiActive().

◆ spacer

QSpacerItem* AccordionWidget::spacer

private

Definition at line 352 of file AccordionWidget.h.

Referenced by AccordionWidget().

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

/home/www/ba/GUI/coregui/Views/AccordionWidget/AccordionWidget.h
/home/www/ba/GUI/coregui/Views/AccordionWidget/AccordionWidget.cpp

Signals

Public Member Functions

Protected Member Functions

Private Slots

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AccordionWidget()

Member Function Documentation

◆ addContentPane() [1/3]

◆ addContentPane() [2/3]

◆ addContentPane() [3/3]

◆ checkIndexError()

◆ findContentPaneIndex()

◆ getActiveContentPaneIndex()

◆ getCollapsible()

◆ getContentPane()

◆ getContentPaneIndex() [1/3]

◆ getContentPaneIndex() [2/3]

◆ getContentPaneIndex() [3/3]

◆ getError()

◆ getMultiActive()

◆ handleClickedSignal()

◆ insertContentPane() [1/3]

◆ insertContentPane() [2/3]

◆ insertContentPane() [3/3]

◆ internalAddContentPane()

◆ internalInsertContentPane()

◆ internalRemoveContentPane()

◆ moveContentPane()

◆ numberOfContentPanes()

◆ numberOfContentPanesChanged

◆ numberOfPanesChanged

◆ paintEvent()

◆ removeContentPane() [1/4]

◆ removeContentPane() [2/4]

◆ removeContentPane() [3/4]

◆ removeContentPane() [4/4]

◆ setCollapsible()

◆ setMultiActive()

◆ swapContentPane()

Member Data Documentation

◆ collapsible

◆ contentPanes

◆ errorString

◆ multiActive

◆ spacer