installer-framework/examples/doc/hidecheckbox.qdoc
Katja Marttila eef1ebfb60 Change 'Checkable' element behavior
Althogh 'Checkable' value is set to package, that can contain packages to
install. Enabling the install of components using 'Checkable' value.

Change-Id: I05d65fe2da65644872d46bdef3accd5e3f16ad31
Reviewed-by: Iikka Eklund <iikka.eklund@qt.io>
2017-05-22 09:09:13 +00:00

60 lines
2.3 KiB
Plaintext

/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://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 http://qt.io/terms-conditions. For further
** information use the contact form at http://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: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\example hidecheckbox
\ingroup qtifwexamples
\title Hide Checkbox Example
\brief Using components' package.xml files to hide checkboxes for items.
\image qtifw-examples-hidecheckbox.png
\e{Hide Checkbox} illustrates how to hide the checkbox for an item.
\include installerfw-examples-configuring.qdocinc
\quotefile hidecheckbox/config/config.xml
\include installerfw-examples-packaging.qdocinc
\list
\li The \c <Checkable> element specifies whether a checkbox is displayed next to an item.
Set to \c false to hide the checkbox for the item.
\endlist
This example attempts to install three components, so we create a package.xml file in each
component directory: componentF, componentF.subcomponent1, and
componentF.subcomponent1.subcomponent1. We also specify the component name and description
in each of them. The top level item, componentF, has \c <Checkable> set to \c false,
so it cannot be selected.
\quotefile hidecheckbox/packages/componentF/meta/package.xml
\include installerfw-examples-generating.qdocinc
*/