Document that toggleViewAction can't be used to toggle the dock widget

...from code.

This is by design; the action is updated when the dock widget changes,
not the other way around (which would easily result in infinite loops).

Change-Id: I9e71784d239a9cbb6c8efaeaa3e3adc6dc590f65
Fixes: QTBUG-80022
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
This commit is contained in:
Volker Hilsheimer 2019-11-14 17:11:11 +01:00
parent d025c1a75f
commit de6520805a

View File

@ -1609,11 +1609,14 @@ bool QDockWidget::event(QEvent *event)
#ifndef QT_NO_ACTION
/*!
Returns a checkable action that can be used to show or close this
dock widget.
Returns a checkable action that can be added to menus and toolbars so that
the user can show or close this dock widget.
The action's text is set to the dock widget's window title.
\note The action can not be used to programmatically show or hide the dock
widget. Use the \l visible property for that.
\sa QAction::text, QWidget::windowTitle
*/
QAction * QDockWidget::toggleViewAction() const