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

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

#include <DockWidgetViewInterface.h>

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

Public Member Functions

 DockWidgetViewInterface (DockWidget *)
 
virtual ~DockWidgetViewInterface ()
 
TitleBaractualTitleBar () const
 
void addDockWidgetAsTab (DockWidgetViewInterface *other, const KDDockWidgets::InitialOption &initialOption={})
 
void addDockWidgetToContainingWindow (DockWidgetViewInterface *other, KDDockWidgets::Location location, DockWidgetViewInterface *relativeTo=nullptr, const KDDockWidgets::InitialOption &initialOption={})
 
Vector< QStringaffinities () const
 
DockWidgetdockWidget () const
 
virtual std::shared_ptr< Core::ViewfocusCandidate () const =0
 
void forceClose ()
 
Groupgroup () const
 
Icon icon (IconPlace place=IconPlace::TitleBar) const
 
bool isFloating () const
 
bool isFocused () const
 
bool isOpen () const
 
void moveToSideBar ()
 
void open ()
 
DockWidgetOptions options () const
 
void raise ()
 
void setAffinities (const Vector< QString > &)
 
void setAffinityName (const QString &name)
 
void setAsCurrentTab ()
 
void setFloating (bool)
 
void setIcon (const Icon &icon, IconPlaces places=IconPlace::All)
 
void setMDIPosition (Point pos)
 Sets this dock widgets position to pos within the MDI layout This only applies if the main window is in MDI mode, which it is not by default.
 
void setMDISize (Size size)
 like setMDIPosition(), but for the size.
 
void setMDIZ (int z)
 like setMDIPosition(), but for the Z only implemented for QtQuick
 
void setOptions (DockWidgetOptions)
 
void setTitle (const QString &)
 
void show ()
 
QString title () const
 
QString uniqueName () const
 

Protected Member Functions

 DockWidgetViewInterface (const DockWidgetViewInterface &)=delete
 
DockWidgetViewInterfaceoperator= (const DockWidgetViewInterface &)=delete
 

Protected Attributes

DockWidget *const m_dockWidget
 

Detailed Description

The interface that DockWidget views should implement.

Definition at line 26 of file DockWidgetViewInterface.h.

Constructor & Destructor Documentation

◆ DockWidgetViewInterface() [1/2]

KDDockWidgets::Core::DockWidgetViewInterface::DockWidgetViewInterface ( DockWidget controller)
explicit

Definition at line 19 of file DockWidgetViewInterface.cpp.

◆ ~DockWidgetViewInterface()

KDDockWidgets::Core::DockWidgetViewInterface::~DockWidgetViewInterface ( )
virtualdefault

◆ DockWidgetViewInterface() [2/2]

KDDockWidgets::Core::DockWidgetViewInterface::DockWidgetViewInterface ( const DockWidgetViewInterface )
protecteddelete

Member Function Documentation

◆ actualTitleBar()

TitleBar * KDDockWidgets::Core::DockWidgetViewInterface::actualTitleBar ( ) const

◆ addDockWidgetAsTab()

void KDDockWidgets::Core::DockWidgetViewInterface::addDockWidgetAsTab ( DockWidgetViewInterface other,
const KDDockWidgets::InitialOption initialOption = {} 
)

◆ addDockWidgetToContainingWindow()

void KDDockWidgets::Core::DockWidgetViewInterface::addDockWidgetToContainingWindow ( DockWidgetViewInterface other,
KDDockWidgets::Location  location,
DockWidgetViewInterface relativeTo = nullptr,
const KDDockWidgets::InitialOption initialOption = {} 
)

◆ affinities()

Vector< QString > KDDockWidgets::Core::DockWidgetViewInterface::affinities ( ) const

◆ dockWidget()

DockWidget * KDDockWidgets::Core::DockWidgetViewInterface::dockWidget ( ) const

◆ focusCandidate()

virtual std::shared_ptr< Core::View > KDDockWidgets::Core::DockWidgetViewInterface::focusCandidate ( ) const
pure virtual

◆ forceClose()

void KDDockWidgets::Core::DockWidgetViewInterface::forceClose ( )

◆ group()

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

◆ icon()

Icon KDDockWidgets::Core::DockWidgetViewInterface::icon ( IconPlace  place = IconPlace::TitleBar) const

Definition at line 139 of file DockWidgetViewInterface.cpp.

References KDDockWidgets::Core::DockWidget::icon(), and m_dockWidget.

Referenced by setIcon().

◆ isFloating()

bool KDDockWidgets::Core::DockWidgetViewInterface::isFloating ( ) const

◆ isFocused()

bool KDDockWidgets::Core::DockWidgetViewInterface::isFocused ( ) const

◆ isOpen()

bool KDDockWidgets::Core::DockWidgetViewInterface::isOpen ( ) const

◆ moveToSideBar()

void KDDockWidgets::Core::DockWidgetViewInterface::moveToSideBar ( )

◆ open()

void KDDockWidgets::Core::DockWidgetViewInterface::open ( )

◆ operator=()

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

◆ options()

DockWidgetOptions KDDockWidgets::Core::DockWidgetViewInterface::options ( ) const

◆ raise()

void KDDockWidgets::Core::DockWidgetViewInterface::raise ( )

◆ setAffinities()

void KDDockWidgets::Core::DockWidgetViewInterface::setAffinities ( const Vector< QString > &  affinities)

◆ setAffinityName()

void KDDockWidgets::Core::DockWidgetViewInterface::setAffinityName ( const QString name)

◆ setAsCurrentTab()

void KDDockWidgets::Core::DockWidgetViewInterface::setAsCurrentTab ( )

◆ setFloating()

void KDDockWidgets::Core::DockWidgetViewInterface::setFloating ( bool  is)

◆ setIcon()

void KDDockWidgets::Core::DockWidgetViewInterface::setIcon ( const Icon &  icon,
IconPlaces  places = IconPlace::All 
)

◆ setMDIPosition()

void KDDockWidgets::Core::DockWidgetViewInterface::setMDIPosition ( Point  pos)

Sets this dock widgets position to pos within the MDI layout This only applies if the main window is in MDI mode, which it is not by default.

Definition at line 159 of file DockWidgetViewInterface.cpp.

References m_dockWidget, and KDDockWidgets::Core::DockWidget::setMDIPosition().

◆ setMDISize()

void KDDockWidgets::Core::DockWidgetViewInterface::setMDISize ( Size  size)

like setMDIPosition(), but for the size.

Definition at line 164 of file DockWidgetViewInterface.cpp.

References m_dockWidget, and KDDockWidgets::Core::DockWidget::setMDISize().

◆ setMDIZ()

void KDDockWidgets::Core::DockWidgetViewInterface::setMDIZ ( int  z)

like setMDIPosition(), but for the Z only implemented for QtQuick

Definition at line 169 of file DockWidgetViewInterface.cpp.

References m_dockWidget, and KDDockWidgets::Core::DockWidget::setMDIZ().

◆ setOptions()

void KDDockWidgets::Core::DockWidgetViewInterface::setOptions ( DockWidgetOptions  opts)

◆ setTitle()

void KDDockWidgets::Core::DockWidgetViewInterface::setTitle ( const QString title)

◆ show()

void KDDockWidgets::Core::DockWidgetViewInterface::show ( )
Deprecated:
. Use open() instead.

Definition at line 93 of file DockWidgetViewInterface.cpp.

References open().

◆ title()

QString KDDockWidgets::Core::DockWidgetViewInterface::title ( ) const

◆ uniqueName()

QString KDDockWidgets::Core::DockWidgetViewInterface::uniqueName ( ) const

Member Data Documentation

◆ m_dockWidget

DockWidget* const KDDockWidgets::Core::DockWidgetViewInterface::m_dockWidget
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