summaryrefslogtreecommitdiffstats
path: root/examples/doc/modifyextract.qdoc
blob: 2114b3b54244a188a7a887130dcc8ff9b6082c1b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Installer Framework.
**
** $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$
**
****************************************************************************/

/*!
    \example modifyextract
    \ingroup qtifwexamples
    \title Modify Extract Installer Example

    \brief Using the extract archive hook in a component script to modify the
    target path.

    \image qtifw-examples-modifyextract.png

    \e{Modify Extract Installer} illustrates how to overwrite the
    \c{component.createOperationsForArchive()} function to be able to install a
    component to a modified path.

    \include installerfw-examples-configuring.qdocinc

    \quotefile modifyextract/config/config.xml

    \include installerfw-examples-packaging.qdocinc

    \list
        \li The \c <Default> element is set to \c true to preselect the
            component in the installer.
        \li The \c <Script> element specifies the file name of the JavaScript
            file that is loaded to perform operations.
    \endlist

    \quotefile modifyextract/packages/org.qtproject.ifw.example.modifyextract/meta/package.xml

    \section1 Modifying Target Path

    In installscript.js, we overwrite the default
    \c{component.createOperationsForArchive()} implementation to be able to
    register an \c Extract operation with a custom argument:

    \quotefromfile modifyextract/packages/org.qtproject.ifw.example.modifyextract/meta/installscript.js
    \skipto createOperationsForArchive
    \printuntil {
    \skipto component.addOperation
    \printuntil }

    \include installerfw-examples-generating.qdocinc
*/