2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
7 * Copyright 1995 Matthias Ettrich
8 * Copyright 1995-2001 The LyX Team.
11 * ====================================================== */
25 /// This represents a single counter.
40 /// Returns the master counter of this counter
41 string master() const;
42 /// sets the master counter for this counter
43 void setMaster(string const & m);
47 /// contains master counter name; master counter is the counter
48 /// that, if stepped (incremented) zeroes this counter. E.g.
49 /// "subparagraph"'s master is "paragraph".
54 /// This is a class of (La)TeX type counters.
55 /// Every instantiation is an array of counters of type Counter.
58 /// Add a new counter to array.
59 void newCounter(string const & newc);
60 /// Add new counter having oldc as its master.
61 void newCounter(string const & newc, string const & oldc);
63 void set(string const & ctr, int val);
65 void addto(string const & ctr, int val);
67 int value(string const & ctr) const;
68 /// Step (increment by one) counter named by arg, and
69 /// zeroes slave counter(s) for which it is the master.
70 /// NOTE sub-slaves not zeroed! That happens at slave's
71 /// first step 0->1. Seems to be sufficient.
72 void step(string const & ctr);
73 /// Reset all counters.
75 /// Reset counters matched by match string.
76 void reset(string const & match);
77 /// Copy counters whose name matches match from the &from to
78 /// the &to array of counters. Empty string matches all.
79 void copy(Counters & from, Counters & to, string const & match = string());
80 /// A numeric label's single item, like .1 for subsection number in
81 /// the 2.1.4 subsubsection number label. "first" indicates if this
82 /// is the first item to be displayed, usually chapter or section.
83 string labelItem(string const & ctr,
84 string const & labeltype,
85 string const & langtype = "latin",
87 /// A complete numeric label, like 2.1.4 for a subsubsection.
88 /// "head" indicates sequence number of first item to be
89 /// displayed, e.g. 0 for chapter, 1 for section.
90 string numberLabel(string const & ctr,
91 string const & labeltype,
92 string const & langtype = "latin",
95 /// Maps counter (layout) names to actual counters.
96 typedef std::map<string, Counter> CounterList;
98 CounterList counterList;