HAL
Public Member Functions | List of all members
hal::ContentAnchor Class Referenceabstract
HAL Gui » Docking System

An abstract class that provides the interface for specific anchors (see SplitterAnchor or TabWidget ). More...

#include <content_anchor.h>

Inheritance diagram for hal::ContentAnchor:
Inheritance graph
Collaboration diagram for hal::ContentAnchor:
Collaboration graph

Public Member Functions

virtual void add (ContentWidget *widget, int index)=0
 
virtual void remove (ContentWidget *widget)=0
 
virtual void detach (ContentWidget *widget)=0
 
virtual void reattach (ContentWidget *widget)=0
 
virtual void open (ContentWidget *widget)=0
 
virtual void close (ContentWidget *widget)=0
 
virtual ~ContentAnchor ()=0
 
virtual int count () const =0
 

Detailed Description

An abstract class that provides the interface for specific anchors (see SplitterAnchor or TabWidget ).

Definition at line 37 of file content_anchor.h.

Constructor & Destructor Documentation

◆ ~ContentAnchor()

hal::ContentAnchor::~ContentAnchor ( )
inlinepure virtual

Destructor that has to be overriden.

Definition at line 94 of file content_anchor.h.

Member Function Documentation

◆ add()

virtual void hal::ContentAnchor::add ( ContentWidget *  widget,
int  index 
)
pure virtual

Adds a given ContentWidget to the anchor.

Parameters
widget- The widget to add.
index- The position.

Implemented in hal::SplitterAnchor, and hal::TabWidget.

Referenced by hal::DockBar::dropEvent().

◆ close()

virtual void hal::ContentAnchor::close ( ContentWidget *  widget)
pure virtual

Closes a given widget.

Parameters
widget- The widget to close.

Implemented in hal::SplitterAnchor, and hal::TabWidget.

Referenced by hal::ContentWidget::close().

◆ count()

virtual int hal::ContentAnchor::count ( ) const
pure virtual

Returns the number of widgets / buttons as of mDockBar->count()

Implemented in hal::TabWidget, and hal::SplitterAnchor.

◆ detach()

virtual void hal::ContentAnchor::detach ( ContentWidget *  widget)
pure virtual

Detaches a given widget from the anchor.

Parameters
widget- The widget to detach.

Implemented in hal::SplitterAnchor, and hal::TabWidget.

Referenced by hal::ContentWidget::detach().

◆ open()

virtual void hal::ContentAnchor::open ( ContentWidget *  widget)
pure virtual

Displays a given widget in the achor's corresponding area.

Parameters
widget- The widget to open.

Implemented in hal::SplitterAnchor, and hal::TabWidget.

Referenced by hal::ContentWidget::open().

◆ reattach()

virtual void hal::ContentAnchor::reattach ( ContentWidget *  widget)
pure virtual

Reattaches a given widget to the anchor.

Parameters
widget- The widget to reattach.

Implemented in hal::SplitterAnchor, and hal::TabWidget.

Referenced by hal::ContentWidget::reattach().

◆ remove()

virtual void hal::ContentAnchor::remove ( ContentWidget *  widget)
pure virtual

Removes a given widget from the anchor.

Parameters
widget- The widget to remove.

Implemented in hal::SplitterAnchor, and hal::TabWidget.

Referenced by hal::ContentWidget::remove().

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