OpenTestSystem::Otx::Runtime::Api::Custom::ICommonDialogsImplementation Class Reference

Allows users to implement their own common Dialogs, consisting of FileOpenDialog, FileSaveDialog, and SelectDirectoryDialog. More...

#include <ICommonDialogsImplementation.h>

Public Member Functions
virtual std::vector< std::string >	FileOpenDialog (const std::string &title, const std::string &message, const std::string &initialPath, const std::string &extensions, bool allowMultiSelect, bool checkFileExists)=0
	Invoked when a FileOpenDialog occurs in OTX-Runtime. More...
virtual std::string	FileSaveDialog (const std::string &title, const std::string &message, const std::string &initialPath, const std::string &extensions, bool checkFileExist)=0
	Invoked when an FileSaveDialog occurs in OTX-Runtime. More...
virtual std::string	SelectDirectoryDialog (const std::string &title, const std::string &message, const std::string &initialPath)=0
	Invoked when a SelectDirectoryDialog occurs in OTX-Runtime. More...

Detailed Description

Allows users to implement their own common Dialogs, consisting of FileOpenDialog, FileSaveDialog, and SelectDirectoryDialog.

Member Function Documentation

FileOpenDialog()

virtual std::vector<std::string> OpenTestSystem::Otx::Runtime::Api::Custom::ICommonDialogsImplementation::FileOpenDialog ( const std::string &  title, const std::string &  message, const std::string &  initialPath, const std::string &  extensions, bool  allowMultiSelect, bool  checkFileExists  )

pure virtual

Invoked when a FileOpenDialog occurs in OTX-Runtime.

Parameters

title	The title to be displayed in the dialog
message	The message to be displayed in the dialog to aid the user in their selection
initialPath	The initial path to select
extensions	The optional (comma separated) list of extensions to filter in this dialog
allowMultiSelect	The optional flag to determine if the dialog will allow the user to select more than one file
checkFileExists	The optional flag to determine if the dialog must check for the file before allowing the user to complete

Returns

Selection from the user will be sent to OTX-Runtime.

FileSaveDialog()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Custom::ICommonDialogsImplementation::FileSaveDialog ( const std::string &  title, const std::string &  message, const std::string &  initialPath, const std::string &  extensions, bool  checkFileExist  )

pure virtual

Invoked when an FileSaveDialog occurs in OTX-Runtime.

Parameters

title	The title to be displayed in the dialog
message	The message to be displayed in the dialog to aid the user in their selection
initialPath	The initial path to select
extensions	The optional (comma separated) list of extensions to filter in this dialog
checkFileExist	The optional flag to determine if the dialog must check for the file before allowing the user to complete

Returns

Returned value will be sent to OTX-Runtime.

SelectDirectoryDialog()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Custom::ICommonDialogsImplementation::SelectDirectoryDialog ( const std::string &  title, const std::string &  message, const std::string &  initialPath  )

pure virtual

Invoked when a SelectDirectoryDialog occurs in OTX-Runtime.

Parameters

title	The title to be displayed in the dialog
message	The message to be displayed in the dialog to aid the user in their selection
initialPath	The initial path to select

Returns

Selection from the user will be sent to OTX-Runtime.

---

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

• ICommonDialogsImplementation.h