Exporter.qbs

Provides support for generating Qbs modules from products. More...

• List of all members, including inherited members

Properties

• additionalContent : string
• artifactTypes : stringList
• excludedDependencies : stringList
• fileName : string

Detailed Description

The Exporter.qbs module contains the properties and rules to create a Qbs module from the Export item of a Product.

Such a module acts as your product's interface to other projects written in Qbs. For instance, suppose you are creating a library. To allow other products both within and outside of your project to make use of it, you would write something like the following:

DynamicLibrary {
    name: "mylibrary"
    qbs.installPrefix: "/opt/mylibrary"
    Depends { name: "Exporter.qbs" }
    property string headersInstallDir: "include"
    // ...
    Group {
        name: "API headers"
        files: ["mylib.h"]
        qbs.install: true
        qbs.installDir: headersInstallDir
    }
    Group {
        fileTagsFilter: ["Exporter.qbs.module"]
        qbs.installDir: "qbs/modules/mylibrary"
    }
    Export {
        Depends { name: "cpp" }
        cpp.includePaths: [exportingProduct.sourceDirectory]
        prefixMapping: [{
                prefix: exportingProduct.sourceDirectory,
                replacement: FileInfo.joinPaths(exportingProduct.qbs.installPrefix,
                                                exportingProduct.headersInstallDir)
            }]
    }
}

To build against this library, from within your project or any other one, you simply declare a dependency:

Depends { name: "mylibrary" }

Relevant File Tags

Property Documentation