summaryrefslogtreecommitdiffstats
path: root/src/pdf/doc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Update PdfPageView code snippetSafiyyah Moosa2 days1-0/+12
| | | | | | | | | | | | The PdfPageView QML Type documentation contains a code snippet. The code snippet should demonstrate how to use the PdfPageView QML type, however it uses the PdfMultiPageView QML type instead. This fix creates a new code snippet that implements the PdfPageView QML type. This snippet replaces the incorrect snippet that was used previously. Fixes: QTBUG-123536 Pick-to: 6.7 Change-Id: I319b4d86133d7dc41664229110a6c13ed46b7e80 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* doc: Add docs for the pdfviewer exampleShawn Rutledge2024-01-191-0/+0
| | | | | | | | | | | This example exists to show a simpler viewer using PdfScrollablePageView rather than PdfMultiPageView. Most users will probably prefer the latter, so we don't highlight this one. Pick-to: 6.7 Task-number: QTBUG-81560 Change-Id: Ia601b8c8ec0cb9002aa118917720a37b4f8095a5 Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* Doc: Remove \ingroup all-examples command from the docsJaishree Vyas2023-12-061-1/+0
| | | | | | | Task-number: QTBUG-115044 Pick-to: 6.5 6.6 Change-Id: I83314f3b7955e1ef9c857bcc96c07f6f90b2f875 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Fix QPdfPageSelector::currentPageLabel property documentationTopi Reinio2023-11-101-0/+3
| | | | | | | | | | | | | | | src/pdfwidgets/qpdfpageselector.cpp: * warning: Cannot find 'QPdfPageSelector::currentPageIndex' specified with '\property' in any header file src/core/doc/src/qtwebengine-deploying.qdoc: * warning: Unknown command '\maocs' Mark documentation modules free of warnings. Pick-to: 6.6 Change-Id: Icbdf9622501b1fc4911f58682ffd2146efc36c1f Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Remove warninglimit .qdocconf variableTopi Reinio2023-06-271-3/+0
| | | | | | | | | | | | | | | | The most common limit for the maximum number of allowed documentation warnings is zero. As all Qt module docs include() a common configuration from qtbase, it's better to control the base warninglimit from a central location in qtbase/doc/global. This allows for a temporary increase of the limit across all modules as needed - for example, when updating the QDoc binary that the CI provisions to a version that introduces new types of documentation warnings. Task-number: QTBUG-113326 Change-Id: Ic28d57f29e1f8ea5b551fe25a413dafcf04c0ccc Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Docs: Add that Qt PDF for Android is not supportedSafiyyah Moosa2023-06-122-0/+16
| | | | | | | | Task-number: QTBUG-83459 Task-number: QTBUG-113551 Pick-to: 6.5 6.6 Change-Id: I1b3e21da8fbd714d4a4291a8804e6c901bf8e292 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* Docs: Fix "Can't link to" example warningsSafiyyah Moosa2023-05-101-1/+1
| | | | | | | Task-number: QTBUG-113160 Pick-to: 6.5 Change-Id: Ic987711802db7eb32cdb15ac9f313d2203984981 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* doc: Provide a screenshot of the PDF Viewer widget example; rename pageShawn Rutledge2023-03-301-0/+0
| | | | | | | | | | | | | | | | Let's be clear in the title that this is a widget-based example, as opposed to the Qt Quick example in the docs. The screenshot is from macOS 13.2.1. The 6.6 example has more features, so this screenshot looks a bit incomplete compared to that. Pick-to: 6.5 Task-number: QTBUG-81560 Change-Id: I28b50d608756f10967f1bf5f7ac72ec9a83d9417 Reviewed-by: Matthias Rauter <matthias.rauter@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* doc: Add the QtPDF Licenses and Attributions sectionShawn Rutledge2023-03-284-0/+40
| | | | | | | Fixes: QTBUG-88482 Pick-to: 6.5 Change-Id: If58a8443afb38f372ca3dc7372472db888586dba Reviewed-by: Michal Klocek <michal.klocek@qt.io>
* Doc: Add the git repo URL for the Qt PDF examplesVenugopal Shivashankar2022-09-071-0/+1
| | | | | | | | | This should enable the readers to access the up-to-date example code. Change-Id: Ie62bdea39d1374b49f1b8f5bf576b27c8f37996f Pick-to: 6.3 6.2 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Use SPDX license identifiersLucie Gérard2022-07-081-0/+3
| | | | | | | | | | | Ammend 9b9d789fcb8f63a8998f1eefe44f2a1c8156c362 : some files were still missing SPDX headers Pick-to: 6.4 Task-number: QTBUG-67283 Task-number: QTBUG-104589 Change-Id: Ia4d2aae636bbdb1a99c422e3b8d3f097c3af34d6 Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Doc: Do not advertise Qt module includeKai Köhne2022-07-083-15/+0
| | | | | | | | | People should rather use class includes, like they are advertised in each class documentation. Pick-to: 6.4 Change-Id: I3fc26c2ff01e35595959878c392dcafa2527d29f Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Fix linking issues on Qt PDF documentationTopi Reinio2022-07-051-1/+2
| | | | | | | | | | | | | These warnings were not captured by the documentation testing in CI. Fix or remove links to properties from inherited QML types, and remove \sa entries that are already linked to in the documentation. Fix incorrect \inqmlmodule argument for PdfPageImage. Pick-to: 6.4 Change-Id: If2c14d468a6dc3cd464ca4de1f4e39ad48d4d326 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* Highlight the multipage pdf viewer exampleShawn Rutledge2022-07-051-0/+2
| | | | | | | | | | ...so that it shows up prominently on Creator's welcome page. Pick-to: 6.4 Task-number: QTBUG-81850 Task-number: QTBUG-103221 Change-Id: I4b61115b45eddb3142fdbc72701fcd005cea39a4 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Use SPDX license identifiersLucie Gérard2022-06-224-104/+8
| | | | | | | | | | | Replace the current license disclaimer in files by a SPDX-License-Identifier. License files are organized under LICENSES directory. Pick-to: 6.4 Task-number: QTBUG-67283 Change-Id: I869ffda1080e283f231eb0dc4477b260f2054d99 Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* doc: Document QPdfBookmarkModel and QPdfLinkModelShawn Rutledge2022-06-061-1/+3
| | | | | | | | | | | QML docs were already in place since 303c25e79ab12d5d48523aa890f2091e98d3b560 and ccbd6fbdbe071f42e1c060ca579786758701f358; but QPdfBookmarkModel existed since 398880564621b06a79a4ba245baf350022ad438a (5ccb928983e8ff5e51989fab60ea413a5b418f29 in the qtpdf repo). Change-Id: Id3e91b4e98e25cf035868e55a22cf69262ee5afc Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* Rename QPdfNavigationStack to QPdfPageNavigator; QML type tooShawn Rutledge2022-05-271-2/+2
| | | | | | | | | | | | | | | | | This might reduce some confusion about the fact that the back/forward "stack" isn't strictly a stack in the data structure sense: it's more like QUndoStack. It causes a QML source incompatibility relative to Qt 5, but keeps the C++ class name the same as it has been in QtPdf for a long time. Amends 3ad445f9f24a9d3f259ed1781460a63346a728e4 [ChangeLog][QtPDF] The PdfNavigationStack QML type has been renamed to PdfPageNavigator, matching the C++ type QPdfPageNavigator. These remember navigation history within a document, and are helpful to implement back/forward buttons similar to those on a web browser in both Qt Quick and widget-based viewer applications. Change-Id: Id8dc17aa416bb7064b1f0f300a47c07c83b7f47e Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io>
* doc: Add docs for QPdfViewShawn Rutledge2022-04-232-3/+7
| | | | | | | | Wrap some long lines in qpdfview.cpp, as a drive-by. Task-number: QTBUG-81560 Change-Id: Ia9865c42e48c81ac2c99b5cbe9d5a10beff40847 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* QtPDF: Get styles working again; remove visible hyperlink adornmentsShawn Rutledge2022-04-201-0/+0
| | | | | | | | | | | | | | | | | | | | | | | Update to versionless imports. The color type comes from the QtQuick import now. Add the styles to CMakeLists.txt so they get installed. Use SystemPalette rather than instantiating a Control. We'd probably better just assume that the PDF has hyperlinks decorated however the author wanted, rather than risking redundant underlines. Declare linkUnderscoreStrokeWidth: -1 since the ShapePath.strokeWidth docs tell us "When set to a negative value, no stroking occurs." But the user can turn them back on using a custom style. Update the screenshot: avoid showing off how bad the underscores looked. PdfPageView doesn't depend on Controls and doesn't import styles: it simply loses the light-grey rectangles around links. The cursor change still informs the user when the mouse is hovering a link. Pick-to: 6.3 Fixes: QTBUG-102303 Change-Id: Ifa4f9982bfaaf0e2e46230e8dbe30a5db7c9f592 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* doc: Add Qt Quick details to the Qt PDF module page; clarify examplesShawn Rutledge2022-04-171-0/+22
| | | | | | | | | The module is more about Qt Quick than about widgets nowadays. Also clarify on the Qt PDF Examples page that one example uses widgets and the other uses Qt Quick. Change-Id: I38a77a4290f9489ef17bf66fe3a0f69be9bd0e88 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* doc: fix QtPDF doc warnings and mistakesShawn Rutledge2022-04-082-1/+2
| | | | | Change-Id: Id2ce2bd8852c4051edd29bf474bac216ba14f2b5 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* doc: begin adding docs for MultiPageView component and exampleShawn Rutledge2022-04-073-0/+9
| | | | | | | Pick-to: 6.3 Task-number: QTBUG-81560 Change-Id: I062e022a97c146e9a746b6d6358868bfe0c0a7d7 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* doc: Document the QPdfSearchModel C++ classShawn Rutledge2022-03-311-0/+0
| | | | | | | | | | | PdfSearchModel already has QML docs since b6dd845ec4a6bfb6b620686681e20d38a2f24101; but QPdfSearchModel could also be used in widget applications (although we haven't added it to the widget example yet). Task-number: QTBUG-81560 Change-Id: I23adf4ef777542a7aea6ecade74ca583a0933d43 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* Combine QPdfDestination and QPdfSearchResult into QPdfLinkShawn Rutledge2022-03-241-0/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Inheritance was a decent way to model this, conceptually. A hyperlink is modeled like the HTML kind: a region covering the source material that the user will click on, and a destination where we will jump when they click it; whereas a search result has the same information plus the text before and after the search text, so that we can show some context in a ListView with search results. By going this way, we need to document which fields we use which way under which conditions. But, we have a rule that value types cannot use inheritance, just in case the user would ever try to use them polymorphically (in spite of the other rule that we never pass value types by pointer, and thus there is no actual polymorphism), or just in case the destructor of the base class would not be called when a subclass value goes out of scope. Anyway, perhaps an upside is that this resembles a link in Xanadu, or in a fully-normalized database schema: an object that fully describes both ends of a connection, and thus is able to traverse either direction, in theory. (Although we don't really use it that way. The link-following behavior in a PDF viewer tends to be one-way, as in a web browser.) When using QAbstractItemModel (as in QPdfSearchModel and QPdfLinkModel), the cells in the "database" are accessed separately via the data() function, so there is no need for a transport object to hold a whole "row". That's OK for item views; but we need this link object for the purpose of less-clumsy C++ API, as a return value from a few functions. For example when implementing a viewer in QML, we use Repeater to instantiate Items for each hyperlink (decorations and a TapHandler), and Repeater uses the QAIM interface. But when implementing a widget-based viewer, it's better to call a hit-testing function like QPdfLinkModel::linkAt(pos) to find out whether a link exists at a particular mouse location; and that function can return a QPdfLink. In this case, the link will not contain contextBefore and contextAfter, because the viewer doesn't need them, and it's difficult to find this text in the PDF model. But QPdfSearchModel::resultsOnPage() and reultAtIndex() return link objects that do contain the context strings. We don't expect users to have made much use of these classes in C++ so far, because we prioritized QML API (which this change does not affect), and did not yet document how to use QPdfSearchModel and QPdfLinkModel in widget-based viewers. Fixes: QTBUG-98886 Change-Id: Ie68f9b893a342d145abac0b143e9254827c70bd7 Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io> Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Doc: Fix find_package() call for Qt PDFKai Köhne2022-01-161-2/+2
| | | | | | Pick-to: 6.3 6.2 Change-Id: Id19aa463db605c861a1bd3502eb964c8f9340e4d Reviewed-by: Michal Klocek <michal.klocek@qt.io>
* Doc: Fix qdoc warnings and enable zero warning limitVenugopal Shivashankar2021-11-152-11/+10
| | | | | Change-Id: Ifa2914e7bca9c224670a1891785d0ba8262cd61b Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Remove unsupported customFiltersKai Köhne2021-08-251-4/+0
| | | | | | Task-number: QTBUG-95987 Change-Id: Ie762a1e45cf0e84951cf7c91bf2144f38ad55dd1 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Add information about building the module with CMakeLeena Miettinen2020-02-033-2/+10
| | | | | | | | Task-number: QTBUG-81560 Change-Id: I9d75606634da4c604f34913908f97a91797d1813 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Leander Beernaert <leander.beernaert@qt.io> Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* Doc: Add dependency to the Qt Quick module to fix QDoc warningsLeena Miettinen2020-01-281-1/+2
| | | | | Change-Id: Ia56a07bc2d53bd4a2166566a9c95126a5d2f9154 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Add docs for the Qt PDF Viewer exampleLeena Miettinen2020-01-283-1/+45
| | | | | | Task-number: QTBUG-81560 Change-Id: I159747a097a6a6a28c2355e8ff6b6c59a4f3a29a Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* Doc: Add QML types from the Qt Quick PDF module to the doc configLeena Miettinen2020-01-222-5/+21
| | | | | | | | | Also add examples, even though the example docs have not been added yet. Task-number: QTBUG-81560 Change-Id: I9ada8e658359788421eda209fffe1eaed967318c Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Add index and module files for Qt PDF module and fix header pathLeena Miettinen2019-11-254-1/+150
| | | | | | Change-Id: I6c8dbc3c8d5c8638d7098ab1d4f2999a4c2e6042 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io> Reviewed-by: Michal Klocek <michal.klocek@qt.io>
* Add qdocconf for the QtPdf moduleTobias Koenig2019-11-251-0/+40
Change-Id: I4fdd53098c32394dbeef58f49b511453079045f9 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-02 03:20:23 +0000