#include <QCustomDockWidget.h>

Inheritance diagram for QCustomDockWidget:

Collaboration diagram for QCustomDockWidget:

Public Slots
void	highlightDock (bool highlight)

void	setIconSlot (const QIcon &icon)

void	setTitleSlot (const QString &title)

Signals
void	closedSignal ()

void	minimizedSignal ()

void	fullscreenSignal (bool is_fullscreen)

void	dockSelectedSignal (bool)

void	windowTitleChanged (const TranslatedString &new_title)

void	windowIconChanged (const QIcon &icon)

Public Member Functions
	QCustomDockWidget (RibbonArea ribbon_area, ContainerWidgetBase *container=nullptr)

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

	QCustomDockWidget (QWidget main_widget, ContainerWidgetBase container=nullptr)

virtual	~QCustomDockWidget ()

void	setMainWidget (QWidget *widget)

QWidget *	mainWidget ()

QString	windowTitle () const

void	setSize (QSize size)

SectionContent *	content () const

void	showDock (bool show_dock)

void	removeDock (bool delete_when_finished)

bool	isVisible () const

void	setupButton (Button *button)

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

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

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

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

QSize	sizeHint () const

void	setSizeHint (const QSize &size)

bool	isDockFullscreen () const

virtual void	setDockSelected (bool selected) override

virtual void	setIcon (const QIcon &icon) override

QIcon	icon () const

virtual void	setTitle (const TranslatedString &title) override

virtual void	setupDialogButton (Button *button)

virtual void	removeButton (Button *button)

void	setWindowFlags (Qt::WindowFlags type)

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

int	width () const

int	height () const

void	setVisible (bool visible)

void	setAllowAutoHideTitle (bool allow_auto_hide)

Public Member Functions inherited from DockItem
	DockItem (RibbonArea ribbon_area, ContainerWidgetBase *container=nullptr)

	DockItem (ContainerWidgetBase *container=nullptr)

virtual	~DockItem ()

void	setRibbonArea (RibbonArea ribbon_area)

void	setDockArea (DropArea drop_area, SectionWidget *section)

SectionIconTab *	titleWidget () const

ContainerWidgetBase *	container () const

SectionWidget *	section () const

FloatingWidget *	floatingWidget () const

virtual void	setContainer (ContainerWidgetBase *container)

virtual void	swapWith (DockItem *other_widget)

void	setClosable (bool closable)

void	setHidable (bool hidable)

void	setWindowable (bool hidable)

void	setShowTab (bool show_tab)

void	setMoveable (bool movable)

bool	isDocked () const

bool	isDockVisible () const

void	setTabFlat (bool flat)

void	moveTabToEnd ()

void	moveTabToStart ()

bool	isClosable () const

bool	isHidable () const

bool	isWindowable () const

bool	isMovable () const

bool	showTab () const

bool	useTabTitle () const

virtual void	setUseTabTitle (bool use_tab_title)

bool	isDockSelected () const

virtual void	setIconID (const String &icon)

virtual const TranslatedString &	title () const

Protected Slots
void	onFullscreenButtonClicked (bool fullscreen)

void	onCloseButtonClicked ()

Protected Member Functions
virtual void	createSectionContent () override

Protected Member Functions inherited from DockItem
virtual void	initialize ()

Protected Attributes
QPointer< QWidget >	m_main_widget

Buffer< Button * >	m_buttons_to_add

bool	m_highlight_dock

QSize	m_size_hint

Protected Attributes inherited from DockItem
UUID	m_uuid

SectionIconTab *	m_icon_title

SectionContent *	m_section_content

SectionWidget *	m_original_section

RibbonArea	m_prefered_ribbon_area

QPointer< ContainerWidgetBase >	m_container

String	m_icon_id

QIcon	m_icon

TranslatedString	m_title

bool	m_is_closable

bool	m_is_windowable

bool	m_is_hidable

bool	m_is_movable

bool	m_is_selected

bool	m_show_tab

bool	m_use_tab_title

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()

~QCustomDockWidget ( )

virtual

Member Function Documentation

◆ closedSignal

void closedSignal ( )

signal

◆ content()

SectionContent * content ( ) const

inline

◆ createSectionContent()

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()

void removeButton ( Button * button )

virtual

◆ removeDock()

void removeDock ( bool delete_when_finished )

◆ setAllowAutoHideTitle()

void setAllowAutoHideTitle ( bool allow_auto_hide )

◆ setDockSelected()

void setDockSelected ( bool selected )

overridevirtual

Reimplemented from DockItem.

◆ setIcon()

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()

void setTitle ( const TranslatedString & title )

overridevirtual

Reimplemented from DockItem.

◆ setTitleSlot

void setTitleSlot ( const QString & title )

slot

◆ setupButton()

void setupButton ( Button * button )

◆ setupDialogButton()

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 files:

Widgets/Headers/QCustomDockWidget.h
Widgets/Source/QCustomDockWidget.cpp

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

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