Fix text direction issue for InsetInfo in RTL context

[lyx.git] / src / BranchList.h

diff --git a/src/BranchList.h b/src/BranchList.h
index 893d8f9b6352657d2268928b44554462c91b5aea..e3e18e1c71f49ba2ae9f305a43633052545318cd 100644 (file)
--- a/src/BranchList.h
+++ b/src/BranchList.h
@@ -3,11 +3,25 @@
  * \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.
- *
- *
+ */
+
+#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,50 +29,58 @@
  * 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 <string>
-#include <list>
-
-
 class Branch {
 public:
        ///
-       std::string const & getBranch() const;
+       Branch();
        ///
-       void setBranch(std::string const &);
+       docstring const & branch() const;
        ///
-       bool getSelected() 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);
        ///
-       std::string const & getColor() const;
+       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:
        ///
-       std::string branch_;
+       docstring branch_;
        ///
        bool selected_;
        ///
-       std::string color_;
+       bool filenameSuffix_;
+       ///
+       RGBColor color_;
 };
 
 
@@ -69,33 +91,48 @@ public:
        typedef List::const_iterator const_iterator;
 
        ///
-       BranchList() : separator_("|") {}
+       BranchList() : separator_(from_ascii("|")) {}
+
+       ///
+       docstring separator() const { return separator_; }
 
        ///
-       bool empty() { return list.empty(); }
+       bool empty() const { return list.empty(); }
+       ///
+       void clear() { list.clear(); }
        ///
        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(std::string const & name);
-       Branch const * find(std::string const & name) const;
+       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(std::string const &);
+       bool add(docstring const &);
        /** remove a branch from list by name
         *  \returns true if a branch is removed.
         */
-       bool remove(std::string const &);
+       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;
        ///
-       std::string separator_;
+       docstring separator_;
 };
 
-#endif
+} // namespace lyx
+
+#endif // BRANCHLIST_H