whytofly
/
qt6-bb10
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document how to use CMake for Qt SQL 

Task-number: QTBUG-73058
Change-Id: I07fa128853531ec09852647436d9302abac1c12c
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
bb10
Kai Koehne 2020-05-22 15:04:28 +02:00
parent 1c0ca1f3d8
commit 292d49c5e9
6 changed files with 21 additions and 83 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/sql/doc/qtsql.qdocconf
View File

@ -26,7 +26,7 @@ qhp.QtSql.subprojects.classes.selectors = class fake:headerfile
qhp.QtSql.subprojects.classes.sortPages = true
tagfile = ../../../doc/qtsql/qtsql.tags
depends += qtcore qtwidgets qtdoc qmake
depends += qtcore qtwidgets qtdoc qmake qtcmake
headerdirs += ..
@ -35,6 +35,7 @@ sourcedirs += .. \
exampledirs += ../../../examples/sql \
../ \
. \ \
snippets
imagedirs += images \

4
src/sql/doc/snippets/CMakeLists.txt Normal file
View File

@ -0,0 +1,4 @@
#! [cmake_use]
find_package(Qt6 COMPONENTS Sql REQUIRED)
target_link_libraries(mytarget Qt::Sql)
#! [cmake_use]

53
src/sql/doc/snippets/code/doc_src_qtsql.cpp
View File

@ -1,53 +0,0 @@
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:BSD$
** 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.
**
** BSD License Usage
** Alternatively, you may use this file under the terms of the BSD license
** as follows:
**
** "Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
** * Redistributions of source code must retain the above copyright
** notice, this list of conditions and the following disclaimer.
** * Redistributions in binary form must reproduce the above copyright
** notice, this list of conditions and the following disclaimer in
** the documentation and/or other materials provided with the
** distribution.
** * Neither the name of The Qt Company Ltd nor the names of its
** contributors may be used to endorse or promote products derived
** from this software without specific prior written permission.
**
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
**
** $QT_END_LICENSE$
**
****************************************************************************/
//! [0]
#include <QtSql>
//! [0]

3
src/sql/doc/snippets/code/doc_src_qtsql.pro
View File

@ -1,3 +0,0 @@
#! [1]
QT += sql
#! [1]

7
src/sql/doc/snippets/snippets.pro
View File

@ -1,9 +1,12 @@
TEMPLATE = app
TARGET = sqldatabase_cppsnippet
QT = core sql sql-private
QT = core sql-private
#! [qmake_use]
QT += sql
#! [qmake_use]
SOURCES += sqldatabase/sqldatabase.cpp \
code/doc_src_qtsql.cpp \
code/doc_src_sql-driver.cpp \
code/src_sql_kernel_qsqldatabase.cpp \
code/src_sql_kernel_qsqlerror.cpp \

34
src/sql/doc/src/qtsql.qdoc
View File

@ -1,6 +1,6 @@
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
@ -41,15 +41,13 @@
The \l{SQL Programming} guide contains information about development using
Qt SQL.
\section1 Getting Started
To enable Qt SQL in a project, add this directive into the C++ files:
\code
#include <QtSql>
\endcode
To link against the Qt SQL module, add this line to the project file:
\code
QT += sql
\endcode
\include module-use.qdocinc using qt module
\snippet snippets/CMakeLists.txt cmake_use
See also the \l[QtDoc]{Building with CMake} overview.
\include module-use.qdocinc building with qmake
\snippet snippets/snippets.pro qmake_use
\section1 Licenses and Attributions
@ -81,18 +79,6 @@
\brief Provides a driver layer, SQL API layer, and a user
interface layer for SQL databases.
To include the definitions of the module's classes, use the
following directive:
\snippet code/doc_src_qtsql.cpp 0
\if !defined(qtforpython)
To link against the module, add this line to your \l qmake \c
.pro file:
\snippet code/doc_src_qtsql.pro 1
\endif
See the \l{SQL Programming} guide for information about using this
module in your applications.
See the \l{Qt SQL} page and the \l{SQL Programming} guide for further
information about using this module in your application.
*/