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

#include <CustomDockButton.h>

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

Signals

void closedSignal ()
 

Public Member Functions

 CustomDockButton (const TranslatedString &name, RibbonArea ribbon_area, ContainerWidgetBase *container=nullptr)
 
 CustomDockButton (const TranslatedString &name, const std::function< void(SectionContent *)> &callback, RibbonArea ribbon_area, ContainerWidgetBase *container=nullptr)
 
 CustomDockButton (const TranslatedString &name, const std::function< void(SectionContent *)> &callback, ContainerWidgetBase *container=nullptr)
 
virtual ~CustomDockButton ()
 
void showButton (bool show_dock, SectionWidget *section)
 
void removeButton ()
 
virtual void setupDialogButton (Button *button)
 
void setCallback (const std::function< void(SectionContent *)> &callback)
 
const std::function< void(SectionContent *)> & callback ()
 
- 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)
 
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 Slots

void onCloseButtonClicked ()
 
void _CustomMenuRequested (const QPoint &pos)
 

Protected Member Functions

virtual void createSectionContent () override
 
- Protected Member Functions inherited from DockItem
virtual void initialize ()
 

Protected Attributes

std::function< void(SectionContent *)> m_callback
 
- 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

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

~CustomDockButton ( )
virtual

Member Function Documentation

◆ _CustomMenuRequested

void _CustomMenuRequested ( const QPoint & pos)
protectedslot

◆ callback()

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

◆ closedSignal

void closedSignal ( )
signal

◆ createSectionContent()

void createSectionContent ( )
overrideprotectedvirtual

Reimplemented from DockItem.

◆ onCloseButtonClicked

void onCloseButtonClicked ( )
protectedslot

◆ removeButton()

void removeButton ( )

◆ setCallback()

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

◆ setupDialogButton()

void setupDialogButton ( Button * button)
virtual

◆ showButton()

void showButton ( bool show_dock,
SectionWidget * section )

Member Data Documentation

◆ m_callback

std::function<void(SectionContent*)> m_callback
protected
The documentation for this class was generated from the following files: