KDDockWidgets API Documentation 2.1
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
KDDockWidgets::Core::GroupViewInterface Class Referenceabstract

The interface that Frame views should implement. More...

#include <GroupViewInterface.h>

Inheritance diagram for KDDockWidgets::Core::GroupViewInterface:
Inheritance graph
[legend]
Collaboration diagram for KDDockWidgets::Core::GroupViewInterface:
Collaboration graph
[legend]

Public Member Functions

 GroupViewInterface (Group *)
 
virtual ~GroupViewInterface ()
 
virtual Rect dragRect () const
 the rect that should start a drag. Only relevant if the title bar isn't visible. For normal KDDW usage this method doesn't need to be reimplemented.
 
Groupgroup () const
 
virtual void insertDockWidget (DockWidget *, int index)
 
bool isMDI () const
 
virtual int nonContentsHeight () const =0
 Returns the height of the "non-dockwidget" part. i.e.: the height of the titlebar (if any), + height of tabbar (if any) + any margins. Should be implemented by frontend developers, as KDDW doesn't know the layout of the group. This is used to honour minimum-sizes of dock widgets.
 
virtual void removeDockWidget (DockWidget *)
 

Protected Member Functions

 GroupViewInterface (const GroupViewInterface &)=delete
 
GroupViewInterfaceoperator= (const GroupViewInterface &)=delete
 

Protected Attributes

Group *const m_group
 

Detailed Description

The interface that Frame views should implement.

Definition at line 24 of file GroupViewInterface.h.

Constructor & Destructor Documentation

◆ GroupViewInterface() [1/2]

KDDockWidgets::Core::GroupViewInterface::GroupViewInterface ( Group controller)
explicit

Definition at line 19 of file GroupViewInterface.cpp.

◆ ~GroupViewInterface()

KDDockWidgets::Core::GroupViewInterface::~GroupViewInterface ( )
virtualdefault

◆ GroupViewInterface() [2/2]

KDDockWidgets::Core::GroupViewInterface::GroupViewInterface ( const GroupViewInterface )
protecteddelete

Member Function Documentation

◆ dragRect()

Rect KDDockWidgets::Core::GroupViewInterface::dragRect ( ) const
virtual

the rect that should start a drag. Only relevant if the title bar isn't visible. For normal KDDW usage this method doesn't need to be reimplemented.

Reimplemented in KDDockWidgetsBindings_wrappersNS::KDDWBindingsFlutter::Group_wrapper, KDDockWidgets::flutter::Group, and KDDockWidgets::QtWidgets::Group.

Definition at line 36 of file GroupViewInterface.cpp.

◆ group()

Group * KDDockWidgets::Core::GroupViewInterface::group ( ) const

Definition at line 31 of file GroupViewInterface.cpp.

References m_group.

◆ insertDockWidget()

void KDDockWidgets::Core::GroupViewInterface::insertDockWidget ( DockWidget dw,
int  index 
)
virtual

◆ isMDI()

bool KDDockWidgets::Core::GroupViewInterface::isMDI ( ) const

Definition at line 26 of file GroupViewInterface.cpp.

References KDDockWidgets::Core::Group::isMDI(), and m_group.

◆ nonContentsHeight()

virtual int KDDockWidgets::Core::GroupViewInterface::nonContentsHeight ( ) const
pure virtual

Returns the height of the "non-dockwidget" part. i.e.: the height of the titlebar (if any), + height of tabbar (if any) + any margins. Should be implemented by frontend developers, as KDDW doesn't know the layout of the group. This is used to honour minimum-sizes of dock widgets.

Implemented in KDDockWidgetsBindings_wrappersNS::KDDWBindingsFlutter::Group_wrapper, KDDockWidgets::flutter::Group, KDDockWidgets::QtQuick::Group, and KDDockWidgets::QtWidgets::Group.

◆ operator=()

GroupViewInterface & KDDockWidgets::Core::GroupViewInterface::operator= ( const GroupViewInterface )
protecteddelete

◆ removeDockWidget()

void KDDockWidgets::Core::GroupViewInterface::removeDockWidget ( DockWidget dw)
virtual

Member Data Documentation

◆ m_group

Group* const KDDockWidgets::Core::GroupViewInterface::m_group
protected

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

© Klarälvdalens Datakonsult AB (KDAB)
"The Qt, C++ and OpenGL Experts"
https://www.kdab.com/
KDDockWidgets
Advanced Dock Widget Framework for Qt
https://www.kdab.com/development-resources/qt-tools/kddockwidgets/
Generated by doxygen 1.9.8