Add documentation to FixedSizeClickLabel

Change-Id: I906e00628365073527a2b8ab1e5bb4e61c8225d0
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: David Schulz <david.schulz@qt.io>
This commit is contained in:
Eike Ziller
2017-12-01 11:54:13 +01:00
parent 9687593bce
commit a6dfae7f10

View File

@@ -35,22 +35,49 @@
For convenience it also has a clicked signal that is emitted whenever the label receives a mouse For convenience it also has a clicked signal that is emitted whenever the label receives a mouse
click. click.
\inmodule Qt Creator
*/
/*!
\fn Utils::FixedSizeClickLabel::clicked()
This signal is emitted when the label is clicked with the left mouse button.
*/
/*!
\property Utils::FixedSizeClickLabel::maxText
This property holds the text that is used to calculate the label's size hint.
*/ */
namespace Utils { namespace Utils {
/*!
Constructs a FixedSizeClickLabel with the parent \a parent.
*/
FixedSizeClickLabel::FixedSizeClickLabel(QWidget *parent) FixedSizeClickLabel::FixedSizeClickLabel(QWidget *parent)
: QLabel(parent) : QLabel(parent)
, m_pressed(false) , m_pressed(false)
{ {
} }
/*!
Sets the label's text to \a text, and changes the size hint of the label to the size of
\a maxText.
\sa maxText
\sa setMaxText
*/
void FixedSizeClickLabel::setText(const QString &text, const QString &maxText) void FixedSizeClickLabel::setText(const QString &text, const QString &maxText)
{ {
QLabel::setText(text); QLabel::setText(text);
m_maxText = maxText; m_maxText = maxText;
} }
/*!
\reimp
*/
QSize FixedSizeClickLabel::sizeHint() const QSize FixedSizeClickLabel::sizeHint() const
{ {
return fontMetrics().boundingRect(m_maxText).size(); return fontMetrics().boundingRect(m_maxText).size();
@@ -66,6 +93,9 @@ void FixedSizeClickLabel::setMaxText(const QString &maxText)
m_maxText = maxText; m_maxText = maxText;
} }
/*!
\reimp
*/
void FixedSizeClickLabel::mousePressEvent(QMouseEvent *ev) void FixedSizeClickLabel::mousePressEvent(QMouseEvent *ev)
{ {
QLabel::mousePressEvent(ev); QLabel::mousePressEvent(ev);
@@ -73,6 +103,9 @@ void FixedSizeClickLabel::mousePressEvent(QMouseEvent *ev)
m_pressed = true; m_pressed = true;
} }
/*!
\reimp
*/
void FixedSizeClickLabel::mouseReleaseEvent(QMouseEvent *ev) void FixedSizeClickLabel::mouseReleaseEvent(QMouseEvent *ev)
{ {
QLabel::mouseReleaseEvent(ev); QLabel::mouseReleaseEvent(ev);