DockItem Class Reference

#include <DockItem.h>

Inheritance diagram for DockItem:

Collaboration diagram for DockItem:

Public Member Functions
	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)
virtual void	setDockSelected (bool selected)
bool	isDockSelected () const
virtual void	setIcon (const QIcon &icon)
virtual void	setIconID (const String &icon)
virtual void	setTitle (const TranslatedString &title)
virtual const TranslatedString &	title () const

Protected Member Functions
virtual void	createSectionContent ()
virtual void	initialize ()

Protected Attributes
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

DockItem() [1/2]

DockItem ( RibbonArea ribbon_area, ContainerWidgetBase * container = nullptr )

explicit

DockItem() [2/2]

DockItem ( ContainerWidgetBase * container = nullptr )

explicit

~DockItem()

~DockItem ( )

virtual

Member Function Documentation

container()

ContainerWidgetBase * container

(

)

const

createSectionContent()

void createSectionContent ( )

protectedvirtual

Reimplemented in CustomDockButton, and QCustomDockWidget.

floatingWidget()

FloatingWidget * floatingWidget

(

)

const

initialize()

void initialize ( )

protectedvirtual

isClosable()

bool isClosable ( ) const

inline

isDocked()

bool isDocked

(

)

const

isDockSelected()

bool isDockSelected ( ) const

inline

isDockVisible()

bool isDockVisible

(

)

const

isHidable()

bool isHidable ( ) const

inline

isMovable()

bool isMovable

(

)

const

isWindowable()

bool isWindowable ( ) const

inline

moveTabToEnd()

void moveTabToEnd

(

)

moveTabToStart()

void moveTabToStart

(

)

section()

SectionWidget * section

(

)

const

setClosable()

void setClosable

(

bool

closable

)

setContainer()

void setContainer ( ContainerWidgetBase * container )

virtual

setDockArea()

void setDockArea	(	DropArea	drop_area,
		SectionWidget *	section )

setDockSelected()

void setDockSelected ( bool selected )

virtual

Reimplemented in QCustomDockWidget.

setHidable()

void setHidable

(

bool

hidable

)

setIcon()

void setIcon ( const QIcon & icon )

virtual

Reimplemented in QCustomDockWidget.

setIconID()

void setIconID ( const String & icon )

virtual

setMoveable()

void setMoveable

(

bool

movable

)

setRibbonArea()

void setRibbonArea

(

RibbonArea

ribbon_area

)

setShowTab()

void setShowTab

(

bool

show_tab

)

setTabFlat()

void setTabFlat

(

bool

flat

)

setTitle()

void setTitle ( const TranslatedString & title )

virtual

Reimplemented in QCustomDockWidget.

setUseTabTitle()

void setUseTabTitle ( bool use_tab_title )

virtual

setWindowable()

void setWindowable

(

bool

hidable

)

showTab()

bool showTab

(

)

const

swapWith()

void swapWith ( DockItem * other_widget )

virtual

title()

virtual const TranslatedString & title ( ) const

inlinevirtual

titleWidget()

SectionIconTab * titleWidget

(

)

const

useTabTitle()

bool useTabTitle

(

)

const

Member Data Documentation

m_container

QPointer<ContainerWidgetBase> m_container

protected

m_icon

QIcon m_icon

protected

m_icon_id

String m_icon_id

protected

m_icon_title

SectionIconTab* m_icon_title

protected

m_is_closable

bool m_is_closable

protected

m_is_hidable

bool m_is_hidable

protected

m_is_movable

bool m_is_movable

protected

m_is_selected

bool m_is_selected

protected

m_is_windowable

bool m_is_windowable

protected

m_original_section

SectionWidget* m_original_section

protected

m_prefered_ribbon_area

RibbonArea m_prefered_ribbon_area

protected

m_section_content

SectionContent* m_section_content

protected

m_show_tab

bool m_show_tab

protected

m_title

TranslatedString m_title

protected

m_use_tab_title

bool m_use_tab_title

protected

m_uuid

UUID m_uuid

protected

---

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

• Widgets/Headers/DockItem.h
• Widgets/Source/DockItem.cpp