MeVisLab Toolbox Reference
macos::Bundle Class Reference

Bundle information. More...

#include <macBundle.h>

Static Public Member Functions

static std::string getBundleName (const std::string &bundlePath=std::string())
 Return name of the bundle (CFBundleName) More...
 
static std::string getBundleDirectory (const std::string &id=std::string())
 Return absolute path to the bundle directory of bundle with the given id or the current application if no id is given (UTF8) More...
 
static std::string getBundleDirectoryOfSubDirectory (const std::string &path)
 Return absolute path to the root bundle directory of the given subdirectory (UTF8) More...
 
static std::string getBundleDirectoryPreferUmbrellaBundle ()
 Return absolute path to the umbrella bundle directory in which this bundle is embedded. Return absolute path to just the main bundle directory otherwise (UTF8) More...
 
static std::string getUmbrellaBundleDirectory ()
 Return absolute path to the umbrella bundle directory in which this bundle is embedded. Return std::string() if this bundle is not within an umbrella bundle (UTF8) More...
 
static std::string getBundleResourcesDirectory (const std::string &bundlePath=std::string())
 Return absolute path of the given bundle's resources directory (UTF8) More...
 
static std::string getBundlePrivateFrameworksDirectory (const std::string &bundlePath=std::string())
 Return absolute path of the given bundle's resources directory (UTF8) More...
 
static std::string getBundleSharedSupportDirectory (const std::string &bundlePath=std::string())
 Return absolute path of the given bundle's shared support directory (UTF8) More...
 
static std::string getBundleId (const std::string &bundlePath=std::string())
 Return bundle identifier of given bundle or empty string if none was found (UTF8) More...
 
static std::string getBundleExecutable (const std::string &bundlePath=std::string())
 Returns absolute path of the main executable of the given bundle (UTF8) More...
 
static std::string getSupportAppWithName (const std::string &appName, const std::string &bundlePath=std::string())
 Returns absolute path of support application (bundled and unbundled) by looking at specific bundle folders (UTF8) More...
 
static std::string getSupportAppWithId (const std::string &id, const std::string &bundlePath=std::string())
 Returns absolute path of support application (bundles only) by looking at specific bundle folders (UTF8) More...
 
static bool isApplicationBundle (const std::string &filePath)
 Returns 'true' if given path points to an application bundle (UTF8) More...
 
static std::string getStringForInfoDictionaryKey (const std::string &key, const std::string &bundlePath=std::string())
 Returns string value for the given key from the bundle's Info.plist file. More...
 
static bool isSystemVersionSufficientForBundle (const std::string &minimumSystemVersionInfoDictKey="MLMinimumSystemVersion", bool displaySoftwareUpdateDialog=true)
 Check operating system version and display software update dialog if update is possible (UTF8) More...
 

Detailed Description

Bundle information.

Definition at line 26 of file macBundle.h.

Member Function Documentation

◆ getBundleDirectory()

static std::string macos::Bundle::getBundleDirectory ( const std::string &  id = std::string())
static

Return absolute path to the bundle directory of bundle with the given id or the current application if no id is given (UTF8)

◆ getBundleDirectoryOfSubDirectory()

static std::string macos::Bundle::getBundleDirectoryOfSubDirectory ( const std::string &  path)
static

Return absolute path to the root bundle directory of the given subdirectory (UTF8)

◆ getBundleDirectoryPreferUmbrellaBundle()

static std::string macos::Bundle::getBundleDirectoryPreferUmbrellaBundle ( )
static

Return absolute path to the umbrella bundle directory in which this bundle is embedded. Return absolute path to just the main bundle directory otherwise (UTF8)

◆ getBundleExecutable()

static std::string macos::Bundle::getBundleExecutable ( const std::string &  bundlePath = std::string())
static

Returns absolute path of the main executable of the given bundle (UTF8)

◆ getBundleId()

static std::string macos::Bundle::getBundleId ( const std::string &  bundlePath = std::string())
static

Return bundle identifier of given bundle or empty string if none was found (UTF8)

◆ getBundleName()

static std::string macos::Bundle::getBundleName ( const std::string &  bundlePath = std::string())
static

Return name of the bundle (CFBundleName)

◆ getBundlePrivateFrameworksDirectory()

static std::string macos::Bundle::getBundlePrivateFrameworksDirectory ( const std::string &  bundlePath = std::string())
static

Return absolute path of the given bundle's resources directory (UTF8)

◆ getBundleResourcesDirectory()

static std::string macos::Bundle::getBundleResourcesDirectory ( const std::string &  bundlePath = std::string())
static

Return absolute path of the given bundle's resources directory (UTF8)

◆ getBundleSharedSupportDirectory()

static std::string macos::Bundle::getBundleSharedSupportDirectory ( const std::string &  bundlePath = std::string())
static

Return absolute path of the given bundle's shared support directory (UTF8)

◆ getStringForInfoDictionaryKey()

static std::string macos::Bundle::getStringForInfoDictionaryKey ( const std::string &  key,
const std::string &  bundlePath = std::string() 
)
static

Returns string value for the given key from the bundle's Info.plist file.

◆ getSupportAppWithId()

static std::string macos::Bundle::getSupportAppWithId ( const std::string &  id,
const std::string &  bundlePath = std::string() 
)
static

Returns absolute path of support application (bundles only) by looking at specific bundle folders (UTF8)

◆ getSupportAppWithName()

static std::string macos::Bundle::getSupportAppWithName ( const std::string &  appName,
const std::string &  bundlePath = std::string() 
)
static

Returns absolute path of support application (bundled and unbundled) by looking at specific bundle folders (UTF8)

◆ getUmbrellaBundleDirectory()

static std::string macos::Bundle::getUmbrellaBundleDirectory ( )
static

Return absolute path to the umbrella bundle directory in which this bundle is embedded. Return std::string() if this bundle is not within an umbrella bundle (UTF8)

◆ isApplicationBundle()

static bool macos::Bundle::isApplicationBundle ( const std::string &  filePath)
static

Returns 'true' if given path points to an application bundle (UTF8)

◆ isSystemVersionSufficientForBundle()

static bool macos::Bundle::isSystemVersionSufficientForBundle ( const std::string &  minimumSystemVersionInfoDictKey = "MLMinimumSystemVersion",
bool  displaySoftwareUpdateDialog = true 
)
static

Check operating system version and display software update dialog if update is possible (UTF8)

Returns 'true' if minimum system version specified in the bundle's Info.plist information dictionary if bigger or equal to the operating system version. if displaySoftwareUpdateDialog is true, display the software update dialog, but only if the major operating system version is the same and the minor operating system version is less than the required minimal version. If the system version is insufficient you should close your application immediately.


The documentation for this class was generated from the following file: