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.
27 /// what appears in the ui
29 /// the filename, without any path
31 /// a short description for use in the ui
32 std::string description;
33 /// the LaTeX packages on which this depends, if any (not implemented)
34 std::vector<std::string> packageList;
35 /// whether those packages are available (not implemented yet)
39 typedef std::vector<LyXModule> LyXModuleList;
42 * The ModuleList represents the various LyXModule's that are available at
49 /// reads the modules from a file generated by configure.py
51 /// add a module to the list
52 void addLayoutModule(std::string const & name,
53 std::string const & filename, std::string const & description,
54 std::vector<std::string> const & packages);
56 LyXModuleList::const_iterator begin() const;
58 LyXModuleList::iterator begin();
60 LyXModuleList::const_iterator end() const;
62 LyXModuleList::iterator end();
64 bool empty() const { return modlist_.empty(); }
65 /// Returns a pointer to the LyXModule with name str.
66 /// Returns a null pointer if no such module is found.
67 LyXModule * operator[](std::string const & str);
70 ModuleList(ModuleList const &);
71 void operator=(ModuleList const &);
74 std::vector<LyXModule> modlist_;
77 extern ModuleList moduleList;