CLAM::Filename Class Reference

This class is a base class for configuration fields representing file names. More...

#include <Filename.hxx>

List of all members.

Classes
struct	Filter
	Item of a Filename filter definition. More...
Public Member Functions
	Filename ()
	Filename (const std::string &s)
	Filename (const char *s)
virtual	~Filename ()
virtual const char *	TypeFamily () const
	Rewrite this method to set a name for the type family name. It is used to build messages such as 'Open the audio file' where 'audio' is the type family.
virtual const Filter *	Filters () const
	Rewrite this method to define the set of filters that subclasses bounds to. See the examples on how to return it. Last item should be {0,0} for class users to stop iterating.

---

Detailed Description

This class is a base class for configuration fields representing file names.

By deriving from Text you have most of the std::string operations available and input serialization supporting spaces on reading.

Use InFilename and OutFilename subclasses to discriminate the serialization direction and subclass them to specify concrete filters and file type family names.

See also:

DirectoryName

Definition at line 44 of file Filename.hxx.

---

Constructor & Destructor Documentation

CLAM::Filename::Filename

(

)

[inline]

Definition at line 52 of file Filename.hxx.

CLAM::Filename::Filename

(

const std::string &

s

)

[inline]

Definition at line 53 of file Filename.hxx.

CLAM::Filename::Filename

(

const char *

s

)

[inline]

Definition at line 54 of file Filename.hxx.

virtual CLAM::Filename::~Filename

(

)

[inline, virtual]

Definition at line 55 of file Filename.hxx.

---

Member Function Documentation

virtual const Filter* CLAM::Filename::Filters

(

)

const [inline, virtual]

Rewrite this method to define the set of filters that subclasses bounds to. See the examples on how to return it. Last item should be {0,0} for class users to stop iterating.

Reimplemented in CLAM::AudioInFilename, CLAM::AudioOutFilename, CLAM::ControlTraceInFilename, CLAM::ControlTraceOutFilename, and CLAM::InSDIFFilename.

Definition at line 64 of file Filename.hxx.

virtual const char* CLAM::Filename::TypeFamily

(

)

const [inline, virtual]

Rewrite this method to set a name for the type family name. It is used to build messages such as 'Open the audio file' where 'audio' is the type family.

Reimplemented in CLAM::AudioInFilename, CLAM::AudioOutFilename, CLAM::ControlTraceInFilename, CLAM::ControlTraceOutFilename, and CLAM::InSDIFFilename.

Definition at line 60 of file Filename.hxx.

---

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

• Filename.hxx