/****************************************************************************
**
** Copyright (C) 2022 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** 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 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$
**
****************************************************************************/

/*!
    \example registerfileextension
    \ingroup qtifwexamples
    \title Register File Extension Example

    \brief Using a component script to register a filename extension on Windows.

    \image qtifw-examples-registerfileextension.png

    \e{Register File Extension} illustrates how to register a file type on
    Windows. We use the \c component.addOperation() function with the
    \c RegisterFileType operation to register a randomly generated file type to
    be opened with Notepad.

    \include installerfw-examples-configuring.qdocinc

    \quotefile registerfileextension/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.
        \li The \c <UserInterfaces> element specifies the file names of the
            installer pages (.ui files) to use.
    \endlist

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

    \section1 Registering File Extensions

    In installscript.qs, we call the \c Component() function to connect to the
    \c addRegisterFileCheckBox signal as soon as all components have been
    loaded:

    \quotefromfile registerfileextension/packages/org.qtproject.ifw.example.registerfileextension/meta/installscript.qs
    \skipto Component()
    \printuntil addRegisterFileCheckBox

    We use the \c addRegisterFileCheckBox() function to display a check box for
    registering the generated file type on the last page of the installer.
    We hide the page when updating and uninstalling:

    \skipto addRegisterFileCheckBox
    \printuntil )
    \skipto isInstaller()
    \printuntil /^\}/

    We connect to the \c openRegisteredFileIfChecked signal when end users
    select \uicontrol Finish on the last installer page:

    \quotefromfile registerfileextension/packages/org.qtproject.ifw.example.registerfileextension/meta/installscript.qs
    \skipto openRegisteredFileIfChecked
    \printuntil ;

    We call the \c openRegisteredFileIfChecked function to check that the
    file type was successfully registered:

    \skipto openRegisteredFileIfChecked
    \printuntil /^\}/

    We bind the \c unusualFileType variable to the \c generateUnusualFileType()
    function that randomly generates a file type with the specified length:

    \quotefromfile registerfileextension/packages/org.qtproject.ifw.example.registerfileextension/meta/installscript.qs
    \skipto generateUnusualFileType
    \printuntil randomString
    \printuntil }

    We use the \c RegisterFileType operation to create a file of the
    specified type and to specify the application to open the file with:

    \quotefromfile registerfileextension/packages/org.qtproject.ifw.example.registerfileextension/meta/installscript.qs
    \skipto component.createOperations()
    \printuntil /^\}/

    \include installerfw-examples-generating.qdocinc

    After running the installer, double-click the installed file,
    \c registeredfile.<extension>, to open it in Notepad.
*/
