API Documentation
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
DockItem Class Reference

The root class that allows iterface with the NDEVR API Widget Docking system. More...

#include <DockItem.h>

Inheritance diagram for DockItem:
[legend]
Collaboration diagram for DockItem:
[legend]

Public Member Functions

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

Protected Member Functions

virtual void createSectionContent ()
 
virtual void initialize ()
 

Protected Attributes

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

The root class that allows iterface with the NDEVR API Widget Docking system.

Constructor & Destructor Documentation

◆ DockItem() [1/2]

DockItem ( RibbonArea ribbon_area,
ContainerWidgetBase * container = nullptr )
explicit

◆ DockItem() [2/2]

DockItem ( ContainerWidgetBase * container = nullptr)
explicit

◆ ~DockItem()

virtual ~DockItem ( )
virtual

Member Function Documentation

◆ container()

ContainerWidgetBase * container ( ) const

◆ createSectionContent()

virtual void createSectionContent ( )
protectedvirtual

Reimplemented in QCustomDockWidget.

◆ floatingWidget()

FloatingWidget * floatingWidget ( ) const

◆ initialize()

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

virtual void setContainer ( ContainerWidgetBase * container)
virtual

◆ setDockArea()

void setDockArea ( DropArea drop_area,
SectionWidget * section )

◆ setDockSelected()

virtual void setDockSelected ( bool selected)
virtual

Reimplemented in QCustomDockWidget.

◆ setHidable()

void setHidable ( bool hidable)

◆ setIcon()

virtual void setIcon ( const QIcon & icon)
virtual

Reimplemented in QCustomDockWidget.

◆ setIconID()

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

virtual void setTitle ( const TranslatedString & title)
virtual

Reimplemented in QCustomDockWidget.

◆ setUseTabTitle()

virtual void setUseTabTitle ( bool use_tab_title)
virtual

◆ setWindowable()

void setWindowable ( bool hidable)

◆ showTab()

bool showTab ( ) const

◆ swapWith()

virtual 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 file: