Provides a wrapper for a widget that can be docked inside a Container or floated as a top-level window within the application. More...

#include <QCustomDockWidget.h>

Inheritance diagram for QCustomDockWidget:

[legend]

Collaboration diagram for QCustomDockWidget:

[legend]

Public Slots
void	highlightDock (bool highlight)

void	setIconSlot (const QIcon &icon)

void	setTitleSlot (const QString &title)

Signals
void	closedSignal ()

void	dockSelectedSignal (bool)

void	fullscreenSignal (bool is_fullscreen)

void	minimizedSignal ()

void	windowIconChanged (const QIcon &icon)

void	windowTitleChanged (const TranslatedString &new_title)

Public Member Functions
SectionContent *	content () const

int	height () const

QIcon	icon () const

bool	isDockFullscreen () const

bool	isVisible () const

QWidget *	mainWidget ()

	QCustomDockWidget (QWidget main_widget, ContainerWidgetBase container=nullptr)

	QCustomDockWidget (QWidget main_widget, RibbonArea ribbon_area, ContainerWidgetBase container=nullptr)

	QCustomDockWidget (RibbonArea ribbon_area, ContainerWidgetBase *container=nullptr)

virtual void	removeButton (Button *button)

void	removeDock (bool delete_when_finished)

void	setAllowAutoHideTitle (bool allow_auto_hide)

virtual void	setDockSelected (bool selected) override

virtual void	setIcon (const QIcon &icon) override

void	setMainWidget (QWidget *widget)

void	setSize (QSize size)

void	setSizeHint (const QSize &size)

virtual void	setTitle (const TranslatedString &title) override

void	setupButton (Button *button)

virtual void	setupDialogButton (Button *button)

void	setVisible (bool visible)

void	setWindowFlag (Qt::WindowType type, bool on=true)

void	setWindowFlags (Qt::WindowFlags type)

void	showDock (bool show_dock)

void	showDock (bool show_dock, const PopupInfo &start_location, const PopupInfo &end_location, SectionWidget *section=nullptr)

void	showDock (bool show_dock, const PopupInfo &start_location, SectionWidget *section=nullptr)

void	showDock (bool show_dock, DropArea area, SectionWidget *section)

void	showDockFullscreen (bool show_dock, const PopupInfo &start_location=PopupInfo())

QSize	sizeHint () const

int	width () const

QString	windowTitle () const

virtual	~QCustomDockWidget ()

Public Member Functions inherited from DockItem
ContainerWidgetBase *	container () const

	DockItem (ContainerWidgetBase *container=nullptr)

	DockItem (RibbonArea ribbon_area, ContainerWidgetBase *container=nullptr)

FloatingWidget *	floatingWidget () const

bool	isClosable () const

bool	isDocked () const

bool	isDockSelected () const

bool	isDockVisible () const

bool	isHidable () const

bool	isMovable () const

bool	isWindowable () const

void	moveTabToEnd ()

void	moveTabToStart ()

SectionWidget *	section () const

void	setClosable (bool closable)

virtual void	setContainer (ContainerWidgetBase *container)

void	setDockArea (DropArea drop_area, SectionWidget *section)

void	setHidable (bool hidable)

virtual void	setIconID (const String &icon)

void	setMoveable (bool movable)

void	setRibbonArea (RibbonArea ribbon_area)

void	setShowTab (bool show_tab)

void	setTabFlat (bool flat)

virtual void	setUseTabTitle (bool use_tab_title)

void	setWindowable (bool hidable)

bool	showTab () const

virtual void	swapWith (DockItem *other_widget)

virtual const TranslatedString &	title () const

SectionIconTab *	titleWidget () const

bool	useTabTitle () const

virtual	~DockItem ()

Protected Slots
void	onCloseButtonClicked ()

void	onFullscreenButtonClicked (bool fullscreen)

Protected Member Functions
virtual void	createSectionContent () override

Protected Member Functions inherited from DockItem
virtual void	initialize ()

Protected Attributes
Buffer< Button * >	m_buttons_to_add

bool	m_highlight_dock

QPointer< QWidget >	m_main_widget

QSize	m_size_hint

Protected Attributes inherited from DockItem
QPointer< ContainerWidgetBase >	m_container

QIcon	m_icon

String	m_icon_id

SectionIconTab *	m_icon_title

bool	m_is_closable

bool	m_is_hidable

bool	m_is_movable

bool	m_is_selected

bool	m_is_windowable

SectionWidget *	m_original_section

RibbonArea	m_prefered_ribbon_area

SectionContent *	m_section_content

bool	m_show_tab

TranslatedString	m_title

bool	m_use_tab_title

UUID	m_uuid

Detailed Description

Provides a wrapper for a widget that can be docked inside a Container or floated as a top-level window within the application.

Constructor & Destructor Documentation

◆ QCustomDockWidget() [1/3]

QCustomDockWidget	(	RibbonArea	ribbon_area,
		ContainerWidgetBase *	container = nullptr )

explicit

◆ QCustomDockWidget() [2/3]

QCustomDockWidget	(	QWidget *	main_widget,
		RibbonArea	ribbon_area,
		ContainerWidgetBase *	container = nullptr )

explicit

◆ QCustomDockWidget() [3/3]

QCustomDockWidget	(	QWidget *	main_widget,
		ContainerWidgetBase *	container = nullptr )

explicit

◆ ~QCustomDockWidget()

virtual ~QCustomDockWidget ( )

virtual

Member Function Documentation

◆ closedSignal

void closedSignal ( )

signal

◆ content()

SectionContent * content ( ) const

inline

◆ createSectionContent()

virtual void createSectionContent ( )

overrideprotectedvirtual

Reimplemented from DockItem.

◆ dockSelectedSignal

void dockSelectedSignal ( bool )

signal

◆ fullscreenSignal

void fullscreenSignal ( bool is_fullscreen )

signal

◆ height()

int height ( ) const

◆ highlightDock

void highlightDock ( bool highlight )

slot

◆ icon()

QIcon icon ( ) const

◆ isDockFullscreen()

bool isDockFullscreen ( ) const

◆ isVisible()

bool isVisible ( ) const

◆ mainWidget()

QWidget * mainWidget ( )

inline

◆ minimizedSignal

void minimizedSignal ( )

signal

◆ onCloseButtonClicked

void onCloseButtonClicked ( )

protectedslot

◆ onFullscreenButtonClicked

void onFullscreenButtonClicked ( bool fullscreen )

protectedslot

◆ removeButton()

virtual void removeButton ( Button * button )

virtual

◆ removeDock()

void removeDock ( bool delete_when_finished )

◆ setAllowAutoHideTitle()

void setAllowAutoHideTitle ( bool allow_auto_hide )

◆ setDockSelected()

virtual void setDockSelected ( bool selected )

overridevirtual

Reimplemented from DockItem.

◆ setIcon()

virtual void setIcon ( const QIcon & icon )

overridevirtual

Reimplemented from DockItem.

◆ setIconSlot

void setIconSlot ( const QIcon & icon )

slot

◆ setMainWidget()

void setMainWidget ( QWidget * widget )

◆ setSize()

void setSize ( QSize size )

◆ setSizeHint()

void setSizeHint ( const QSize & size )

◆ setTitle()

virtual void setTitle ( const TranslatedString & title )

overridevirtual

Reimplemented from DockItem.

◆ setTitleSlot

void setTitleSlot ( const QString & title )

slot

◆ setupButton()

void setupButton ( Button * button )

◆ setupDialogButton()

virtual void setupDialogButton ( Button * button )

virtual

◆ setVisible()

void setVisible ( bool visible )

◆ setWindowFlag()

void setWindowFlag	(	Qt::WindowType	type,
		bool	on = true )

◆ setWindowFlags()

void setWindowFlags ( Qt::WindowFlags type )

◆ showDock() [1/4]

void showDock ( bool show_dock )

◆ showDock() [2/4]

void showDock	(	bool	show_dock,
		const PopupInfo &	start_location,
		const PopupInfo &	end_location,
		SectionWidget *	section = nullptr )

◆ showDock() [3/4]

void showDock	(	bool	show_dock,
		const PopupInfo &	start_location,
		SectionWidget *	section = nullptr )

◆ showDock() [4/4]

void showDock	(	bool	show_dock,
		DropArea	area,
		SectionWidget *	section )

◆ showDockFullscreen()

void showDockFullscreen	(	bool	show_dock,
		const PopupInfo &	start_location = PopupInfo() )

◆ sizeHint()

QSize sizeHint ( ) const

◆ width()

int width ( ) const

◆ windowIconChanged

void windowIconChanged ( const QIcon & icon )

signal

◆ windowTitle()

QString windowTitle ( ) const

◆ windowTitleChanged

void windowTitleChanged ( const TranslatedString & new_title )

signal

Member Data Documentation

◆ m_buttons_to_add

Buffer<Button*> m_buttons_to_add

protected

◆ m_highlight_dock

bool m_highlight_dock

protected

◆ m_main_widget

QPointer<QWidget> m_main_widget

protected

◆ m_size_hint

QSize m_size_hint

protected

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

Widgets/Headers/QCustomDockWidget.h

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ QCustomDockWidget() [1/3]

◆ QCustomDockWidget() [2/3]

◆ QCustomDockWidget() [3/3]

◆ ~QCustomDockWidget()

Member Function Documentation

◆ closedSignal

◆ content()

◆ createSectionContent()

◆ dockSelectedSignal

◆ fullscreenSignal

◆ height()

◆ highlightDock

◆ icon()

◆ isDockFullscreen()

◆ isVisible()

◆ mainWidget()

◆ minimizedSignal

◆ onCloseButtonClicked

◆ onFullscreenButtonClicked

◆ removeButton()

◆ removeDock()

◆ setAllowAutoHideTitle()

◆ setDockSelected()

◆ setIcon()

◆ setIconSlot

◆ setMainWidget()

◆ setSize()

◆ setSizeHint()

◆ setTitle()

◆ setTitleSlot

◆ setupButton()

◆ setupDialogButton()

◆ setVisible()

◆ setWindowFlag()

◆ setWindowFlags()

◆ showDock() [1/4]

◆ showDock() [2/4]

◆ showDock() [3/4]

◆ showDock() [4/4]

◆ showDockFullscreen()

◆ sizeHint()

◆ width()

◆ windowIconChanged

◆ windowTitle()

◆ windowTitleChanged

Member Data Documentation

◆ m_buttons_to_add

◆ m_highlight_dock

◆ m_main_widget

◆ m_size_hint