Ocean
Ocean::Platform::Utilities Class Reference

This class implements utilities and helper functions. More...

Public Types

typedef std::vector< std::wstring > Commands
 Definition of a vector holding application commands. More...
 

Static Public Member Functions

static Commands parseCommandLine (const wchar_t *commandLine)
 Parses the command line and returns the individual command elements. More...
 
static void showMessageBox (const std::string &title, const std::string &message)
 Shows a modal message box with a title, a message and an OK button. More...
 
static void showMessageBoxApple (const std::string &title, const std::string &message)
 Shows a modal message box with a title, a message and an OK button on Apple platforms only. More...
 

Detailed Description

This class implements utilities and helper functions.

Member Typedef Documentation

◆ Commands

typedef std::vector<std::wstring> Ocean::Platform::Utilities::Commands

Definition of a vector holding application commands.

Member Function Documentation

◆ parseCommandLine()

static Commands Ocean::Platform::Utilities::parseCommandLine ( const wchar_t *  commandLine)
static

Parses the command line and returns the individual command elements.

The entire command line may contain several commands separated by space characters.
Command elements which contain space characters must be surrounded by quotation marks.
However, all surrounding quotation marks will be removed during the parsing process.
The first argument should not be the filename (and path) of the executable.

Parameters
commandLineCommand line to be parsed
Returns
Individual commands

◆ showMessageBox()

static void Ocean::Platform::Utilities::showMessageBox ( const std::string &  title,
const std::string &  message 
)
static

Shows a modal message box with a title, a message and an OK button.

Beware: This function is supported for Desktop platforms only.

Parameters
titleThe title to be shown in the box
messageThe message to be shown in the box

◆ showMessageBoxApple()

static void Ocean::Platform::Utilities::showMessageBoxApple ( const std::string &  title,
const std::string &  message 
)
static

Shows a modal message box with a title, a message and an OK button on Apple platforms only.

Beware: This function is supported for Desktop platforms only.

Parameters
titleThe title to be shown in the box
messageThe message to be shown in the box

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