Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-68798

QTimer Class documentation refers to nonexistent activated() signal

    XMLWordPrintable

Details

    • Bug
    • Resolution: Done
    • P3: Somewhat important
    • 5.11.2
    • 5.7.1, 5.8.0, 5.11.0
    • Documentation
    • None
    • c4928e99e9e571890ddfc08ff80139a1dba5fb5d

    Description

      Documentation for QTimer class mentions "activated()" signal, but this doesn't actually exist.  Refer to section

      http://doc.qt.io/qt-5/qtimer.html#accuracy-and-timer-resolution

      where it says "Qt will emit activated() only once,"

      I'm pretty sure it's supposed to refer to the timeout() signal.

      Then when referring to the various start() methods, e.g.

      http://doc.qt.io/qt-5/qtimer.html#start

      it says "If singleShot is true, the timer will be activated only once."

      What I think it's meant to say is: "If singleShot is true, the timer will only emit the timeout() signal once when the interval expires." (rather than continuing to emit that signal repetitively).  But if it has emitted timeout() and is then started again via a call to start(), it will emit another timeout() event when the time interval expires.

      Please clarify this documentation.

       

      Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

          People

            jbornema Joerg Bornemann
            jasona360 Jason Armistead
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes