KDDockWidgets API Documentation 2.1
|
#include <TitleBar.h>
Signals | |
void | closeButtonEnabledChanged (bool) |
void | floatButtonToolTipChanged (const QString &) |
void | floatButtonVisibleChanged (bool) |
void | iconChanged () |
void | isFocusedChanged () |
void | maximizeButtonVisibleChanged (bool) |
void | minimizeButtonVisibleChanged (bool) |
void | numDockWidgetsChanged () |
Emitted when the number of dock widgets under this titlebar changes. | |
void | titleBarQmlItemChanged () |
void | titleChanged () |
Signals inherited from KDDockWidgets::QtQuick::View | |
void | geometryUpdated () |
void | itemGeometryChanged () |
Public Member Functions | |
TitleBar (Core::TitleBar *controller, QQuickItem *parent=nullptr) | |
~TitleBar () override | |
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) | |
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::TitleBarViewInterface | |
TitleBarViewInterface (Core::TitleBar *) | |
virtual | ~TitleBarViewInterface () |
Protected Member Functions | |
bool | closeButtonEnabled () const |
bool | event (QEvent *) override |
QString | floatButtonToolTip () const |
bool | floatButtonVisible () const |
bool | hasIcon () const |
void | init () override |
Q_INVOKABLE bool | isFloating () const |
bool | isFocused () const |
Q_INVOKABLE bool | isMaximized () const override |
bool | maximizeButtonVisible () const |
bool | maximizeUsesRestoreIcon () const |
bool | minimizeButtonVisible () const |
Q_INVOKABLE void | onAutoHideClicked () |
Q_INVOKABLE void | onCloseClicked () |
Q_INVOKABLE bool | onDoubleClicked () |
Q_INVOKABLE void | onFloatClicked () |
Q_INVOKABLE void | onMaximizeClicked () |
Q_INVOKABLE void | onMinimizeClicked () |
void | setCloseButtonEnabled (bool) |
void | setFloatButtonVisible (bool) |
void | setTitleBarQmlItem (QQuickItem *) |
QString | title () const |
QQuickItem * | titleBarMouseArea () const |
QQuickItem * | titleBarQmlItem () const |
Q_INVOKABLE void | toggleMaximized () |
These 2 are the same, both just toggle window maximization. | |
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::TitleBarViewInterface | |
TitleBarViewInterface (const TitleBarViewInterface &)=delete | |
TitleBarViewInterface & | operator= (const TitleBarViewInterface &)=delete |
Properties | |
bool | closeButtonEnabled |
QString | floatButtonToolTip |
bool | floatButtonVisible |
bool | hasIcon |
bool | isFocused |
bool | maximizeButtonVisible |
bool | maximizeUsesRestoreIcon |
bool | minimizeButtonVisible |
QString | title |
QQuickItem * | titleBarMouseArea |
QQuickItem * | titleBarQmlItem |
Properties inherited from KDDockWidgets::QtQuick::View | |
bool | isFixedHeight |
bool | isFixedWidth |
Additional Inherited Members | |
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 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::TitleBarViewInterface | |
Core::TitleBar *const | m_titleBar |
Definition at line 29 of file qtquick/views/TitleBar.h.
|
explicit |
Definition at line 29 of file qtquick/views/TitleBar.cpp.
References KDDockWidgets::QtQuick::View::setFixedHeight().
|
override |
Definition at line 36 of file qtquick/views/TitleBar.cpp.
|
protected |
Definition at line 154 of file qtquick/views/TitleBar.cpp.
References KDDockWidgets::Core::TitleBar::closeButtonEnabled(), and KDDockWidgets::Core::TitleBarViewInterface::m_titleBar.
|
signal |
Referenced by init().
|
overrideprotected |
Definition at line 57 of file qtquick/views/TitleBar.cpp.
References KDDockWidgets::QtQuick::View::event(), KDDockWidgets::Config::Flag_TitleBarIsFocusable, KDDockWidgets::QtQuick::View::flags(), KDDockWidgets::Core::TitleBar::focus(), KDDockWidgets::Core::TitleBarViewInterface::m_titleBar, QEvent::MouseButtonPress, Qt::MouseFocusReason, KDDockWidgets::Config::self(), and QEvent::type().
|
protected |
Definition at line 159 of file qtquick/views/TitleBar.cpp.
References KDDockWidgets::Core::TitleBar::floatButtonToolTip(), and KDDockWidgets::Core::TitleBarViewInterface::m_titleBar.
|
signal |
Referenced by init().
|
protected |
Definition at line 134 of file qtquick/views/TitleBar.cpp.
References KDDockWidgets::Core::TitleBar::floatButtonVisible(), and KDDockWidgets::Core::TitleBarViewInterface::m_titleBar.
|
signal |
Referenced by init().
|
protected |
Definition at line 164 of file qtquick/views/TitleBar.cpp.
References KDDockWidgets::Core::TitleBar::hasIcon(), and KDDockWidgets::Core::TitleBarViewInterface::m_titleBar.
|
signal |
Referenced by init().
|
overrideprotectedvirtual |
init method to solve cyclic ctor dependencies between view and controllers Called by the controller
Reimplemented from KDDockWidgets::Core::View.
Definition at line 40 of file qtquick/views/TitleBar.cpp.
References closeButtonEnabledChanged(), KDDockWidgets::Core::TitleBar::dptr(), floatButtonToolTipChanged(), floatButtonVisibleChanged(), iconChanged(), isFocusedChanged(), KDDockWidgets::Core::TitleBarViewInterface::m_titleBar, maximizeButtonVisibleChanged(), minimizeButtonVisibleChanged(), numDockWidgetsChanged(), and titleChanged().
|
protected |
Definition at line 219 of file qtquick/views/TitleBar.cpp.
References KDDockWidgets::Core::TitleBar::isFloating(), and KDDockWidgets::Core::TitleBarViewInterface::m_titleBar.
|
protected |
Definition at line 129 of file qtquick/views/TitleBar.cpp.
References KDDockWidgets::Core::TitleBar::isFocused(), and KDDockWidgets::Core::TitleBarViewInterface::m_titleBar.
|
signal |
Referenced by init().
|
overrideprotectedvirtual |
Implements KDDockWidgets::Core::View.
Definition at line 224 of file qtquick/views/TitleBar.cpp.
References KDDockWidgets::QtQuick::View::isMaximized().
|
protected |
Definition at line 144 of file qtquick/views/TitleBar.cpp.
References KDDockWidgets::Core::TitleBarViewInterface::m_titleBar, and KDDockWidgets::Core::TitleBar::maximizeButtonVisible().
|
signal |
Referenced by init().
|
protected |
Definition at line 149 of file qtquick/views/TitleBar.cpp.
References KDDockWidgets::Core::TitleBarViewInterface::m_titleBar, KDDockWidgets::Core::TitleBar::maximizeButtonType(), and KDDockWidgets::Normal.
|
protected |
Definition at line 139 of file qtquick/views/TitleBar.cpp.
References KDDockWidgets::Core::TitleBarViewInterface::m_titleBar, and KDDockWidgets::Core::TitleBar::supportsMinimizeButton().
|
signal |
Referenced by init().
|
signal |
Emitted when the number of dock widgets under this titlebar changes.
Referenced by init().
|
protected |
Definition at line 209 of file qtquick/views/TitleBar.cpp.
References KDDockWidgets::Core::TitleBarViewInterface::m_titleBar, and KDDockWidgets::Core::TitleBar::onAutoHideClicked().
|
protected |
Definition at line 189 of file qtquick/views/TitleBar.cpp.
References KDDockWidgets::Core::TitleBarViewInterface::m_titleBar, and KDDockWidgets::Core::TitleBar::onCloseClicked().
|
protected |
Definition at line 184 of file qtquick/views/TitleBar.cpp.
References KDDockWidgets::Core::TitleBarViewInterface::m_titleBar, and KDDockWidgets::Core::TitleBar::onDoubleClicked().
|
protected |
Definition at line 194 of file qtquick/views/TitleBar.cpp.
References KDDockWidgets::Core::TitleBarViewInterface::m_titleBar, and KDDockWidgets::Core::TitleBar::onFloatClicked().
|
protected |
Definition at line 199 of file qtquick/views/TitleBar.cpp.
References KDDockWidgets::Core::TitleBarViewInterface::m_titleBar, and KDDockWidgets::Core::TitleBar::onMaximizeClicked().
|
protected |
Definition at line 204 of file qtquick/views/TitleBar.cpp.
References KDDockWidgets::Core::TitleBarViewInterface::m_titleBar, and KDDockWidgets::Core::TitleBar::onMinimizeClicked().
|
protected |
Definition at line 174 of file qtquick/views/TitleBar.cpp.
References KDDockWidgets::Core::View::is(), KDDockWidgets::Core::TitleBarViewInterface::m_titleBar, and KDDockWidgets::Core::TitleBar::setCloseButtonEnabled().
|
protected |
Definition at line 179 of file qtquick/views/TitleBar.cpp.
References KDDockWidgets::Core::View::is(), KDDockWidgets::Core::TitleBarViewInterface::m_titleBar, and KDDockWidgets::Core::TitleBar::setFloatButtonVisible().
|
protected |
Definition at line 109 of file qtquick/views/TitleBar.cpp.
References titleBarQmlItemChanged().
|
protected |
Definition at line 169 of file qtquick/views/TitleBar.cpp.
References KDDockWidgets::Core::TitleBarViewInterface::m_titleBar, and KDDockWidgets::Core::TitleBar::title().
|
protected |
Definition at line 101 of file qtquick/views/TitleBar.cpp.
|
protected |
Definition at line 96 of file qtquick/views/TitleBar.cpp.
|
signal |
Referenced by setTitleBarQmlItem().
|
signal |
Referenced by init().
|
protected |
These 2 are the same, both just toggle window maximization.
Definition at line 214 of file qtquick/views/TitleBar.cpp.
References KDDockWidgets::Core::TitleBarViewInterface::m_titleBar, and KDDockWidgets::Core::TitleBar::toggleMaximized().
|
readwrite |
Definition at line 38 of file qtquick/views/TitleBar.h.
|
read |
Definition at line 46 of file qtquick/views/TitleBar.h.
|
readwrite |
Definition at line 40 of file qtquick/views/TitleBar.h.
|
read |
Definition at line 37 of file qtquick/views/TitleBar.h.
|
read |
Definition at line 47 of file qtquick/views/TitleBar.h.
|
read |
Definition at line 42 of file qtquick/views/TitleBar.h.
|
read |
Definition at line 48 of file qtquick/views/TitleBar.h.
|
read |
Definition at line 44 of file qtquick/views/TitleBar.h.
|
read |
Definition at line 36 of file qtquick/views/TitleBar.h.
|
read |
Definition at line 35 of file qtquick/views/TitleBar.h.
|
readwrite |
Definition at line 33 of file qtquick/views/TitleBar.h.