diff options
| author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2016-12-21 14:07:13 +0100 |
|---|---|---|
| committer | Jani Heikkinen <jani.heikkinen@qt.io> | 2016-12-22 10:57:24 +0000 |
| commit | be24f42336537e891df2b59e2e64713571a0792a (patch) | |
| tree | 30661bfa847dbe16a0c63541974521813fbc24c8 /src/webengine | |
| parent | 4bcf51ba125a8c74a71a949fbfce2e106646c0fc (diff) | |
Doc: Describe default values for WebEngineView::printToPdf()
The doc does not mention that two out of three parameters have
default values and can be left out.
Also fix the method signature to use QML conventions.
Change-Id: I4c88653ce1fc5890aadce74be878098d16ae274c
Reviewed-by: Michael Brüning <michael.bruning@qt.io>
Diffstat (limited to 'src/webengine')
| -rw-r--r-- | src/webengine/doc/src/webengineview.qdoc | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index 52ca84c6b..2e5bde409 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -1121,11 +1121,14 @@ */ /*! - \qmlmethod void WebEngineView::printToPdf(const QString &filePath, PrintedPageSizeId pageSizeId, PrintedPageOrientation orientation) + \qmlmethod void WebEngineView::printToPdf(const string filePath, PrintedPageSizeId pageSizeId, PrintedPageOrientation orientation) \since QtWebEngine 1.3 Prints the WebEngineView's current content to a PDF document and stores it under \a filePath. The document's size will be determined by the value of \a pageSizeId and its orientation will be determined using \a orientation. + + If you leave out \a pageSizeID, it defaults to \c A4. If you leave out + \a orientation, it defaults to \c Portrait. */ /*! @@ -1137,6 +1140,9 @@ The \a resultCallback must take a string parameter. This string will contain the document's data upon successful printing and an empty string otherwise. + + If you leave out \a pageSizeID, it defaults to \c A4. If you leave out + \a orientation, it defaults to \c Portrait. */ /*! |