Qbs

Blog Documentation Get Qbs Community
  • Qbs Manual
  • QbsModules
  • ib
  • Qbs 2.4.0
  • ib

    Provides support for Apple Interface Builder and related tools and file types. More...

    Since: Qbs 1.1

    Properties

    Detailed Description

    The ib module contains properties and rules for building Interface Builder documents, storyboards, asset catalogs, and icon sets.

    This module is only available on Apple platforms.

    Relevant File Tags

    The file tags determine how the tagged directories and files are handled.

    TagAuto-tagged File NamesSinceDescription
    "assetcatalog"*.xcassets1.3Tagged directories are compiled into compiled asset catalog archives (.car files) on supported platforms, or a collection of loose resource files. The resulting files will be automatically tagged bundle.input. If the current product is a bundle, the files will be included in the bundle's resources directory.
    "iconset"*.iconset1.3Tagged directories are compiled into Apple ICNS files. The resulting files will be automatically tagged bundle.input. If the current product is a bundle, the files will be included in the bundle's resources directory.
    "nib"*.nib, *.xib1.1Tagged "NIB" and "XIB" files will be compiled. The output may be a flat file or a bundle (directory structure). The resulting files will be automatically tagged bundle.input. If the current product is a bundle, the files will be included in the bundle's resources directory.
    "png"*.png1.9Tagged PNG files may be converted into multi-resolution TIFFs. Source files should adopt the @2x naming convention in order to be properly grouped. The resulting files will be given the tiff file tag.
    "storyboard"*.storyboard1.3Tagged storyboard files will be compiled. The output may be a flat file or a bundle (directory structure). The resulting files will be automatically tagged bundle.input. If the current product is a bundle, the files will be included in the bundle's resources directory.

    Property Documentation

    actoolName : string [since Qbs 1.3]

    The name of the actool binary used to compile asset catalogs.

    This property should not normally need to be changed.

    Default: "actool"

    This property was introduced in Qbs 1.3.


    actoolPath : string [since Qbs 1.3]

    The directory where the actool binary is located.

    This property should not normally need to be changed.

    Default: actoolName

    This property was introduced in Qbs 1.3.


    appIconName : string [since Qbs 1.3]

    The name of the resource in the asset catalog that will be used as the application's icon.

    Used to generate the partial Info.plist which will be merged into the resulting app.

    If this property is undefined, no application icon will be specified.

    Default: Undefined

    This property was introduced in Qbs 1.3.


    autoActivateCustomFonts : bool [since Qbs 1.3]

    Instructs the ibtool compiler to add custom fonts to the application's Info.plist when compiling XIBs and storyboards, which will cause the fonts to activate upon application launch.

    Requires Xcode 6 or newer.

    Default: true

    This property was introduced in Qbs 1.3.


    compressPngs : bool [since Qbs 1.3]

    Whether to compress PNG image files when building asset catalogs.

    Default: true

    This property was introduced in Qbs 1.3.


    errors : bool

    Whether to print errors when compiling.

    Does not apply to icon sets.

    Default: true


    flags : stringList

    Additional flags to pass to the underlying tool (ibtool, actool, iconutil).

    Default: Undefined

    Default: true


    flatten : bool

    Compiles XIBs and storyboards into flattened (non-wrapper) files.

    Set to false to preserve editability of the resulting NIB and storyboard bundles in Interface Builder.

    This property should not normally need to be changed.

    Default: true


    ibtoolName : string [since Qbs 1.3]

    The name of the ibtool binary used to compile NIBs and storyboards.

    This property should not normally need to be changed.

    Default: "ibtool"

    This property was introduced in Qbs 1.3.


    ibtoolPath : string [since Qbs 1.3]

    The directory where the ibtool binary is located.

    This property should not normally need to be changed.

    Default: ibtoolName

    This property was introduced in Qbs 1.3.


    iconutilName : string [since Qbs 1.3]

    The name of the iconutil binary used to compile icon sets.

    This property should not normally need to be changed.

    Default: "iconutil"

    This property was introduced in Qbs 1.3.


    iconutilPath : string [since Qbs 1.3]

    The directory where the iconutil binary is located.

    This property should not normally need to be changed.

    Default: iconutilName

    This property was introduced in Qbs 1.3.


    launchImageName : string [since Qbs 1.3]

    The name of the resource in the asset catalog that will be used as the application's launch image.

    Used to generate the partial Info.plist which will be merged into the resulting app.

    If this property is undefined, no launch image will be specified.

    This property is specific to iOS.

    Default: Undefined

    This property was introduced in Qbs 1.3.


    module : string [since Qbs 1.3]

    Sets the name of the module that the NIB or storyboard is a part of.

    Requires Xcode 6 or newer.

    Default: Undefined

    This property was introduced in Qbs 1.3.


    notices : bool

    Whether to print notifications when compiling.

    Does not apply to icon sets.

    Default: true


    warnings : bool

    Whether to print warnings when compiling.

    Does not apply to icon sets.

    Default: true