Merge branch 'master' into features/indexmacros

[lyx.git] / src / insets / InsetLabel.h

diff --git a/src/insets/InsetLabel.h b/src/insets/InsetLabel.h
index e9fa8b50d6a92f5959a6c0749da248a69b326ea5..dba25f01c942475a61752cf9c862e9229feaece7 100644 (file)
--- a/src/insets/InsetLabel.h
+++ b/src/insets/InsetLabel.h
@@ -4,7 +4,7 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -17,39 +17,96 @@
 
 namespace lyx {
 
-class InsetLabel : public InsetCommand {
+class InsetLabel : public InsetCommand
+{
 public:
        ///
-       InsetLabel(InsetCommandParams const &);
+       InsetLabel(Buffer * buf, InsetCommandParams const &);
+
+       ///
+       docstring const & activeCounter() const { return active_counter_; }
+       ///
+       docstring const & counterValue() const { return counter_value_; }
+       ///
+       docstring const & prettyCounter() const { return pretty_counter_; }
+       ///
+       int rowFlags() const override { return CanBreakBefore | CanBreakAfter; }
+       /// Updates only the label string, doesn't handle undo nor references.
+       void updateLabel(docstring const & new_label, bool const active = true);
+       /// Updates the label and the references to it.
+       /// Will also handle undo/redo if \p cursor is passed.
+       void updateLabelAndRefs(docstring const & new_label, Cursor * cursor = 0);
+
+       /// \name Public functions inherited from Inset class
+       //@{
+       /// verify label and update references.
+       void initView() override;
        ///
-       docstring screenLabel() const;
+       bool isLabeled() const override { return true; }
        ///
-       EDITABLE editable() const { return IS_EDITABLE; }
+       bool hasSettings() const override { return true; }
        ///
-       InsetCode lyxCode() const { return LABEL_CODE; }
-       /// Appends \c list with this label
-       void getLabelList(std::vector<docstring> & list) const;
+       InsetCode lyxCode() const override { return LABEL_CODE; }
        ///
-       int latex(odocstream &, OutputParams const &) const;
+       void latex(otexstream & os, OutputParams const & runparams_in) const override;
        ///
-       int plaintext(odocstream &, OutputParams const &) const;
+       int plaintext(odocstringstream & ods, OutputParams const & op,
+                     size_t max_length = INT_MAX) const override;
        ///
-       int docbook(odocstream &, OutputParams const &) const;
+       void docbook(XMLStream &, OutputParams const &) const override;
+       ///
+       docstring xhtml(XMLStream &, OutputParams const &) const override;
+       ///
+       void updateBuffer(ParIterator const & it, UpdateType, bool const deleted = false) override;
+       ///
+       void addToToc(DocIterator const & di, bool output_active,
+                                 UpdateType utype, TocBackend & backend) const override;
+       /// Is the content of this inset part of the immediate (visible) text sequence?
+       bool isPartOfTextSequence() const override { return false; }
+       //@}
+
+       /// \name Static public methods obligated for InsetCommand derived classes
+       //@{
        ///
        static ParamInfo const & findInfo(std::string const &);
        ///
-       static std::string defaultCommand() { return "label"; };
+       static std::string defaultCommand() { return "label"; }
        ///
-       static bool isCompatibleCommand(std::string const & s) 
+       static bool isCompatibleCommand(std::string const & s)
                { return s == "label"; }
+       //@}
+
+       //FIXME: private
+       /// \name Private functions inherited from InsetCommand class
+       //@{
        ///
-       void addToToc(ParConstIterator const &) const;
-protected:
-       ///
-       void doDispatch(Cursor & cur, FuncRequest & cmd);
+       docstring screenLabel() const override;
+       //@}
+
 private:
+       /// \name Private functions inherited from Inset class
+       //@{
+       ///
+       Inset * clone() const override { return new InsetLabel(*this); }
+       ///
+       bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus & status) const override;
+       ///
+       void doDispatch(Cursor & cur, FuncRequest & cmd) override;
+       //@}
+
+       ///
+       void uniqueLabel(docstring & label) const;
+       ///
+       void updateReferences(docstring const & old_label,
+               docstring const & new_label);
+       ///
+       docstring screen_label_;
+       ///
+       docstring active_counter_;
+       ///
+       docstring counter_value_;
        ///
-       Inset * clone() const;
+       docstring pretty_counter_;
 };