diff options
| author | Paul Wicking <paul.wicking@qt.io> | 2025-11-06 12:06:40 +0100 |
|---|---|---|
| committer | Paul Wicking <paul.wicking@qt.io> | 2025-11-06 22:53:26 +0100 |
| commit | 2d4bb691635684759a8fbeeba374d67547b6bf30 (patch) | |
| tree | 8295adb57941681dd7af2119229e7694b0c7a370 /src/core/api/qwebengineframe.cpp | |
| parent | 9d112ae51e9360f28839d8a8d1cf7afd5d3accc9 (diff) | |
Doc: Add missing property docs
Task-number: QTBUG-140629
Change-Id: Iab2d22dba0ff8728786f3554bb537808735782cd
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Diffstat (limited to 'src/core/api/qwebengineframe.cpp')
| -rw-r--r-- | src/core/api/qwebengineframe.cpp | 24 |
1 files changed, 16 insertions, 8 deletions
diff --git a/src/core/api/qwebengineframe.cpp b/src/core/api/qwebengineframe.cpp index 6bced5b06..4fec8233e 100644 --- a/src/core/api/qwebengineframe.cpp +++ b/src/core/api/qwebengineframe.cpp @@ -47,7 +47,8 @@ QWebEngineFrame::QWebEngineFrame(QWeakPointer<QtWebEngineCore::WebContentsAdapte } /*! - Returns \c{true} if this object represents an existing frame; \c{false} otherwise. + \property QWebEngineFrame::isValid + \brief Whether this object represents an existing frame. Once a frame is invalid, it never becomes valid again. */ @@ -58,7 +59,8 @@ bool QWebEngineFrame::isValid() const } /*! - Returns the frame name; that is, what would be returned by \c window.name in JavaScript. + \property QWebEngineFrame::name + \brief The frame name; that is, what would be returned by \c window.name in JavaScript. If the frame could not be found, returns a null QString. @@ -71,7 +73,8 @@ QString QWebEngineFrame::name() const } /*! - Returns the value of the frame's \c name HTML attribute, or an empty string if it has none. + \property QWebEngineFrame::htmlName + \brief The value of the frame's \c name HTML attribute, or an empty string if it has none. If the frame could not be found, returns a null QString. @@ -84,7 +87,8 @@ QString QWebEngineFrame::htmlName() const } /*! - Returns a list of the frame's children in an arbitrary order. + \property QWebEngineFrame::children + \brief A list of the frame's children in an arbitrary order. If the frame could not be found, returns an empty list. */ @@ -98,7 +102,8 @@ QList<QWebEngineFrame> QWebEngineFrame::children() const } /*! - Returns the URL of the content currently loaded in this frame. + \property QWebEngineFrame::url + \brief The URL of the content currently loaded in this frame. If the frame could not be found, returns an empty QUrl. */ @@ -109,8 +114,10 @@ QUrl QWebEngineFrame::url() const } /*! - Returns the size of the frame within the viewport, measured in logical pixels. On devices - with a scale factor other than 100%, this will not correspond to the on-screen size; + \property QWebEngineFrame::size + \brief The size of the frame within the viewport, measured in logical pixels. + + On devices with a scale factor other than 100%, this will not correspond to the on-screen size; instead, it will be the size before scaling is applied. In such cases, the size may contain fractional values. @@ -123,7 +130,8 @@ QSizeF QWebEngineFrame::size() const } /*! - Returns \c{true} if this object represents the page's main frame; \c{false} otherwise. + \property QWebEngineFrame::isMainFrame + \brief Whether this object represents the page's main frame. */ bool QWebEngineFrame::isMainFrame() const { |