KDDockWidgets API Documentation 2.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
KDDockWidgets::flutter::Group Class Reference

#include <Group.h>

Inheritance diagram for KDDockWidgets::flutter::Group:
Inheritance graph
[legend]
Collaboration diagram for KDDockWidgets::flutter::Group:
Collaboration graph
[legend]

Public Member Functions

 Group (Core::Group *controller, Core::View *parent=nullptr)
 
 ~Group () override
 
int currentIndex () const
 
Rect dragRect () const override
 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.
 
Size maxSizeHint () const override
 Reimplemented for internal purposes.
.
 
Size minSize () const override
 Reimplemented for internal purposes.
.
 
- Public Member Functions inherited from KDDockWidgets::flutter::View
 View (Core::Controller *controller, Core::ViewType type, Core::View *, Qt::WindowFlags windowFlags={})
 
 ~View () override
 
void activateWindow () override
 
std::shared_ptr< Core::ViewasWrapper () override
 Returns this view, but as a wrapper.
 
std::shared_ptr< Core::ViewchildViewAt (Point p) const override
 
Vector< std::shared_ptr< Core::View > > childViews () const override
 @Returns a list of child views
 
bool close () override
 
void enableAttribute (Qt::WidgetAttribute attr, bool enable=true) override
 
Qt::WindowFlags flags () const override
 
Qt::FocusPolicy focusPolicy () const override
 
Rect geometry () const override
 
void grabMouse () override
 
Core::HANDLE handle () const override
 Returns a handle for the GUI element This value only makes sense to the frontend. For example, for QtQuick it might be a QQuickItem, while for QtWidgets it's a QWidget. Can be whatever the frontend developer wants, as long as it uniquely identifies the GUI element. KDDW backend only uses it for comparison purposes.
 
bool hasAttribute (Qt::WidgetAttribute attr) const override
 
bool hasFocus () const override
 
void hide () override
 
bool isActiveWindow () const override
 
bool isExplicitlyHidden () const override
 
bool isMaximized () const override
 
bool isMinimized () const override
 
virtual bool isMounted () const
 
bool isRootView () const override
 
bool isVisible () const override
 
Point mapFromGlobal (Point globalPt) const override
 
Point mapTo (Core::View *parent, Point pos) const override
 
Point mapToGlobal (Point localPt) const override
 
Size maxSizeHint () const override
 
Size minSize () const override
 
void move (int x, int y) override
 
Rect normalGeometry () const override
 
virtual void onChildAdded (Core::View *childView)
 
virtual void onChildRemoved (Core::View *childView)
 
virtual void onChildVisibilityChanged (Core::View *childView)
 
bool onFlutterWidgetResized (int w, int h)
 
virtual void onGeometryChanged ()
 
void onMouseEvent (Event::Type eventType, Point localPos, Point globalPos, bool leftIsPressed)
 Called by flutter when a mouse event is received.
 
virtual void onMousePress (MouseEvent *)
 View can override if it's interested in events which the event filter rejected.
 
virtual void onRebuildRequested ()
 Implemented in Dart.
 
std::shared_ptr< Core::ViewparentView () const override
 Returns the gui element's parent. Like QWidget::parentWidget()
 
void raise () override
 
void raiseAndActivate () override
 
virtual void raiseChild (Core::View *childView)
 
virtual void raiseWindow (Core::View *rootView)
 
void releaseKeyboard () override
 
void releaseMouse () override
 
void render (QPainter *) override
 
std::shared_ptr< Core::ViewrootView () const override
 Returns the top-level gui element which this view is inside It's the root view of the window.
 
void setCursor (Qt::CursorShape shape) override
 
void setFixedHeight (int h) override
 
void setFixedWidth (int w) override
 
void setFlag (Qt::WindowType f, bool on=true) override
 
void setFocus (Qt::FocusReason reason) override
 
void setFocusPolicy (Qt::FocusPolicy policy) override
 
void setGeometry (Rect geometry) override
 
void setHeight (int h) override
 
void setMaximumSize (Size sz) override
 
void setMinimumSize (Size sz) override
 
void setMouseTracking (bool enable) override
 
void setNormalGeometry (Rect geo)
 
void setParent (Core::View *parent) override
 
void setSize (int w, int h) override
 
void setViewName (const QString &name) override
 Equivalent to Qt's QObject::objectName()
 
void setVisible (bool visible) override
 
void setWidth (int w) override
 
void setWindowIcon (const Icon &icon) override
 
void setWindowOpacity (double v) override
 
void setWindowTitle (const QString &title) override
 
void setZOrder (int z) override
 Sets the z order Not supported on all platforms and only relevant for MDI mode.
 
void show () override
 
void showMaximized () override
 
void showMinimized () override
 
void showNormal () override
 
void update () override
 
void updateGeometry ()
 
QString viewName () const override
 
std::shared_ptr< Core::Window > window () const override
 Returns the window this view is inside For the Qt frontend, this wraps a QWindow. Like QWidget::window()
 
- Public Member Functions inherited from KDDockWidgets::Core::View
 View (Controller *controller, ViewType)
 
template<typename T >
T * asController ()
 Returns the View's controller, casted as T.
 
Core::DockWidgetasDockWidgetController () const
 
Core::DropAreaasDropAreaController () const
 
Core::FloatingWindowasFloatingWindowController () const
 asFooController() are deprecated. Use asController<T>() instead
 
Core::GroupasGroupController () const
 
Core::LayoutasLayout () const
 
Core::MainWindowasMainWindowController () const
 
Core::MDILayoutasMDILayoutController () const
 
Core::StackasStackController () const
 
Core::TabBarasTabBarController () const
 
Core::TitleBarasTitleBarController () const
 
Controllercontroller () const
 Returns this view's controller.
 
virtual void createPlatformWindow ()
 
bool deliverViewEventToFilters (Event *e)
 Delivers mouse events and such to event filters.
 
void dumpDebug ()
 Prints some debug to stderr.
 
bool equals (const std::shared_ptr< View > &) const
 
bool equals (const View *other) const
 Returns whether this view represents the same GUI element as the other.
 
int height () const
 
bool inDtor () const
 Returns whether the DTOR is currently running. freed() might be true while inDtor false, as the implementation of free() is free to delay it (with deleteLater() for example)
 
virtual void init ()
 
void installViewEventFilter (EventFilterInterface *)
 Installs an event filter in this view to intercept the event it receives Analogue to QObject::installEventFilter() in the Qt world.
 
virtual bool is (ViewType) const
 Returns whether the view is of the specified type Virtual so it can be overridden by ViewWrapper. When we're wrapping an existing GUI element only the specific frontend can know what's the actual type.
 
bool isFixedHeight () const
 
bool isFixedWidth () const
 
virtual bool isNull () const
 Returns whether the gui item represented by this view was already deleted Usually false, as KDDW internal gui elements inherit View, and nobody will access them after destruction. However, ViewWrapper derived classes, wrap an existing gui element, which might get deleted. Override isNull() in our ViewWrapper subclasses and return true if the wrapped gui element was already deleted.
 
int minimumHeight () const
 
int minimumWidth () const
 
void move (Point)
 
virtual bool onFocusInEvent (FocusEvent *)
 
virtual bool onResize (int h, int w)
 
bool onResize (Size)
 
Point pos () const
 
Rect rect () const
 
void removeViewEventFilter (EventFilterInterface *)
 Removes the event filter.
 
void resize (int w, int h)
 
void resize (Size)
 
Size screenSize () const
 Returns the size of the screen that this view belongs to.
 
void setSize (Size)
 
Size size () const
 
int width () const
 
int x () const
 
int y () const
 
virtual int zOrder () const
 
- Public Member Functions inherited from KDDockWidgets::Core::GroupViewInterface
 GroupViewInterface (Group *)
 
virtual ~GroupViewInterface ()
 
Groupgroup () const
 
virtual void insertDockWidget (DockWidget *, int index)
 
bool isMDI () const
 
virtual void removeDockWidget (DockWidget *)
 

Protected Member Functions

int nonContentsHeight () const override
 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.
 
- Protected Member Functions inherited from KDDockWidgets::Core::View
 View (const View &)=delete
 
Viewoperator= (const View &)=delete
 
- Protected Member Functions inherited from KDDockWidgets::Core::GroupViewInterface
 GroupViewInterface (const GroupViewInterface &)=delete
 
GroupViewInterfaceoperator= (const GroupViewInterface &)=delete
 

Additional Inherited Members

- Static Public Member Functions inherited from KDDockWidgets::Core::View
static bool equals (const View *one, const View *two)
 
static ControllerfirstParentOfType (View *view, ViewType)
 Returns the controller of the first parent view of the specified type Goes up the view hierarchy chain until it finds it. Returns nullptr otherwise.
 
static Size hardcodedMinimumSize ()
 The minimum minimum size a dock widget can have.
 
- Public Attributes inherited from KDDockWidgets::Core::View
Private *const d
 
- Protected Attributes inherited from KDDockWidgets::Core::View
Controller *const m_controller
 
bool m_inDtor = false
 
- Protected Attributes inherited from KDDockWidgets::Core::GroupViewInterface
Group *const m_group
 

Detailed Description

Definition at line 29 of file flutter/views/Group.h.

Constructor & Destructor Documentation

◆ Group()

Group::Group ( Core::Group controller,
Core::View parent = nullptr 
)
explicit

Definition at line 40 of file flutter/views/Group.cpp.

◆ ~Group()

Group::~Group ( )
override

Definition at line 46 of file flutter/views/Group.cpp.

Member Function Documentation

◆ currentIndex()

int Group::currentIndex ( ) const

◆ dragRect()

Rect Group::dragRect ( ) const
overridevirtual

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 from KDDockWidgets::Core::GroupViewInterface.

Reimplemented in KDDockWidgetsBindings_wrappersNS::KDDWBindingsFlutter::Group_wrapper.

Definition at line 71 of file flutter/views/Group.cpp.

◆ maxSizeHint()

Size Group::maxSizeHint ( ) const
overridevirtual

Reimplemented for internal purposes.
.

Implements KDDockWidgets::Core::View.

Reimplemented in KDDockWidgetsBindings_wrappersNS::KDDWBindingsFlutter::Group_wrapper.

Definition at line 61 of file flutter/views/Group.cpp.

References KDDockWidgets::flutter::View::maxSizeHint().

◆ minSize()

Size Group::minSize ( ) const
overridevirtual

◆ nonContentsHeight()

int Group::nonContentsHeight ( ) const
overrideprotectedvirtual

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.

Implements KDDockWidgets::Core::GroupViewInterface.

Reimplemented in KDDockWidgetsBindings_wrappersNS::KDDWBindingsFlutter::Group_wrapper.

Definition at line 66 of file flutter/views/Group.cpp.

Referenced by minSize().


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