summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSafiyyah Moosa <[email protected]>2025-04-01 16:23:24 +0200
committerSafiyyah Moosa <[email protected]>2025-04-09 07:15:08 +0200
commit7b66c906bf7a8c32650157fdd13221822ec1558e (patch)
tree8d6164daa8e6b4b3298591ac2fa61377313df1e5
parent80d01c4ccb697b9d390cc0da49c2f111b19b4c5b (diff)
Doc: Add Alt-text to the Qt SQL examples
QDoc generates warnings for images that do not have alt-text associated with them. Alt-text is used to add context to images for users who use screen-readers. This patch applies alt-text to images in the Qt SQL module that do not have any alt-text associated with them. Fixes: QTBUG-135114 Pick-to: 6.9 6.8 Change-Id: Iead375852d30219db7dfed12bb1f383eb55713e6 Reviewed-by: Topi Reiniƶ <[email protected]>
-rw-r--r--examples/sql/doc/src/books.qdoc2
-rw-r--r--examples/sql/doc/src/cachedtable.qdoc2
-rw-r--r--examples/sql/doc/src/drilldown.qdoc2
-rw-r--r--examples/sql/doc/src/masterdetail.qdoc4
-rw-r--r--examples/sql/doc/src/querymodel.qdoc2
-rw-r--r--examples/sql/doc/src/relationaltablemodel.qdoc2
-rw-r--r--examples/sql/doc/src/sqlbrowser.qdoc2
-rw-r--r--examples/sql/doc/src/sqlwidgetmapper.qdoc6
-rw-r--r--examples/sql/doc/src/tablemodel.qdoc2
-rw-r--r--src/sql/doc/src/sql-programming.qdoc2
-rw-r--r--src/sql/models/qsqlrelationaldelegate.cpp2
-rw-r--r--src/sql/models/qsqlrelationaltablemodel.cpp2
12 files changed, 15 insertions, 15 deletions
diff --git a/examples/sql/doc/src/books.qdoc b/examples/sql/doc/src/books.qdoc
index b4ca8bdd2ee..9ad479ce63d 100644
--- a/examples/sql/doc/src/books.qdoc
+++ b/examples/sql/doc/src/books.qdoc
@@ -11,7 +11,7 @@
The Books example shows how Qt's SQL classes can be used with the model/view
framework to create rich user interfaces for information stored in a database.
- \borderedimage books-demo.png
+ \image books-demo.png {The main window displays information related to the books stored in the database}
Information about a collection of books is held in a database. The books are
catalogued by author, title, genre, and year of publication. Although each of
diff --git a/examples/sql/doc/src/cachedtable.qdoc b/examples/sql/doc/src/cachedtable.qdoc
index ff60f7b1b77..d186346d633 100644
--- a/examples/sql/doc/src/cachedtable.qdoc
+++ b/examples/sql/doc/src/cachedtable.qdoc
@@ -11,7 +11,7 @@
caching any changes to the data until the user explicitly submits them using a
push button.
- \borderedimage cachedtable-example.png
+ \image cachedtable-example.png {The user updates a cell in the table, and selects the submit button to apply the change in the database}
The example consists of a single class, \c TableEditor, which is a
custom dialog widget that allows the user to modify data stored in
diff --git a/examples/sql/doc/src/drilldown.qdoc b/examples/sql/doc/src/drilldown.qdoc
index d334018b4a2..2a7ece5d904 100644
--- a/examples/sql/doc/src/drilldown.qdoc
+++ b/examples/sql/doc/src/drilldown.qdoc
@@ -11,7 +11,7 @@
well as submit changes, using the QSqlRelationalTableModel and
QDataWidgetMapper classes.
- \borderedimage drilldown-example.png Screenshot of the Drill Down Example
+ \image drilldown-example.png {The main window displays user-selectable images of the Qt, Qt Quick, Qt Creator and Qt Project products}
When running the example application, a user can retrieve
information about each item by clicking the corresponding image.
diff --git a/examples/sql/doc/src/masterdetail.qdoc b/examples/sql/doc/src/masterdetail.qdoc
index fec579a6a0c..b8bae20e5bb 100644
--- a/examples/sql/doc/src/masterdetail.qdoc
+++ b/examples/sql/doc/src/masterdetail.qdoc
@@ -13,9 +13,9 @@
database, while each album's tracks are stored in an XML
file.
- The example also shows how to add as well as remove data from both
+ The example also shows how to add, as well as remove data from both
the database and the associated XML file using the API provided by
the Qt SQL and Qt XML modules, respectively.
- \borderedimage masterdetail-example.png
+ \image masterdetail-example.png {The main window displays artist and album information from the database, together with the album tracks stored in an XML file}
*/
diff --git a/examples/sql/doc/src/querymodel.qdoc b/examples/sql/doc/src/querymodel.qdoc
index c9fa4cec96f..c9068214c7e 100644
--- a/examples/sql/doc/src/querymodel.qdoc
+++ b/examples/sql/doc/src/querymodel.qdoc
@@ -11,5 +11,5 @@
data obtained from a SQL query, using a model that encapsulates
the query and table views to display the results.
- \borderedimage querymodel-example.png
+ \image querymodel-example.png {The user can create different query models, from a Plain Query Model, to models that can be edited and customized further}
*/
diff --git a/examples/sql/doc/src/relationaltablemodel.qdoc b/examples/sql/doc/src/relationaltablemodel.qdoc
index 371fef8133f..e3f7ab2c8d2 100644
--- a/examples/sql/doc/src/relationaltablemodel.qdoc
+++ b/examples/sql/doc/src/relationaltablemodel.qdoc
@@ -10,5 +10,5 @@
\brief The Relational Table Model example shows how to use table views with a relational
model to visualize the relations between items in a database.
- \borderedimage relationaltablemodel-example.png
+ \image relationaltablemodel-example.png {The main window displays the relationship between a user's name, the city that that they are from, as well as the corresponding country}
*/
diff --git a/examples/sql/doc/src/sqlbrowser.qdoc b/examples/sql/doc/src/sqlbrowser.qdoc
index ad783f57605..db8fccfba3c 100644
--- a/examples/sql/doc/src/sqlbrowser.qdoc
+++ b/examples/sql/doc/src/sqlbrowser.qdoc
@@ -10,5 +10,5 @@
\brief The SQL Browser example shows how a data browser can be used to visualize
the results of SQL statements on a live database.
- \borderedimage sqlbrowser-demo.png
+ \image sqlbrowser-demo.png {The main window depicts the connected database together with the items in the database. The user is able to generate an SQL query and submit it.}
*/
diff --git a/examples/sql/doc/src/sqlwidgetmapper.qdoc b/examples/sql/doc/src/sqlwidgetmapper.qdoc
index 0764e601c3a..ea66ad48207 100644
--- a/examples/sql/doc/src/sqlwidgetmapper.qdoc
+++ b/examples/sql/doc/src/sqlwidgetmapper.qdoc
@@ -10,7 +10,7 @@
\brief The SQL Widget Mapper example shows how to use a map information from a
database to widgets on a form.
- \borderedimage sql-widget-mapper.png
+ \image sql-widget-mapper.png {The main window displays the user name, the user address, and it classifies the address type.}
In the \l{Combo Widget Mapper Example}, we showed how to use a named
mapping between a widget mapper and a QComboBox widget with a special
@@ -51,7 +51,7 @@
including values for the address types that correspond to the address
types are stored in a separate table.
- \borderedimage widgetmapper-sql-mapping-table.png
+ \image widgetmapper-sql-mapping-table.png {The main window displays a table that consists of the information stored in the database.}
We create an "addresstype" table containing the identifiers used in the
"person" table and the corresponding strings:
@@ -70,7 +70,7 @@
used wherever the "typeid" is presented to the user. (See the
QSqlRelationalTableModel::setRelation() documentation for details.)
- \borderedimage widgetmapper-sql-mapping.png
+ \image widgetmapper-sql-mapping.png {The table depicts the relationship between the "typeid" field and the "addresstype".}
The constructor of the \c Window class can be explained in three parts.
In the first part, we set up the model used to hold the data, then we set
diff --git a/examples/sql/doc/src/tablemodel.qdoc b/examples/sql/doc/src/tablemodel.qdoc
index 1542d121aab..5bd29ce6531 100644
--- a/examples/sql/doc/src/tablemodel.qdoc
+++ b/examples/sql/doc/src/tablemodel.qdoc
@@ -10,5 +10,5 @@
\brief The Table Model example shows how to use a specialized SQL table model with table
views to edit information in a database.
- \borderedimage tablemodel-example.png
+ \image tablemodel-example.png {The user is able to edit fields in Table Model View 1, and these changes are propagated to Table Model View 2}
*/
diff --git a/src/sql/doc/src/sql-programming.qdoc b/src/sql/doc/src/sql-programming.qdoc
index a7f87fe73fa..07daf942ac4 100644
--- a/src/sql/doc/src/sql-programming.qdoc
+++ b/src/sql/doc/src/sql-programming.qdoc
@@ -565,7 +565,7 @@
using QDataWidgetMapper with an SQL model is as simple as using it with
any other table model.
- \image qdatawidgetmapper-simple.png
+ \image qdatawidgetmapper-simple.png {The table depicts the relationship between the different fields}
The \l{books}{Books} example shows how information can
be presented for easy access by using QDataWidgetMapper and a set of
diff --git a/src/sql/models/qsqlrelationaldelegate.cpp b/src/sql/models/qsqlrelationaldelegate.cpp
index ee9bc668b6c..73a6fbe5016 100644
--- a/src/sql/models/qsqlrelationaldelegate.cpp
+++ b/src/sql/models/qsqlrelationaldelegate.cpp
@@ -23,7 +23,7 @@ QT_BEGIN_NAMESPACE
conjunction with QSqlRelationalTableModel to provide tables with
foreign key support.
- \image relationaltable.png
+ \image relationaltable.png {The user is able to edit a foreign key in a relational table}
\sa QSqlRelationalTableModel, {Model/View Programming}
*/
diff --git a/src/sql/models/qsqlrelationaltablemodel.cpp b/src/sql/models/qsqlrelationaltablemodel.cpp
index 8f9015630a1..c359adac44c 100644
--- a/src/sql/models/qsqlrelationaltablemodel.cpp
+++ b/src/sql/models/qsqlrelationaltablemodel.cpp
@@ -347,7 +347,7 @@ void QSqlRelationalTableModelPrivate::clearCache()
QSqlRelationalDelegate to provide tables with foreign key
support.
- \image relationaltable.png
+ \image relationaltable.png {The user is able to edit a foreign key in a relational table}
Notes: