Developer Documentation

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
OpenFlipper Branding

OpenFlipper supports branding of the UI and several components by an integrated branding mechanism. Generally you can create a branding directory either directly inside the toplevel directory or within a package.

Note
  You can have only one branding directory at a time (cmake will throw a warning and use only the first one).

Configurations made in this directory will overwrite some icons, settings and configurations.

SourceDir/branding/branding.cmake // General cmake file for branding flags
SourceDir/branding/branding.h // Header file that could be included to allow source code changes

# CMake Options

OPENFLIPPER_PRODUCT_NAME // Name of the Product found in all visible places
OPENFLIPPER_PRODUCT_STRING // String of the Product without space,... used for config dir and others

# Application internal icons

If you want to replace the icon set of OpenFlipper (partially or complete), you can override them with icon sets for linux, win, mac or all at once.

SourceDir/branding/linux/Icons // Linux specific icons
SourceDir/branding/mac/Icons // Mac specific icons
SourceDir/branding/win/Icons // Windows specific icons
SourceDir/branding/Icons // Toplevel icon directory overwriting also the OS specific icons

# Mac Specific bundle branding

For Mac OS several special options are available to configure the final bundle.

The files used for the bungle are:

SourceDir/branding/mac/OpenFlipper_Icon.icns // Bundle icon
SourceDir/branding/mac/Info.plist // Plist file