Commit Graph

40 Commits

Author SHA1 Message Date
Eskil Abrahamsen Blomfeldt 9438576ce4 Graphics 2D docs
This adds an overview of 2D graphics in Qt and how they compare
to each other. There are many tools for this in Qt and they all
have their place. This will hopefully help users navigate the
forest.

Pick-to: 6.10
Fixes: QTBUG-137101
Change-Id: I855c5db8f6f1efe34cfbeecd0d2e05703bc124da
Reviewed-by: Eirik Aavitsland <eirik.aavitsland@qt.io>
2025-08-07 10:08:33 +02:00
Alexei Cazacov 0357422e5b Doc: Remove the "Building UIs with Qt Quick" tree section from qtdoc
This commit removes the "Building UIs with Qt Quick" tree section from
the qtdoc module. This section is moved to the Qt Quick module as a
getting started subtree.

Task-number: QTBUG-134130
Pick-to: 6.10 6.9
Change-Id: I818548673460eb940a1ffc898876e986642130f8
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2025-08-04 13:42:12 +03:00
Alexei Cazacov c0f9e536ea Docs: Move the Qt Quick for Android section to Qt Quick
This commit removes the Qt Quick for Android section from the qtdoc
module.

Task-number: QTBUG-134251
Pick-to: 6.9 6.9.0 6.8
Change-Id: I80f99fbaf2736fe3ddfdba2333a4385aa0cdb4e6
Reviewed-by: Rami Potinkara <rami.potinkara@qt.io>
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
2025-03-17 12:45:56 +00:00
Alexei Cazacov 13658d532e Docs: Remove unused images
Pick-to: 6.9
Change-Id: I062e54f3777fd222e5e3d99b11b1558b1d800ce9
Reviewed-by: Matthias Rauter <matthias.rauter@qt.io>
2025-02-27 15:46:46 +02:00
Matthias Rauter 80b6f2e63d Introduce string class overview
The current page for "group string-processing" is pretty empty and
mostly autogenerated. This patch adds some context and explanations.

Pick-to: 6.8 6.9
Task-number: QTBUG-77020
Change-Id: Ic13defcee574af7725a8eb7a33ae5f8467694dbc
Reviewed-by: Marc Mutz <marc.mutz@qt.io>
2025-02-14 08:28:16 +01:00
Nicholas Bennett c5c77dcec5 Docs: Long live Qt Quick for Android
The final decision has been made and what was known as QML for Android
shall hence forth be known as Qt Quick for Android.

Pick-to: 6.8 6.8.0
Change-Id: Ia36023d5e8e662ec0467176790c8134d9bc49819
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
2024-09-26 15:23:54 +00:00
Assam Boudjelthia 5051e82814 Android: fix background color for qml for image
Some of the boxes had black background while others
had white, they don't look nice. Now, all backgrounds
are suitable for a white background.

Pick-to: 6.8
Change-Id: Iedf3905e837c62f8f3a13ed9a647d5e160dbd15f
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
2024-09-04 20:47:06 +03:00
Nicholas Bennett 7c412c5303 Docs: Add a top-level page of the "QML for Android" feature
This covers the feature, how it works, and how to use it.

Task-number: QTBUG-127739
Pick-to: 6.8
Change-Id: I8d02dc642957b8230ffeb9307a436174d4639d12
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2024-08-29 10:01:06 +00:00
Leena Miettinen ae0f981945 Doc: Add new number images for screenshots
Change-Id: Id207620964d0dee08c8cf4f355a1a284d90feb97
Reviewed-by: Esa Törmänen <esa.tormanen@qt.io>
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
Reviewed-by: Inkamari Harjula <inkamari.harjula@qt.io>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io>
2024-06-11 08:40:16 +02:00
Nicholas Bennett d52ebf9350 Docs: Move Qt Tools for Android Studio docs to tool's source repo
Documentation moved here: qt-labs/android-studio-tools

Task-number: QTTA-72
Pick-to: 6.7 6.8
Change-Id: I6429dbebfc3a41989162cb0cc9985260b7f4a06f
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2024-06-10 15:48:12 +03:00
Nicholas Bennett 7dab842a4e Add video to Android Studio plugin docs
Added the getting started Youtube in the plugin docs

Task-number: QTBUG-123140
Pick-to: 6.7 6.7.0
Change-Id: I4807d3eecde65b1dcda50070f4c2ee8705d4088b
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2024-04-02 07:48:32 +00:00
Nicholas Bennett 60d268cd20 Add Qt Android Studio Plugin Documentation
Add the page with all the info for the plugin. Add a link in on the
Qt for Android home page. The plugin UI help menu and IntelliJ market
website should link to this as the master.

Task-number: QTBUG-121447
Pick-to: 6.7 6.7.0
Change-Id: Icb27903c2c64f0b68e1479a394cd2f150c920a0b
Reviewed-by: Tinja Paavoseppä <tinja.paavoseppa@qt.io>
2024-03-28 09:10:02 +00:00
Assam Boudjelthia f40a3c641f Android: update how it works page
Update the documentation of how Qt for Android works
page in more detail, taking into account the recent
refactoring done to the Java implementation. Also,
update the architecture diagram.

Fixes: QTBUG-115020
Pick-to: 6.7
Change-Id: I9cfc29539a7a8d4965fc6d37c7242234df65b85f
Reviewed-by: Rami Potinkara <rami.potinkara@qt.io>
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
Reviewed-by: Tinja Paavoseppä <tinja.paavoseppa@qt.io>
2024-01-10 13:09:04 +02:00
Nicholas Bennett 23d41aaf79 Docs: Add Android platform documentation
How it works page, host environment variables page,
and relevant CMake information page added.

Fixes: QTBUG-107704
Pick-to: 6.4 6.2
Change-Id: I823d3f9d97f49e79da867660bd4cd41a8378266a
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2022-11-29 13:50:52 +02:00
Topi Reinio 4ed4407167 Fix path for YouTube video thumbnail
A relative path was used to refer to a thumbnail image for a video link
on Qt for Android overview page. While QDoc was able to locate and copy
the image to the output directory, the relative path appears as-is in
the generated .qhp file and is no longer correct, causing qhelpgenerator
to ignore it.

Consolidate all 'extra images' into the same source directory and handle
them in one location in the .qdocconf file.

Pick-to: 6.4
Change-Id: I66531da883bac57fcf32e75c11eb087a648d9798
Reviewed-by: Luca Di Sera <luca.disera@qt.io>
2022-10-13 12:38:14 +02:00
Nicholas Bennett 0fbb595b7f Docs: Fix getting started with android YouTube video ID
The YouTube ID copied from the browser was incorrect.

This patch fixes this.
Will build locally and check embedded YouTube videos work in future
before pushing.

Pick-to: 6.4
Change-Id: Ib48500a2b49abb17177353bc544dcb05d10c219b
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2022-10-07 21:19:25 +03:00
Nicholas Bennett 1908dac337 Docs: Embed getting started with android video in relevant docs page
Embedded the YouTube video in the getting started with android docs.

Fixes: QTBUG-107151
Pick-to: 6.4
Change-Id: I9b4e77de6f6be19eb29efd7241a9e7ee1ddefa02
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2022-10-04 10:41:04 +00:00
Leena Miettinen 132c77d7e0 Doc: Update Getting Started and Development Tools topics
To reflect the changes in Qt Creator, Qt Installer, and the
solutions offering.

Fixes: QTBUG-100158
Pick-to: 5.15 6.2 6.3
Change-Id: Idbf2c8b40cf741e6819ee6b538cbd26398b77413
Reviewed-by: Tino Pyssysalo <tino.pyssysalo@qt.io>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
2022-01-26 15:27:45 +01:00
Leena Miettinen d581b487b0 Doc: Improve Getting Started with Qt
- Describe designer and developer options
- Describe embedded and MCU use cases

Fixes: QTBUG-89417
Fixes: QDS-4280
Change-Id: Ifa713f65df8a1479c38ba116f95374e089d2d8e3
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2021-05-20 10:57:47 +02:00
Andreas Buhr 72b5a14c90 Correct file path to YouTube video preview
Pick-to: 6.0
Change-Id: If5649cffb3cda16611702159acd3a83e26a804b7
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-12-09 18:09:34 +01:00
Tor Arne Vestbø 12e591e672 Update high-DPI documentation
The various QT_SCALING_X environment variables are not documented,
as these are for internal testing.

Fixes: QTBUG-84250
Pick-to: 6.0
Pick-to: 6.0.0
Change-Id: I4bd40f915bb874523996c76eac69b61a3a938a38
Reviewed-by: Morten Johan Sørvig <morten.sorvig@qt.io>
2020-11-27 12:02:44 +01:00
Jerome Pasion 907225afda Add image of Qt Creator in Development Tools overview
-image shows more of Qt Creator's capabilities

Task-number: QTBUG-87158
Change-Id: I87830a094737484dab74445183b26eccbf586391
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-11-18 17:28:22 +01:00
Jerome Pasion 99f4670df0 Remove "Qt Quick Text Editor Guide" for Qt 6.0
-originally written for Qt Creator 3.3 and Qt 5.4
-unmaintained and doesn't have example files
-there is a new Text Editor example in Qt Quick Controls 2

Task-number: QTBUG-86102
Change-Id: I5395643efc926f873f341db227166fe8067e80e2
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
2020-11-17 20:16:26 +01:00
Jerome Pasion ccfa91ba25 Add images to Graphics overview
-from "What is new in Qt Quick 3D 6.0" (November 3, 2020)

Task-number: QTBUG-87158
Change-Id: I21cc4bb4b4fa34aa612c6587e969681a01c921e2
Reviewed-by: Andy Nichols <andy.nichols@qt.io>
Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
2020-11-17 20:15:59 +01:00
Jerome Pasion d157bb34b6 Update Graphics overview for Qt 6.0
-add Qt Rendering Hardware Interface and Qt Quick 3D
-update content regarding Qt Quick graphics
-add Qt OpenGL content

Task-number: QTBUG-83651
Task-number: QTBUG-87158
Change-Id: Ia8c64286874c2238303775d9bbb599acfcb4cae4
Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
2020-11-11 17:34:01 +01:00
Leena Miettinen 3825a45d5c Update Qt and Qt Creator icons on the landing page
Fixes: QTBUG-78686
Change-Id: I885420d2b184588d7f27b546e51c327fcfebc376
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-09-23 14:56:01 +02:00
Kavindra Palaraja 2d021dd91a [docs] Add documentation about Wayland architecture
* Created a new topic to provide some conceptual content on Wayland
* Added some diagrams to support the story

Task-number: AUTOSUITE-679
Change-Id: Iac4fb425f1bdce8fba79e06994f933ac86d55056
Reviewed-by: Johan Helsing <johan.helsing@qt.io>
2019-04-01 14:54:05 +00:00
Venugopal Shivashankar a38799f6e1 Doc: Add the missing animated gif
The example that demonstrated custom QML type creation
was replaced in 9d88932795, but the corresponding
animated gif was not updated/added.

Change-Id: I81e85e2d1c815405164ec047d9adda4e31958429
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
2019-02-13 15:29:17 +00:00
Venugopal Shivashankar 9d88932795 Doc: Replace Controls 1 and MouseArea references
Also, updated the snippet that demonstrates creating
custom QML types.

Change-Id: I5a385b4d2eb7d96a50f314e5c6d1304665600bb8
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
2018-12-07 12:55:55 +00:00
Venugopal Shivashankar d9e2f412cc Doc: Add link to the YouTube video about installing Qt
Change-Id: Ifb3920d5af764fd77644c32628223f5b5deb214f
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2018-09-03 08:27:09 +00:00
Leena Miettinen 76c602dec5 Use the check mark image, ok.png, in tables
Change-Id: I1869285e53751a3a9ff2bf78219774f6ed4e9ef1
Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
2016-10-17 14:05:38 +00:00
Leena Miettinen 72fbe19645 Doc: Add number images for use in screenshots
The numbers can be copy-pasted on screenshots to
highlight parts of the screenshots. Use the numbers
instead of red boxes or arrows, for example.

Change-Id: Ia6876ba854718d8d322400efa03e67dac5151316
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2016-05-26 10:49:56 +00:00
Topi Reinio c9b78b2b80 Doc: Update landing page icons
.. with new Qt and Qt Creator logos. Adjust the green on the 'Tools'
icon to be the new Qt green.

Task-number: QTBUG-53343
Change-Id: I7af7838487258f85854698fe122b6896cd9e0e50
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2016-05-18 11:52:44 +00:00
Edward Welbourne 0d69406c73 Purge sRGB chunks from PNGs in documentation.
Subjects each *.png file that matched grep -law "sRGB" to:
pngcrush -ow -brute -rem allb -reduce -force

Change-Id: I9aec2466a86ebf090bd99e368cd4a5a71b956aff
Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
2016-03-22 12:09:38 +00:00
Venugopal Shivashankar eeba1cb12d Doc: Added a few lines about Qt location in the Qt 5 intro.
Change-Id: I4770b151af374b0c11db52315e30a38715b95d71
Reviewed-by: Laszlo Agocs <laszlo.agocs@theqtcompany.com>
Reviewed-by: Alex Blasche <alexander.blasche@theqtcompany.com>
2015-10-15 08:13:50 +00:00
Jerome Pasion 5cd576ea73 Doc: Adding Qt Quick Controls "Getting Started".
-A new Getting Started guide that uses the Qt Designer and Qt Creator
workflow.
-Uses Controls, Layouts, and Window QML types.
-Written with Qt Creator 3.3 and Qt 5.4.

Task-number: QTBUG-33595
Change-Id: I75fe5d6b439255d867de75b6b5c7c26bc82491e0
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
2015-03-05 15:54:35 +00:00
Jerome Pasion 60dad7d411 Doc: Updated styling QML use case page.
-focused on styling the controls
-removed section about customizing properties (already covered)
-revised the section about SystemPalette

Task-number: QTBUG-33595
Change-Id: I065971fa9ab57e5eacf83077925ccb52c9f9717d
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
2014-10-28 19:32:29 +01:00
Topi Reinio 46c6fa7642 Doc: Updated logos on the landing page
Updated Qt and Qt Creator logos on the landing page, and removed
some obsolete information.

Task-number: QTBUG-41856
Change-Id: I6e4ff988c1611dd75ec8b040b506271821e0266f
Reviewed-by: Diana de Sousa <diana.desousa@digia.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2014-10-16 13:58:54 +02:00
Jerome Pasion 15c0c98d44 Doc: Updated main landing page with a new layout and images.
-added image thumbnails
-updated CSS file with recent changes.

Task-number: QTBUG-36411
Change-Id: I4af92292d9b1c139eb8e6f7f03d4fea0ac00a9b0
Reviewed-by: Martin Smith <martin.smith@digia.com>
2014-02-20 13:41:10 +01:00
Jerome Pasion 8c8b826d62 Doc: Adding "QML Application Developer Resources" guide.
-ported from qtdeclarative.git
-fixed snippet and image paths to doc/snippets and doc/images

Because this guide will need to cover more than Qt QML and Qt Quick,
this guide does not need to be in qtdeclarative.

Change-Id: Id6a47420a1e73b5c55b7233571557e3558e82043
Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com>
Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
2013-04-29 14:32:59 +02:00