X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBranchList.h;h=60e6b8d26c205f1b3c26ca28afd2785500004732;hb=eeb36e808c9726fd3689926a3c20457e3b801341;hp=3f2978acee0d96b31b245a54f57b6f5ef5a5f819;hpb=00e305c9d9bd8b0ff54b6c58adb6192d5934ed60;p=lyx.git diff --git a/src/BranchList.h b/src/BranchList.h index 3f2978acee..60e6b8d26c 100644 --- 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 + + +namespace lyx { + +/** * \class Branch * * A class describing a 'branch', i.e., a named alternative for @@ -15,64 +29,72 @@ * 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 "support/docstring.h" - -#include - - -namespace lyx { - - class Branch { public: /// - Branch(); + Branch() {} /// - docstring const & getBranch() const; + docstring const & branch() 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); + /// + void setListID(int const id) { branch_list_id_ = id; } /// - RGBColor const & getColor() const; + std::string const & color() const; /// - void setColor(RGBColor const &); + std::string const & lightModeColor() const; + /// + std::string const & darkModeColor() const; /** - * Set color from a string "#rrggbb". - * Use LColor:background if the string is no valid color. + * Set background color from a hexcolor string "#rrggbb" or a lyx color name. + * 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. + * This sets the dark color if in dark mode, else the light color. */ - void setColor(std::string const &); + void setColor(std::string const & color); + /// Set dark and light background colors + void setColors(std::string const & color, + std::string const & dmcolor = std::string()); + /// + int listID() const { return branch_list_id_; } private: /// docstring branch_; /// - bool selected_; + bool selected_ = false; + /// + bool filenameSuffix_ = false; + /// light mode background color + std::string lmcolor_ = "background"; + /// dark mode background color + std::string dmcolor_ = "background"; /// - RGBColor color_; + int branch_list_id_ = 0; }; @@ -83,15 +105,21 @@ public: typedef List::const_iterator const_iterator; /// - BranchList() : separator_(from_ascii("|")) {} + BranchList() : separator_(from_ascii("|")), id_(rand()) {} /// - bool empty() const { return list.empty(); } + docstring separator() const { return separator_; } + /// - void clear() { list.clear(); } + int id() const { return id_; } + /// - const_iterator begin() const { return list.begin(); } - const_iterator end() const { return list.end(); } + 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. */ @@ -106,28 +134,24 @@ public: * \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; + List list_; /// docstring separator_; + /// + int id_; }; - -class BranchNamesEqual : public std::unary_function { -public: - BranchNamesEqual(docstring const & name) - : name_(name) {} - bool operator()(Branch const & branch) const - { - return branch.getBranch() == name_; - } -private: - docstring name_; -}; - - } // namespace lyx -#endif +#endif // BRANCHLIST_H