- Qbs Manual
- QbsConvenienceItems
- CppLibrary
- Qbs 3.3.1

CppApplication ◦ CppStd

# CppLibrary

C++ library. More...

Since: | Qbs 3.2
Inherits: | Library
Inherited By: | DynamicLibrary, ObjectLibrary, and StaticLibrary

- List of all members, including inherited members
- CppLibrary is part of List of All Items.

## Properties

- headersDirectoryName : string `(since Qbs 3.2)`
- privateHeaders : stringList `(since Qbs 3.2)`
- privateHeadersDirectory : string `(since Qbs 3.2)`
- publicHeaders : stringList `(since Qbs 3.2)`
- publicHeadersDirectory : string `(since Qbs 3.2)`

## Detailed Description

A CppLibrary is an Library that has a dependency on the cpp module.

It also provides additional properties to ease the installation of public and private headers.

## Property Documentation

headersDirectoryName : string `[since Qbs 3.2]`

The name of the directory where headers are installed.

Default: Product.targetName

This property was introduced in Qbs 3.2.

privateHeaders : stringList `[since Qbs 3.2]`

The list of the private headers.

Files are autoatically tagged with the `"hpp"` tag and are installed to privateHeadersDirectory if library installation is requested.

On Apple platforms, if isBundle is `true`, files are also tagged as `"bundle.input.public_hpp"` and are copied into the `PrivateHeaders` directory within the bundle.

Default: `[]`

This property was introduced in Qbs 3.2.

privateHeadersDirectory : string `[since Qbs 3.2]`

The directory where to install private headers.

Default: installpaths.headers + `"/"` + headersDirectoryName + `"/private"`

This property was introduced in Qbs 3.2.

publicHeaders : stringList `[since Qbs 3.2]`

The list of the public headers.

Files are autoatically tagged with the `"hpp"` tag and are installed to publicHeadersDirectory if library installation is requested.

On Apple platforms, if isBundle is `true`, files are also tagged as `"bundle.input.public_hpp"` and are copied into the `Headers` directory within the bundle.

Default: `[]`

This property was introduced in Qbs 3.2.

publicHeadersDirectory : string `[since Qbs 3.2]`

The directory where to install public headers.

Default: installpaths.headers + `"/"` + headersDirectoryName

This property was introduced in Qbs 3.2.