QDockWidget Class

Documentación de funciones miembro

[explicit] QDockWidget::QDockWidget(QWidget *parent = nullptr, Qt::WindowFlags flags = Qt::WindowFlags())

Construye un QDockWidget con parent parent y window flags flags. El widget dock se colocará en el área izquierda del widget dock.

[explicit] QDockWidget::QDockWidget(const QString &title, QWidget *parent = nullptr, Qt::WindowFlags flags = Qt::WindowFlags())

Construye un QDockWidget con parent parent y window flags flags. El widget dock se colocará en el área izquierda del widget dock.

El título de la ventana se establece en title. Este título se utiliza cuando el QDockWidget está acoplado y desacoplado. También se utiliza en el menú contextual proporcionado por QMainWindow.

Véase también setWindowTitle().

[virtual noexcept] QDockWidget::~QDockWidget()

Destruye el widget del dock.

[signal] void QDockWidget::allowedAreasChanged(Qt::DockWidgetAreas allowedAreas)

Esta señal se emite cuando cambia la propiedad allowedAreas. El parámetro allowedAreas indica el nuevo valor de la propiedad.

[override virtual protected] void QDockWidget::changeEvent(QEvent *event)

Reimplementa: QWidget::changeEvent(QEvent *event).

[override virtual protected] void QDockWidget::closeEvent(QCloseEvent *event)

Reimplementa: QWidget::closeEvent(QCloseEvent *event).

[signal] void QDockWidget::dockLocationChanged(Qt::DockWidgetArea area)

Esta señal se emite cuando el widget del dock se mueve a otro dock area, o se mueve a una ubicación diferente en su área de dock actual. Esto ocurre cuando el widget del dock es movido programáticamente o es arrastrado a una nueva ubicación por el usuario.

Véase también dockLocation() y setDockLocation().

[override virtual protected] bool QDockWidget::event(QEvent *event)

Reimplementa: QWidget::event(QEvent *event).

[signal] void QDockWidget::featuresChanged(QDockWidget::DockWidgetFeatures features)

Esta señal se emite cuando cambia la propiedad features. El parámetro features indica el nuevo valor de la propiedad.

[virtual protected] void QDockWidget::initStyleOption(QStyleOptionDockWidget *option) const

Inicializa option con los valores de este QDockWidget. Este método es útil para las subclases cuando necesitan un QStyleOptionDockWidget, pero no quieren rellenar toda la información ellos mismos.

Véase también QStyleOption::initFrom().

bool QDockWidget::isAreaAllowed(Qt::DockWidgetArea area) const

Devuelve true si este widget de muelle se puede colocar en el area dado ; en caso contrario devuelve false.

[override virtual protected] void QDockWidget::paintEvent(QPaintEvent *event)

Reimplementa: QWidget::paintEvent(QPaintEvent *event).

[since 6.9] void QDockWidget::setDockLocation(Qt::DockWidgetArea area)

Asigna este widget de anclaje a area. Si está anclado en otra ubicación de anclaje, se moverá a area. Si es flotante o parte de pestañas flotantes, la siguiente llamada a setFloating(false) lo anclará en area.

Esta función se introdujo en Qt 6.9.

Ver también dockLocation() y dockLocationChanged().

void QDockWidget::setTitleBarWidget(QWidget *widget)

Establece un widget arbitrario como barra de título del widget del dock. Si widget es nullptr, cualquier widget de barra de título personalizado establecido previamente en el widget del dock se elimina, pero no se borra, y en su lugar se utilizará la barra de título predeterminada.

Si se establece un widget de barra de título, QDockWidget no utilizará decoraciones nativas de la ventana cuando esté flotando.

Estos son algunos consejos para implementar barras de título personalizadas:

• Los eventos del ratón que no son manejados explícitamente por el widget de la barra de título deben ser ignorados llamando a QMouseEvent::ignore(). Estos eventos se propagan al padre QDockWidget, que los maneja de la manera habitual, moviéndose cuando se arrastra la barra de título, acoplándose y desacoplándose cuando se hace doble clic, etc.
• Cuando DockWidgetVerticalTitleBar se establece en QDockWidget, el widget de la barra de título se reposiciona en consecuencia. En resizeEvent(), la barra de título debe comprobar qué orientación debe asumir:

  QDockWidget *dockWidget = qobject_cast<QDockWidget*>(parentWidget());
  if (dockWidget->features() & QDockWidget::DockWidgetVerticalTitleBar) {
      // I need to be vertical
  } else {
      // I need to be horizontal
  }

• El widget de la barra de título debe tener una función válida QWidget::sizeHint() y QWidget::minimumSizeHint(). Estas funciones deben tener en cuenta la orientación actual de la barra de título.
• No es posible eliminar una barra de título de un widget dock. Sin embargo, se puede conseguir un efecto similar estableciendo un QWidget construido por defecto como widget de la barra de título.

Utilizando qobject_cast() como se muestra arriba, el widget de la barra de título tiene acceso completo a su padre QDockWidget. Por lo tanto, puede realizar operaciones como acoplar y ocultar en respuesta a las acciones del usuario.

Véase también titleBarWidget() y DockWidgetVerticalTitleBar.

void QDockWidget::setWidget(QWidget *widget)

Establece el widget para el widget del dock en widget.

Si el widget del dock es visible cuando se añade widget, debes show() explícitamente.

Ten en cuenta que debes añadir el diseño del widget antes de llamar a esta función; si no, el widget no será visible.

Véase también widget().

QWidget *QDockWidget::titleBarWidget() const

Devuelve el widget de la barra de título personalizada establecido en QDockWidget, o nullptr si no se ha establecido ninguna barra de título personalizada.

Véase también setTitleBarWidget().

QAction *QDockWidget::toggleViewAction() const

Devuelve una acción comprobable que puede añadirse a menús y barras de herramientas para que el usuario pueda mostrar o cerrar este widget acoplable.

El texto de la acción se establece en el título de la ventana del widget.

El objeto QAction es propiedad de QDockWidget. Se borrará automáticamente cuando se destruya QDockWidget.

Véase también QAction::text y QWidget::windowTitle.

[signal] void QDockWidget::topLevelChanged(bool topLevel)

Esta señal se emite cuando cambia la propiedad floating. El parámetro topLevel es true si el widget del dock es ahora flotante; en caso contrario es false.

Véase también isWindow().

[signal] void QDockWidget::visibilityChanged(bool visible)

Esta señal se emite cuando el widget del dock se vuelve visible (o invisible). Esto ocurre cuando el widget se oculta o se muestra, así como cuando está anclado en un área de anclaje con pestañas y su pestaña se selecciona o se deselecciona.

QWidget *QDockWidget::widget() const

Devuelve el widget para el widget del dock. Esta función devuelve cero si no se ha establecido el widget.

Véase también setWidget().