 |
KDDockWidgets API Documentation 2.1
|
Loading...
Searching...
No Matches
|
KDDockWidgets API Documentation 2.1
|
#include <Config_c.h>
Public Member Functions | |
| ~Config_wrapper () | |
| KDDockWidgets::Size | absoluteWidgetMaxSize () const |
| KDDockWidgets::Size | absoluteWidgetMinSize () const |
| double | draggedWindowOpacity () const |
| bool | dropIndicatorsInhibited () const |
| bool | layoutSaverUsesStrictMode () const |
| int | layoutSpacing () const |
| int | mdiPopupThreshold () const |
| bool | onlyProgrammaticDrag () const |
| void | printDebug () |
| int | separatorThickness () const |
| void | setAbsoluteWidgetMaxSize (KDDockWidgets::Size size) |
| void | setAbsoluteWidgetMinSize (KDDockWidgets::Size size) |
| void | setDraggedWindowOpacity (double opacity) |
| void | setDropIndicatorsInhibited (bool inhibit) const |
| void | setLayoutSaverStrictMode (bool arg__1) |
| void | setLayoutSpacing (int arg__1) |
| void | setMDIPopupThreshold (int arg__1) |
| void | setOnlyProgrammaticDrag (bool arg__1) |
| void | setSeparatorThickness (int value) |
| void | setStartDragDistance (int arg__1) |
| void | setTransparencyOnlyOverDropIndicator (bool only) |
| void | setViewFactory (KDDockWidgets::Core::ViewFactory *arg__1) |
| int | startDragDistance () const |
| bool | transparencyOnlyOverDropIndicator () const |
| KDDockWidgets::Core::ViewFactory * | viewFactory () const |
 Public Member Functions inherited from KDDockWidgets::Config | |
| ~Config () | |
| destructor, called at shutdown | |
| Size | absoluteWidgetMaxSize () const |
| Size | absoluteWidgetMinSize () const |
| Config::CustomizableWidgets | disabledPaintEvents () const |
| DockWidgetFactoryFunc | dockWidgetFactoryFunc () const |
| Returns the DockWidgetFactoryFunc. nullptr by default. | |
| DragAboutToStartFunc | dragAboutToStartFunc () const |
| DragEndedFunc | dragEndedFunc () const |
| double | draggedWindowOpacity () const |
| returns the opacity to use when dragging dock widgets By default it's 1.0, fully opaque | |
| DropIndicatorAllowedFunc | dropIndicatorAllowedFunc () const |
| Used internally by the framework. Returns the function which was passed to setDropIndicatorAllowedFunc() By default it's nullptr. | |
| bool | dropIndicatorsInhibited () const |
| Returns whether drop indicators are inhibited. by default this is false unless you call setDropIndicatorsInhibited(true) | |
| Flags | flags () const |
| returns the chosen flags | |
| InternalFlags | internalFlags () const |
| bool | layoutSaverUsesStrictMode () const |
| int | layoutSpacing () const |
| MainWindowFactoryFunc | mainWindowFactoryFunc () const |
| Returns the MainWindowFactoryFunc. nullptr by default. | |
| MDIFlags | mdiFlags () const |
| returns the chosen MDI flags default is MDIFlag_None | |
| int | mdiPopupThreshold () const |
| bool | onlyProgrammaticDrag () const |
| void | printDebug () |
| Prints some debug information. | |
| int | separatorThickness () const |
| Returns the thickness of the separator. | |
| void | setAbsoluteWidgetMaxSize (Size size) |
| Sets the maximum size a dock widget can have. Widgets can still provide their own max-size and it will be respected, however it can never be bigger than this one. | |
| void | setAbsoluteWidgetMinSize (Size size) |
| Sets the minimum size a dock widget can have. Widgets can still provide their own min-size and it will be respected, however it can never be smaller than this one. | |
| void | setDisabledPaintEvents (CustomizableWidgets) |
| Disables our internal widget's paint events By default, KDDockWidget's internal widgets reimplement paintEvent(). Disabling them (which makes the base-class, QWidget::paintEvent() be called instead) can be useful if you want to style. | |
| void | setDockWidgetFactoryFunc (DockWidgetFactoryFunc) |
| Registers a DockWidgetFactoryFunc. | |
| void | setDragAboutToStartFunc (DragAboutToStartFunc func) |
| set a callback to be called once a drag starts | |
| void | setDragEndedFunc (DragEndedFunc func) |
| set a callback to be called once drag ends | |
| void | setDraggedWindowOpacity (double opacity) |
| sets the dragged window opacity 1.0 is fully opaque while 0.0 is fully transparent | |
| void | setDropIndicatorAllowedFunc (DropIndicatorAllowedFunc func) |
| Allows the client app to disallow certain docking indicators. | |
| void | setDropIndicatorsInhibited (bool inhibit) const |
| Allows to disable support for drop indicators while dragging By default drop indicators will be shown when dragging dock widgets. This functionality can be toggled whenever you need it (it's not a startup-only setting). | |
| void | setFlags (Flags flags) |
| setter for the flags | |
| void | setInternalFlags (InternalFlags flags) |
| void | setLayoutSaverStrictMode (bool) |
| void | setLayoutSpacing (int) |
| void | setMainWindowFactoryFunc (MainWindowFactoryFunc) |
| counter-part of DockWidgetFactoryFunc but for the main window. Should be rarely used. It's good practice to have the main window before restoring a layout. It's here so we can use it in the linter executable | |
| void | setMDIFlags (MDIFlags) |
| Setter for the MDI flags. | |
| void | setMDIPopupThreshold (int) |
| Sets the MDI popup threshold. When the layout is MDI and you drag a dock widget X pixels behond the window's edge, it will float the dock widget. by default this value is 250px. Use -1 to disable. | |
| void | setOnlyProgrammaticDrag (bool) |
| void | setSeparatorThickness (int value) |
| setter for separatorThickness Note: Only use this function at startup before creating any DockWidget or MainWindow. Note: For backwards compatibility, setting separatorThickness will set layoutSpacing to the same value. | |
| void | setStartDragDistance (int) |
| Sets how many pixels the mouse needs to travel before a drag is actually started Calling this is usually unneeded and just provided as a means to override Platform::startDragDistance() , which already has a reasonable default 4 pixels. | |
| void | setTransparencyOnlyOverDropIndicator (bool only) |
| Sets whether transparency is only set when the dragged window is over a drop indicator This is only relevant when using setDraggedWindowOpacity() Default is false. | |
| void | setViewFactory (Core::ViewFactory *) |
| Sets the ViewFactory. | |
| int | startDragDistance () const |
| Returns the value set by setStartDragDistance() Returns -1 if setStartDragDistance() wasn't call, in which case the Platform::startDragDistance() will be used. | |
| bool | transparencyOnlyOverDropIndicator () const |
| Returns whether transparency is only set when the dragged window is over a drop indicator This is only relevant when using setDraggedWindowOpacity() Default is false. | |
| Core::ViewFactory * | viewFactory () const |
| getter for the framework view factory | |
Static Public Member Functions | |
| static KDDockWidgets::Config & | self () |
| Static Public Member Functions inherited from KDDockWidgets::Config | |
| static bool | hasFlag (Flag) |
| Returns whether the specified flag is set or not. | |
| static bool | hasMDIFlag (MDIFlag) |
| Returns whether the specified MDI flag is set or not. | |
| static Config & | self () |
| returns the singleton Config instance | |
Definition at line 17 of file Config_c.h.
| KDDockWidgetsBindings_wrappersNS::Config_wrapper::~Config_wrapper | ( | ) |
Definition at line 136 of file Config_c.cpp.
| KDDockWidgets::Size KDDockWidgetsBindings_wrappersNS::Config_wrapper::absoluteWidgetMaxSize | ( | ) | const |
Definition at line 32 of file Config_c.cpp.
| KDDockWidgets::Size KDDockWidgetsBindings_wrappersNS::Config_wrapper::absoluteWidgetMinSize | ( | ) | const |
Definition at line 36 of file Config_c.cpp.
| double KDDockWidgetsBindings_wrappersNS::Config_wrapper::draggedWindowOpacity | ( | ) | const |
Definition at line 40 of file Config_c.cpp.
| bool KDDockWidgetsBindings_wrappersNS::Config_wrapper::dropIndicatorsInhibited | ( | ) | const |
Definition at line 44 of file Config_c.cpp.
| bool KDDockWidgetsBindings_wrappersNS::Config_wrapper::layoutSaverUsesStrictMode | ( | ) | const |
Definition at line 48 of file Config_c.cpp.
| int KDDockWidgetsBindings_wrappersNS::Config_wrapper::layoutSpacing | ( | ) | const |
Definition at line 52 of file Config_c.cpp.
| int KDDockWidgetsBindings_wrappersNS::Config_wrapper::mdiPopupThreshold | ( | ) | const |
Definition at line 56 of file Config_c.cpp.
| bool KDDockWidgetsBindings_wrappersNS::Config_wrapper::onlyProgrammaticDrag | ( | ) | const |
Definition at line 60 of file Config_c.cpp.
| void KDDockWidgetsBindings_wrappersNS::Config_wrapper::printDebug | ( | ) |
Definition at line 64 of file Config_c.cpp.
References KDDockWidgets::Config::printDebug().
|
static |
Definition at line 68 of file Config_c.cpp.
Referenced by c_static_KDDockWidgets__Config__self().
| int KDDockWidgetsBindings_wrappersNS::Config_wrapper::separatorThickness | ( | ) | const |
Definition at line 72 of file Config_c.cpp.
| void KDDockWidgetsBindings_wrappersNS::Config_wrapper::setAbsoluteWidgetMaxSize | ( | KDDockWidgets::Size | size | ) |
Definition at line 76 of file Config_c.cpp.
References KDDockWidgets::Config::setAbsoluteWidgetMaxSize().
| void KDDockWidgetsBindings_wrappersNS::Config_wrapper::setAbsoluteWidgetMinSize | ( | KDDockWidgets::Size | size | ) |
Definition at line 80 of file Config_c.cpp.
References KDDockWidgets::Config::setAbsoluteWidgetMinSize().
| void KDDockWidgetsBindings_wrappersNS::Config_wrapper::setDraggedWindowOpacity | ( | double | opacity | ) |
Definition at line 84 of file Config_c.cpp.
References KDDockWidgets::Config::setDraggedWindowOpacity().
| void KDDockWidgetsBindings_wrappersNS::Config_wrapper::setDropIndicatorsInhibited | ( | bool | inhibit | ) | const |
Definition at line 88 of file Config_c.cpp.
References KDDockWidgets::Config::setDropIndicatorsInhibited().
| void KDDockWidgetsBindings_wrappersNS::Config_wrapper::setLayoutSaverStrictMode | ( | bool | arg__1 | ) |
Definition at line 92 of file Config_c.cpp.
References KDDockWidgets::Config::setLayoutSaverStrictMode().
| void KDDockWidgetsBindings_wrappersNS::Config_wrapper::setLayoutSpacing | ( | int | arg__1 | ) |
Definition at line 96 of file Config_c.cpp.
References KDDockWidgets::Config::setLayoutSpacing().
| void KDDockWidgetsBindings_wrappersNS::Config_wrapper::setMDIPopupThreshold | ( | int | arg__1 | ) |
Definition at line 100 of file Config_c.cpp.
References KDDockWidgets::Config::setMDIPopupThreshold().
| void KDDockWidgetsBindings_wrappersNS::Config_wrapper::setOnlyProgrammaticDrag | ( | bool | arg__1 | ) |
Definition at line 104 of file Config_c.cpp.
References KDDockWidgets::Config::setOnlyProgrammaticDrag().
| void KDDockWidgetsBindings_wrappersNS::Config_wrapper::setSeparatorThickness | ( | int | value | ) |
Definition at line 108 of file Config_c.cpp.
References KDDockWidgets::Config::setSeparatorThickness().
| void KDDockWidgetsBindings_wrappersNS::Config_wrapper::setStartDragDistance | ( | int | arg__1 | ) |
Definition at line 112 of file Config_c.cpp.
References KDDockWidgets::Config::setStartDragDistance().
| void KDDockWidgetsBindings_wrappersNS::Config_wrapper::setTransparencyOnlyOverDropIndicator | ( | bool | only | ) |
Definition at line 116 of file Config_c.cpp.
References KDDockWidgets::Config::setTransparencyOnlyOverDropIndicator().
| void KDDockWidgetsBindings_wrappersNS::Config_wrapper::setViewFactory | ( | KDDockWidgets::Core::ViewFactory * | arg__1 | ) |
Definition at line 120 of file Config_c.cpp.
References KDDockWidgets::Config::setViewFactory().
| int KDDockWidgetsBindings_wrappersNS::Config_wrapper::startDragDistance | ( | ) | const |
Definition at line 124 of file Config_c.cpp.
| bool KDDockWidgetsBindings_wrappersNS::Config_wrapper::transparencyOnlyOverDropIndicator | ( | ) | const |
Definition at line 128 of file Config_c.cpp.
| KDDockWidgets::Core::ViewFactory * KDDockWidgetsBindings_wrappersNS::Config_wrapper::viewFactory | ( | ) | const |
Definition at line 132 of file Config_c.cpp.
KDDockWidgets
© Klarälvdalens Datakonsult AB (KDAB)