4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
9 * Full author contact details are available in file CREDITS.
15 #include "InsetCommand.h"
20 class InsetLabel : public InsetCommand
24 InsetLabel(Buffer * buf, InsetCommandParams const &);
27 docstring const & activeCounter() const { return active_counter_; }
29 docstring const & counterValue() const { return counter_value_; }
31 docstring const & prettyCounter() const { return pretty_counter_; }
32 /// Updates only the label string, doesn't handle undo nor references.
33 void updateLabel(docstring const & new_label, bool const active = true);
34 /// Updates the label and the references to it.
35 /// Will also handle undo/redo if \p cursor is passed.
36 void updateLabelAndRefs(docstring const & new_label, Cursor * cursor = 0);
38 /// \name Public functions inherited from Inset class
40 /// verify label and update references.
41 void initView() override;
43 bool isLabeled() const override { return true; }
45 bool hasSettings() const override { return true; }
47 InsetCode lyxCode() const override { return LABEL_CODE; }
49 void latex(otexstream & os, OutputParams const & runparams_in) const override;
51 int plaintext(odocstringstream & ods, OutputParams const & op,
52 size_t max_length = INT_MAX) const override;
54 void docbook(XMLStream &, OutputParams const &) const override;
56 docstring xhtml(XMLStream &, OutputParams const &) const override;
58 void updateBuffer(ParIterator const & it, UpdateType, bool const deleted = false) override;
60 void addToToc(DocIterator const & di, bool output_active,
61 UpdateType utype, TocBackend & backend) const override;
62 /// Is the content of this inset part of the immediate (visible) text sequence?
63 bool isPartOfTextSequence() const override { return false; }
66 /// \name Static public methods obligated for InsetCommand derived classes
69 static ParamInfo const & findInfo(std::string const &);
71 static std::string defaultCommand() { return "label"; }
73 static bool isCompatibleCommand(std::string const & s)
74 { return s == "label"; }
78 /// \name Private functions inherited from InsetCommand class
81 docstring screenLabel() const override;
85 /// \name Private functions inherited from Inset class
88 Inset * clone() const override { return new InsetLabel(*this); }
90 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus & status) const override;
92 void doDispatch(Cursor & cur, FuncRequest & cmd) override;
96 void uniqueLabel(docstring & label) const;
98 void updateReferences(docstring const & old_label,
99 docstring const & new_label);
101 docstring screen_label_;
103 docstring active_counter_;
105 docstring counter_value_;
107 docstring pretty_counter_;