diff options
author | Venugopal Shivashankar <venugopal.shivashankar@digia.com> | 2012-12-11 17:47:11 +0100 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2012-12-12 15:18:07 +0100 |
commit | 4338bd8c6ed93ca13ccbb0bfbdda44f6c71ecccb (patch) | |
tree | 7e7b73fe24cc4789a2276df3e8edbff1b06cb02a | |
parent | 720de3bd4cebe0df7025572bda4520726573043b (diff) | |
download | qtdoc-4338bd8c6ed93ca13ccbb0bfbdda44f6c71ecccb.tar.gz |
Doc: Moved activeqt tools documentation to qtactiveqt repo
Change-Id: I2b7084b38f8923b4574f9517176ce209f91a1ad9
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
-rw-r--r-- | doc/src/development/activeqt-dumpcpp.qdoc | 129 | ||||
-rw-r--r-- | doc/src/development/activeqt-dumpdoc.qdoc | 69 | ||||
-rw-r--r-- | doc/src/snippets/code/doc_src_activeqt-dumpcpp.cpp | 65 |
3 files changed, 0 insertions, 263 deletions
diff --git a/doc/src/development/activeqt-dumpcpp.qdoc b/doc/src/development/activeqt-dumpcpp.qdoc deleted file mode 100644 index 6baa1a1c..00000000 --- a/doc/src/development/activeqt-dumpcpp.qdoc +++ /dev/null @@ -1,129 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). -** Contact: http://www.qt-project.org/legal -** -** 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 Digia. For licensing terms and -** conditions see http://qt.digia.com/licensing. For further information -** use the contact form at http://qt.digia.com/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: http://www.gnu.org/copyleft/fdl.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \page activeqt-dumpcpp.html - \title The dumpcpp Tool (ActiveQt) - - \ingroup activeqt-tools - - \keyword dumpcpp - - The \c dumpcpp tool generates a C++ namespace for a type library. - - To generate a C++ namespace for a type library, call \c dumpcpp with the following - command line parameters: - - \table - \header - \li Option - \li Result - \row - \li input - \li Generate documentation for \e input. \e input can specify a type library file or a type - library ID, or a CLSID or ProgID for an object - \row - \li -o file - \li Writes the class declaration to \e {file}.h and meta object infomation to \e {file}.cpp - \row - \li -n namespace - \li Generate a C++ namespace \e namespace - \row - \li -nometaobject - \li Do not generate a .cpp file with the meta object information. - The meta object is then generated in runtime. - \row - \li -getfile libid - \li Print the filename for the typelibrary \e libid to stdout - \row - \li -compat - \li Generate namespace with dynamicCall-compatible API - \row - \li -v - \li Print version information - \row - \li -h - \li Print help - \endtable - - \c dumpcpp can be integrated into the \c qmake build system. In your .pro file, list the type - libraries you want to use in the TYPELIBS variable: - - \snippet examples/activeqt/qutlook/qutlook.pro 0 - - The generated namespace will declare all enumerations, as well as one QAxObject subclass - for each \c coclass and \c interface declared in the type library. coclasses marked with - the \c control attribute will be wrapped by a QAxWidget subclass. - - Those classes that wrap creatable coclasses (i.e. coclasses that are not marked - as \c noncreatable) have a default constructor; this is typically a single class - of type \c Application. - - \snippet doc/src/snippets/code/doc_src_activeqt-dumpcpp.cpp 0 - - All other classes can only be created by passing an IDispatch interface pointer - to the constructor; those classes should however not be created explicitly. - Instead, use the appropriate API of already created objects. - - \snippet doc/src/snippets/code/doc_src_activeqt-dumpcpp.cpp 1 - - All coclass wrappers also have one constructors taking an interface wrapper class - for each interface implemented. - - \snippet doc/src/snippets/code/doc_src_activeqt-dumpcpp.cpp 2 - - You have to create coclasses to be able to connect to signals of the subobject. - Note that the constructor deletes the interface object, so the following will - cause a segmentation fault: - - \snippet doc/src/snippets/code/doc_src_activeqt-dumpcpp.cpp 3 - - If the return type is of a coclass or interface type declared in another type - library you have to include the namespace header for that other type library - before including the header for the namespace you want to use (both header have - to be generated with this tool). - - By default, methods and property returning subobjects will use the type as in - the type library. The caller of the function is responsible for deleting or - reparenting the object returned. If the \c -compat switch is set, properties - and method returning a COM object have the return type \c IDispatch*, and - the namespace will not declare wrapper classes for interfaces. - - In this case, create the correct wrapper class explicitly: - - \snippet doc/src/snippets/code/doc_src_activeqt-dumpcpp.cpp 4 - - You can of course use the IDispatch* returned directly, in which case you have to - call \c Release() when finished with the interface. - - All classes in the namespace are tagged with a macro that allows you to export - or import them from a DLL. To do that, declare the macro to expand to - \c __declspec(dllimport/export) before including the header file. - - To build the tool you must first build the QAxContainer library. - Then run your make tool in \c tools/dumpcpp. -*/ diff --git a/doc/src/development/activeqt-dumpdoc.qdoc b/doc/src/development/activeqt-dumpdoc.qdoc deleted file mode 100644 index 2b20f8bd..00000000 --- a/doc/src/development/activeqt-dumpdoc.qdoc +++ /dev/null @@ -1,69 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). -** Contact: http://www.qt-project.org/legal -** -** 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 Digia. For licensing terms and -** conditions see http://qt.digia.com/licensing. For further information -** use the contact form at http://qt.digia.com/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: http://www.gnu.org/copyleft/fdl.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \page activeqt-dumpdoc.html - \title The dumpdoc Tool (ActiveQt) - - \ingroup activeqt-tools - - \keyword dumpdoc - - The \c dumpdoc tool generates Qt-style documentation for any - COM object and writes it into the file specified. - - Call \c dumpdoc with the following command line parameters: - - \table - \header - \li Option - \li Result - \row - \li -o file - \li Writes output to \e file - \row - \li object - \li Generate documentation for \e object - \row - \li -v - \li Print version information - \row - \li -h - \li Print help - \endtable - - \e object must be an object installed on the local machine (ie. - remote objects are not supported), and can include subobjects - accessible through properties, ie. - \c Outlook.Application/Session/CurrentUser - - The generated file will be an HTML file using Qt documentation - style. - - To build the tool you must first build the QAxContainer library. - Then run your make tool in \c tools/dumpdoc. -*/ diff --git a/doc/src/snippets/code/doc_src_activeqt-dumpcpp.cpp b/doc/src/snippets/code/doc_src_activeqt-dumpcpp.cpp deleted file mode 100644 index 5620fed0..00000000 --- a/doc/src/snippets/code/doc_src_activeqt-dumpcpp.cpp +++ /dev/null @@ -1,65 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). -** Contact: http://www.qt-project.org/legal -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:BSD$ -** 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 Digia Plc and its Subsidiary(-ies) 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] -Outlook::Application *outlook = new Outlook::Application; -//! [0] - - -//! [1] -Outlook::_NameSpace *session = outlook->Session(); -//! [1] - - -//! [2] -Outlook::NameSpace *session = outlook->Session(); -//! [2] - - -//! [3] -Outlook::_NameSpace *tmp = outlook->Session(); -Outlook::NameSpace *session = new Outlook::NameSpace(tmp); -delete tmp; // or any other use of tmp: segfault -//! [3] - - -//! [4] -Outlook::NameSpace *session = new Outlook::NameSpace(outlook->Session()); -//! [4] |