]> git.lyx.org Git - lyx.git/blobdiff - src/TocBackend.h
Remove boost/format support
[lyx.git] / src / TocBackend.h
index 176175d7f385d054784071292a90055d9c745d2d..2520927406dd15a2cebbf5aa86d4cf9d9be96c2d 100644 (file)
 #define TOC_BACKEND_H
 
 #include "DocIterator.h"
+#include "FuncRequest.h"
+#include "OutputEnums.h"
+#include "Toc.h"
 
-#include "support/shared_ptr.h"
 #include "support/strfwd.h"
 
-#include <map>
-#include <vector>
 #include <stack>
-#include <string>
 
 
 namespace lyx {
 
 class Buffer;
-class FuncRequest;
 
 
 /* FIXME: toc types are currently identified by strings. It cannot be converted
@@ -54,6 +52,8 @@ enum TocType {
        NOMENCL,//"nomencl"
        LISTING,//"listings"
        FLOAT,//"figure", "table", "algorithm", user-defined (from layout?)
+       MATH_MACRO,//"math-macro"
+       EXTERNAL,//"external"
        SENSELESS,//"senseless"
        TOC_TYPE_COUNT
 }
@@ -64,8 +64,8 @@ enum TocType {
 */
 class TocItem
 {
-       friend class Toc;
        friend class TocBackend;
+       friend class TocBuilder;
 
 public:
        /// Default constructor for STL containers.
@@ -75,7 +75,8 @@ public:
                int depth,
                docstring const & s,
                bool output_active,
-               docstring const & t = docstring()
+               docstring const & t = docstring(),
+               FuncRequest action = FuncRequest(LFUN_UNKNOWN_ACTION)
                );
        ///
        ~TocItem() {}
@@ -89,19 +90,22 @@ public:
        void str(docstring const & s) { str_ = s; }
        ///
        docstring const & tooltip() const;
-       ///
+       /// String for display, e.g. it has a mark if output is inactive
        docstring const asString() const;
        ///
        DocIterator const & dit() const { return dit_; }
        ///
        bool isOutput() const { return output_; }
-
-       /// the action corresponding to the goTo above
+       ///
+       void setAction(FuncRequest a) { action_ = a; }
+       /// custom action, or the default one (paragraph-goto) if not customised
        FuncRequest action() const;
 
 protected:
        /// Current position of item.
        DocIterator dit_;
+
+private:
        /// nesting depth
        int depth_;
        /// Full item string
@@ -110,25 +114,11 @@ protected:
        docstring tooltip_;
        /// Is this item in a note, inactive branch, etc?
        bool output_;
+       /// Custom action
+       FuncRequest action_;
 };
 
 
-///
-class Toc : public std::vector<TocItem>
-{
-public:
-       typedef std::vector<TocItem>::const_iterator const_iterator;
-       typedef std::vector<TocItem>::iterator iterator;
-       const_iterator item(DocIterator const & dit) const;
-       /// Look for a TocItem given its depth and string.
-       /// \return The first matching item.
-       /// \retval end() if no item was found.
-       iterator item(int depth, docstring const & str);
-};
-
-typedef Toc::const_iterator TocIterator;
-
-
 /// Caption-enabled TOC builders
 class TocBuilder
 {
@@ -156,16 +146,6 @@ private:
 };
 
 
-/// The ToC list.
-/// A class and no typedef because we want to forward declare it.
-class TocList : public std::map<std::string, shared_ptr<Toc> >
-{
-private:
-       // this can create null pointers
-       using std::map<std::string, shared_ptr<Toc> >::operator[];
-};
-
-
 ///
 class TocBuilderStore
 {
@@ -187,12 +167,18 @@ private:
 class TocBackend
 {
 public:
+       static Toc::const_iterator findItem(Toc const & toc,
+                                           DocIterator const & dit);
+       /// Look for a TocItem given its depth and string.
+       /// \return The first matching item.
+       /// \retval end() if no item was found.
+       static Toc::iterator findItem(Toc & toc, int depth, docstring const & str);
        ///
        TocBackend(Buffer const * buffer) : buffer_(buffer) {}
        ///
        void setBuffer(Buffer const * buffer) { buffer_ = buffer; }
        ///
-       void update(bool output_active);
+       void update(bool output_active, UpdateType utype);
        /// \return true if the item was updated.
        bool updateItem(DocIterator const & pit);
        ///
@@ -203,7 +189,7 @@ public:
        /// nevel null
        shared_ptr<TocBuilder> builder(std::string const & type);
        /// Return the first Toc Item before the cursor
-       TocIterator item(
+       Toc::const_iterator item(
                std::string const & type, ///< Type of Toc.
                DocIterator const & dit ///< The cursor location in the document.
        ) const;
@@ -211,6 +197,8 @@ public:
        ///
        void writePlaintextTocList(std::string const & type,
                odocstringstream & os, size_t max_length) const;
+       ///
+       docstring outlinerName(std::string const & type) const;
 
 private:
        ///