]> git.lyx.org Git - lyx.git/blobdiff - src/Counters.h
Correction: The inset name is citation, not cite
[lyx.git] / src / Counters.h
index 71ae36e8a6113c979e61619f3544ef54968db8c6..511c4902c84230c26e2dddf52fb1814f9878b691 100644 (file)
@@ -20,7 +20,7 @@
 #include "support/docstring.h"
 
 #include <map>
-#include <deque>
+#include <vector>
 
 
 namespace lyx {
@@ -50,6 +50,10 @@ public:
        void reset();
        /// Returns the master counter of this counter.
        docstring const & master() const;
+       /// Checks if the master counter is cnt, and if so removes
+       /// it. This is used when a counter is deleted.
+       /// \return whether we removed the master.
+       bool checkAndRemoveMaster(docstring const & cnt);
        /// Returns a LaTeX-like string to format the counter. 
        /** This is similar to what one gets in LaTeX when using
         *  "\the<counter>". The \c in_appendix bool tells whether we
@@ -97,7 +101,10 @@ private:
 /// Every instantiation is an array of counters of type Counter.
 class Counters {
 public:
-       ///
+       /// NOTE Do not call this in an attempt to clear the counters.
+       /// That will wipe out all the information we have about them
+       /// from the document class (e.g., which ones are defined).
+       /// Instead, call Counters::reset().
        Counters();
        /// Add new counter newc having masterc as its master, 
        /// ls as its label, and lsa as its appendix label.
@@ -124,10 +131,13 @@ public:
        /// step 0->1. Seems to be sufficient.
        /// \param utype determines whether we track the counters.
        void step(docstring const & ctr, UpdateType utype);
-       /// Reset all counters.
+       /// Reset all counters, and all the internal data structures
+       /// used for keeping track of their values.
        void reset();
        /// Reset counters matched by match string.
        void reset(docstring const & match);
+       /// Remove counter \p cnt.
+       bool remove(docstring const & cnt);
        /// Copy counters whose name matches match from the &from to
        /// the &to array of counters. Empty string matches all.
        void copy(Counters & from, Counters & to,
@@ -188,7 +198,7 @@ private:
         */
        docstring flattenLabelString(docstring const & counter, bool in_appendix,
                                     std::string const &lang,
-                                    std::deque<docstring> & callers) const;
+                                    std::vector<docstring> & callers) const;
        /// Returns the value of the counter according to the
        /// numbering scheme numbertype.
        /** Available numbering schemes are arabic (1, 2,...), roman
@@ -213,9 +223,9 @@ private:
        /// Are we in a subfloat?
        bool subfloat_;
        /// Used to keep track of active counters.
-       std::deque<docstring> counter_stack_;
+       std::vector<docstring> counter_stack_;
        /// Same, but for last layout.
-       std::deque<Layout const *> layout_stack_;
+       std::vector<Layout const *> layout_stack_;
 };
 
 } // namespace lyx