KDDockWidgets API Documentation 2.1
|
#include <View.h>
Public Member Functions | |
View (Core::Controller *controller, Core::ViewType type, QWidget *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 localPos) const override |
QVector< std::shared_ptr< Core::View > > | childViews () const override |
@Returns a list of child views | |
bool | close () override |
void | createPlatformWindow () 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 | isMaximized () const override |
bool | isMinimized () const override |
bool | isRootView () const override |
bool | isVisible () const override |
QPoint | mapFromGlobal (QPoint globalPt) const override |
QPoint | mapTo (Core::View *someAncestor, QPoint pos) const override |
QPoint | mapToGlobal (QPoint localPt) const override |
QSize | maxSizeHint () const override |
QSize | minimumSizeHint () const override |
QSize | minSize () const override |
void | move (int x, int y) override |
QRect | normalGeometry () const override |
std::shared_ptr< Core::View > | parentView () const override |
Returns the gui element's parent. Like QWidget::parentWidget() | |
void | raise () override |
void | raiseAndActivate () override |
void | releaseKeyboard () override |
void | releaseMouse () override |
void | render (QPainter *p) 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 | setFixedWidth (int w) override |
void | setFlag (Qt::WindowType flag, bool on=true) override |
void | setFocus (Qt::FocusReason reason) override |
void | setFocusPolicy (Qt::FocusPolicy policy) override |
void | setGeometry (QRect geo) override |
void | setHeight (int height) override |
void | setMaximumSize (QSize sz) override |
void | setMinimumSize (QSize sz) override |
void | setMouseTracking (bool enable) override |
void | setParent (Core::View *parent) override |
void | setSize (int width, int height) override |
void | setVisible (bool is) override |
void | setWidth (int width) override |
void | setWindowIcon (const QIcon &icon) override |
void | setWindowOpacity (double v) override |
void | setWindowTitle (const QString &title) override |
void | show () override |
void | showMaximized () override |
void | showMinimized () override |
void | showNormal () override |
void | update () override |
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() | |
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. | |
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 |
virtual void | setZOrder (int) |
Sets the z order Not supported on all platforms and only relevant for MDI mode. | |
Size | size () const |
int | width () const |
int | x () const |
int | y () const |
Static Public Member Functions | |
static QVector< std::shared_ptr< Core::View > > | childViewsFor (const QWidget *parent) |
static void | raiseAndActivate (QWidget *w) |
static void | setParentFor (QWidget *widget, Core::View *parent) |
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. | |
Protected Member Functions | |
void | closeEvent (QCloseEvent *ev) override |
bool | event (QEvent *e) override |
void | resizeEvent (QResizeEvent *ev) override |
Protected Member Functions inherited from KDDockWidgets::Core::View | |
View (const View &)=delete | |
View & | operator= (const View &)=delete |
Additional Inherited Members | |
Public Attributes inherited from KDDockWidgets::Core::View | |
Private *const | d |
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 |
Definition at line 35 of file qtwidgets/views/View.h.
|
explicit |
|
overridevirtualdefault |
Reimplemented from KDDockWidgets::Core::View.
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 224 of file qtwidgets/views/View.h.
|
overridevirtual |
Returns this view, but as a wrapper.
Implements KDDockWidgets::Core::View.
Definition at line 153 of file qtwidgets/views/View.cpp.
|
override |
Definition at line 124 of file qtwidgets/views/View.cpp.
References QWidget::childAt().
|
inlineoverridevirtual |
@Returns a list of child views
Implements KDDockWidgets::Core::View.
Definition at line 391 of file qtwidgets/views/View.h.
|
static |
Definition at line 160 of file qtwidgets/views/View.cpp.
References QObject::children(), QVector::push_back(), and QVector::reserve().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 274 of file qtwidgets/views/View.h.
References QWidget::close().
|
overrideprotected |
Definition at line 108 of file qtwidgets/views/View.cpp.
|
inlineoverridevirtual |
Reimplemented from KDDockWidgets::Core::View.
Definition at line 164 of file qtwidgets/views/View.h.
References QWidget::create().
|
inlineoverridevirtual |
Enable/disable attributes. This is mostly for QtWidget compatibility Do not use. We don't depend on Qt::WidgetAttribute in a future version.
Implements KDDockWidgets::Core::View.
Definition at line 284 of file qtwidgets/views/View.h.
References QWidget::setAttribute().
|
overrideprotected |
Definition at line 99 of file qtwidgets/views/View.cpp.
References QEvent::LayoutRequest, and QEvent::type().
Referenced by KDDockWidgets::QtWidgets::DockWidget::event(), and KDDockWidgets::QtWidgets::FloatingWindow::event().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 294 of file qtwidgets/views/View.h.
References QWidget::windowFlags.
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 339 of file qtwidgets/views/View.h.
References QWidget::focusPolicy.
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 97 of file qtwidgets/views/View.h.
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 359 of file qtwidgets/views/View.h.
References QWidget::grabMouse().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 289 of file qtwidgets/views/View.h.
References QWidget::testAttribute().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 344 of file qtwidgets/views/View.h.
References QWidget::hasFocus().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 169 of file qtwidgets/views/View.h.
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 309 of file qtwidgets/views/View.h.
References QWidget::isActiveWindow.
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 119 of file qtwidgets/views/View.h.
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 334 of file qtwidgets/views/View.h.
References QWidget::isMaximized().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 329 of file qtwidgets/views/View.h.
References QWidget::isMinimized().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 234 of file qtwidgets/views/View.h.
References QWidget::isWindow().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 114 of file qtwidgets/views/View.h.
|
inlineoverride |
Definition at line 244 of file qtwidgets/views/View.h.
|
inlineoverride |
Definition at line 249 of file qtwidgets/views/View.h.
References QWidget::mapTo().
|
inlineoverride |
Definition at line 239 of file qtwidgets/views/View.h.
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 75 of file qtwidgets/views/View.h.
References QSizePolicy::Fixed, QSize::height(), QSizePolicy::Maximum, QSize::setHeight(), QSize::setWidth(), QWidget::sizePolicy, and QSize::width().
|
inlineoverride |
Definition at line 68 of file qtwidgets/views/View.h.
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 57 of file qtwidgets/views/View.h.
References QSize::expandedTo().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 129 of file qtwidgets/views/View.h.
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 102 of file qtwidgets/views/View.h.
|
overridevirtual |
Returns the gui element's parent. Like QWidget::parentWidget()
Implements KDDockWidgets::Core::View.
Definition at line 143 of file qtwidgets/views/View.cpp.
References QWidget::parentWidget().
|
inlineoverridevirtual |
If this view is a root view, then raises its window, otherwise, raises itself relatively to its siblings and does not raise its window
Implements KDDockWidgets::Core::View.
Definition at line 229 of file qtwidgets/views/View.h.
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 219 of file qtwidgets/views/View.h.
|
inlinestatic |
Definition at line 211 of file qtwidgets/views/View.h.
References QWidget::activateWindow(), QWidget::raise(), and QWidget::window().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 369 of file qtwidgets/views/View.h.
References QWidget::releaseKeyboard().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 364 of file qtwidgets/views/View.h.
References QWidget::releaseMouse().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 259 of file qtwidgets/views/View.h.
|
inlineoverrideprotected |
Definition at line 400 of file qtwidgets/views/View.h.
References QResizeEvent::size().
|
overridevirtual |
Returns the top-level gui element which this view is inside It's the root view of the window.
Implements KDDockWidgets::Core::View.
Definition at line 133 of file qtwidgets/views/View.cpp.
References QWidget::window().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 264 of file qtwidgets/views/View.h.
References QWidget::setCursor().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 154 of file qtwidgets/views/View.h.
References QWidget::setFixedHeight().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 149 of file qtwidgets/views/View.h.
References QWidget::setFixedWidth().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 279 of file qtwidgets/views/View.h.
References QWidget::setWindowFlag().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 374 of file qtwidgets/views/View.h.
References QWidget::setFocus().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 379 of file qtwidgets/views/View.h.
References QWidget::setFocusPolicy().
|
inlineoverride |
Definition at line 107 of file qtwidgets/views/View.h.
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 144 of file qtwidgets/views/View.h.
References QWidget::width.
|
override |
Definition at line 90 of file qtwidgets/views/View.cpp.
References QWidget::maximumSize.
|
override |
Definition at line 114 of file qtwidgets/views/View.cpp.
References QWidget::minimumSize, and QWidget::setMinimumSize().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 269 of file qtwidgets/views/View.h.
References QWidget::setMouseTracking().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 206 of file qtwidgets/views/View.h.
|
inlinestatic |
Definition at line 191 of file qtwidgets/views/View.h.
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 134 of file qtwidgets/views/View.h.
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 124 of file qtwidgets/views/View.h.
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 139 of file qtwidgets/views/View.h.
References QWidget::height.
|
inlineoverride |
Definition at line 304 of file qtwidgets/views/View.h.
References QWidget::setWindowIcon().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 254 of file qtwidgets/views/View.h.
References QWidget::setWindowOpacity().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 299 of file qtwidgets/views/View.h.
References QWidget::setWindowTitle().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 159 of file qtwidgets/views/View.h.
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 324 of file qtwidgets/views/View.h.
References QWidget::showMaximized().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 319 of file qtwidgets/views/View.h.
References QWidget::showMinimized().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 314 of file qtwidgets/views/View.h.
References QWidget::showNormal().
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 174 of file qtwidgets/views/View.h.
|
inlineoverridevirtual |
Implements KDDockWidgets::Core::View.
Definition at line 384 of file qtwidgets/views/View.h.
References QObject::objectName.
|
overridevirtual |
Returns the window this view is inside For the Qt frontend, this wraps a QWindow. Like QWidget::window()
Implements KDDockWidgets::Core::View.
Definition at line 78 of file qtwidgets/views/View.cpp.
References QWidget::window().
|
inlineoverridevirtual |
Returns the zOrder Not supported on all platforms and only relevant for MDI mode.
Reimplemented from KDDockWidgets::Core::View.
Definition at line 179 of file qtwidgets/views/View.h.
References QWidget::parentWidget().