Properties

Provides conditional setting of properties. More...

• List of all members, including inherited members
• Properties is part of List of All Items.

Properties

• condition : bool
• overrideListProperties : bool

Detailed Description

The Properties item is an auxiliary item for setting multiple property values conditionally.

In the following example, two properties are set if the project is built for Windows:

Product {
    Properties {
        condition: qbs.targetOS.includes("windows")
        cpp.defines: ["ON_WINDOWS"]
        cpp.includePaths: ["extraWindowsIncludes"]
    }
}

Multiple Properties items can be specified to set properties dependent on different conditions. The order of appearance is important. Semantics are similar to if-else-chains. The following example

Product {
    Properties {
        condition: qbs.targetOS.includes("windows")
        cpp.defines: ["ON_WINDOWS"]
        cpp.includePaths: ["myWindowsIncludes"]
    }
    Properties {
        condition: qbs.targetOS.includes("linux")
        cpp.defines: ["ON_LINUX"]
        cpp.includePaths: ["myLinuxIncludes"]
    }
    cpp.defines: ["ON_UNKNOWN_PLATFORM"]
}

is equivalent to

Product {
    cpp.defines: {
        if (qbs.targetOS.includes("windows"))
            return ["ON_WINDOWS"];
        if (qbs.targetOS.includes("linux"))
            return ["ON_LINUX"];
        return ["ON_UNKNOWN_PLATFORM"];
    }
    cpp.includePaths: {
        if (qbs.targetOS.includes("windows"))
            return ["myWindowsIncludes"];
        if (qbs.targetOS.includes("linux"))
            return ["myLinuxIncludes"];
        return base;
    }
}

In Properties items, one can access the outer value of a property.

Product {
    Properties {
        condition: qbs.targetOS.includes("windows")
        cpp.defines: outer.concat("ON_WINDOWS")     // === ["FOO", "ON_WINDOWS"]
    }
    Properties {
        condition: qbs.targetOS.includes("linux")
        cpp.defines: ["ON_LINUX"]                   // === ["ON_LINUX"]
    }
    cpp.defines: ["FOO"]
}

We suggest to use the Properties item for mutually exclusive conditions only. It is especially useful if there are several properties to set, based on the same condition.

Property Documentation

Project PropertyOptions