core/DockWidget.h

Go to the documentation of this file.

/*
  This file is part of KDDockWidgets.
 
  SPDX-FileCopyrightText: 2019 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
  Author: Sérgio Martins <sergio.martins@kdab.com>
 
  SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
 
  Contact KDAB at <info@kdab.com> for commercial licensing options.
*/
 
#ifndef KD_CONTROLLERS_DOCKWIDGET_H
#define KD_CONTROLLERS_DOCKWIDGET_H
#pragma once
 
#include "kddockwidgets/docks_export.h"
#include "kddockwidgets/KDDockWidgets.h"
#include "kddockwidgets/LayoutSaver.h"
#include "kddockwidgets/core/Controller.h"
#include "kddockwidgets/core/Action.h"
 
#include <memory>
 
// clazy:excludeall=ctor-missing-parent-argument
 
class TestDocks;
 
namespace KDDockWidgets {
 
class DockRegistry;
class LayoutSaver;
 
namespace Core {
 
class DragController;
class MainWindow;
class FloatingWindow;
class Group;
class Layout;
class TitleBar;
 
class DOCKS_EXPORT DockWidget : public Controller
{
    Q_OBJECT
public:
    typedef Vector<DockWidget *> List;
 
    explicit DockWidget(View *view, const QString &uniqueName, DockWidgetOptions options = {},
                        LayoutSaverOptions layoutSaverOptions = {});
 
    ~DockWidget() override;
 
    void init();
 
    void addDockWidgetAsTab(KDDockWidgets::Core::DockWidget *other,
                            const KDDockWidgets::InitialOption &initialOption = {});
 
    void
    addDockWidgetToContainingWindow(KDDockWidgets::Core::DockWidget *other,
                                    KDDockWidgets::Location location,
                                    KDDockWidgets::Core::DockWidget *relativeTo = nullptr,
                                    const KDDockWidgets::InitialOption &initialOption = {});
 
    void setGuestView(std::shared_ptr<View> guest);
 
    std::shared_ptr<View> guestView() const;
 
    bool isFloating() const;
 
    bool setFloating(bool floats);
 
    FloatingWindow *floatingWindow() const;
 
    Action *toggleAction() const;
 
    Action *floatAction() const;
 
    QString uniqueName() const;
 
    QString title() const;
 
    void setTitle(const QString &title);
 
    Rect groupGeometry() const;
 
    DockWidgetOptions options() const;
 
    KDDockWidgets::LayoutSaverOptions layoutSaverOptions() const;
 
    void setOptions(DockWidgetOptions);
 
    bool isTabbed() const;
 
    bool isCurrentTab() const;
 
    void setAsCurrentTab();
 
    int tabIndex() const;
 
    int currentTabIndex() const;
 
    void setIcon(const Icon &icon, IconPlaces places = IconPlace::All);
 
    Icon icon(IconPlace place = IconPlace::TitleBar) const;
 
    void forceClose();
 
    Core::TitleBar *titleBar() const;
 
    bool isOpen() const;
 
    void setAffinities(const Vector<QString> &);
 
    void setAffinityName(const QString &name);
 
    Vector<QString> affinities() const;
 
    void open();
 
    void show();
 
    void raise();
 
    bool isMainWindow() const;
 
    bool isInMainWindow() const;
 
    MainWindow *mainWindow() const;
 
    bool isFocused() const;
 
    void moveToSideBar();
 
    void removeFromSideBar();
 
    bool isOverlayed() const;
 
    SideBarLocation sideBarLocation() const;
 
    bool isInSideBar() const;
 
    bool hasPreviousDockedLocation() const;
 
    Size lastOverlayedSize() const;
 
    Size sizeInLayout() const;
 
    void resizeInLayout(int left, int top, int right, int bottom);
 
    static DockWidget *byName(const QString &uniqueName);
 
    bool skipsRestore() const;
 
    CloseReason lastCloseReason() const;
 
    void setFloatingGeometry(Rect geo);
 
    void setUserType(int userType);
    int userType() const;
 
    void setMDIPosition(Point pos);
    void setMDISize(Size size);
    void setMDIZ(int z);
 
    int mdiZ() const;
 
    bool isPersistentCentralDockWidget() const;
 
    void onResize(Size newSize);
 
    void setFloatingWindowFlags(FloatingWindowFlags);
    KDDockWidgets::FloatingWindowFlags floatingWindowFlags() const;
 
    bool startDragging(bool singleTab = false);
 
    bool wasRestored() const;
 
    void setUniqueName(const QString &);
 
protected:
    void setParentView_impl(View *parent) override;
 
public:
    class Private;
    Private *dptr() const;
    Private *const d;
 
    static DockWidget *deserialize(const std::shared_ptr<LayoutSaver::DockWidget> &);
 
private:
    KDDW_DELETE_COPY_CTOR(DockWidget)
};
 
}
 
}
 
#endif