KDDockWidgets::Core::TabBarViewInterface Class Reference

The interface that TabBar views should implement. More...

#include <TabBarViewInterface.h>

Inheritance diagram for KDDockWidgets::Core::TabBarViewInterface:

Collaboration diagram for KDDockWidgets::Core::TabBarViewInterface:

Public Member Functions
	TabBarViewInterface (TabBar *)
virtual	~TabBarViewInterface ()
virtual void	changeTabIcon (int index, const Icon &icon)=0
virtual void	insertDockWidget (int index, DockWidget *dw, const Icon &icon, const QString &title)=0
virtual void	moveTabTo (int from, int to)=0
virtual Rect	rectForTab (int index) const =0
virtual void	removeDockWidget (DockWidget *dw)=0
virtual void	renameTab (int index, const QString &)=0
virtual void	setCurrentIndex (int index)=0
virtual void	setTabsAreMovable (bool)
	Implement if your frontend will support reordering tabs with mouse Currently only the QtWidgets frontend supports it.
virtual int	tabAt (Point localPt) const =0
virtual QString	text (int index) const =0
	Returns the tab text for the specified index This is only used by tests, to make sure your tab's text is correct.

Protected Member Functions
	TabBarViewInterface (const TabBarViewInterface &)=delete
TabBarViewInterface &	operator= (const TabBarViewInterface &)=delete

Protected Attributes
TabBar *const	m_tabBar

Detailed Description

The interface that TabBar views should implement.

Definition at line 30 of file TabBarViewInterface.h.

Constructor & Destructor Documentation

TabBarViewInterface() [1/2]

KDDockWidgets::Core::TabBarViewInterface::TabBarViewInterface ( TabBar *  controller )

explicit

Definition at line 18 of file TabBarViewInterface.cpp.

~TabBarViewInterface()

KDDockWidgets::Core::TabBarViewInterface::~TabBarViewInterface ( )

virtualdefault

TabBarViewInterface() [2/2]

KDDockWidgets::Core::TabBarViewInterface::TabBarViewInterface ( const TabBarViewInterface &  )

protecteddelete

Member Function Documentation

changeTabIcon()

virtual void KDDockWidgets::Core::TabBarViewInterface::changeTabIcon ( int  index, const Icon &  icon  )

pure virtual

Implemented in KDDockWidgets::flutter::TabBar.

insertDockWidget()

virtual void KDDockWidgets::Core::TabBarViewInterface::insertDockWidget ( int  index, DockWidget *  dw, const Icon &  icon, const QString &  title  )

pure virtual

Implemented in KDDockWidgets::flutter::TabBar.

moveTabTo()

virtual void KDDockWidgets::Core::TabBarViewInterface::moveTabTo ( int  from, int  to  )

pure virtual

Implemented in KDDockWidgetsBindings_wrappersNS::KDDWBindingsFlutter::TabBar_wrapper, KDDockWidgets::flutter::TabBar, KDDockWidgets::QtQuick::TabBar, and KDDockWidgets::QtWidgets::TabBar.

operator=()

TabBarViewInterface & KDDockWidgets::Core::TabBarViewInterface::operator= ( const TabBarViewInterface &  )

protecteddelete

rectForTab()

virtual Rect KDDockWidgets::Core::TabBarViewInterface::rectForTab ( int  index ) const

pure virtual

Implemented in KDDockWidgetsBindings_wrappersNS::KDDWBindingsFlutter::TabBar_wrapper, KDDockWidgets::flutter::TabBar, KDDockWidgets::QtQuick::TabBar, and KDDockWidgets::QtWidgets::TabBar.

removeDockWidget()

virtual void KDDockWidgets::Core::TabBarViewInterface::removeDockWidget ( DockWidget *  dw )

pure virtual

Implemented in KDDockWidgets::QtQuick::TabBar, KDDockWidgets::QtWidgets::TabBar, KDDockWidgets::flutter::TabBar, and KDDockWidgetsBindings_wrappersNS::KDDWBindingsFlutter::TabBar_wrapper.

renameTab()

virtual void KDDockWidgets::Core::TabBarViewInterface::renameTab ( int  index, const QString &    )

pure virtual

Implemented in KDDockWidgets::QtQuick::TabBar, KDDockWidgets::QtWidgets::TabBar, KDDockWidgetsBindings_wrappersNS::KDDWBindingsFlutter::TabBar_wrapper, and KDDockWidgets::flutter::TabBar.

setCurrentIndex()

virtual void KDDockWidgets::Core::TabBarViewInterface::setCurrentIndex ( int  index )

pure virtual

Implemented in KDDockWidgetsBindings_wrappersNS::KDDWBindingsFlutter::TabBar_wrapper, KDDockWidgets::flutter::TabBar, KDDockWidgets::QtQuick::TabBar, and KDDockWidgets::QtWidgets::TabBar.

setTabsAreMovable()

void KDDockWidgets::Core::TabBarViewInterface::setTabsAreMovable ( bool  )

virtual

Implement if your frontend will support reordering tabs with mouse Currently only the QtWidgets frontend supports it.

Reimplemented in KDDockWidgets::QtWidgets::TabBar.

Definition at line 25 of file TabBarViewInterface.cpp.

tabAt()

virtual int KDDockWidgets::Core::TabBarViewInterface::tabAt ( Point  localPt ) const

pure virtual

Implemented in KDDockWidgetsBindings_wrappersNS::KDDWBindingsFlutter::TabBar_wrapper, and KDDockWidgets::flutter::TabBar.

text()

virtual QString KDDockWidgets::Core::TabBarViewInterface::text ( int  index ) const

pure virtual

Returns the tab text for the specified index This is only used by tests, to make sure your tab's text is correct.

Implemented in KDDockWidgetsBindings_wrappersNS::KDDWBindingsFlutter::TabBar_wrapper, KDDockWidgets::flutter::TabBar, KDDockWidgets::QtQuick::TabBar, and KDDockWidgets::QtWidgets::TabBar.

Member Data Documentation

m_tabBar

TabBar* const KDDockWidgets::Core::TabBarViewInterface::m_tabBar

protected

Definition at line 57 of file TabBarViewInterface.h.

Referenced by KDDockWidgets::QtQuick::TabBar::event(), KDDockWidgets::QtQuick::TabBar::init(), KDDockWidgets::QtWidgets::TabBar::init(), KDDockWidgets::QtWidgets::TabBar::insertDockWidget(), KDDockWidgets::QtWidgets::TabBar::removeDockWidget(), KDDockWidgets::QtQuick::TabBar::stackView(), and KDDockWidgets::QtQuick::TabBar::tabBarAutoHide().

---

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

• TabBarViewInterface.h
• TabBarViewInterface.cpp