]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetLabel.h
Whitespace
[lyx.git] / src / insets / InsetLabel.h
index 3ab79b6f2825c7194d573d6573738325c7d0079d..65a6d3aa20fa3f5b16a739f1ad52da99021f8b56 100644 (file)
@@ -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.
  */
 
 namespace lyx {
 
-class InsetLabel : public InsetCommand {
+class Counter;
+
+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_; }
+       /// Updates only the label string, doesn't handle undo nor references.
+       void updateLabel(docstring const & new_label);
+       /// 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.
-       /**
-         * Overloaded from Inset::initView.
-         **/
        void initView();
-
        ///
-       docstring screenLabel() const;
+       bool isLabeled() const { return true; }
        ///
-       EDITABLE editable() const { return IS_EDITABLE; }
+       bool hasSettings() const { return true; }
        ///
        InsetCode lyxCode() const { return LABEL_CODE; }
        ///
-       int latex(odocstream &, OutputParams const &) const;
-       ///
-       int plaintext(odocstream &, OutputParams const &) const;
+       int plaintext(odocstringstream & ods, OutputParams const & op,
+                     size_t max_length = INT_MAX) const;
        ///
        int docbook(odocstream &, OutputParams const &) const;
        ///
+       docstring xhtml(XHTMLStream &, OutputParams const &) const;
+       ///
+       void updateBuffer(ParIterator const & it, UpdateType);
+       ///
+       void addToToc(DocIterator const & di, bool output_active,
+                                 UpdateType utype, TocBackend & backend) const;
+       /// Is the content of this inset part of the immediate (visible) text sequence?
+       bool isPartOfTextSequence() const { 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) 
                { return s == "label"; }
+       //@}
+
+       //FIXME: private
+       /// \name Private functions inherited from InsetCommand class
+       //@{
        ///
-       void updateLabels(ParIterator const & it);
+       docstring screenLabel() const;
+       //@}
+       
+private:
+       /// \name Private functions inherited from Inset class
+       //@{
        ///
-       void addToToc(ParConstIterator const &) const;
+       Inset * clone() const { return new InsetLabel(*this); }
        ///
-       void updateCommand(docstring const & new_label, bool updaterefs = true);
-protected:
+       bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus & status) const;
        ///
        void doDispatch(Cursor & cur, FuncRequest & cmd);
-private:
+       //@}
+
        ///
-       Inset * clone() const { return new InsetLabel(*this); }
+       void uniqueLabel(docstring & label) const;
+       ///
+       void updateReferences(docstring const & old_label,
+               docstring const & new_label);
        ///
        docstring screen_label_;
+       ///
+       docstring active_counter_;
+       ///
+       docstring counter_value_;
+       ///
+       docstring pretty_counter_;
 };