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

The window that will hold the classic indicators This is a window so it can be over the window that is being dragged. More...

#include <ClassicIndicatorWindowViewInterface.h>

Inheritance diagram for KDDockWidgets::Core::ClassicIndicatorWindowViewInterface:
Inheritance graph
[legend]

Public Member Functions

 ClassicIndicatorWindowViewInterface ()=default
 
 ClassicIndicatorWindowViewInterface (const ClassicIndicatorWindowViewInterface &)=delete
 
virtual ~ClassicIndicatorWindowViewInterface ()
 
virtual DropLocation hover (Point)=0
 
virtual bool isWindow () const =0
 
ClassicIndicatorWindowViewInterfaceoperator= (const ClassicIndicatorWindowViewInterface &)=delete
 
virtual Point posForIndicator (DropLocation) const =0
 
virtual void raise ()=0
 
virtual void resize (Size)=0
 
virtual void setGeometry (Rect)=0
 
virtual void setObjectName (const QString &)=0
 
virtual void setVisible (bool)=0
 
virtual void updateIndicatorVisibility ()=0
 
virtual void updatePositions ()=0
 

Detailed Description

The window that will hold the classic indicators This is a window so it can be over the window that is being dragged.

Definition at line 24 of file ClassicIndicatorWindowViewInterface.h.

Constructor & Destructor Documentation

◆ ClassicIndicatorWindowViewInterface() [1/2]

KDDockWidgets::Core::ClassicIndicatorWindowViewInterface::ClassicIndicatorWindowViewInterface ( )
default

◆ ~ClassicIndicatorWindowViewInterface()

ClassicIndicatorWindowViewInterface::~ClassicIndicatorWindowViewInterface ( )
virtual

Definition at line 16 of file ClassicIndicatorWindowViewInterface.cpp.

◆ ClassicIndicatorWindowViewInterface() [2/2]

KDDockWidgets::Core::ClassicIndicatorWindowViewInterface::ClassicIndicatorWindowViewInterface ( const ClassicIndicatorWindowViewInterface )
delete

Member Function Documentation

◆ hover()

virtual DropLocation KDDockWidgets::Core::ClassicIndicatorWindowViewInterface::hover ( Point  )
pure virtual

Called when the mouse is dragging a window over a drop area The implementer should:

  • Iterate over all visible indicators, if any is under the mouse then it should show the "active" icon variant.

Implemented in KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::ClassicIndicatorWindowViewInterface_wrapper, KDDockWidgetsBindings_wrappersNS::KDDWBindingsFlutter::IndicatorWindow_wrapper, and KDDockWidgets::flutter::IndicatorWindow.

Referenced by KDDockWidgets::Core::ClassicDropIndicatorOverlay::hover_impl().

◆ isWindow()

virtual bool KDDockWidgets::Core::ClassicIndicatorWindowViewInterface::isWindow ( ) const
pure virtual

◆ operator=()

ClassicIndicatorWindowViewInterface & KDDockWidgets::Core::ClassicIndicatorWindowViewInterface::operator= ( const ClassicIndicatorWindowViewInterface )
delete

◆ posForIndicator()

virtual Point KDDockWidgets::Core::ClassicIndicatorWindowViewInterface::posForIndicator ( DropLocation  ) const
pure virtual

◆ raise()

virtual void KDDockWidgets::Core::ClassicIndicatorWindowViewInterface::raise ( )
pure virtual

◆ resize()

virtual void KDDockWidgets::Core::ClassicIndicatorWindowViewInterface::resize ( Size  )
pure virtual

◆ setGeometry()

virtual void KDDockWidgets::Core::ClassicIndicatorWindowViewInterface::setGeometry ( Rect  )
pure virtual

◆ setObjectName()

virtual void KDDockWidgets::Core::ClassicIndicatorWindowViewInterface::setObjectName ( const QString )
pure virtual

◆ setVisible()

virtual void KDDockWidgets::Core::ClassicIndicatorWindowViewInterface::setVisible ( bool  )
pure virtual

◆ updateIndicatorVisibility()

virtual void KDDockWidgets::Core::ClassicIndicatorWindowViewInterface::updateIndicatorVisibility ( )
pure virtual

◆ updatePositions()

virtual void KDDockWidgets::Core::ClassicIndicatorWindowViewInterface::updatePositions ( )
pure virtual

Called by the framework to updates the position of the individual drop indicators This function is called when the drag first starts and also if the window resizes itself (unlikely during drag though) The implementer should:

  • call rect() to know where to put the outer indicators
  • call classicIndicators->hoveredGroup(), if not null, will give you the rect for the inner indicators

Implemented in KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::ClassicIndicatorWindowViewInterface_wrapper, KDDockWidgetsBindings_wrappersNS::KDDWBindingsFlutter::IndicatorWindow_wrapper, KDDockWidgets::flutter::IndicatorWindow, KDDockWidgets::QtQuick::ClassicDropIndicatorOverlay, and KDDockWidgets::QtWidgets::IndicatorWindow.

Referenced by KDDockWidgets::Core::ClassicDropIndicatorOverlay::updateVisibility().


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