src/TextClassList.h

   1 // -*- C++ -*-
   2 /**
   3  * \file TextClassList.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef TEXTCLASSLIST_H
  13 #define TEXTCLASSLIST_H
  14
  15 #include "TextClass.h"
  16
  17 #include "support/strfwd.h"
  18 #include "support/types.h"
  19
  20 #include <vector>
  21
  22
  23 namespace lyx {
  24
  25 class Layout;
  26
  27 /// Reads the style files
  28 extern bool LyXSetStyle();
  29
  30 ///
  31 class TextClassList {
  32 public:
  33         ///
  34         TextClassList() {}
  35         ///
  36         typedef std::vector<TextClass> ClassList;
  37         ///
  38         typedef ClassList::const_iterator const_iterator;
  39         ///
  40         const_iterator begin() const { return classlist_.begin(); }
  41         ///
  42         const_iterator end() const { return classlist_.end(); }
  43         ///
  44         bool empty() const { return classlist_.empty(); }
  45
  46         /// Gets textclass number from name, -1 if textclass name does not exist
  47         std::pair<bool, TextClassIndex> const
  48         numberOfClass(std::string const & textClassName) const;
  49
  50         ///
  51         TextClass const & operator[](TextClassIndex index) const;
  52         TextClass & at(TextClassIndex index);
  53
  54         /// Read textclass list.  Returns false if this fails.
  55         bool read();
  56
  57         /// Clears the textclass so as to force it to be reloaded
  58         void reset(TextClassIndex const & index);
  59
  60         /// add a textclass from user local directory.
  61         /// Return ture/false, and textclass number
  62         std::pair<bool, TextClassIndex> const
  63         addTextClass(std::string const & textclass, std::string const & path);
  64
  65 private:
  66         /// noncopyable
  67         TextClassList(TextClassList const &);
  68         void operator=(TextClassList const &);
  69
  70         ///
  71         mutable ClassList classlist_;
  72 };
  73
  74 ///
  75 extern TextClassList textclasslist;
  76 ///
  77 TextClassIndex defaultTextclass();
  78
  79
  80 } // namespace lyx
  81
  82 #endif