CLAM-Development  1.4.0
Public Member Functions
CLAM::InFilename Class Reference

Input file name configuration field. More...

#include <Filename.hxx>

List of all members.

Public Member Functions

 InFilename (const std::string &s="")
 InFilename (const char *s)
- Public Member Functions inherited from CLAM::Filename
 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.
- Public Member Functions inherited from CLAM::Text
 Text ()
 Text (const std::string &value)
 Text (const char *value)

Detailed Description

Input file name configuration field.

Common operations on std::string are available to this field. Specialize this class for concrete input file formats by redefining Filename::Filter and Filename::TypeFamily.

class InImageFilename : public InFilename
{
public:
InImageFilename(const std::string & s="") : InFilename(s) {}
InImageFilename(const char * s) : InFilename(s) {}
virtual const char * TypeFamily() const { return "Image"; }
virtual const Filter * Filters() const
{
static const Filter filters[] = {
{"Portable Network Graphics", "*.png"},
{"JPEG Image", "*.jpg"},
{"Scalable Vector Graphics", "*.svg"},
{0,0}
};
return filters;
}
};
CLAM_TYPEINFOGROUP(BasicCTypeInfo, InImageFilename);
See also:
OutFilename

Definition at line 102 of file Filename.hxx.


Constructor & Destructor Documentation

CLAM::InFilename::InFilename ( const std::string &  s = "")
inline

Definition at line 105 of file Filename.hxx.

CLAM::InFilename::InFilename ( const char *  s)
inline

Definition at line 106 of file Filename.hxx.


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