4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Martin Vermeer
9 * Full author contact details are available in file CREDITS.
15 #include "ColorCode.h"
17 #include "support/docstring.h"
27 * A class describing a 'branch', i.e., a named alternative for
28 * selectively outputting some parts of a document while suppressing
31 * A branch has a name, can either be selected or not, and uses a
32 * user-specifiable background colour. All these can be set and
37 * A class containing a vector of all defined branches within a
38 * document. It has methods for selecting or deselecting branches by
39 * name, for outputting a '|'-separated string of all elements or only
40 * the selected ones, and for adding and removing elements.
48 docstring const & branch() const;
50 void setBranch(docstring const &);
52 bool isSelected() const;
53 /** Select/deselect the branch.
54 * \return true if the selection status changes.
56 bool setSelected(bool);
57 /** If true, the branch name will be appended
58 * to the output file name.
60 bool hasFileNameSuffix() const;
61 /// Select/deselect filename suffix property.
62 void setFileNameSuffix(bool);
64 void setListID(int const id) { branch_list_id_ = id; }
66 std::string const & color() const;
68 std::string const & lightModeColor() const;
70 std::string const & darkModeColor() const;
72 * Set background color from a hexcolor string "#rrggbb" or a lyx color name.
73 * Use Color:background if the string is no valid color.
74 * This ensures compatibility with LyX 1.4.0 that had the symbolic
75 * color "none" that was displayed as Color:background.
76 * This sets the dark color if in dark mode, else the light color.
78 void setColor(std::string const & color);
79 /// Set dark and light background colors
80 void setColors(std::string const & color,
81 std::string const & dmcolor = std::string());
83 int listID() const { return branch_list_id_; }
89 bool selected_ = false;
91 bool filenameSuffix_ = false;
92 /// light mode background color
93 std::string lmcolor_ = "background";
94 /// dark mode background color
95 std::string dmcolor_ = "background";
97 int branch_list_id_ = 0;
103 typedef std::list<Branch> List;
105 typedef List::const_iterator const_iterator;
108 BranchList() : separator_(from_ascii("|")), id_(rand()) {}
111 docstring separator() const { return separator_; }
114 int id() const { return id_; }
117 bool empty() const { return list_.empty(); }
119 void clear() { list_.clear(); }
121 const_iterator begin() const { return list_.begin(); }
122 const_iterator end() const { return list_.end(); }
124 /** \returns the Branch with \c name. If not found, returns 0.
126 Branch * find(docstring const & name);
127 Branch const * find(docstring const & name) const;
129 /** Add (possibly multiple (separated by separator())) branches to list
130 * \returns true if a branch is added.
132 bool add(docstring const &);
133 /** remove a branch from list by name
134 * \returns true if a branch is removed.
136 bool remove(docstring const &);
137 /** rename an branch in list
138 * \returns true if renaming succeeded.
139 * if \p merge is true, the branch will be removed
140 * if a branch with the newname already exists.
142 bool rename(docstring const &, docstring const &, bool const merge = false);
143 /// get the complete filename suffix
144 docstring getFileNameSuffix() const;
150 docstring separator_;
157 #endif // BRANCHLIST_H