SCR_FileWrapper Class Reference

The SCR_FileWrapper class is base class to TemporaryFile and PermanentFile. More...

#include <fileinterface.h>

Inheritance diagram for SCR_FileWrapper:

Collaboration diagram for SCR_FileWrapper:

Public Slots
SCR_FileWrapper &	setPath (String &path)
	Specify absolute path of this image file. Name of file can be changed only if there is an open stream.
String	path ()
	Retrieve file path.
String	extension ()
	Retrieve file extension.
bool	exists ()
	Verify if file exists on disk.
Stream Manipulation
bool	isOpen ()
	Check if file is opened.
bool	isClose ()
	Check if file is closed.
bool	open (int m=int(SCR_FileIOTypeWrapper::WRITE_ONLY))
	Open file stream for read/write.
bool	close ()
	Close file stream.
void	write (String &text)
	Write string in current stream.
void	writeLine (String &text)
	Write string line in current stream.
void	write (SCR_FileWrapper *file)
	Write entire content of parameter file in current stream.
String	read ()
	Read entire content of stream.
String	readLine ()
	Read single line of stream.
File management
bool	move (SCR_FileWrapper *dest)
bool	copy (SCR_FileWrapper *dest)

Detailed Description

The SCR_FileWrapper class is base class to TemporaryFile and PermanentFile.

Member Function Documentation

bool SCR_FileWrapper::close ( )

slot

Close file stream.

Returns

Sucess/Failure of operation

bool SCR_FileWrapper::copy ( SCR_FileWrapper *  dest )

slot

Copy current SCR_FileWrapper to new SCR_FileWrapper destination

Parameters

dest	Destination

Returns

Result of operation

bool SCR_FileWrapper::exists ( )

slot

Verify if file exists on disk.

Returns

exists on disk

String SCR_FileWrapper::extension ( )

slot

Retrieve file extension.

Returns

extension String

bool SCR_FileWrapper::isClose ( )

slot

Check if file is closed.

Returns

stream status

bool SCR_FileWrapper::isOpen ( )

slot

Check if file is opened.

Returns

stream status

bool SCR_FileWrapper::move ( SCR_FileWrapper *  dest )

slot

Move current SCR_FileWrapper to new SCR_FileWrapper destination

Parameters

dest	Destination

Returns

Result of operation

bool SCR_FileWrapper::open ( int  m = int(SCR_FileIOTypeWrapper::WRITE_ONLY) )

slot

Open file stream for read/write.

Parameters

m	IO stream descriptor

Returns

Success/Failure of operation

String SCR_FileWrapper::path ( )

slot

Retrieve file path.

Returns

full path String

String SCR_FileWrapper::read ( )

slot

Read entire content of stream.

Returns

String

String SCR_FileWrapper::readLine ( )

slot

Read single line of stream.

Returns

String

SCR_FileWrapper& SCR_FileWrapper::setPath ( String &  path )

slot

Specify absolute path of this image file. Name of file can be changed only if there is an open stream.

Parameters

path	Absolute path String of image file

Returns

TemporaryFile reference

void SCR_FileWrapper::write ( String &  text )

slot

Write string in current stream.

Parameters

text	Text to write

void SCR_FileWrapper::write ( SCR_FileWrapper *  file )

slot

Write entire content of parameter file in current stream.

Parameters

file	SCR_FileWrapper object

void SCR_FileWrapper::writeLine ( String &  text )

slot

Write string line in current stream.

Parameters

text	Text to write

---

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

• dox_files/objectScript/fileinterface.h