From 45e434b69dea9aaca97a7c9efb6fff576e32c471 Mon Sep 17 00:00:00 2001 From: Andreas Eliasson Date: Tue, 15 Mar 2022 11:10:02 +0100 Subject: Doc: Revise Active Qt module landing page MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Task-number: QTBUG-100369 Pick-to: 6.3 6.3.0 Change-Id: I0dbd1cdca5e9a0ec244656f3306ac988c111b0b4 Reviewed-by: Topi Reiniö --- .../doc/snippets/qtactive-module-use.qdocinc | 47 ++++++++ src/activeqt/doc/src/activeqt-index.qdoc | 122 +++++++++------------ 2 files changed, 101 insertions(+), 68 deletions(-) create mode 100644 src/activeqt/doc/snippets/qtactive-module-use.qdocinc (limited to 'src') diff --git a/src/activeqt/doc/snippets/qtactive-module-use.qdocinc b/src/activeqt/doc/snippets/qtactive-module-use.qdocinc new file mode 100644 index 0000000..d571fe7 --- /dev/null +++ b/src/activeqt/doc/snippets/qtactive-module-use.qdocinc @@ -0,0 +1,47 @@ +/**************************************************************************** +** +** Copyright (C) 2022 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $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$ +** +****************************************************************************/ + +//! [building with cmake] + Use the \c {find_package()} command to locate the needed module components + in the \c {Qt6} package: + + \code + find_package(Qt6 REQUIRED COMPONENTS \1 \2) + target_link_libraries(mytarget PRIVATE Qt6::\1 Qt6::\2) + \endcode + + For more details, see the \l {Build with CMake} overview. +//! [building with cmake] + +//! [building_with_qmake] + To configure the modules for building with qmake, add the module as a value + of the \c QT variable in the project's .pro file: + + \code + QT += \1 \2 + \endcode +//! [building_with_qmake] diff --git a/src/activeqt/doc/src/activeqt-index.qdoc b/src/activeqt/doc/src/activeqt-index.qdoc index f5ca630..c952537 100644 --- a/src/activeqt/doc/src/activeqt-index.qdoc +++ b/src/activeqt/doc/src/activeqt-index.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 The Qt Company Ltd. +** Copyright (C) 2022 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt Toolkit. @@ -43,14 +43,14 @@ \title Active Qt \brief Provides ActiveX and COM integration on Windows - Qt's ActiveX and COM support allows Qt for Windows developers to: + Qt's ActiveX and COM support enables Qt for Windows developers to: \list - \li Access and use ActiveX controls and COM objects provided by any - ActiveX server in their Qt applications. - \li Make their Qt applications available as COM servers, with - any number of Qt objects and widgets as COM objects and ActiveX - controls. + \li Access and use ActiveX controls and COM objects provided by any + ActiveX server in their Qt applications. + \li Make their Qt applications available as COM servers, with + any number of Qt objects and widgets as COM objects and ActiveX + controls. \endlist For more information about using ActiveX with Qt, see @@ -59,83 +59,69 @@ The ActiveQt framework consists of two modules: \list - \li The \l{Using ActiveX controls and COM in Qt}{QAxContainer} - module is a static library implementing QObject and QWidget subclasses, - QAxObject and QAxWidget, that act as containers for COM objects and - ActiveX controls. - \li The \l{Building ActiveX servers in Qt}{QAxServer} - module is a static library that implements - functionality for in-process and executable COM servers. This - module provides the QAxAggregated, QAxBindable and QAxFactory - classes. + \li The \l{Using ActiveX controls and COM in Qt}{QAxContainer} + module is a static library that implements a QObject subclass, + QAxObject, and a QWidget subclass, QAxWidget, which act as containers + for COM objects and ActiveX controls. + \li The \l{Building ActiveX servers in Qt}{QAxServer} + module is a static library that implements functionality for in-process + and executable COM servers. This module provides the QAxAggregated, + QAxBindable, and QAxFactory classes. \endlist A set of \l{Tools for ActiveQt}{tools} is provided to simplify the developing and building of Qt projects that use ActiveX. - \section1 Articles and Guides - \list - \li \l{Tools for ActiveQt} - \li \l{Using ActiveX controls and COM in Qt} - \li \l{Building ActiveX servers in Qt} - \endlist + \section1 Using the Module - \section1 Licenses and Attributions + \include {module-use.qdocinc} {using the c++ api} - The QAxContainer and QAxServer modules are available under - commercial licenses from \l{The Qt Company}. In addition, they - are available under the \l{BSD 3-clause "New" or "Revised" License}: + \section2 Building with CMake - \badcode - Copyright (C) 2017 The Qt Company Ltd. - - 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. - \endcode + \include {qtactive-module-use.qdocinc} {building with cmake} + {AxContainer} {AxServer} - See \l{Qt Licensing} for further details. + \section2 Building with qmake - \section1 Reference + \include {qtactive-module-use.qdocinc} {building_with_qmake} + {axcontainer} {axserver} + + \section1 Articles and Guides \list - \li \l{QAxContainer C++ Classes} - \li \l{QAxServer C++ Classes} + \li \l{Tools for ActiveQt} + \li \l{Using ActiveX controls and COM in Qt} + \li \l{Building ActiveX servers in Qt} \endlist \target ActiveQt Examples \section1 Examples + \list - \li \l{Multiple Example (ActiveQt)} - \li \l{Qutlook Example (ActiveQt)} - \li \l{COM App Example (ActiveQt)} - \li \l{Dot Net Example (ActiveQt)} - \li \l{OpenGL Example (ActiveQt)} - \li \l{Hierarchy Example (ActiveQt)} - \li \l{Media Player Example (ActiveQt)} - \li \l{Menus Example (ActiveQt)} - \li \l{Wrapper Example (ActiveQt)} - \li \l{Simple Example (ActiveQt)} + \li \l{Multiple Example (ActiveQt)} + \li \l{Qutlook Example (ActiveQt)} + \li \l{COM App Example (ActiveQt)} + \li \l{Dot Net Example (ActiveQt)} + \li \l{OpenGL Example (ActiveQt)} + \li \l{Hierarchy Example (ActiveQt)} + \li \l{Media Player Example (ActiveQt)} + \li \l{Menus Example (ActiveQt)} + \li \l{Wrapper Example (ActiveQt)} + \li \l{Simple Example (ActiveQt)} \endlist + + \section1 Reference + + \list + \li \l{QAxContainer C++ Classes} + \li \l{QAxServer C++ Classes} + \endlist + + \section1 Licenses and Attributions + + The QAxContainer and QAxServer modules are available under + commercial licenses from \l{The Qt Company}. In addition, they + are available under the \l{BSD 3-clause "New" or "Revised" License}: + + See \l{Qt Licensing} for further details. */ -- cgit v1.2.1