A DockItem that represents a button. These can be placed on the Docking widget to add functionality. For example, in touch mode we use this class to have a "Add View" button. More...

#include <CustomDockButton.h>

Inheritance diagram for CustomDockButton:

[legend]

Collaboration diagram for CustomDockButton:

[legend]

Signals
void	closedSignal ()

Public Member Functions
const std::function< void(SectionContent *)> &	callback ()

	CustomDockButton (const TranslatedString &name, const std::function< void(SectionContent )> &callback, ContainerWidgetBase container=nullptr)

	CustomDockButton (const TranslatedString &name, const std::function< void(SectionContent )> &callback, RibbonArea ribbon_area, ContainerWidgetBase container=nullptr)

	CustomDockButton (const TranslatedString &name, RibbonArea ribbon_area, ContainerWidgetBase *container=nullptr)

void	removeButton ()

void	setCallback (const std::function< void(SectionContent *)> &callback)

virtual void	setupDialogButton (Button *button)

void	showButton (bool show_dock, SectionWidget *section)

virtual	~CustomDockButton ()

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)

virtual void	setDockSelected (bool selected)

void	setHidable (bool hidable)

virtual void	setIcon (const QIcon &icon)

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	setTitle (const TranslatedString &title)

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

Additional Inherited Members
Protected Member Functions inherited from DockItem
virtual void	initialize ()

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

A DockItem that represents a button. These can be placed on the Docking widget to add functionality. For example, in touch mode we use this class to have a "Add View" button.

Constructor & Destructor Documentation

◆ CustomDockButton() [1/3]

CustomDockButton	(	const TranslatedString &	name,
		RibbonArea	ribbon_area,
		ContainerWidgetBase *	container = nullptr )

explicit

◆ CustomDockButton() [2/3]

CustomDockButton	(	const TranslatedString &	name,
		const std::function< void(SectionContent *)> &	callback,
		RibbonArea	ribbon_area,
		ContainerWidgetBase *	container = nullptr )

explicit

◆ CustomDockButton() [3/3]

CustomDockButton	(	const TranslatedString &	name,
		const std::function< void(SectionContent *)> &	callback,
		ContainerWidgetBase *	container = nullptr )

explicit

◆ ~CustomDockButton()

virtual ~CustomDockButton ( )

virtual

Member Function Documentation

◆ callback()

const std::function< void(SectionContent *)> & callback ( )

◆ closedSignal

void closedSignal ( )

signal

◆ removeButton()

void removeButton ( )

◆ setCallback()

void setCallback ( const std::function< void(SectionContent *)> & callback )

◆ setupDialogButton()

virtual void setupDialogButton ( Button * button )

virtual

◆ showButton()

void showButton	(	bool	show_dock,
		SectionWidget *	section )

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

Widgets/Headers/CustomDockButton.h

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CustomDockButton() [1/3]

◆ CustomDockButton() [2/3]

◆ CustomDockButton() [3/3]

◆ ~CustomDockButton()

Member Function Documentation

◆ callback()

◆ closedSignal

◆ removeButton()

◆ setCallback()

◆ setupDialogButton()

◆ showButton()