---

WWhizFile Class Reference

Represents a file. More...

#include <WWhizInterface2.h>

Inheritance diagram for WWhizFile

[legend]Collaboration diagram for WWhizFile:

[legend]List of all members.

Public Methods
virtual const CString&	GetFullName ()const=0
virtual CString	GetCaseFullName ()const=0
virtual const CString&	GetShortName (void)const=0
	To facilitate faster file lookups, every file has a "short" title associated with it. More...
virtual const CString&	GetTitle (void)const=0
virtual const CString&	GetExt (void)const=0
virtual const CString&	GetPath (void)const=0
virtual const CTime&	GetTimeStamp (void)const=0
virtual WWhizTagList&	GetTagList (void)const=0
virtual void	SetShortName (const CString &shortName)=0
	Sets the short name of the file. More...
virtual void	SetTitle (const CString &title)=0
	Sets the file title of the file. More...
virtual void	SetExt (const CString &ext)=0
	Sets the extension of the file. More...
virtual void	SetPath (const CString &path)=0
	Sets the path of the file. More...
virtual void	SetTimeStamp (CTime timeStamp)=0
	Sets the time stamp of the file. More...
virtual WWhizTagList&	GetOrderedTagList (void)const=0
virtual bool	IsWorkspaceFile (void)const=0

---

Detailed Description

Represents a file.

---

Member Function Documentation

CString WWhizFile::GetCaseFullName ( ) const [pure virtual]

Returns: Returns the case-sensitive version of the full path name, as it appears on disk.

const CString & WWhizFile::GetExt ( void ) const [pure virtual]

Returns: Returns the lowercase file extension.

const CString & WWhizFile::GetFullName ( ) const [pure virtual]

Returns: Returns the lowercase version of the full path name.

WWhizTagList & WWhizFile::GetOrderedTagList ( void ) const [pure virtual]

Returns: Retrieves a non sorted tag list, ordered according their position within the file.

const CString & WWhizFile::GetPath ( void ) const [pure virtual]

Returns: Returns the case-sensitive path name.

const CString & WWhizFile::GetShortName ( void ) const [pure virtual]

To facilitate faster file lookups, every file has a "short" title associated with it. The short name is all lowercase and only contains alphanumeric characters. Underscores are not included. Do not use GetShortName() for the display of the file title. Instead, use GetTitle(). Returns: Returns the alphanumeric "short" title for the file.

WWhizTagList & WWhizFile::GetTagList ( void ) const [pure virtual]

Returns: Returns the tag list associated with this file.

const CTime & WWhizFile::GetTimeStamp ( void ) const [pure virtual]

Returns: Returns the file stamp of the file the last time WWhizInterface::RefreshFileList() was called.

const CString & WWhizFile::GetTitle ( void ) const [pure virtual]

Returns: Returns the case-sensitive file title.

bool WWhizFile::IsWorkspaceFile ( void ) const [pure virtual]

Returns: Returns whether this file is a member of the workspace or not.

void WWhizFile::SetExt ( const CString & ext ) [pure virtual]

Sets the extension of the file. Only use this function on file's returned via WWhizFileList::Create(). Parameters: ext   The new extension for the file.

void WWhizFile::SetPath ( const CString & path ) [pure virtual]

Sets the path of the file. Only use this function on file's returned via WWhizFileList::Create(). Parameters: ext   The new path for the file.

void WWhizFile::SetShortName ( const CString & shortName ) [pure virtual]

Sets the short name of the file. Only use this function on file's returned via WWhizFileList::Create(). Parameters: shortName   The new short name for the file.

void WWhizFile::SetTimeStamp ( CTime timeStamp ) [pure virtual]

Sets the time stamp of the file. Only use this function on file's returned via WWhizFileList::Create(). Parameters: ext   The new time stamp for the file.

void WWhizFile::SetTitle ( const CString & title ) [pure virtual]

Sets the file title of the file. Only use this function on file's returned via WWhizFileList::Create(). Parameters: title   The new title for the file.

---

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

• WWhizInterface2.h

---