src/InsetList.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetList.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef INSET_LIST_H
  13 #define INSET_LIST_H
  14
  15 #include "insets/InsetCode.h"
  16
  17 #include "support/types.h"
  18
  19 #include <vector>
  20
  21
  22 namespace lyx {
  23
  24 class Inset;
  25 class Buffer;
  26
  27 ///
  28 class InsetList {
  29 public:
  30         ///
  31         InsetList() {}
  32         ///
  33         InsetList(InsetList const &);
  34
  35         ///
  36         class InsetTable {
  37         public:
  38                 ///
  39                 InsetTable(pos_type p, Inset * i) : pos(p), inset(i) {}
  40                 ///
  41                 pos_type pos;
  42                 ///
  43                 Inset * inset;
  44         };
  45         ///
  46         typedef std::vector<InsetTable> List;
  47         ///
  48         typedef List::iterator iterator;
  49         ///
  50         typedef List::const_iterator const_iterator;
  51
  52         ///
  53         ~InsetList();
  54         ///
  55         iterator begin() { return list_.begin(); }
  56         ///
  57         iterator end() { return list_.end(); }
  58         ///
  59         const_iterator begin() const { return list_.begin(); }
  60         ///
  61         const_iterator end() const { return list_.end(); }
  62         ///
  63         bool empty() const { return list_.empty(); }
  64         ///
  65         iterator insetIterator(pos_type pos);
  66         ///
  67         const_iterator insetIterator(pos_type pos) const;
  68         ///
  69         void insert(Inset * inset, pos_type pos);
  70         ///
  71         void erase(pos_type pos);
  72         ///
  73         Inset * release(pos_type);
  74         ///
  75         Inset * get(pos_type pos) const;
  76         ///
  77         void increasePosAfterPos(pos_type pos);
  78         ///
  79         void decreasePosAfterPos(pos_type pos);
  80
  81         /// search for next occurence of an \c Inset type.
  82         /// \return the position of the found inset.
  83         /// \retval -1 if no \c Inset is found.
  84         pos_type find(
  85                 InsetCode code, ///< Code of inset to find.
  86                 pos_type startpos = 0 ///< start position for the search.
  87                 ) const;
  88
  89         /// count occurences of of an \c Inset type.
  90         /// \return the number of found inset(s).
  91         int count(
  92                 InsetCode code, ///< Code of inset type to count.
  93                 pos_type startpos = 0 ///< start position for the counting.
  94                 ) const;
  95
  96 private:
  97         ///
  98         List list_;
  99 };
 100
 101
 102 } // namespace lyx
 103
 104 #endif