QGIS API Documentation 3.27.0-Master (1c05421486)
Classes | Public Member Functions | List of all members
QgsTabWidget Class Reference

The QgsTabWidget class is the same as the QTabWidget but with additional methods to temporarily hide/show tabs. More...

#include <qgstabwidget.h>

Inheritance diagram for QgsTabWidget:
Inheritance graph
[legend]

Public Member Functions

 QgsTabWidget (QWidget *parent=nullptr)
 Create a new QgsTabWidget with the optionally provided parent. More...
 
void hideTab (QWidget *tab)
 Hides the tab with the given widget. More...
 
int realTabIndex (QWidget *widget)
 Returns the index of the tab with the given widget. More...
 
void setTabStyle (int tabIndex, const QgsAttributeEditorElement::LabelStyle &labelStyle)
 Sets the optional custom labelStyle for the tab identified by tabIndex. More...
 
void setTabVisible (QWidget *tab, bool visible)
 Control the visibility for the tab with the given widget. More...
 
void showTab (QWidget *tab)
 Shows the tab with the given widget. More...
 
void tabInserted (int index) override
 Is called internally whenever a new tab has been inserted. More...
 
void tabRemoved (int index) override
 Is called internally whenever a tab has been removed. More...
 

Detailed Description

The QgsTabWidget class is the same as the QTabWidget but with additional methods to temporarily hide/show tabs.

Since
QGIS 3.0

Definition at line 32 of file qgstabwidget.h.

Constructor & Destructor Documentation

◆ QgsTabWidget()

QgsTabWidget::QgsTabWidget ( QWidget *  parent = nullptr)

Create a new QgsTabWidget with the optionally provided parent.

Since
QGIS 3.0

Definition at line 20 of file qgstabwidget.cpp.

Member Function Documentation

◆ hideTab()

void QgsTabWidget::hideTab ( QWidget *  tab)

Hides the tab with the given widget.

Since
QGIS 3.0

Definition at line 30 of file qgstabwidget.cpp.

◆ realTabIndex()

int QgsTabWidget::realTabIndex ( QWidget *  widget)

Returns the index of the tab with the given widget.

This index is not the same as the one provided to insertTab and removeTab since these methods are not aware of hidden tabs.

Since
QGIS 3.0

Definition at line 64 of file qgstabwidget.cpp.

◆ setTabStyle()

void QgsTabWidget::setTabStyle ( int  tabIndex,
const QgsAttributeEditorElement::LabelStyle labelStyle 
)

Sets the optional custom labelStyle for the tab identified by tabIndex.

Since
QGIS 3.26

Definition at line 77 of file qgstabwidget.cpp.

◆ setTabVisible()

void QgsTabWidget::setTabVisible ( QWidget *  tab,
bool  visible 
)

Control the visibility for the tab with the given widget.

Since
QGIS 3.0

Definition at line 56 of file qgstabwidget.cpp.

◆ showTab()

void QgsTabWidget::showTab ( QWidget *  tab)

Shows the tab with the given widget.

Since
QGIS 3.0

Definition at line 43 of file qgstabwidget.cpp.

◆ tabInserted()

void QgsTabWidget::tabInserted ( int  index)
override

Is called internally whenever a new tab has been inserted.

Is used to keep track of currently available and visible tabs.

Since
QGIS 3.0

Definition at line 82 of file qgstabwidget.cpp.

◆ tabRemoved()

void QgsTabWidget::tabRemoved ( int  index)
override

Is called internally whenever a tab has been removed.

Is used to keep track of currently available and visible tabs.

Since
QGIS 3.0

Definition at line 117 of file qgstabwidget.cpp.


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