KDDockWidgets API Documentation 2.1
|
#include <Stack.h>
Public Member Functions | |
Stack (Core::Stack *controller, QQuickItem *parent=nullptr) | |
Public Member Functions inherited from KDDockWidgets::QtQuick::View | |
View (Core::Controller *controller, Core::ViewType type, QQuickItem *parent=nullptr, Qt::WindowFlags windowFlags={}) | |
~View () override=default | |
void | activateWindow () override |
std::shared_ptr< Core::View > | asWrapper () override |
Returns this view, but as a wrapper. | |
std::shared_ptr< Core::View > | childViewAt (QPoint p) const override |
QVector< 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 |
QRect | geometry () const override |
void | grabMouse () override |
bool | hasAttribute (Qt::WidgetAttribute attr) const override |
bool | hasFocus () const override |
void | hide () override |
bool | isActiveWindow () const override |
bool | isExplicitlyHidden () const override |
bool | isFixedHeight () const |
bool | isFixedWidth () const |
bool | isMaximized () const override |
bool | isMinimized () const override |
bool | isRootView () const override final |
bool | isVisible () const override |
QPoint | mapFromGlobal (QPoint globalPt) const override |
QPoint | mapTo (Core::View *parent, QPoint pos) const override |
QPoint | mapToGlobal (QPoint localPt) const override |
QSize | maxSizeHint () const override |
QSize | minSize () const override |
void | move (int x, int y) override |
QRect | normalGeometry () const override |
void | onWindowStateChangeEvent (QWindowStateChangeEvent *) |
std::shared_ptr< Core::View > | parentView () const override |
Returns the gui element's parent. Like QWidget::parentWidget() | |
QQuickView * | quickView () const |
void | raise () override |
void | raiseAndActivate () override |
Q_INVOKABLE void | redirectMouseEvents (QQuickItem *from) |
void | releaseKeyboard () override |
void | releaseMouse () override |
void | render (QPainter *) override |
std::shared_ptr< Core::View > | rootView () 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 | setFixedSize (Size) |
void | setFixedWidth (int w) override |
void | setFlag (Qt::WindowType f, bool on=true) override |
void | setFocus (Qt::FocusReason reason) override |
void | setFocusPolicy (Qt::FocusPolicy) override |
void | setGeometry (QRect) override |
void | setHeight (int h) override |
void | setMaximumSize (QSize sz) override |
void | setMinimumSize (QSize sz) override |
void | setMouseTracking (bool enable) override |
void | setNormalGeometry (QRect geo) |
void | setParent (Core::View *parent) override |
void | setParent (QQuickItem *parent) |
void | setSize (int w, int h) override final |
void | setVisible (bool is) override |
void | setWidth (int w) override |
void | setWindowIcon (const QIcon &icon) override |
void | setWindowOpacity (double v) override |
void | setWindowTitle (const QString &title) override |
void | setZOrder (int) override |
Sets the z order Not supported on all platforms and only relevant for MDI mode. | |
void | show () override |
Q_INVOKABLE void | showMaximized () override |
Q_INVOKABLE void | showMinimized () override |
Q_INVOKABLE void | showNormal () override |
void | update () override |
void | updateGeometry () |
QString | viewName () const override |
virtual QQuickItem * | visualItem () const |
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() | |
int | zOrder () const override |
Public Member Functions inherited from KDDockWidgets::QtCommon::View_qt | |
View_qt (Core::Controller *controller, Core::ViewType type, QObject *thisObj) | |
~View_qt () 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. | |
void | setViewName (const QString &name) override |
Equivalent to Qt's QObject::objectName() | |
QObject * | thisObject () const |
virtual QVariant | viewProperty (const char *name) const |
Equivalent to Qt's QObject::property() | |
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::DockWidget * | asDockWidgetController () const |
Core::DropArea * | asDropAreaController () const |
Core::FloatingWindow * | asFloatingWindowController () const |
asFooController() are deprecated. Use asController<T>() instead | |
Core::Group * | asGroupController () const |
Core::Layout * | asLayout () const |
Core::MainWindow * | asMainWindowController () const |
Core::MDILayout * | asMDILayoutController () const |
Core::Stack * | asStackController () const |
Core::TabBar * | asTabBarController () const |
Core::TitleBar * | asTitleBarController () const |
virtual std::shared_ptr< View > | childViewAt (Point localPos) const =0 |
Controller * | controller () 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. | |
virtual Point | mapFromGlobal (Point) const =0 |
virtual Point | mapTo (View *, Point) const =0 |
virtual Point | mapToGlobal (Point) const =0 |
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. | |
virtual void | setGeometry (Rect)=0 |
virtual void | setMaximumSize (Size sz)=0 |
virtual void | setMinimumSize (Size)=0 |
void | setSize (Size) |
virtual void | setWindowIcon (const Icon &)=0 |
Size | size () const |
int | width () const |
int | x () const |
int | y () const |
Public Member Functions inherited from KDDockWidgets::Core::StackViewInterface | |
StackViewInterface (Stack *) | |
virtual | ~StackViewInterface () |
virtual bool | isPositionDraggable (Point p) const |
Reimplement if you want to support dragging by QTabWidget instead of TitleBar This is only implemented by QtWidgets. Instead of reimplementing this, consider reimplementing TabBarViewInterface::isPositionDraggable() instead. This exists only because the background of QTabBar is the QTabWidget, which probably isn't true for other frontends. | |
virtual void | setDocumentMode (bool) |
Sets QTabWidget::documentMode(). Only implemented for QtWidgets. Probably not interesting for other frontends to implement, therefore it's not pure-virtual. | |
Additional Inherited Members | |
Signals inherited from KDDockWidgets::QtQuick::View | |
void | geometryUpdated () |
void | itemGeometryChanged () |
Static Public Member Functions inherited from KDDockWidgets::QtQuick::View | |
static std::shared_ptr< Core::View > | asQQuickWrapper (QQuickItem *item) |
static bool | close (QQuickItem *) |
static QQuickItem * | createItem (const QString &filename, QQuickItem *parent, QQmlContext *ctx=nullptr) |
Convenience to create a QQuickItem parented to parent . Uses the engine from the parent. | |
static QQuickItem * | createItem (QQmlEngine *engine, const QString &filename, QQmlContext *context=nullptr) |
Convenience to create a QQuickItem. | |
static bool | isRootView (const QQuickItem *) |
static void | makeItemFillParent (QQuickItem *item) |
This is equivalent to "anchors.fill: parent but in C++. | |
static std::shared_ptr< Core::View > | parentViewFor (const QQuickItem *) |
static void | raiseAndActivate (QQuickItem *) |
Static Public Member Functions inherited from KDDockWidgets::QtCommon::View_qt | |
static QObject * | asQObject (View *) |
Static Public Member Functions inherited from KDDockWidgets::Core::View | |
static bool | equals (const View *one, const View *two) |
static Controller * | firstParentOfType (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 Member Functions inherited from KDDockWidgets::QtQuick::View | |
bool | event (QEvent *) override |
bool | eventFilter (QObject *watched, QEvent *ev) override |
void | itemChange (QQuickItem::ItemChange, const QQuickItem::ItemChangeData &) override |
virtual void | onHoverEvent (QHoverEvent *, QPoint) |
Override in case you want to have different styling on hover. | |
void | QQUICKITEMgeometryChanged (const QRectF &newGeometry, const QRectF &oldGeometry) override |
Protected Member Functions inherited from KDDockWidgets::Core::View | |
View (const View &)=delete | |
View & | operator= (const View &)=delete |
Protected Member Functions inherited from KDDockWidgets::Core::StackViewInterface | |
StackViewInterface (const StackViewInterface &)=delete | |
StackViewInterface & | operator= (const StackViewInterface &)=delete |
Protected Attributes inherited from KDDockWidgets::QtCommon::View_qt | |
EventFilter *const | m_eventFilter |
QObject *const | m_thisObj |
Protected Attributes inherited from KDDockWidgets::Core::View | |
Controller *const | m_controller |
bool | m_inDtor = false |
Protected Attributes inherited from KDDockWidgets::Core::StackViewInterface | |
Stack *const | m_stack |
Properties inherited from KDDockWidgets::QtQuick::View | |
bool | isFixedHeight |
bool | isFixedWidth |
Definition at line 36 of file qtquick/views/Stack.h.
|
explicit |
Definition at line 22 of file qtquick/views/Stack.cpp.
References KDDockWidgets::QtQuick.