Update status

[lyx.git] / src / BranchList.h

diff --git a/src/BranchList.h b/src/BranchList.h
index 3b6b2554fe63d4e64a04eee89fa28f1c4f82f569..e3e18e1c71f49ba2ae9f305a43633052545318cd 100644 (file)
--- a/src/BranchList.h
+++ b/src/BranchList.h
@@ -1,13 +1,27 @@
-// -*- C++ -*- 
+// -*- C++ -*-
 /**
- * \file BranchList.h 
+ * \file BranchList.h
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
- * \author Martin Vermeer
- * 
- * Full author contact details are available in file CREDITS.
  *
+ * \author Martin Vermeer
  *
+ * Full author contact details are available in file CREDITS.
+ */
+
+#ifndef BRANCHLIST_H
+#define BRANCHLIST_H
+
+#include "ColorCode.h"
+
+#include "support/docstring.h"
+
+#include <list>
+
+
+namespace lyx {
+
+/**
  * \class Branch
  *
  * A class describing a 'branch', i.e., a named alternative for
@@ -15,92 +29,110 @@
  * other parts.
  *
  * A branch has a name, can either be selected or not, and uses a
- * user-specifyable background colour. All these can be set and
+ * user-specifiable background colour. All these can be set and
  * queried.
- * 
+ *
  * \class BranchList
  *
  * A class containing a vector of all defined branches within a
- * document. Has methods for selecting or deselecting branches by
+ * document. It has methods for selecting or deselecting branches by
  * name, for outputting a '|'-separated string of all elements or only
  * the selected ones, and for adding and removing elements.
  */
 
-
-#ifndef BRANCHES_H
-#define BRANCHES_H
-
-#include "LString.h"
-#include <list>
-
 class Branch {
 public:
        ///
-       string const getBranch() const;
-       ///
-       void setBranch(string const &);
-       ///
-       bool getSelected() const;
-       ///
-       void setSelected(bool);
-       /// 
-       string const getColor() const;
-       ///
-       void setColor(string const &);
-
+       Branch();
+       ///
+       docstring const & branch() const;
+       ///
+       void setBranch(docstring const &);
+       ///
+       bool isSelected() const;
+       /** Select/deselect the branch.
+        *  \return true if the selection status changes.
+        */
+       bool setSelected(bool);
+       /** If true, the branch name will be appended
+        *  to the output file name.
+        */
+       bool hasFileNameSuffix() const;
+       /// Select/deselect filename suffix property.
+       void setFileNameSuffix(bool);
+       ///
+       RGBColor const & color() 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:
        ///
-       string branch_;
+       docstring branch_;
        ///
        bool selected_;
        ///
-       string color_;
+       bool filenameSuffix_;
+       ///
+       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(); }
+       BranchList() : separator_(from_ascii("|")) {}
+
        ///
-       List::const_iterator begin() const { return list.begin(); }
+       docstring separator() const { return separator_; }
+
        ///
-       List::const_iterator end() const { return list.end(); }
+       bool empty() const { return list.empty(); }
        ///
-       string getColor(string const &) const;
-       ///     
-       void setColor(string const &, string const &);
-       /// Select/deselect multiple branches given in '|'-separated string
-       void setSelected(string const &, bool);
-       /// Add multiple branches to list
-       void add(string const &);
-       /// remove a branch from list by name
-       void remove(string const &);
-       /// return whether this branch is selected
-       bool selected(string const &) const;
-       /// return, as a '|'-separated string, all branch names
-       string allBranches() const;
-       /// 
-       string allSelected() const;
+       void clear() { list.clear(); }
        ///
-       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 &);
+       /** rename an branch in list
+        *  \returns true if renaming succeeded.
+        * if \p merge is true, the branch will be removed
+        * if a branch with the newname already exists.
+        */
+       bool rename(docstring const &, docstring const &, bool const merge = false);
+       /// get the complete filename suffix
+       docstring getFileNameSuffix() const;
+
 private:
        ///
        List list;
        ///
-       string separator_;
+       docstring separator_;
 };
 
-#endif
+} // namespace lyx
+
+#endif // BRANCHLIST_H