BazisLib::FilePath Class Reference
Represents a path to a file. More...
#include <file.h>
Collaboration diagram for BazisLib::FilePath:
Classes | |
| class | iterator |
Public Member Functions | |
| FilePath (const String &str) | |
| FilePath (const String::value_type *pszStr) | |
| FilePath * | operator-> () |
| String | GetFullPath () const |
| String | GetPathBase () const |
| String | GetFileNameBase () const |
| String | GetFileName () const |
| String | GetExtension () const |
| String | GetParentPath () const |
| FilePath | Parent () const |
| bool | UpOneLevel () |
| bool | IsAbsolute () const |
| bool | IsInCurrentDir () const |
| bool | IsValid () const |
| bool | AppendPath (const FilePath &Path) |
| FilePath | operator+ (const FilePath &addend) |
Static Public Member Functions | |
| static iterator | GetFirstRootPath () |
| static FilePath | GetCurrentPath () |
Static Private Attributes | |
| static FilePath & | InvalidPath |
Detailed Description
Represents a path to a file.The basic idea behind the FilePath class is to provide a platform-independent way of specifying file paths. No matter, what character is used as a separator, no matter what is the way of distinguishing between absolute and relative paths, the application should use the same API provided by this class. This class is a descendant of the String class that adds various methods for dealing with file paths. Let's introduce 3 main key points about file paths:
- Root path is a FS path to some pseudo-root object, such as a disk drive on Windows, or a mount point in Unix
- Parent path is a path to the directory that contains current file or dir
- File path base is the full file path except the extension
Constructor & Destructor Documentation
| BazisLib::FilePath::FilePath | ( | const String & | str | ) | [inline] |
| BazisLib::FilePath::FilePath | ( | const String::value_type * | pszStr | ) | [inline] |
Member Function Documentation
| bool BazisLib::FilePath::AppendPath | ( | const FilePath & | Path | ) | [inline] |
Here is the call graph for this function:
| FilePath BazisLib::FilePath::GetCurrentPath | ( | ) | [inline, static] |
| String BazisLib::FilePath::GetExtension | ( | ) | const [inline] |
| String BazisLib::FilePath::GetFileName | ( | ) | const [inline] |
| String BazisLib::FilePath::GetFileNameBase | ( | ) | const [inline] |
| FilePath::iterator BazisLib::FilePath::GetFirstRootPath | ( | ) | [inline, static] |
| String BazisLib::FilePath::GetFullPath | ( | ) | const [inline] |
| String BazisLib::FilePath::GetParentPath | ( | ) | const [inline] |
| String BazisLib::FilePath::GetPathBase | ( | ) | const [inline] |
| bool BazisLib::FilePath::IsAbsolute | ( | ) | const [inline] |
| bool BazisLib::FilePath::IsInCurrentDir | ( | ) | const [inline] |
| bool BazisLib::FilePath::IsValid | ( | ) | const [inline] |
Here is the call graph for this function:
| FilePath* BazisLib::FilePath::operator-> | ( | ) | [inline] |
| FilePath BazisLib::FilePath::Parent | ( | ) | const [inline] |
| bool BazisLib::FilePath::UpOneLevel | ( | ) | [inline] |
Member Data Documentation
FilePath& BazisLib::FilePath::InvalidPath [static, private] |
The documentation for this class was generated from the following files: