Src/FileLocation.h

   1 /**
   2  * @file FileLocation.h
   3  *
   4  * @brief Declaration for FileLocation class.
   5  *
   6  */
   7 // ID line follows -- this is updated by SVN
   8 // $Id$
   9
  10 #ifndef FileLocation_included
  11 #define FileLocation_included
  12
  13 #include "FileTextEncoding.h"
  14
  15 /**
  16  * @brief A structure containing file's path and encoding information.
  17  */
  18 struct FileLocation
  19 {
  20         String filepath; /**< Full path for the file. */
  21         FileTextEncoding encoding; /**< Encoding info for the file. */
  22
  23         /**
  24          * The default constructor.
  25          */
  26         FileLocation()
  27         {
  28         }
  29
  30         /**
  31          * The constructor taking a path as a parameter.
  32          * @param [in] path Full path for the file.
  33          */
  34         FileLocation(const String& path) : filepath(path)
  35         {
  36         }
  37
  38 // Methods
  39
  40         /**
  41          * Set the file path.
  42          * @param [in] sFilePath Full path for the file.
  43          */
  44         void setPath(const String & sFilePath) { this->filepath = sFilePath; }
  45
  46 // Copy constructor & copy operator should do the obvious correct things
  47 };
  48
  49 #endif // FileLocation_included