* \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 BRANCHLIST_H
-#define BRANCHLIST_H
-
-#include "ColorCode.h"
-
-#include "support/docstring.h"
-
-#include <list>
-
-
-namespace lyx {
-
class Branch {
public:
///
/** If true, the branch name will be appended
* to the output file name.
*/
- bool hasFilenameSuffix() const;
+ bool hasFileNameSuffix() const;
/// Select/deselect filename suffix property.
- void setFilenameSuffix(bool);
+ void setFileNameSuffix(bool);
///
RGBColor const & color() const;
///
BranchList() : separator_(from_ascii("|")) {}
///
- bool empty() const { return list.empty(); }
+ docstring separator() const { return separator_; }
+
+ ///
+ bool empty() const { return list_.empty(); }
///
- void clear() { list.clear(); }
+ void clear() { list_.clear(); }
///
- const_iterator begin() const { return list.begin(); }
- const_iterator end() const { return list.end(); }
+ 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.
*/
*/
bool rename(docstring const &, docstring const &, bool const merge = false);
/// get the complete filename suffix
- docstring getFilenameSuffix() const;
+ docstring getFileNameSuffix() const;
private:
///
- List list;
+ List list_;
///
docstring separator_;
};