QWhatsThis Class

Descripción detallada

La ayuda "¿Qué es esto?" forma parte del sistema de ayuda en línea de una aplicación, y proporciona a los usuarios información sobre la funcionalidad y el uso de un widget concreto. Los textos de ayuda de "¿Qué es esto?" suelen ser más largos y detallados que los de tooltips, pero generalmente proporcionan menos información que la suministrada por ventanas de ayuda independientes.

QWhatsThis proporciona una única ventana con un texto explicativo que aparece cuando el usuario pregunta "¿Qué es esto?". La forma predeterminada en que los usuarios formulan la pregunta es mover el foco al widget correspondiente y pulsar Mayús+F1. El texto de ayuda aparece inmediatamente; desaparece en cuanto el usuario hace otra cosa. (Ten en cuenta que si existe un atajo de teclado para Mayús+F1, este mecanismo no funcionará). Algunos cuadros de diálogo proporcionan un botón "?" que los usuarios pueden pulsar para entrar en el modo "¿Qué es esto?"; a continuación, hacen clic en el widget correspondiente para que aparezca la ventana "¿Qué es esto?". También es posible incluir una opción de menú o un botón en la barra de herramientas para pasar al modo "¿Qué es esto?

Para añadir el texto "¿Qué es esto?" a un widget o a una acción, basta con llamar a QWidget::setWhatsThis() o QAction::setWhatsThis().

El texto puede ser texto enriquecido o texto sin formato. Si especifica una cadena con formato de texto enriquecido, se representará utilizando la hoja de estilos predeterminada, lo que permite incrustar imágenes en el texto mostrado. Para ser lo más rápida posible, la hoja de estilos por defecto utiliza un método sencillo para determinar si el texto puede ser mostrado como texto plano. Véase Qt::mightBeRichText() para más detalles.

newAct = new QAction(tr("&New"), this);
newAct->setShortcut(tr("Ctrl+N"));
newAct->setStatusTip(tr("Create a new file"));
newAct->setWhatsThis(tr("Click this option to create a new file."));

Una forma alternativa de entrar en el modo "¿Qué es esto?" es llamar a createAction(), y añadir el QAction devuelto a un menú o a una barra de herramientas. Al invocar esta acción de ayuda contextual (en la imagen inferior, el botón con la flecha y el icono del signo de interrogación), el usuario pasa al modo "¿Qué es esto?". Si ahora hace clic en un widget, se muestra el texto de ayuda correspondiente. El modo se abandona cuando se proporciona ayuda o cuando el usuario pulsa Esc.

Puede entrar en el modo "¿Qué es esto?" mediante programación con enterWhatsThisMode(), comprobar el modo con inWhatsThisMode() y volver al modo normal con leaveWhatsThisMode().

Si desea controlar manualmente el comportamiento "¿Qué es esto?" de un widget, consulte Qt::WA_CustomWhatsThis.

También es posible mostrar diferentes textos de ayuda para diferentes regiones de un widget, utilizando un QHelpEvent del tipo QEvent::WhatsThis. Intercepte el evento de ayuda en la función QWidget::event() de su widget y llame a QWhatsThis::showText() con el texto que desea mostrar para la posición especificada en QHelpEvent::pos(). Si el texto es texto enriquecido y el usuario hace clic en un enlace, el widget también recibe un QWhatsThisClickedEvent con la referencia del enlace como QWhatsThisClickedEvent::href(). Si se gestiona un QWhatsThisClickedEvent (es decir, QWidget::event() devuelve true), la ventana de ayuda permanece visible. Llame a QWhatsThis::hideText() para ocultarla explícitamente.