imgdoc2::IOpenExistingOptions Class Reference

This interface gathers all parameters for the operation of "opening an existing file". More...

#include <IOpenExistingOptions.h>

Public Member Functions
virtual void	SetFilename (const char *filename)=0
virtual void	SetOpenReadonly (bool read_only)=0
virtual bool	GetOpenReadonly () const =0
virtual const std::string &	GetFilename () const =0
void	SetFilename (const std::string &filename)
	IOpenExistingOptions (const IOpenExistingOptions &)=delete
IOpenExistingOptions &	operator= (const IOpenExistingOptions &)=delete
	IOpenExistingOptions (IOpenExistingOptions &&)=delete
IOpenExistingOptions &	operator= (IOpenExistingOptions &&)=delete

Detailed Description

This interface gathers all parameters for the operation of "opening an existing file".

Member Function Documentation

GetFilename()

virtual const std::string & imgdoc2::IOpenExistingOptions::GetFilename ( ) const

pure virtual

Gets the filename. The string is given in UTF8-encoding.

Returns

The filename (in UTF8-encoding).

GetOpenReadonly()

virtual bool imgdoc2::IOpenExistingOptions::GetOpenReadonly ( ) const

pure virtual

Gets a boolean indicating whether the file is to be opened as "readonly".

Returns

True if the file is to be opened as "readonly"; false otherwise.

SetFilename() [1/2]

virtual void imgdoc2::IOpenExistingOptions::SetFilename ( const char *  filename )

pure virtual

Sets the filename of the file to be opened.

Parameters

filename

The null-terminated string specifying the file to be opened. The string is expected to be in UTF8-encoding.

SetFilename() [2/2]

void imgdoc2::IOpenExistingOptions::SetFilename ( const std::string &  filename )

inline

Sets the filename of the file to be opened.

Parameters

filename

The null-terminated string specifying the file to be opened. The string is expected to be in UTF8-encoding.

SetOpenReadonly()

virtual void imgdoc2::IOpenExistingOptions::SetOpenReadonly ( bool  read_only )

pure virtual

Sets whether the file is to opened as "readonly".

Parameters

read_only

True file is to opened as "readonly".

---

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

• inc/IOpenExistingOptions.h