* \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
* 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 "Color.h"
-
-#include <string>
-#include <list>
-
-
-namespace lyx {
-
-
class Branch {
public:
///
Branch();
///
- std::string const & getBranch() const;
+ docstring const & branch() const;
///
- void setBranch(std::string const &);
+ void setBranch(docstring const &);
///
- bool getSelected() 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 & getColor() const;
- ///
- void setColor(RGBColor const &);
+ std::string const & color() const;
/**
* Set color from a string "#rrggbb".
- * Use LColor:background if the string is no valid color.
+ * 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 LColor:background.
+ * color "none" that was displayed as Color:background.
*/
void setColor(std::string const &);
private:
///
- std::string branch_;
+ docstring branch_;
///
bool selected_;
///
- RGBColor color_;
+ bool filenameSuffix_;
+ ///
+ std::string color_;
};
typedef List::const_iterator const_iterator;
///
- BranchList() : separator_("|") {}
+ BranchList() : separator_(from_ascii("|")) {}
///
- bool empty() const { return list.empty(); }
+ docstring separator() const { return separator_; }
+
///
- void clear() { list.clear(); }
+ bool empty() const { return list_.empty(); }
///
- const_iterator begin() const { return list.begin(); }
- const_iterator end() const { return list.end(); }
+ 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;
+ List list_;
///
- std::string separator_;
-};
-
-
-class BranchNamesEqual : public std::unary_function<Branch, bool> {
-public:
- BranchNamesEqual(std::string const & name)
- : name_(name) {}
- bool operator()(Branch const & branch) const
- {
- return branch.getBranch() == name_;
- }
-private:
- std::string name_;
+ docstring separator_;
};
-
} // namespace lyx
-#endif
+#endif // BRANCHLIST_H