KDDockWidgets API Documentation 2.1
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper Class Reference

#include <TitleBar_c.h>

Inheritance diagram for KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper:
Inheritance graph
[legend]
Collaboration diagram for KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper:
Collaboration graph
[legend]

Public Types

typedef bool(* Callback_isMDI) (void *)
 
typedef bool(* Callback_isWindow) (void *)
 
typedef void(* Callback_setParentView_impl) (void *, KDDockWidgets::Core::View *parent)
 
typedef KDDockWidgets::Core::DockWidget *(* Callback_singleDockWidget) (void *)
 

Public Member Functions

 TitleBar_wrapper (KDDockWidgets::Core::FloatingWindow *parent)
 
 TitleBar_wrapper (KDDockWidgets::Core::Group *parent)
 
 TitleBar_wrapper (KDDockWidgets::Core::View *arg__1)
 
 ~TitleBar_wrapper ()
 
bool closeButtonEnabled () const
 
QString floatButtonToolTip () const
 
bool floatButtonVisible () const
 
KDDockWidgets::Core::FloatingWindowfloatingWindow () const
 
KDDockWidgets::Core::Groupgroup () const
 
bool hasIcon () const
 
bool isCloseButtonEnabled () const
 
bool isCloseButtonVisible () const
 
bool isFloatButtonVisible () const
 
bool isFloating () const
 
bool isFocused () const
 
virtual bool isMDI () const
 
virtual bool isMDI_nocallback () const
 
bool isOverlayed () const
 
bool isStandalone () const
 
virtual bool isWindow () const
 
virtual bool isWindow_nocallback () const
 
KDDockWidgets::Core::MainWindowmainWindow () const
 
bool maximizeButtonVisible () const
 
void onAutoHideClicked ()
 
void onCloseClicked ()
 
bool onDoubleClicked ()
 
void onFloatClicked ()
 
void onMaximizeClicked ()
 
void onMinimizeClicked ()
 
void setCloseButtonEnabled (bool arg__1)
 
void setCloseButtonVisible (bool arg__1)
 
void setFloatButtonVisible (bool arg__1)
 
virtual void setParentView_impl (KDDockWidgets::Core::View *parent)
 
virtual void setParentView_impl_nocallback (KDDockWidgets::Core::View *parent)
 
void setTitle (const QString &title)
 
bool supportsAutoHideButton () const
 
bool supportsFloatingButton () const
 
bool supportsMaximizeButton () const
 
bool supportsMinimizeButton () const
 
KDDockWidgets::Core::TabBartabBar () const
 
QString title () const
 
bool titleBarIsFocusable () const
 
void toggleMaximized ()
 
void updateButtons ()
 
- Public Member Functions inherited from KDDockWidgets::Core::TitleBar
 TitleBar (Core::View *)
 
 TitleBar (FloatingWindow *parent)
 Creates the TitleBar used by Floating windows.
 
 TitleBar (Group *parent)
 Creates the TitleBar used by tab groups.
 
virtual ~TitleBar () override
 
bool buttonHidesIfDisabled (TitleBarButtonType) const
 
bool buttonIsUserHidden (TitleBarButtonType) const
 
bool buttonIsUserHidden (TitleBarButtonType, bool enabled) const
 Overload which also consults buttonHidesIfDisabled.
 
bool closeButtonEnabled () const
 
DockWidget::List dockWidgets () const
 the list of dockwidgets under this TitleBar. There should always be at least 1. If more than 1 then they are tabbed.
 
Private * dptr () const
 
QString floatButtonToolTip () const
 
bool floatButtonVisible () const
 
FloatingWindowfloatingWindow () const
 getter for m_floatingWindow
 
void focus (Qt::FocusReason reason)
 
Core::Groupgroup () const
 getter for m_group
 
bool hasIcon () const
 returns whether this title bar has an icon
 
Icon icon () const
 the icon
 
bool isFloating () const
 Returns true if this title-bar is the title bar of a floating window.
 
bool isFocused () const
 returns whether any of the DockWidgets this TitleBar controls has a child focus Not to be confused with QWidget::hasFocus(), which just refers to 1 widget. This works more like QtQuick's FocusScope
 
bool isMDI () const override
 From Draggable interface.
 
bool isStandalone () const
 Returns whether this titlebar is standalone. See comment in the ctor.
 
bool isWindow () const override
 
MainWindowmainWindow () const
 If this title bar belongs to a dock widget docked into the main window, returns the main window Returns nullptr otherwise.
 
std::unique_ptr< WindowBeingDragged > makeWindow () override
 
TitleBarButtonType maximizeButtonType () const
 
bool maximizeButtonVisible () const
 
void onAutoHideClicked ()
 
void onCloseClicked ()
 
bool onDoubleClicked ()
 
void onFloatClicked ()
 
void onMaximizeClicked ()
 
void onMinimizeClicked ()
 
void setCloseButtonEnabled (bool)
 
void setCloseButtonVisible (bool)
 
void setFloatButtonVisible (bool)
 
void setHideDisabledButtons (TitleBarButtonTypes)
 
void setIcon (const Icon &icon)
 
void setTitle (const QString &title)
 
void setUserHiddenButtons (TitleBarButtonTypes)
 Allows to override's KDDW's default visibility logic and force hide a button.
 
Core::DockWidgetsingleDockWidget () const override final
 
bool supportsAutoHideButton () const
 returns whether this title bar supports the auto-hide button
 
bool supportsFloatingButton () const
 returns whether this title bar supports a floating/docking button
 
bool supportsMaximizeButton () const
 returns whether this title bar supports a maximize/restore button
 
bool supportsMinimizeButton () const
 returns whether this title bar supports a minimize button
 
TabBartabBar () const
 Returns the tab bar which is under this title bar. It's only nullptr for the case of having a Floating Window with more than one nested Frame.
 
QString title () const
 
bool titleBarIsFocusable () const
 
void toggleMaximized ()
 
void updateButtons ()
 updates the close button enabled state
 
- Public Member Functions inherited from KDDockWidgets::Core::Controller
 Controller (ViewType type, View *)
 
virtual ~Controller ()
 
bool close ()
 
void destroyLater ()
 
Controller::Private * dptr () const
 
Rect geometry () const
 
int height () const
 
bool inDtor () const
 
bool is (ViewType) const
 Returns whether this controller is of the specified type.
 
bool isFixedHeight () const
 
bool isFixedWidth () const
 
bool isVisible () const
 
Point mapToGlobal (Point) const
 
Point pos () const
 
Rect rect () const
 
void setParentView (View *parent)
 
void setVisible (bool)
 
void show () const
 
Size size () const
 
ViewType type () const
 Returns the type of this controller.
 
Viewview () const
 Returns the view associated with this controller, if any.
 
int width () const
 
std::shared_ptr< Viewwindow () const
 
int x () const
 
int y () const
 

Public Attributes

Callback_isMDI m_isMDICallback = nullptr
 
Callback_isWindow m_isWindowCallback = nullptr
 
Callback_setParentView_impl m_setParentView_implCallback = nullptr
 
Callback_singleDockWidget m_singleDockWidgetCallback = nullptr
 

Additional Inherited Members

- Protected Member Functions inherited from KDDockWidgets::Core::TitleBar
bool isOverlayed () const
 
- Protected Attributes inherited from KDDockWidgets::Core::Controller
bool m_inDtor = false
 

Detailed Description

Definition at line 24 of file KDDWBindingsCore/TitleBar_c.h.

Member Typedef Documentation

◆ Callback_isMDI

typedef bool(* KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::Callback_isMDI) (void *)

Definition at line 71 of file KDDWBindingsCore/TitleBar_c.h.

◆ Callback_isWindow

typedef bool(* KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::Callback_isWindow) (void *)

Definition at line 73 of file KDDWBindingsCore/TitleBar_c.h.

◆ Callback_setParentView_impl

typedef void(* KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::Callback_setParentView_impl) (void *, KDDockWidgets::Core::View *parent)

Definition at line 75 of file KDDWBindingsCore/TitleBar_c.h.

◆ Callback_singleDockWidget

typedef KDDockWidgets::Core::DockWidget *(* KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::Callback_singleDockWidget) (void *)

Definition at line 77 of file KDDWBindingsCore/TitleBar_c.h.

Constructor & Destructor Documentation

◆ ~TitleBar_wrapper()

KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::~TitleBar_wrapper ( )

Definition at line 220 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ TitleBar_wrapper() [1/3]

KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::TitleBar_wrapper ( KDDockWidgets::Core::FloatingWindow parent)

Definition at line 33 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ TitleBar_wrapper() [2/3]

KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::TitleBar_wrapper ( KDDockWidgets::Core::Group parent)

Definition at line 37 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ TitleBar_wrapper() [3/3]

KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::TitleBar_wrapper ( KDDockWidgets::Core::View arg__1)

Definition at line 41 of file KDDWBindingsCore/TitleBar_c.cpp.

Member Function Documentation

◆ closeButtonEnabled()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::closeButtonEnabled ( ) const

Definition at line 45 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ floatButtonToolTip()

QString KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::floatButtonToolTip ( ) const

Definition at line 49 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ floatButtonVisible()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::floatButtonVisible ( ) const

Definition at line 53 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ floatingWindow()

KDDockWidgets::Core::FloatingWindow * KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::floatingWindow ( ) const

Definition at line 57 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ group()

KDDockWidgets::Core::Group * KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::group ( ) const

Definition at line 61 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ hasIcon()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::hasIcon ( ) const

Definition at line 65 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ isCloseButtonEnabled()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::isCloseButtonEnabled ( ) const

Definition at line 69 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ isCloseButtonVisible()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::isCloseButtonVisible ( ) const

Definition at line 73 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ isFloatButtonVisible()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::isFloatButtonVisible ( ) const

Definition at line 77 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ isFloating()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::isFloating ( ) const

Definition at line 81 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ isFocused()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::isFocused ( ) const

Definition at line 85 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ isMDI()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::isMDI ( ) const
virtual

Definition at line 89 of file KDDWBindingsCore/TitleBar_c.cpp.

References m_isMDICallback.

◆ isMDI_nocallback()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::isMDI_nocallback ( ) const
virtual

◆ isOverlayed()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::isOverlayed ( ) const

◆ isStandalone()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::isStandalone ( ) const

Definition at line 106 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ isWindow()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::isWindow ( ) const
virtual

Definition at line 110 of file KDDWBindingsCore/TitleBar_c.cpp.

References m_isWindowCallback.

◆ isWindow_nocallback()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::isWindow_nocallback ( ) const
virtual

◆ mainWindow()

KDDockWidgets::Core::MainWindow * KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::mainWindow ( ) const

Definition at line 123 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ maximizeButtonVisible()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::maximizeButtonVisible ( ) const

Definition at line 127 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ onAutoHideClicked()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::onAutoHideClicked ( )

◆ onCloseClicked()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::onCloseClicked ( )

◆ onDoubleClicked()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::onDoubleClicked ( )

Definition at line 139 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ onFloatClicked()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::onFloatClicked ( )

◆ onMaximizeClicked()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::onMaximizeClicked ( )

◆ onMinimizeClicked()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::onMinimizeClicked ( )

◆ setCloseButtonEnabled()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::setCloseButtonEnabled ( bool  arg__1)

◆ setCloseButtonVisible()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::setCloseButtonVisible ( bool  arg__1)

◆ setFloatButtonVisible()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::setFloatButtonVisible ( bool  arg__1)

◆ setParentView_impl()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::setParentView_impl ( KDDockWidgets::Core::View parent)
virtual

◆ setParentView_impl_nocallback()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::setParentView_impl_nocallback ( KDDockWidgets::Core::View parent)
virtual

◆ setTitle()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::setTitle ( const QString title)

◆ supportsAutoHideButton()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::supportsAutoHideButton ( ) const

Definition at line 184 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ supportsFloatingButton()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::supportsFloatingButton ( ) const

Definition at line 188 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ supportsMaximizeButton()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::supportsMaximizeButton ( ) const

Definition at line 192 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ supportsMinimizeButton()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::supportsMinimizeButton ( ) const

Definition at line 196 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ tabBar()

KDDockWidgets::Core::TabBar * KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::tabBar ( ) const

Definition at line 200 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ title()

QString KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::title ( ) const

Definition at line 204 of file KDDWBindingsCore/TitleBar_c.cpp.

Referenced by setTitle().

◆ titleBarIsFocusable()

bool KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::titleBarIsFocusable ( ) const

Definition at line 208 of file KDDWBindingsCore/TitleBar_c.cpp.

◆ toggleMaximized()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::toggleMaximized ( )

◆ updateButtons()

void KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::updateButtons ( )

Member Data Documentation

◆ m_isMDICallback

Callback_isMDI KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::m_isMDICallback = nullptr

Definition at line 72 of file KDDWBindingsCore/TitleBar_c.h.

Referenced by isMDI().

◆ m_isWindowCallback

Callback_isWindow KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::m_isWindowCallback = nullptr

Definition at line 74 of file KDDWBindingsCore/TitleBar_c.h.

Referenced by isWindow().

◆ m_setParentView_implCallback

Callback_setParentView_impl KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::m_setParentView_implCallback = nullptr

Definition at line 76 of file KDDWBindingsCore/TitleBar_c.h.

Referenced by setParentView_impl().

◆ m_singleDockWidgetCallback

Callback_singleDockWidget KDDockWidgetsBindings_wrappersNS::KDDWBindingsCore::TitleBar_wrapper::m_singleDockWidgetCallback = nullptr

Definition at line 78 of file KDDWBindingsCore/TitleBar_c.h.


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