lyx_mirror/src/BranchList.h

117 lines
2.4 KiB
C
Raw Normal View History

// -*- C++ -*-
/**
* \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.
*
*
* \class Branch
*
* A class describing a 'branch', i.e., a named alternative for
* selectively outputting some parts of a document while suppressing
* 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
* queried.
*
* \class BranchList
*
* A class containing a vector of all defined branches within a
* document. 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 <string>
#include <list>
class Branch {
public:
///
std::string const & getBranch() const;
///
void setBranch(std::string const &);
///
bool getSelected() const;
/** Select/deselect the branch.
* \return true if the selection status changes.
*/
bool setSelected(bool);
///
std::string const & getColor() const;
///
void setColor(std::string const &);
private:
///
std::string branch_;
///
bool selected_;
///
std::string color_;
};
class BranchList {
///
typedef std::list<Branch> List;
public:
typedef List::const_iterator const_iterator;
///
BranchList() : separator_("|") {}
///
bool empty() { 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.
*/
Branch * find(std::string const & name);
Branch const * find(std::string const & name) const;
/** Add (possibly multiple (separated by separator())) branches to list
* \returns true if a branch is added.
*/
bool add(std::string const &);
/** remove a branch from list by name
* \returns true if a branch is removed.
*/
bool remove(std::string const &);
private:
///
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_;
};
#endif