Counter();
///
Counter(docstring const & mc, docstring const & ls,
- docstring const & lsa);
+ docstring const & lsa, docstring const & guiname);
/// \return true on success
bool read(Lexer & lex);
///
///
int value() const;
///
+ void saveValue();
+ ///
+ void restoreValue();
+ ///
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<counter>". The \c in_appendix bool tells whether we
/// Similar, but used for formatted references in XHTML output.
/// E.g., for a section counter it might be "section \thesection"
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
/// This is actually one less than the initial value, since the
/// counter is always stepped before being used.
int initial_value_;
- /// contains master counter name.
- /** The master counter is the counter that, if stepped
+ ///
+ int saved_value_;
+ /// 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.
docstring labelstringappendix_;
/// Similar, but used for formatted references in XHTML output
docstring prettyformat_;
+ ///
+ docstring guiname_;
+ /// The name used for the counter in LaTeX
+ docstring latexname_;
/// Cache of the labelstring with \\the<counter> expressions expanded,
/// indexed by language
mutable StringMap flatlabelstring_;
/// 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 & lsa,
+ docstring const & guiname);
/// Checks whether the given counter exists.
bool hasCounter(docstring const & c) const;
/// reads the counter name
void addto(docstring const & ctr, int val);
///
int value(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.
+ ///
+ void saveValue(docstring const & ctr) const;
+ ///
+ void restoreValue(docstring const & ctr) const;
+ /// 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
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 & 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.
*/
/// format given by Counter::prettyFormat().
docstring prettyCounter(docstring const & cntr,
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.
/// Also for updateBuffer().
/// Call this when entering things like footnotes, where there is now
/// no "last layout" and we want to restore the "last layout" on exit.
- void clearLastLayout() { layout_stack_.push_back(0); }
+ void clearLastLayout() { layout_stack_.push_back(nullptr); }
/// Call this when exiting things like footnotes.
void restoreLastLayout() { layout_stack_.pop_back(); }
///
///
void restoreLastCounter() { counter_stack_.pop_back(); }
// @}
+ ///
+ std::vector<docstring> listOfCounters() const;
private:
/** expands recursively any \\the<counter> macro in the
* labelstring of \c counter. The \c lang code is used to
std::vector<docstring> counter_stack_;
/// Same, but for last layout.
std::vector<Layout const *> layout_stack_;
-
- ///
- friend void swap(Counters &, Counters &);
};
} // namespace lyx
projects / lyx.git / blobdiff