wwWidgets Home · All Classes · Main Classes · Grouped Classes · Functions

QwwTipWidget Class Reference
[wwWidgets module]

The QwwTipWidget class provides a widget that displays application tips. More...

 #include <QwwTipWidget>

This class is not part of the Qt GUI Framework Edition.

Inherits QWidget.

• List of all members, including inherited members

Properties

• 58 properties inherited from QWidget
• 1 property inherited from QObject

Public Functions

• 217 public functions inherited from QWidget
• 13 public functions inherited from QPaintDevice
• 29 public functions inherited from QObject

Public Slots

• 19 public slots inherited from QWidget
• 1 public slot inherited from QObject

Signals

• 1 signal inherited from QWidget
• 1 signal inherited from QObject

Additional Inherited Members

• 1 public type inherited from QObject
• 4 static public members inherited from QWidget
• 4 static public members inherited from QObject
• 37 protected functions inherited from QWidget
• 1 protected function inherited from QPaintDevice
• 7 protected functions inherited from QObject
• 1 protected slot inherited from QWidget
• 1 protected type inherited from QPaintDevice
• 2 protected variables inherited from QObject

Detailed Description

The QwwTipWidget class provides a widget that displays application tips.

The widget can be embedded into a dialog and connected to its signals to provide a quick way to show startup tips for the user.

Tips displayed are adjustable using the tips property. The widget can contain a checkbox that asks whether the user wants to see the tips again next time the application is started. This checkbox doesn't implement any logic, if you want to have that behavior in your application, you have to implement it yourself using some persistent data storage like QSettings.

Tips are displayed in rich text, so they can contain formatting, images and other elements that can be rendered using Scribe.

Property Documentation

canvasFrameShape : QFrame::Shape

This property holds the frame shape of the canvas where tips are displayed.

Access functions:

checkVisible : bool

This property holds whether the "show tips on startup" checkbox is visible.

Access functions:

closeVisible : bool

This property holds whether the close button is visible.

Access functions:

currentTip : int

This property holds index of the currently shown tip.

Access functions:

tips : QStringList

This property holds a list of tips associated with the widget.

Access functions:

tipsEnabled : bool

This property holds this property holds whether showing tips is enabled.

Access functions:

Member Function Documentation

QwwTipWidget::QwwTipWidget ( const QStringList & list, QWidget * parent = 0 )

Constructs a tip widget with list of tips and a given parent

const QPushButton * QwwTipWidget::closeButton () const

returns a pointer to the "close" button

void QwwTipWidget::closed ()   [signal]

This signal is emitted when the tip widget is closed.

QWidget * QwwTipWidget::headerWidget () const

returns a pointer to the header widget

See also setHeaderWidget().

const QPushButton * QwwTipWidget::nextButton () const

returns a pointer to the "next" button

void QwwTipWidget::nextTip ()   [slot]

This slot changes the current tip to the next one. In case the currently displayed tip is the last one, function will make the first tip current.

const QPushButton * QwwTipWidget::prevButton () const

returns a pointer to the "prev" button

void QwwTipWidget::prevTip ()   [slot]

This slot changes the current tip to the previous one. In case the currently displayed tip is the first one, function will make the last tip current.

void QwwTipWidget::setCheckHidden ( bool v )   [slot]

Convenience function. Equivalent to setCheckVisible(!v).

void QwwTipWidget::setCloseHidden ( bool v )   [slot]

Convenience function. Equivalent to setCloseVisible(!v).

void QwwTipWidget::setHeaderWidget ( QWidget * hw )

sets hw as a header of the widget

See also headerWidget().

const QTextBrowser * QwwTipWidget::tipCanvas () const

returns a pointer to the tip canvas

void QwwTipWidget::tipChanged ( int index )   [signal]

This signal is emitted whenever the currently shown tip changes to index