]> git.lyx.org Git - lyx.git/blobdiff - src/TocBackend.h
* Only enter inset which return true on isActive(). This is the behavior in the curso...
[lyx.git] / src / TocBackend.h
index 38d638ffedeff6531403365175b4925ae0422f60..75f0ea4ffd66b95bc54eb9415f625c6ea305a95a 100644 (file)
@@ -41,7 +41,8 @@ public:
        ///
        TocItem(ParConstIterator const & par_it = ParConstIterator(),
                int d = -1,
-               docstring const & s = docstring());
+               docstring const & s = docstring()
+               );
        ///
        ~TocItem() {}
        ///
@@ -57,7 +58,7 @@ public:
 
        /// the action corresponding to the goTo above
        FuncRequest action() const;
-       
+
 protected:
        /// Current position of item.
        ParConstIterator par_it_;
@@ -105,12 +106,15 @@ public:
        ///
        Toc const & toc(std::string const & type) const;
        /// Return the first Toc Item before the cursor
-       TocIterator const item(std::string const & type, ParConstIterator const &) const;
+       TocIterator const item(
+               std::string const & type, ///< Type of Toc.
+               ParConstIterator const & ///< The cursor location in the document.
+               ) const;
 
        void writePlaintextTocList(std::string const & type, odocstream & os) const;
 
 private:
-       /// 
+       ///
        TocList tocs_;
        ///
        Buffer const * buffer_;