]> git.lyx.org Git - lyx.git/blobdiff - src/BranchList.h
bit of cleanup to avoid ambiguities (in the sense of cell vs column)
[lyx.git] / src / BranchList.h
index 08a719a1c7cbb0c92076839cf330680eebc25478..1438f8275a5203be8ed89d3f7b5fb96eb7442f4e 100644 (file)
@@ -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
  * 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:
        ///
@@ -53,6 +54,12 @@ public:
         *  \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 & color() const;
        ///
@@ -71,6 +78,8 @@ private:
        ///
        bool selected_;
        ///
+       bool filenameSuffix_;
+       ///
        RGBColor color_;
 };
 
@@ -111,6 +120,8 @@ public:
         * 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:
        ///