* 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 screenLabel() const;
+ 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, 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();
+ ///
+ bool isLabeled() const { return true; }
///
- EDITABLE editable() const { return IS_EDITABLE; }
+ bool hasSettings() const { return true; }
///
InsetCode lyxCode() const { return LABEL_CODE; }
- /// Appends \c list with this label
- void getLabelList(std::vector<docstring> & list) const;
///
- int latex(odocstream &, OutputParams const &) const;
+ void latex(otexstream & os, OutputParams const & runparams_in) 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(XMLStream &, OutputParams const &) const;
+ ///
+ void updateBuffer(ParIterator const & it, UpdateType, bool const deleted = false);
+ ///
+ 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)
+ 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;
+ //@}
+
private:
+ /// \name Private functions inherited from Inset class
+ //@{
///
Inset * clone() const { return new InsetLabel(*this); }
+ ///
+ bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus & status) const;
+ ///
+ void doDispatch(Cursor & cur, FuncRequest & cmd);
+ //@}
+
+ ///
+ 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_;
};