Take into account the latex encoding when generating math preview snippets.

[lyx.git] / src / BranchList.h

diff --git a/src/BranchList.h b/src/BranchList.h
index aaa5f15ecd548c5a8cc3bc2276a728d2b1b5cc6c..00814ab95722e2aa3258bfd257a10d339f19f689 100644 (file)
--- a/src/BranchList.h
+++ b/src/BranchList.h
@@ -30,78 +30,93 @@
 #ifndef BRANCHES_H
 #define BRANCHES_H
 
-#include <string>
+#include "ColorCode.h"
+
+#include "support/docstring.h"
+
 #include <list>
 
 
+namespace lyx {
+
+
 class Branch {
 public:
        ///
-       std::string const getBranch() const;
-       ///
-       void setBranch(std::string const &);
-       ///
-       bool getSelected() const;
+       Branch();
        ///
-       void setSelected(bool);
+       docstring const & getBranch() const;
        ///
-       std::string const getColor() const;
+       void setBranch(docstring const &);
        ///
+       bool getSelected() const;
+       /** Select/deselect the branch.
+        *  \return true if the selection status changes.
+        */
+       bool setSelected(bool);
+       ///
+       RGBColor const & getColor() const;
+       ///
+       void setColor(RGBColor const &);
+       /**
+        * Set color from a string "#rrggbb".
+        * Use Color:background if the string is no valid color.
+        * This ensures compatibility with LyX 1.4.0 that had the symbolic
+        * color "none" that was displayed as Color:background.
+        */
        void setColor(std::string const &);
 
-
 private:
        ///
-       std::string branch_;
+       docstring branch_;
        ///
        bool selected_;
        ///
-       std::string color_;
+       RGBColor color_;
 };
 
 
 class BranchList {
-public:
-       ///
-       BranchList() : separator_("|") {}
-
        ///
        typedef std::list<Branch> List;
+public:
+       typedef List::const_iterator const_iterator;
 
        ///
-       void clear();
-       ///
-       bool empty() { return list.empty(); }
-       ///
-       bool size() const { return list.size(); }
-       ///
-       List::const_iterator begin() const { return list.begin(); }
-       ///
-       List::const_iterator end() const { return list.end(); }
-       ///
-       std::string getColor(std::string const &) const;
+       BranchList() : separator_(from_ascii("|")) {}
+
        ///
-       void setColor(std::string const &, std::string const &);
-       /// Select/deselect multiple branches given in '|'-separated string
-       void setSelected(std::string const &, bool);
-       /// Add multiple branches to list
-       void add(std::string const &);
-       /// remove a branch from list by name
-       void remove(std::string const &);
-       /// return whether this branch is selected
-       bool selected(std::string const &) const;
-       /// return, as a '|'-separated string, all branch names
-       std::string allBranches() const;
+       bool empty() const { return list.empty(); }
        ///
-       std::string allSelected() const;
+       void clear() { list.clear(); }
        ///
-       std::string const separator() const;
+       const_iterator begin() const { return list.begin(); }
+       const_iterator end() const { return list.end(); }
+
+       /** \returns the Branch with \c name. If not found, returns 0.
+        */
+       Branch * find(docstring const & name);
+       Branch const * find(docstring const & name) const;
+
+       /** Add (possibly multiple (separated by separator())) branches to list
+        *  \returns true if a branch is added.
+        */
+       bool add(docstring const &);
+       /** remove a branch from list by name
+        *  \returns true if a branch is removed.
+        */
+       bool remove(docstring const &);
 
 private:
        ///
        List list;
        ///
-       std::string separator_;
+       docstring separator_;
 };
 
+
+
+
+} // namespace lyx
+
 #endif