ads::CDockAreaTitleBar Class Reference

#include <DockAreaTitleBar.h>

Inheritance diagram for ads::CDockAreaTitleBar:

Public Types
using	Super = QFrame

Public Slots
void	markTabsMenuOutdated ()

Signals
void	tabBarClicked (int index)

Public Member Functions
QAbstractButton *	button (TitleBarButton which) const
	CDockAreaTitleBar (CDockAreaWidget *parent)
virtual void	contextMenuEvent (QContextMenuEvent *event) override
int	indexOf (QWidget *widget) const
void	insertWidget (int index, QWidget *widget)
virtual void	mouseDoubleClickEvent (QMouseEvent *event) override
virtual void	mouseMoveEvent (QMouseEvent *ev) override
virtual void	mousePressEvent (QMouseEvent *ev) override
virtual void	mouseReleaseEvent (QMouseEvent *ev) override
virtual void	setVisible (bool Visible) override
CDockAreaTabBar *	tabBar () const
void	updateDockWidgetActionsButtons ()
virtual	~CDockAreaTitleBar ()

Private Slots
void	onCloseButtonClicked ()
void	onCurrentTabChanged (int Index)
void	onTabsMenuAboutToShow ()
void	onTabsMenuActionTriggered (QAction *Action)
void	onUndockButtonClicked ()

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

Friends
struct	DockAreaTitleBarPrivate

Detailed Description

Title bar of a dock area. The title bar contains a tabbar with all tabs for a dock widget group and with a tabs menu button, a undock button and a close button.

Definition at line 50 of file DockAreaTitleBar.h.

Member Typedef Documentation

Super

using ads::CDockAreaTitleBar::Super = QFrame

Definition at line 100 of file DockAreaTitleBar.h.

Constructor & Destructor Documentation

CDockAreaTitleBar()

ads::CDockAreaTitleBar::CDockAreaTitleBar

(

CDockAreaWidget *

parent

)

Default Constructor

Definition at line 256 of file DockAreaTitleBar.cpp.

~CDockAreaTitleBar()

ads::CDockAreaTitleBar::~CDockAreaTitleBar ( )

virtual

Virtual Destructor

Definition at line 278 of file DockAreaTitleBar.cpp.

Member Function Documentation

button()

QAbstractButton * ads::CDockAreaTitleBar::button

(

TitleBarButton

which

)

const

Returns the button corresponding to the given title bar button identifier

Definition at line 442 of file DockAreaTitleBar.cpp.

contextMenuEvent()

void ads::CDockAreaTitleBar::contextMenuEvent ( QContextMenuEvent *  event )

overridevirtual

Show context menu

Definition at line 573 of file DockAreaTitleBar.cpp.

indexOf()

int ads::CDockAreaTitleBar::indexOf

(

QWidget *

widget

)

const

Searches for widget widget in this title bar. You can use this function, to get the position of the default widget in the tile bar.

int tabBarIndex = TitleBar->indexOf(TitleBar->tabBar());
int closeButtonIndex = TitleBar->indexOf(TitleBar->button(TitleBarButtonClose));

Definition at line 600 of file DockAreaTitleBar.cpp.

insertWidget()

void ads::CDockAreaTitleBar::insertWidget	(	int	index,
		QWidget *	widget
	)

Inserts a custom widget at position index into this title bar. If index is negative, the widget is added at the end. You can use this function to insert custom widgets into the title bar.

Definition at line 593 of file DockAreaTitleBar.cpp.

markTabsMenuOutdated

void ads::CDockAreaTitleBar::markTabsMenuOutdated ( )

slot

Call this slot to tell the title bar that it should update the tabs menu the next time it is shown.

Definition at line 305 of file DockAreaTitleBar.cpp.

mouseDoubleClickEvent()

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

overridevirtual

Double clicking the title bar also starts floating of the complete area

Definition at line 554 of file DockAreaTitleBar.cpp.

mouseMoveEvent()

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

overridevirtual

Starts floating the complete docking area including all dock widgets, if it is not the last dock area in a floating widget

Definition at line 504 of file DockAreaTitleBar.cpp.

mousePressEvent()

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

overridevirtual

Stores mouse position to detect dragging

Definition at line 464 of file DockAreaTitleBar.cpp.

mouseReleaseEvent()

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

overridevirtual

Stores mouse position to detect dragging

Definition at line 483 of file DockAreaTitleBar.cpp.

onCloseButtonClicked

void ads::CDockAreaTitleBar::onCloseButtonClicked ( )

privateslot

Definition at line 356 of file DockAreaTitleBar.cpp.

onCurrentTabChanged

void ads::CDockAreaTitleBar::onCurrentTabChanged ( int  Index )

privateslot

Definition at line 424 of file DockAreaTitleBar.cpp.

onTabsMenuAboutToShow

void ads::CDockAreaTitleBar::onTabsMenuAboutToShow ( )

privateslot

Definition at line 330 of file DockAreaTitleBar.cpp.

onTabsMenuActionTriggered

void ads::CDockAreaTitleBar::onTabsMenuActionTriggered ( QAction *  Action )

privateslot

Definition at line 381 of file DockAreaTitleBar.cpp.

onUndockButtonClicked

void ads::CDockAreaTitleBar::onUndockButtonClicked ( )

privateslot

Definition at line 371 of file DockAreaTitleBar.cpp.

setVisible()

void ads::CDockAreaTitleBar::setVisible ( bool  Visible )

overridevirtual

Marks the tabs menu outdated before it calls its base class implementation

Definition at line 456 of file DockAreaTitleBar.cpp.

tabBar()

CDockAreaTabBar * ads::CDockAreaTitleBar::tabBar

(

)

const

Returns the pointer to the tabBar()

Definition at line 299 of file DockAreaTitleBar.cpp.

tabBarClicked

void ads::CDockAreaTitleBar::tabBarClicked ( int  index )

signal

This signal is emitted if a tab in the tab bar is clicked by the user or if the user clicks on a tab item in the title bar tab menu.

updateDockWidgetActionsButtons()

void ads::CDockAreaTitleBar::updateDockWidgetActionsButtons

(

)

Updates the visibility of the dock widget actions in the title bar

Definition at line 390 of file DockAreaTitleBar.cpp.

Friends And Related Function Documentation

DockAreaTitleBarPrivate

friend struct DockAreaTitleBarPrivate

friend

Definition at line 55 of file DockAreaTitleBar.h.

Member Data Documentation

d

DockAreaTitleBarPrivate* ads::CDockAreaTitleBar::d

private

private data (pimpl)

Definition at line 54 of file DockAreaTitleBar.h.

---

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

• DockAreaTitleBar.h
• DockAreaTitleBar.cpp