X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FCounters.h;h=57fff35faee57d094245a4870e88955f338fc6d3;hb=4e50da3e655b9f8d26f7d5e439d72b219d32279d;hp=e411bbb26cd94b3bb148ebdb9d11bc39fa75bfdd;hpb=196d9caeb0b9f74d02750f774de1ca63a483803f;p=lyx.git diff --git a/src/Counters.h b/src/Counters.h index e411bbb26c..57fff35fae 100644 --- a/src/Counters.h +++ b/src/Counters.h @@ -17,7 +17,7 @@ #include "OutputEnums.h" -#include "support/strfwd.h" +#include "support/docstring.h" #include #include @@ -52,12 +52,12 @@ public: void step(); /// void reset(); - /// Returns the master counter of this counter. - docstring const & master() const; - /// Checks if the master counter is cnt, and if so removes + /// Returns the parent counter of this counter. + docstring const & parent() const; + /// Checks if the parent 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); + /// \return whether we removed the parent. + bool checkAndRemoveParent(docstring const & cnt); /// Returns a LaTeX-like string to format the counter. /** This is similar to what one gets in LaTeX when using * "\the". The \c in_appendix bool tells whether we @@ -69,6 +69,8 @@ public: docstring const & prettyFormat() const { return prettyformat_; } /// docstring const & guiName() const { return guiname_; } + /// + docstring const & latexName() const { return latexname_; } /// Returns a map of LaTeX-like strings to format the counter. /** For each language, the string is similar to what one gets @@ -87,12 +89,12 @@ private: int initial_value_; /// int saved_value_; - /// contains master counter name. - /** The master counter is the counter that, if stepped + /// contains parent counter name. + /** The parent counter is the counter that, if stepped * (incremented) zeroes this counter. E.g. "subsection"'s - * master is "section". + * parent is "section". */ - docstring master_; + docstring parent_; /// Contains a LaTeX-like string to format the counter. docstring labelstring_; /// The same as labelstring_, but in appendices. @@ -101,6 +103,8 @@ private: docstring prettyformat_; /// docstring guiname_; + /// The name used for the counter in LaTeX + docstring latexname_; /// Cache of the labelstring with \\the expressions expanded, /// indexed by language mutable StringMap flatlabelstring_; @@ -119,10 +123,10 @@ public: /// from the document class (e.g., which ones are defined). /// Instead, call Counters::reset(). Counters(); - /// Add new counter newc having masterc as its master, + /// Add new counter newc having parentc its parent, /// ls as its label, and lsa as its appendix label. void newCounter(docstring const & newc, - docstring const & masterc, + docstring const & parentc, docstring const & ls, docstring const & lsa, docstring const & guiname); @@ -143,14 +147,14 @@ public: void saveValue(docstring const & ctr) const; /// void restoreValue(docstring const & ctr) const; - /// Reset recursively all the counters that are slaves of the one named by \c ctr. - void resetSlaves(docstring const & ctr); - /// Increment by one master of counter named by \c ctr. + /// Reset recursively all the counters that are children of the one named by \c ctr. + void resetChildren(docstring const & ctr); + /// Increment by one the parent of counter named by \c ctr. /// This also resets the counter named by \c ctr. /// \param utype determines whether we track the counters. - void stepMaster(docstring const & ctr, UpdateType utype); - /// Increment by one counter named by \c ctr, and zeroes slave - /// counter(s) for which it is the master. + void stepParent(docstring const & ctr, UpdateType utype); + /// Increment by one counter named by \c ctr, and zeroes child + /// counter(s) for which it is the parent. /// \param utype determines whether we track the counters. void step(docstring const & ctr, UpdateType utype); /// Reset all counters, and all the internal data structures @@ -158,12 +162,10 @@ public: void reset(); /// Reset counters matched by match string. void reset(docstring const & match); + /// Copy counter \p cnt to \p newcnt. + bool copy(docstring const & cnt, docstring const & newcnt); /// 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 const & from, Counters & to, - docstring const & match = docstring()); /** returns the expanded string representation of counter \c * c. The \c lang code is used to translate the string. */ @@ -181,6 +183,8 @@ public: std::string const & lang) const; /// docstring const & guiName(docstring const & cntr) const; + /// + docstring const & latexName(docstring const & cntr) const; /// Are we in appendix? bool appendix() const { return appendix_; } /// Set the state variable indicating whether we are in appendix.