ads::CDockWidgetTab Class Reference

#include <DockWidgetTab.h>

Inheritance diagram for ads::CDockWidgetTab:

Public Types
using	Super = QFrame

Public Slots
virtual void	setVisible (bool visible) override

Signals
void	activeTabChanged ()
void	clicked ()
void	closeOtherTabsRequested ()
void	closeRequested ()
void	elidedChanged (bool elided)
void	moved (const QPoint &GlobalPos)

Public Member Functions
	CDockWidgetTab (CDockWidget *DockWidget, QWidget *parent=0)
CDockAreaWidget *	dockAreaWidget () const
CDockWidget *	dockWidget () const
virtual bool	event (QEvent *e) override
const QIcon &	icon () const
QSize	iconSize () const
bool	isActiveTab () const
bool	isClosable () const
bool	isTitleElided () const
void	setActiveTab (bool active)
void	setDockAreaWidget (CDockAreaWidget *DockArea)
void	setElideMode (Qt::TextElideMode mode)
void	setIcon (const QIcon &Icon)
void	setIconSize (const QSize &Size)
void	setText (const QString &title)
QString	text () const
void	updateStyle ()
virtual	~CDockWidgetTab ()

Protected Member Functions
virtual void	contextMenuEvent (QContextMenuEvent *ev) override
virtual void	mouseDoubleClickEvent (QMouseEvent *event) override
virtual void	mouseMoveEvent (QMouseEvent *ev) override
virtual void	mousePressEvent (QMouseEvent *ev) override
virtual void	mouseReleaseEvent (QMouseEvent *ev) override

Properties
bool	activeTab
QSize	iconSize

Private Slots
void	detachDockWidget ()

Private Member Functions
void	onDockWidgetFeaturesChanged ()

Private Attributes
DockWidgetTabPrivate *	d
	private data (pimpl) More...

Friends
class	CDockManager
class	CDockWidget
struct	DockWidgetTabPrivate

Detailed Description

A dock widget tab that shows a title and an icon. The dock widget tab is shown in the dock area title bar to switch between tabbed dock widgets

Definition at line 50 of file DockWidgetTab.h.

Member Typedef Documentation

using ads::CDockWidgetTab::Super = QFrame

Definition at line 78 of file DockWidgetTab.h.

Constructor & Destructor Documentation

ads::CDockWidgetTab::CDockWidgetTab	(	CDockWidget *	DockWidget,
		QWidget *	parent = 0
	)

Default Constructor param[in] DockWidget The dock widget this title bar belongs to param[in] parent The parent widget of this title bar

Definition at line 327 of file DockWidgetTab.cpp.

ads::CDockWidgetTab::~CDockWidgetTab ( )

virtual

Virtual Destructor

Definition at line 341 of file DockWidgetTab.cpp.

Member Function Documentation

void ads::CDockWidgetTab::activeTabChanged ( )

signal

void ads::CDockWidgetTab::clicked ( )

signal

void ads::CDockWidgetTab::closeOtherTabsRequested ( )

signal

void ads::CDockWidgetTab::closeRequested ( )

signal

void ads::CDockWidgetTab::contextMenuEvent ( QContextMenuEvent *  ev )

overrideprotectedvirtual

Definition at line 474 of file DockWidgetTab.cpp.

void ads::CDockWidgetTab::detachDockWidget ( )

privateslot

Definition at line 660 of file DockWidgetTab.cpp.

CDockAreaWidget * ads::CDockWidgetTab::dockAreaWidget

(

)

const

Returns the dock area widget this title bar belongs to.

Returns

This function returns 0 if the dock widget that owns this title bar widget has not been added to any dock area yet.

Definition at line 560 of file DockWidgetTab.cpp.

CDockWidget * ads::CDockWidgetTab::dockWidget

(

)

const

Returns the dock widget this title widget belongs to

Definition at line 546 of file DockWidgetTab.cpp.

void ads::CDockWidgetTab::elidedChanged ( bool  elided )

signal

bool ads::CDockWidgetTab::event ( QEvent *  e )

overridevirtual

Track event ToolTipChange and set child ToolTip

Definition at line 673 of file DockWidgetTab.cpp.

const QIcon & ads::CDockWidgetTab::icon

(

)

const

Returns the icon

Definition at line 599 of file DockWidgetTab.cpp.

QSize ads::CDockWidgetTab::iconSize

(

)

const

Returns the icon size. If no explicit icon size has been set, the function returns an invalid QSize

bool ads::CDockWidgetTab::isActiveTab

(

)

const

Returns true, if this is the active tab

Definition at line 501 of file DockWidgetTab.cpp.

bool ads::CDockWidgetTab::isClosable

(

)

const

This function returns true if the assigned dock widget is closable

Definition at line 653 of file DockWidgetTab.cpp.

bool ads::CDockWidgetTab::isTitleElided

(

)

const

Returns true if text is elided on the tab's title

Definition at line 645 of file DockWidgetTab.cpp.

void ads::CDockWidgetTab::mouseDoubleClickEvent ( QMouseEvent *  event )

overrideprotectedvirtual

Double clicking the tab widget makes the assigned dock widget floating

Definition at line 613 of file DockWidgetTab.cpp.

void ads::CDockWidgetTab::mouseMoveEvent ( QMouseEvent *  ev )

overrideprotectedvirtual

Definition at line 397 of file DockWidgetTab.cpp.

void ads::CDockWidgetTab::mousePressEvent ( QMouseEvent *  ev )

overrideprotectedvirtual

Definition at line 349 of file DockWidgetTab.cpp.

void ads::CDockWidgetTab::mouseReleaseEvent ( QMouseEvent *  ev )

overrideprotectedvirtual

Definition at line 365 of file DockWidgetTab.cpp.

void ads::CDockWidgetTab::moved ( const QPoint &  GlobalPos )

signal

void ads::CDockWidgetTab::onDockWidgetFeaturesChanged ( )

private

Definition at line 687 of file DockWidgetTab.cpp.

void ads::CDockWidgetTab::setActiveTab

(

bool

active

)

Set this true to make this tab the active tab

Definition at line 508 of file DockWidgetTab.cpp.

void ads::CDockWidgetTab::setDockAreaWidget

(

CDockAreaWidget *

DockArea

)

Sets the dock area widget the dockWidget returned by dockWidget() function belongs to.

Definition at line 553 of file DockWidgetTab.cpp.

void ads::CDockWidgetTab::setElideMode

(

Qt::TextElideMode

mode

)

Sets the text elide mode

Definition at line 695 of file DockWidgetTab.cpp.

void ads::CDockWidgetTab::setIcon

(

const QIcon &

Icon

)

Sets the icon to show in title bar

Definition at line 567 of file DockWidgetTab.cpp.

void ads::CDockWidgetTab::setIconSize

(

const QSize &

Size

)

Set an explicit icon size. If no icon size has been set explicitely, than the tab sets the icon size depending on the style

Definition at line 716 of file DockWidgetTab.cpp.

void ads::CDockWidgetTab::setText

(

const QString &

title

)

Sets the tab text

Definition at line 638 of file DockWidgetTab.cpp.

void ads::CDockWidgetTab::setVisible ( bool  visible )

overridevirtualslot

Definition at line 630 of file DockWidgetTab.cpp.

QString ads::CDockWidgetTab::text

(

)

const

Returns the tab text

Definition at line 606 of file DockWidgetTab.cpp.

void ads::CDockWidgetTab::updateStyle

(

)

Update stylesheet style if a property changes

Definition at line 702 of file DockWidgetTab.cpp.

Friends And Related Function Documentation

friend class CDockManager

friend

Definition at line 60 of file DockWidgetTab.h.

friend class CDockWidget

friend

Definition at line 59 of file DockWidgetTab.h.

friend struct DockWidgetTabPrivate

friend

Definition at line 58 of file DockWidgetTab.h.

Member Data Documentation

DockWidgetTabPrivate* ads::CDockWidgetTab::d

private

private data (pimpl)

Definition at line 57 of file DockWidgetTab.h.

Property Documentation

bool ads::CDockWidgetTab::activeTab

readwrite

Definition at line 53 of file DockWidgetTab.h.

QSize ads::CDockWidgetTab::iconSize

readwrite

Definition at line 54 of file DockWidgetTab.h.

---

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

• DockWidgetTab.h
• DockWidgetTab.cpp