4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
22 * This struct represents a particular LyX "module", which is a like a layout
23 * file, except that it does not stand alone. In that sense, it is more like
24 * a LaTeX package, where a layout file corresponds to a LaTeX class.
29 LyXModule(std::string n, std::string f, std::string d,
30 std::vector<std::string> p);
31 /// whether the required packages are available
33 /// what appears in the ui
35 /// the filename, without any path
37 /// a short description for use in the ui
38 std::string description;
39 /// the LaTeX packages on which this depends, if any (not implemented)
40 std::vector<std::string> packageList;
48 typedef std::vector<LyXModule> LyXModuleList;
51 * The ModuleList represents the various LyXModule's that are available at
58 /// reads the modules from a file generated by configure.py
60 /// add a module to the list
61 void addLayoutModule(std::string const & name,
62 std::string const & filename, std::string const & description,
63 std::vector<std::string> const & packages);
65 LyXModuleList::const_iterator begin() const;
67 LyXModuleList::iterator begin();
69 LyXModuleList::const_iterator end() const;
71 LyXModuleList::iterator end();
73 bool empty() const { return modlist_.empty(); }
74 /// Returns a pointer to the LyXModule with name str.
75 /// Returns a null pointer if no such module is found.
76 LyXModule * operator[](std::string const & str);
79 ModuleList(ModuleList const &);
80 void operator=(ModuleList const &);
83 std::vector<LyXModule> modlist_;
86 extern ModuleList moduleList;