os::FileReference Class Reference

Semi persistent reference to a file. More...

Classes
class	Private

Public Member Functions
	FileReference ()
	FileReference (const String &cPath, bool bFollowLinks=false)
	FileReference (const Directory &cDir, const String &cName, bool bFollowLinks=false)
	FileReference (const FileReference &cRef)
virtual	~FileReference ()
status_t	SetTo (const String &cPath, bool bFollowLinks=false)
status_t	SetTo (const Directory &cDir, const String &cName, bool bFollowLinks=false)
status_t	SetTo (const FileReference &cRef)
void	Unset ()
bool	IsValid () const
String	GetName () const
status_t	GetPath (String *pcPath) const
int	Rename (const String &cNewName)
status_t	Delete ()
Window *	RenameDialog (const Messenger &cMsgTarget, Message *pcChangeMsg)
	Create a dialog which can be used to rename a directory or file. More...
Window *	InfoDialog (const Messenger &cMsgTarget, Message *pcChangeMsg)
	Create a dialog which shows information about a file or directory. More...
status_t	GetStat (struct stat *psStat) const
const Directory &	GetDirectory () const

Detailed Description

Description:

FileReference's serve much the same functionality as a plain path. It uniquely identifies a file within the filesystem. The main advantage of a FileReference is that it can partly "track" the file it reference. While moving a file to another directory or renaming the directory it lives in or any of it's subdirectories whould break a path, it will not affect a FileReference. Renaming the file itself however from outside the FileReference (ie. not using the FileReference::Rename() member) will break a FileReference aswell.

See Also

Author

Kurt Skauen (kurt@.nosp@m.athe.nosp@m.os.cx)

Constructor & Destructor Documentation

FileReference::FileReference

(

)

FileReference::FileReference	(	const String &	cPath,
		bool	bFollowLinks = false
	)

References os::String::c_str(), os::FileReference::Private::m_cDirectory, os::FileReference::Private::m_cName, os::FSNode::SetTo(), and os::String::size().

FileReference::FileReference	(	const Directory &	cDir,
		const String &	cName,
		bool	bFollowLinks = false
	)

References os::SymLink::ConstructPath(), os::Path::GetPath(), os::FileReference::Private::m_cDirectory, os::FileReference::Private::m_cName, SetTo(), and os::FSNode::SetTo().

FileReference::FileReference

(

const FileReference &

cRef

)

References os::FileReference::Private::m_cDirectory, and os::FileReference::Private::m_cName.

FileReference::~FileReference ( )

virtual

Member Function Documentation

status_t FileReference::Delete

(

)

References os::String::c_str(), and GetPath().

const Directory & FileReference::GetDirectory

(

)

const

References os::FileReference::Private::m_cDirectory.

Referenced by os::FSNode::FSNode(), and os::FSNode::SetTo().

String FileReference::GetName

(

)

const

References os::FileReference::Private::m_cName.

Referenced by os::FSNode::FSNode(), and os::FSNode::SetTo().

status_t FileReference::GetPath

(

String *

pcPath

)

const

References os::Directory::GetPath(), os::FileReference::Private::m_cDirectory, and os::FileReference::Private::m_cName.

Referenced by Delete(), InfoDialog(), and RenameDialog().

status_t FileReference::GetStat

(

struct stat *

psStat

)

const

References os::String::c_str(), os::FSNode::GetFileDescriptor(), os::FileReference::Private::m_cDirectory, and os::FileReference::Private::m_cName.

Window * FileReference::InfoDialog	(	const Messenger &	cMsgTarget,
		Message *	pcChangeMsg
	)

Description:

This dialog will show information about a file like its name, size and type. It is also possible to change the file type. If any changes have been made, then a message will be sent to the supplied message target.

Note:

Don’t forget to place the window at the right position and show it.

Parameters

cMsgTarget	- The target that will receive the message.
pcMsg	- The message that will be sent.

Author

Arno Klenke (arno_.nosp@m.klen.nosp@m.ke@ya.nosp@m.hoo..nosp@m.de)

References GetPath().

bool FileReference::IsValid

(

void

)

const

References os::FSNode::IsValid(), and os::FileReference::Private::m_cDirectory.

Referenced by os::FSNode::FSNode(), os::NodeMonitor::NodeMonitor(), os::FSNode::SetTo(), and os::NodeMonitor::SetTo().

status_t FileReference::Rename

(

const String &

cNewName

)

References os::String::c_str(), os::Directory::GetPath(), os::FileReference::Private::m_cDirectory, os::FileReference::Private::m_cName, and SetTo().

Referenced by RenameFileWin::HandleMessage().

Window * FileReference::RenameDialog	(	const Messenger &	cMsgTarget,
		Message *	pcMsg
	)

Description:

The created window contains an input field where the user can type the new name of the directory/file. A message will be sent to the supplied message target if the file/directory has been renamed.

Note:

Don’t forget to place the window at the right position and show it.

Parameters

cMsgTarget	- The target that will receive the message.
pcMsg	- The message that will be sent.

Author

Arno Klenke (arno_.nosp@m.klen.nosp@m.ke@ya.nosp@m.hoo..nosp@m.de)

References GetPath().

int FileReference::SetTo	(	const String &	cPath,
		bool	bFollowLinks = false
	)

References os::errno_exception::error().

Referenced by FileReference(), os::Directory::GetNextEntry(), Rename(), and SetTo().

int FileReference::SetTo	(	const Directory &	cDir,
		const String &	cName,
		bool	bFollowLinks = false
	)

References os::errno_exception::error(), and SetTo().

status_t FileReference::SetTo

(

const FileReference &

cRef

)

References os::FileReference::Private::m_cDirectory, os::FileReference::Private::m_cName, and os::FSNode::SetTo().

void FileReference::Unset

(

)

References os::FileReference::Private::m_cDirectory, and os::FSNode::Unset().