From 5c21acf1d092c7cef0d8a14575bc35596b58cd95 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Fri, 27 May 2016 16:44:08 +0200 Subject: Add documentation Change-Id: I450da7c1c07d738785a1cfee3a1f6b8d0c39db86 Reviewed-by: Kai Koehne --- .qmake.conf | 2 - LICENSE.FDL | 450 ++++++++++++++++++++++++++++ doc/config/qtwebbrowser-project.qdocconf | 40 +++ doc/doc.pri | 44 +++ doc/images/block-diagram.png | Bin 0 -> 3716 bytes doc/images/bookmarks.png | Bin 0 -> 10034 bytes doc/images/html5test.png | Bin 0 -> 18589 bytes doc/images/inputhelp.png | Bin 0 -> 4289 bytes doc/images/menubar.png | Bin 0 -> 3397 bytes doc/images/pageselection.png | Bin 0 -> 50712 bytes doc/images/settings.png | Bin 0 -> 11771 bytes doc/images/src/block-diagram.qmodel | 496 +++++++++++++++++++++++++++++++ doc/images/virtualkeyboard.png | Bin 0 -> 12271 bytes doc/images/webbrowser.png | Bin 0 -> 136640 bytes doc/qtwebbrowser-online.qdocconf | 16 + doc/qtwebbrowser.qdocconf | 2 + doc/src/external-resources.qdoc | 53 ++++ doc/src/qtwebbrowser.qdoc | 185 ++++++++++++ qtwebbrowser.pro | 5 + 19 files changed, 1291 insertions(+), 2 deletions(-) delete mode 100644 .qmake.conf create mode 100644 LICENSE.FDL create mode 100644 doc/config/qtwebbrowser-project.qdocconf create mode 100644 doc/doc.pri create mode 100644 doc/images/block-diagram.png create mode 100644 doc/images/bookmarks.png create mode 100644 doc/images/html5test.png create mode 100644 doc/images/inputhelp.png create mode 100644 doc/images/menubar.png create mode 100644 doc/images/pageselection.png create mode 100644 doc/images/settings.png create mode 100644 doc/images/src/block-diagram.qmodel create mode 100644 doc/images/virtualkeyboard.png create mode 100644 doc/images/webbrowser.png create mode 100644 doc/qtwebbrowser-online.qdocconf create mode 100644 doc/qtwebbrowser.qdocconf create mode 100644 doc/src/external-resources.qdoc create mode 100644 doc/src/qtwebbrowser.qdoc diff --git a/.qmake.conf b/.qmake.conf deleted file mode 100644 index 53aeb41..0000000 --- a/.qmake.conf +++ /dev/null @@ -1,2 +0,0 @@ -load(qt_build_config) -MODULE_VERSION=1.0.0 diff --git a/LICENSE.FDL b/LICENSE.FDL new file mode 100644 index 0000000..938bb8d --- /dev/null +++ b/LICENSE.FDL @@ -0,0 +1,450 @@ + GNU Free Documentation License + Version 1.3, 3 November 2008 + + + Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +0. PREAMBLE + +The purpose of this License is to make a manual, textbook, or other +functional and useful document "free" in the sense of freedom: to +assure everyone the effective freedom to copy and redistribute it, +with or without modifying it, either commercially or noncommercially. +Secondarily, this License preserves for the author and publisher a way +to get credit for their work, while not being considered responsible +for modifications made by others. + +This License is a kind of "copyleft", which means that derivative +works of the document must themselves be free in the same sense. It +complements the GNU General Public License, which is a copyleft +license designed for free software. + +We have designed this License in order to use it for manuals for free +software, because free software needs free documentation: a free +program should come with manuals providing the same freedoms that the +software does. But this License is not limited to software manuals; +it can be used for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this License +principally for works whose purpose is instruction or reference. + + +1. APPLICABILITY AND DEFINITIONS + +This License applies to any manual or other work, in any medium, that +contains a notice placed by the copyright holder saying it can be +distributed under the terms of this License. Such a notice grants a +world-wide, royalty-free license, unlimited in duration, to use that +work under the conditions stated herein. The "Document", below, +refers to any such manual or work. Any member of the public is a +licensee, and is addressed as "you". You accept the license if you +copy, modify or distribute the work in a way requiring permission +under copyright law. + +A "Modified Version" of the Document means any work containing the +Document or a portion of it, either copied verbatim, or with +modifications and/or translated into another language. + +A "Secondary Section" is a named appendix or a front-matter section of +the Document that deals exclusively with the relationship of the +publishers or authors of the Document to the Document's overall +subject (or to related matters) and contains nothing that could fall +directly within that overall subject. (Thus, if the Document is in +part a textbook of mathematics, a Secondary Section may not explain +any mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, +commercial, philosophical, ethical or political position regarding +them. + +The "Invariant Sections" are certain Secondary Sections whose titles +are designated, as being those of Invariant Sections, in the notice +that says that the Document is released under this License. If a +section does not fit the above definition of Secondary then it is not +allowed to be designated as Invariant. The Document may contain zero +Invariant Sections. If the Document does not identify any Invariant +Sections then there are none. + +The "Cover Texts" are certain short passages of text that are listed, +as Front-Cover Texts or Back-Cover Texts, in the notice that says that +the Document is released under this License. A Front-Cover Text may +be at most 5 words, and a Back-Cover Text may be at most 25 words. + +A "Transparent" copy of the Document means a machine-readable copy, +represented in a format whose specification is available to the +general public, that is suitable for revising the document +straightforwardly with generic text editors or (for images composed of +pixels) generic paint programs or (for drawings) some widely available +drawing editor, and that is suitable for input to text formatters or +for automatic translation to a variety of formats suitable for input +to text formatters. A copy made in an otherwise Transparent file +format whose markup, or absence of markup, has been arranged to thwart +or discourage subsequent modification by readers is not Transparent. +An image format is not Transparent if used for any substantial amount +of text. A copy that is not "Transparent" is called "Opaque". + +Examples of suitable formats for Transparent copies include plain +ASCII without markup, Texinfo input format, LaTeX input format, SGML +or XML using a publicly available DTD, and standard-conforming simple +HTML, PostScript or PDF designed for human modification. Examples of +transparent image formats include PNG, XCF and JPG. Opaque formats +include proprietary formats that can be read and edited only by +proprietary word processors, SGML or XML for which the DTD and/or +processing tools are not generally available, and the +machine-generated HTML, PostScript or PDF produced by some word +processors for output purposes only. + +The "Title Page" means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the material +this License requires to appear in the title page. For works in +formats which do not have any title page as such, "Title Page" means +the text near the most prominent appearance of the work's title, +preceding the beginning of the body of the text. + +The "publisher" means any person or entity that distributes copies of +the Document to the public. + +A section "Entitled XYZ" means a named subunit of the Document whose +title either is precisely XYZ or contains XYZ in parentheses following +text that translates XYZ in another language. (Here XYZ stands for a +specific section name mentioned below, such as "Acknowledgements", +"Dedications", "Endorsements", or "History".) To "Preserve the Title" +of such a section when you modify the Document means that it remains a +section "Entitled XYZ" according to this definition. + +The Document may include Warranty Disclaimers next to the notice which +states that this License applies to the Document. These Warranty +Disclaimers are considered to be included by reference in this +License, but only as regards disclaiming warranties: any other +implication that these Warranty Disclaimers may have is void and has +no effect on the meaning of this License. + +2. VERBATIM COPYING + +You may copy and distribute the Document in any medium, either +commercially or noncommercially, provided that this License, the +copyright notices, and the license notice saying this License applies +to the Document are reproduced in all copies, and that you add no +other conditions whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or further +copying of the copies you make or distribute. However, you may accept +compensation in exchange for copies. If you distribute a large enough +number of copies you must also follow the conditions in section 3. + +You may also lend copies, under the same conditions stated above, and +you may publicly display copies. + + +3. COPYING IN QUANTITY + +If you publish printed copies (or copies in media that commonly have +printed covers) of the Document, numbering more than 100, and the +Document's license notice requires Cover Texts, you must enclose the +copies in covers that carry, clearly and legibly, all these Cover +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on +the back cover. Both covers must also clearly and legibly identify +you as the publisher of these copies. The front cover must present +the full title with all words of the title equally prominent and +visible. You may add other material on the covers in addition. +Copying with changes limited to the covers, as long as they preserve +the title of the Document and satisfy these conditions, can be treated +as verbatim copying in other respects. + +If the required texts for either cover are too voluminous to fit +legibly, you should put the first ones listed (as many as fit +reasonably) on the actual cover, and continue the rest onto adjacent +pages. + +If you publish or distribute Opaque copies of the Document numbering +more than 100, you must either include a machine-readable Transparent +copy along with each Opaque copy, or state in or with each Opaque copy +a computer-network location from which the general network-using +public has access to download using public-standard network protocols +a complete Transparent copy of the Document, free of added material. +If you use the latter option, you must take reasonably prudent steps, +when you begin distribution of Opaque copies in quantity, to ensure +that this Transparent copy will remain thus accessible at the stated +location until at least one year after the last time you distribute an +Opaque copy (directly or through your agents or retailers) of that +edition to the public. + +It is requested, but not required, that you contact the authors of the +Document well before redistributing any large number of copies, to +give them a chance to provide you with an updated version of the +Document. + + +4. MODIFICATIONS + +You may copy and distribute a Modified Version of the Document under +the conditions of sections 2 and 3 above, provided that you release +the Modified Version under precisely this License, with the Modified +Version filling the role of the Document, thus licensing distribution +and modification of the Modified Version to whoever possesses a copy +of it. In addition, you must do these things in the Modified Version: + +A. Use in the Title Page (and on the covers, if any) a title distinct + from that of the Document, and from those of previous versions + (which should, if there were any, be listed in the History section + of the Document). You may use the same title as a previous version + if the original publisher of that version gives permission. +B. List on the Title Page, as authors, one or more persons or entities + responsible for authorship of the modifications in the Modified + Version, together with at least five of the principal authors of the + Document (all of its principal authors, if it has fewer than five), + unless they release you from this requirement. +C. State on the Title page the name of the publisher of the + Modified Version, as the publisher. +D. Preserve all the copyright notices of the Document. +E. Add an appropriate copyright notice for your modifications + adjacent to the other copyright notices. +F. Include, immediately after the copyright notices, a license notice + giving the public permission to use the Modified Version under the + terms of this License, in the form shown in the Addendum below. +G. Preserve in that license notice the full lists of Invariant Sections + and required Cover Texts given in the Document's license notice. +H. Include an unaltered copy of this License. +I. Preserve the section Entitled "History", Preserve its Title, and add + to it an item stating at least the title, year, new authors, and + publisher of the Modified Version as given on the Title Page. If + there is no section Entitled "History" in the Document, create one + stating the title, year, authors, and publisher of the Document as + given on its Title Page, then add an item describing the Modified + Version as stated in the previous sentence. +J. Preserve the network location, if any, given in the Document for + public access to a Transparent copy of the Document, and likewise + the network locations given in the Document for previous versions + it was based on. These may be placed in the "History" section. + You may omit a network location for a work that was published at + least four years before the Document itself, or if the original + publisher of the version it refers to gives permission. +K. For any section Entitled "Acknowledgements" or "Dedications", + Preserve the Title of the section, and preserve in the section all + the substance and tone of each of the contributor acknowledgements + and/or dedications given therein. +L. Preserve all the Invariant Sections of the Document, + unaltered in their text and in their titles. Section numbers + or the equivalent are not considered part of the section titles. +M. Delete any section Entitled "Endorsements". Such a section + may not be included in the Modified Version. +N. Do not retitle any existing section to be Entitled "Endorsements" + or to conflict in title with any Invariant Section. +O. Preserve any Warranty Disclaimers. + +If the Modified Version includes new front-matter sections or +appendices that qualify as Secondary Sections and contain no material +copied from the Document, you may at your option designate some or all +of these sections as invariant. To do this, add their titles to the +list of Invariant Sections in the Modified Version's license notice. +These titles must be distinct from any other section titles. + +You may add a section Entitled "Endorsements", provided it contains +nothing but endorsements of your Modified Version by various +parties--for example, statements of peer review or that the text has +been approved by an organization as the authoritative definition of a +standard. + +You may add a passage of up to five words as a Front-Cover Text, and a +passage of up to 25 words as a Back-Cover Text, to the end of the list +of Cover Texts in the Modified Version. Only one passage of +Front-Cover Text and one of Back-Cover Text may be added by (or +through arrangements made by) any one entity. If the Document already +includes a cover text for the same cover, previously added by you or +by arrangement made by the same entity you are acting on behalf of, +you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one. + +The author(s) and publisher(s) of the Document do not by this License +give permission to use their names for publicity for or to assert or +imply endorsement of any Modified Version. + + +5. COMBINING DOCUMENTS + +You may combine the Document with other documents released under this +License, under the terms defined in section 4 above for modified +versions, provided that you include in the combination all of the +Invariant Sections of all of the original documents, unmodified, and +list them all as Invariant Sections of your combined work in its +license notice, and that you preserve all their Warranty Disclaimers. + +The combined work need only contain one copy of this License, and +multiple identical Invariant Sections may be replaced with a single +copy. If there are multiple Invariant Sections with the same name but +different contents, make the title of each such section unique by +adding at the end of it, in parentheses, the name of the original +author or publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list of +Invariant Sections in the license notice of the combined work. + +In the combination, you must combine any sections Entitled "History" +in the various original documents, forming one section Entitled +"History"; likewise combine any sections Entitled "Acknowledgements", +and any sections Entitled "Dedications". You must delete all sections +Entitled "Endorsements". + + +6. COLLECTIONS OF DOCUMENTS + +You may make a collection consisting of the Document and other +documents released under this License, and replace the individual +copies of this License in the various documents with a single copy +that is included in the collection, provided that you follow the rules +of this License for verbatim copying of each of the documents in all +other respects. + +You may extract a single document from such a collection, and +distribute it individually under this License, provided you insert a +copy of this License into the extracted document, and follow this +License in all other respects regarding verbatim copying of that +document. + + +7. AGGREGATION WITH INDEPENDENT WORKS + +A compilation of the Document or its derivatives with other separate +and independent documents or works, in or on a volume of a storage or +distribution medium, is called an "aggregate" if the copyright +resulting from the compilation is not used to limit the legal rights +of the compilation's users beyond what the individual works permit. +When the Document is included in an aggregate, this License does not +apply to the other works in the aggregate which are not themselves +derivative works of the Document. + +If the Cover Text requirement of section 3 is applicable to these +copies of the Document, then if the Document is less than one half of +the entire aggregate, the Document's Cover Texts may be placed on +covers that bracket the Document within the aggregate, or the +electronic equivalent of covers if the Document is in electronic form. +Otherwise they must appear on printed covers that bracket the whole +aggregate. + + +8. TRANSLATION + +Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of section 4. +Replacing Invariant Sections with translations requires special +permission from their copyright holders, but you may include +translations of some or all Invariant Sections in addition to the +original versions of these Invariant Sections. You may include a +translation of this License, and all the license notices in the +Document, and any Warranty Disclaimers, provided that you also include +the original English version of this License and the original versions +of those notices and disclaimers. In case of a disagreement between +the translation and the original version of this License or a notice +or disclaimer, the original version will prevail. + +If a section in the Document is Entitled "Acknowledgements", +"Dedications", or "History", the requirement (section 4) to Preserve +its Title (section 1) will typically require changing the actual +title. + + +9. TERMINATION + +You may not copy, modify, sublicense, or distribute the Document +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense, or distribute it is void, and +will automatically terminate your rights under this License. + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, receipt of a copy of some or all of the same material does +not give you any rights to use it. + + +10. FUTURE REVISIONS OF THIS LICENSE + +The Free Software Foundation may publish new, revised versions of the +GNU Free Documentation License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. See +http://www.gnu.org/copyleft/. + +Each version of the License is given a distinguishing version number. +If the Document specifies that a particular numbered version of this +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that specified version or +of any later version that has been published (not as a draft) by the +Free Software Foundation. If the Document does not specify a version +number of this License, you may choose any version ever published (not +as a draft) by the Free Software Foundation. If the Document +specifies that a proxy can decide which future versions of this +License can be used, that proxy's public statement of acceptance of a +version permanently authorizes you to choose that version for the +Document. + +11. RELICENSING + +"Massive Multiauthor Collaboration Site" (or "MMC Site") means any +World Wide Web server that publishes copyrightable works and also +provides prominent facilities for anybody to edit those works. A +public wiki that anybody can edit is an example of such a server. A +"Massive Multiauthor Collaboration" (or "MMC") contained in the site +means any set of copyrightable works thus published on the MMC site. + +"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0 +license published by Creative Commons Corporation, a not-for-profit +corporation with a principal place of business in San Francisco, +California, as well as future copyleft versions of that license +published by that same organization. + +"Incorporate" means to publish or republish a Document, in whole or in +part, as part of another Document. + +An MMC is "eligible for relicensing" if it is licensed under this +License, and if all works that were first published under this License +somewhere other than this MMC, and subsequently incorporated in whole or +in part into the MMC, (1) had no cover texts or invariant sections, and +(2) were thus incorporated prior to November 1, 2008. + +The operator of an MMC Site may republish an MMC contained in the site +under CC-BY-SA on the same site at any time before August 1, 2009, +provided the MMC is eligible for relicensing. + + +ADDENDUM: How to use this License for your documents + +To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and +license notices just after the title page: + + Copyright (c) YEAR YOUR NAME. + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.3 + or any later version published by the Free Software Foundation; + with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. + A copy of the license is included in the section entitled "GNU + Free Documentation License". + +If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, +replace the "with...Texts." line with this: + + with the Invariant Sections being LIST THEIR TITLES, with the + Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. + +If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. + +If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, +to permit their use in free software. diff --git a/doc/config/qtwebbrowser-project.qdocconf b/doc/config/qtwebbrowser-project.qdocconf new file mode 100644 index 0000000..d4570ca --- /dev/null +++ b/doc/config/qtwebbrowser-project.qdocconf @@ -0,0 +1,40 @@ +include($QT_INSTALL_DOCS/global/macros.qdocconf) +include($QT_INSTALL_DOCS/global/qt-cpp-defines.qdocconf) +include($QT_INSTALL_DOCS/global/compat.qdocconf) +include($QT_INSTALL_DOCS/global/fileextensions.qdocconf) + +project = "QtWebBrowser" +description = "Qt WebBrowser Manual" + +sourcedirs += .. +imagedirs += ../images +outputdir = $OUTDIR + +sources.fileextensions = "*.qdoc" + +qhp.projects = QtWebBrowser +qhp.QtWebBrowser.file = qtwebbrowser.qhp +qhp.QtWebBrowser.namespace = org.qt-project.qtwebbrowser.$$QTWEBBROWSER_VERSION_TAG +qhp.QtWebBrowser.virtualFolder = qtwebbrowser +qhp.QtWebBrowser.indexTitle = Qt WebBrowser +qhp.QtWebBrowser.filterAttributes = qtwebbrowser +qhp.QtWebBrowser.customFilters.QtWebBrowser.name = Qt WebBrowser $QTWEBBROWSER_VERSION +qhp.QtWebBrowser.customFilters.QtWebBrowser.filterAttributes = qtwebbrowser $QTWEBBROWSER_VERSION +qhp.QtWebBrowser.indexRoot = + +qhp.QtWebBrowser.subprojects = manual +qhp.QtWebBrowser.subprojects.manual.indexTitle = Qt WebBrowser +qhp.QtWebBrowser.subprojects.manual.title = Qt WebBrowser +qhp.QtWebBrowser.subprojects.manual.type = manual + +indexes += $QT_INSTALL_DOCS/qtlocation/qtlocation.index \ + $QT_INSTALL_DOCS/qtquick/qtquick.index \ + $QT_INSTALL_DOCS/qtvirtualkeyboard/qtvirtualkeyboard.index \ + $QT_INSTALL_DOCS/qtwebengine/qtwebengine.index + +# Doxygen compatibility commands +macro.see = "\\sa" +macro.function = "\\fn" + +navigation.homepage = "Qt WebBrowser Manual" +buildversion = "Qt WebBrowser $QTWEBBROWSER_VERSION" diff --git a/doc/doc.pri b/doc/doc.pri new file mode 100644 index 0000000..6ccd058 --- /dev/null +++ b/doc/doc.pri @@ -0,0 +1,44 @@ +HELPGENERATOR = $$shell_path($$[QT_INSTALL_BINS]/qhelpgenerator) -platform minimal +QDOC_BIN = $$shell_path($$[QT_INSTALL_BINS]/qdoc) +QDOC_GLOBAL = QT_INSTALL_DOCS=$$[QT_INSTALL_DOCS/src] QDOC_INDEX_DIR=$$[QT_INSTALL_DOCS] +COMPAT = + +# unset the installdir for qdoc, so we force generation +# of URLs for the links to the Qt documentation +QMAKE_DOCS_INSTALLDIR = + +defineReplace(cmdEnv) { + !equals(QMAKE_DIR_SEP, /): 1 ~= s,^(.*)$,(set \\1) &&,g + return("$$1") +} + +defineReplace(qdoc) { + return("$$cmdEnv(OUTDIR=$$1 QTWEBBROWSER_VERSION=$$QTWEBBROWSER_VERSION QTWEBBROWSER_VERSION_TAG=$$QTWEBBROWSER_VERSION_TAG $$QDOC_GLOBAL) $$QDOC_BIN") +} + +QHP_FILE = $$OUT_PWD/doc/html/qtwebbrowser.qhp +QCH_FILE = $$OUT_PWD/doc/qtwebbrowser.qch + +HELP_DEP_FILES = $$PWD/src/qtwebbrowser.qdoc $$PWD/src/external-resources.qdoc + +html_docs.commands = $$qdoc($$OUT_PWD/doc/html) $$PWD/qtwebbrowser.qdocconf +html_docs.depends += $$HELP_DEP_FILES +html_docs.files = $$QHP_FILE + +html_docs_online.commands = $$qdoc($$OUT_PWD/doc/html) $$PWD/qtwebbrowser-online.qdocconf +html_docs_online.depends += $$HELP_DEP_FILES + +qch_docs.commands = $$HELPGENERATOR -o \"$$QCH_FILE\" $$QHP_FILE +qch_docs.depends += html_docs + +docs_online.depends = html_docs_online +docs.depends = qch_docs +QMAKE_EXTRA_TARGETS += qch_docs html_docs html_docs_online docs docs_online + +DISTFILES += \ + $$HELP_DEP_FILES \ + $$PWD/config/qtwebbrowser-project.qdocconf \ + $$PWD/qtwebbrowser.qdocconf \ + $$PWD/qtwebbrowser-online.qdocconf \ + $$PWD/images/src/block-diagram.qmodel + diff --git a/doc/images/block-diagram.png b/doc/images/block-diagram.png new file mode 100644 index 0000000..50dec11 Binary files /dev/null and b/doc/images/block-diagram.png differ diff --git a/doc/images/bookmarks.png b/doc/images/bookmarks.png new file mode 100644 index 0000000..5796891 Binary files /dev/null and b/doc/images/bookmarks.png differ diff --git a/doc/images/html5test.png b/doc/images/html5test.png new file mode 100644 index 0000000..4d71ac0 Binary files /dev/null and b/doc/images/html5test.png differ diff --git a/doc/images/inputhelp.png b/doc/images/inputhelp.png new file mode 100644 index 0000000..cd310ba Binary files /dev/null and b/doc/images/inputhelp.png differ diff --git a/doc/images/menubar.png b/doc/images/menubar.png new file mode 100644 index 0000000..943dc25 Binary files /dev/null and b/doc/images/menubar.png differ diff --git a/doc/images/pageselection.png b/doc/images/pageselection.png new file mode 100644 index 0000000..67e216d Binary files /dev/null and b/doc/images/pageselection.png differ diff --git a/doc/images/settings.png b/doc/images/settings.png new file mode 100644 index 0000000..069d477 Binary files /dev/null and b/doc/images/settings.png differ diff --git a/doc/images/src/block-diagram.qmodel b/doc/images/src/block-diagram.qmodel new file mode 100644 index 0000000..7a78937 --- /dev/null +++ b/doc/images/src/block-diagram.qmodel @@ -0,0 +1,496 @@ + + + + {f35988a9-6bcf-4b28-9496-6d2bda6b4b59} + + + + + + + + {0076d7ae-ef4b-45eb-8cfb-6ab04beb9d0c} + + + block-diagram + + + + + + + {a8c8ed99-0062-4b4c-935d-1076b1886ea3} + + + + + + + + + + {a8c8ed99-0062-4b4c-935d-1076b1886ea3} + + + block-diagram + + + + + + + + + + + + {31670797-833f-490c-a1a7-96027da776ae} + + + {35301846-40c1-4814-8279-27e504981b6d} + Qt WebBrowser + x:200;y:210 + x:-80;y:-30;w:160;h:60 + false + 0 + true + + + + + + + + + + + + + {4d899821-3971-40fd-ac87-fb15d951bd03} + + + {0b5ebe96-6859-435b-a13a-e1520b3feeb5} + Qt Quick + x:475;y:300 + x:-80;y:-30;w:160;h:60 + false + 0 + + + + + + + + + + + + + {26ba5615-d61d-4d53-bc8a-a23fb5d92543} + + + {152e2926-742b-4266-a67d-0badd705cd90} + Qt WebEngine + x:475;y:210 + x:-80;y:-30;w:160;h:60 + false + 0 + + + + + + + + + + + + + {f68aba0c-bb1c-45e9-9f3e-ec530e272d7d} + + + {a6df659c-bbb2-4109-b0e6-60918263837d} + Qt VirtualKeyboard + x:200;y:300 + x:-80;y:-30;w:160;h:60 + false + 0 + + + + + + + + + + + + + {9ecae4ad-a91b-4afb-b852-9513ef0db2bd} + + + {a2469a49-9150-43c6-95f9-46a9df37d5a2} + {31670797-833f-490c-a1a7-96027da776ae} + {4d899821-3971-40fd-ac87-fb15d951bd03} + + + + + + + + + + + + + {efba6948-7090-4bbc-ae78-1ff87ad47bbf} + + + {74e1c3d1-48e0-4f6e-98c7-5775be6ff115} + {31670797-833f-490c-a1a7-96027da776ae} + {26ba5615-d61d-4d53-bc8a-a23fb5d92543} + + + + + + + + + + + + + {12376e90-4be9-4a93-befe-fb2c7523e6c8} + + + {c0b38869-5ee2-4ceb-a90c-f1f0e8958253} + {31670797-833f-490c-a1a7-96027da776ae} + {f68aba0c-bb1c-45e9-9f3e-ec530e272d7d} + + + + + + + + + + + + + {92a27c93-ee2c-45d9-acd5-e64b320e5c02} + + + {80706f71-fbfb-4a87-b090-6384b2226b55} + {26ba5615-d61d-4d53-bc8a-a23fb5d92543} + {4d899821-3971-40fd-ac87-fb15d951bd03} + + + + + + + + + + + + + {d177f4d0-a1af-48ac-96af-1ca71308d9f1} + + + {e736c99c-a627-4731-a8dc-0a14f8b48354} + {f68aba0c-bb1c-45e9-9f3e-ec530e272d7d} + {4d899821-3971-40fd-ac87-fb15d951bd03} + + + + + + + + 1464094346159 + Components + + + + + + + + + + {19c62089-bf53-411a-b533-1418ec5c160d} + + + + + + + + {19c62089-bf53-411a-b533-1418ec5c160d} + + + New Package + + + + + + + + + + {37e5fedf-65dc-4f96-ad9e-294c5abc5aa0} + + + + + + + + {37e5fedf-65dc-4f96-ad9e-294c5abc5aa0} + + + ew Package + + + + + + + + + + {35301846-40c1-4814-8279-27e504981b6d} + + + + + + + + {35301846-40c1-4814-8279-27e504981b6d} + + + Qt WebBrowser + + + + + + + {a2469a49-9150-43c6-95f9-46a9df37d5a2} + + + + + + + + {a2469a49-9150-43c6-95f9-46a9df37d5a2} + + + {35301846-40c1-4814-8279-27e504981b6d} + {0b5ebe96-6859-435b-a13a-e1520b3feeb5} + + + + + + + + + + {74e1c3d1-48e0-4f6e-98c7-5775be6ff115} + + + + + + + + {74e1c3d1-48e0-4f6e-98c7-5775be6ff115} + + + {35301846-40c1-4814-8279-27e504981b6d} + {152e2926-742b-4266-a67d-0badd705cd90} + + + + + + + + + + {c0b38869-5ee2-4ceb-a90c-f1f0e8958253} + + + + + + + + {c0b38869-5ee2-4ceb-a90c-f1f0e8958253} + + + {35301846-40c1-4814-8279-27e504981b6d} + {a6df659c-bbb2-4109-b0e6-60918263837d} + + + + + + + + + + + + + + + + + + + + + {0b5ebe96-6859-435b-a13a-e1520b3feeb5} + + + + + + + + {0b5ebe96-6859-435b-a13a-e1520b3feeb5} + + + Qt Quick + + + + + + + + + + {152e2926-742b-4266-a67d-0badd705cd90} + + + + + + + + {152e2926-742b-4266-a67d-0badd705cd90} + + + Qt WebEngine + + + + + + + {80706f71-fbfb-4a87-b090-6384b2226b55} + + + + + + + + {80706f71-fbfb-4a87-b090-6384b2226b55} + + + {152e2926-742b-4266-a67d-0badd705cd90} + {0b5ebe96-6859-435b-a13a-e1520b3feeb5} + + + + + + + + + + + + + + + + + + + + + {a6df659c-bbb2-4109-b0e6-60918263837d} + + + + + + + + {a6df659c-bbb2-4109-b0e6-60918263837d} + + + Qt VirtualKeyboard + + + + + + + {e736c99c-a627-4731-a8dc-0a14f8b48354} + + + + + + + + {e736c99c-a627-4731-a8dc-0a14f8b48354} + + + {a6df659c-bbb2-4109-b0e6-60918263837d} + {0b5ebe96-6859-435b-a13a-e1520b3feeb5} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/images/virtualkeyboard.png b/doc/images/virtualkeyboard.png new file mode 100644 index 0000000..ad40d3f Binary files /dev/null and b/doc/images/virtualkeyboard.png differ diff --git a/doc/images/webbrowser.png b/doc/images/webbrowser.png new file mode 100644 index 0000000..b111dcd Binary files /dev/null and b/doc/images/webbrowser.png differ diff --git a/doc/qtwebbrowser-online.qdocconf b/doc/qtwebbrowser-online.qdocconf new file mode 100644 index 0000000..673d0f0 --- /dev/null +++ b/doc/qtwebbrowser-online.qdocconf @@ -0,0 +1,16 @@ +include(config/qtwebbrowser-project.qdocconf) + +HTML.footer = \ + " \n" \ + "

\n" \ + " © 2016 The Qt Company Ltd.\n" \ + " Documentation contributions included herein are the copyrights of\n" \ + " their respective owners. " \ + " The documentation provided herein is licensed under the terms of the" \ + " GNU Free Documentation" \ + " License version 1.3 as published by the Free Software Foundation. " \ + " Qt and respective logos are trademarks of The Qt Company Ltd " \ + " in Finland and/or other countries worldwide. All other trademarks are property\n" \ + " of their respective owners.

\n" + +include($QT_INSTALL_DOCS/global/qt-html-templates-online.qdocconf) diff --git a/doc/qtwebbrowser.qdocconf b/doc/qtwebbrowser.qdocconf new file mode 100644 index 0000000..2379b46 --- /dev/null +++ b/doc/qtwebbrowser.qdocconf @@ -0,0 +1,2 @@ +include(config/qtwebbrowser-project.qdocconf) +include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf) diff --git a/doc/src/external-resources.qdoc b/doc/src/external-resources.qdoc new file mode 100644 index 0000000..8a5cc00 --- /dev/null +++ b/doc/src/external-resources.qdoc @@ -0,0 +1,53 @@ +/**************************************************************************** +** +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt WebBrowser application. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \externalpage https://www.chromium.org/ + \title Chromium Project +*/ + +/*! + \externalpage https://www.google.com/ + \title Google +*/ + +/*! + \externalpage https://doc.qt.io/qt-5/qtwebengine-debugging.html + \title Qt WebEngine Debugging and Profiling +*/ + +/* + This prevents autolinking of each occurrence of 'WebEngine' + To link to the WebEngine QML type, use explicit linking: + \l [QML] WebEngine + \sa {QtWebEngine::}{WebEngine} +*/ +/*! +\externalpage nolink +\title WebEngine +\internal +*/ diff --git a/doc/src/qtwebbrowser.qdoc b/doc/src/qtwebbrowser.qdoc new file mode 100644 index 0000000..08496a0 --- /dev/null +++ b/doc/src/qtwebbrowser.qdoc @@ -0,0 +1,185 @@ +/**************************************************************************** +** +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt WebBrowser application. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! +\page qtwebbrowser-index.html + +\title Qt WebBrowser + +The Qt WebBrowser (codename \c{Roadtrip}) is a browser for embedded +devices developed using the capabilities of Qt and \l{Qt WebEngine}. +Using recent \l{Chromium Project}{Chromium}, it features up-to-date +HTML technologies behind a minimal but slick touch-friendly +user interface written in \l{Qt Quick}. + +\image webbrowser.png + +\section1 User Interface + +The user interface of the browser is designed for embedded devices +using a touch screen. It uses flat icons and minimalistic transitions to +provide a contemporary look and feel. + +All central actions are conveniently accessible in the menu bar at the +top. When the user scrolls down a page, the menu bar disappears to +leave more screen space for content. It appears again if +the user scrolls upwards. + +\image menubar.png + +The \uicontrol Back button (1) and \uicontrol Forward button (2) navigate +through the history of pages already visited. +The input bar (3) allows the user to type and edit URL's, +or search for text. It also allows to reload a page, or stop a page currently +loading. +Pages can be bookmarked with the \uicontrol Bookmark button (6), +the bookmarked pages are accessible through the \uicontrol Home button (4). +The \uicontrol Pages button (5) allows the user to manage the pages +currently opened. The \uicontrol Settings button (7) brings up a view of +the current settings. + +\section2 Opening Pages + +The input bar supports typing in either a full URL or a query +that is automatically passed to \l{Google}. Url suggestions of visited pages +matching the text are suggested during typing. The current text can be +cleared by pressing the \uicontrol Cancel button on the right. + +\image inputhelp.png + +When the user finishes editing, a blue line serves as a progress indicator +for the page currently loading. The loading can be stopped by pressing +the \uicontrol Cancel button. After the page finished loading +this button is replaced by a \uicontrol Reload button, that forces a reload +of the page when pressed. + +\section2 Page Scrolling + +The view of the page can be moved around by pressing and moving a finger. + +\section2 Page Zooming + +Zoom in or out a particular section of the page by pinching fingers. + +\section2 Bookmark Management + +Individual pages can be bookmarked by pressing the \uicontrol Bookmark +button. By pressing the same button again the page is removed from the +bookmarks. + +The \uicontrol Home button lets the user browse the bookmarked pages +in a multi-page grid. Each page is represented by its name and icon, +if available. + +\image bookmarks.png + +\section2 Page Management + +The \uicontrol Pages button enables the user to open new pages and to +switch between them using the Carousel UI pattern: + +\image pageselection.png + +The number of pages that can be opened simultaneously is intentionally +limited to 10. + +\section2 User Settings + +A settings page is available by pressing the \uicontrol Settings button. +The page contains options for enabling a \e {private browsing} mode +that does not leave traces in the history and cookies. + +\image settings.png + +\section2 Virtual Keyboard + +The integrated \l{Qt Virtual Keyboard} +slides in whenever text input is required. It enables typing text in a +great variety of different languages. + +\image virtualkeyboard.png + +\section1 Features + +Qt WebEngine leverages \l{Chromium Project}{Chromium} to provide +a state-of-the art, high performance HTML5 web engine. + +\image html5test.png + +\section2 Video and Audio + +Chromium and therefore Qt WebEngine directly +integrate with OS services to access video and audio devices. +After the user acknowledges access to them, solutions using WebRTC, such as +video and audio conferencing, work out-of-the-box, provided that the +required codecs are available. + +\section2 Location Information + +Qt WebEngine uses \l {Qt Location} to provide pages with location +information. Again, the users have to explicitly give their consent to each +page attempting to access this information. + +\section2 Fullscreen Mode + +Videos can be played in fullscreen mode. + +\section1 Developer Features + +\section2 Developer Tools + +Qt WebEngine supports remotely accessing the built-in Chromium Developer +Tools. This allows debugging and optimizing individual pages on the device. + +For more information, see the \l{Qt WebEngine} documentation on +\l{Qt WebEngine Debugging and Profiling}{Debugging and Profiling}. + +\section2 Simulation of Touch Input + +While the Qt WebBrowser is optimized for touch devices, +it can also be tested on all the desktop operating systems. +Keyboard and mouse input works out of the box. Touch input +can be simulated by using several mouse buttons +while pressing the \c Ctrl key. + +\section1 Platform Requirements + +Qt WebBrowser requires the \l{Qt WebEngine}, +\l{Qt Quick} and +\l{Qt Virtual Keyboard} modules in version 5.7 or +newer. + +\image block-diagram.png + +At minimum 1 GB of RAM is advised to provide a seamless experience +for different pages. Depending on the exact configuration and the +pages visited this can be further optimized. + +Qt Quick and Qt WebEngine use OpenGL for rendering. Best performance +therefore requires dedicated graphics hardware with drivers supporting +OpenGL. +*/ diff --git a/qtwebbrowser.pro b/qtwebbrowser.pro index 65d9262..61ab909 100644 --- a/qtwebbrowser.pro +++ b/qtwebbrowser.pro @@ -1,2 +1,7 @@ TEMPLATE = subdirs SUBDIRS = src + +QTWEBBROWSER_VERSION = 1.0.0 +QTWEBBROWSER_VERSION_TAG = 100 + +include(doc/doc.pri) -- cgit v1.2.3