Directory pager is a paged string list for directory file names. More...
#include <memory.h>
Inheritance diagram for ucommon::DirPager:
Collaboration diagram for ucommon::DirPager:
Public Member Functions | |
| DirPager (char *path) | |
| char * | get (unsigned item) |
| Get string item from list. | |
| operator bool () | |
| bool | operator! () |
| char * | operator* () |
| void | operator= (char *path) |
| char * | operator[] (unsigned item) |
| Return specified filename from directory list. | |
Protected Member Functions | |
| virtual bool | filter (char *filename) |
| Filter filenames in a derived class. | |
| bool | load (char *path) |
| Load a directory path. | |
Protected Attributes | |
| char * | dir |
Detailed Description
Directory pager is a paged string list for directory file names.
This protocol is used to convert a directory into a list of filenames. As a protocol it offers a filtering method to select which files to include in the list.
Member Function Documentation
| virtual bool ucommon::DirPager::filter | ( | char * | filename | ) | [protected, virtual] |
Filter filenames in a derived class.
- Parameters:
-
filename to filter.
- Returns:
- true if include in final list.
| char* ucommon::DirPager::get | ( | unsigned | item | ) | [inline] |
Get string item from list.
This is useful when stringpager is passed as a pointer and hence inconvenient for the [] operator.
- Parameters:
-
item to access.
- Returns:
- pointer to text for item, or NULL if out of range.
Reimplemented from ucommon::stringpager.
| bool ucommon::DirPager::load | ( | char * | path | ) | [protected] |
Load a directory path.
- Parameters:
-
path to load.
- Returns:
- true if valid.
| char* ucommon::DirPager::operator[] | ( | unsigned | item | ) | [inline] |
Return specified filename from directory list.
This is a convenience operator.
- Parameters:
-
item to access.
- Returns:
- text of item or NULL if invalid.
Reimplemented from ucommon::stringpager.
The documentation for this class was generated from the following file:
- ucommon/memory.h
