lyx_mirror/src/insets/InsetLabel.h
Abdelrazak Younes 2a01208cae addendum to r39250: I forgot about math labels. This fixes it.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@39251 a592a061-630c-0410-9148-cb99ea01b6c8
2011-07-06 18:52:56 +00:00

110 lines
2.5 KiB
C++

// -*- C++ -*-
/**
* \file InsetLabel.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Lars Gullik Bjønnes
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSET_LABEL_H
#define INSET_LABEL_H
#include "InsetCommand.h"
namespace lyx {
class Counter;
class InsetLabel : public InsetCommand
{
public:
///
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.
void initView();
///
bool isLabeled() const { return true; }
///
bool hasSettings() const { return true; }
///
InsetCode lyxCode() const { return LABEL_CODE; }
///
int plaintext(odocstream &, OutputParams const &) const;
///
int docbook(odocstream &, OutputParams const &) const;
///
docstring xhtml(XHTMLStream &, OutputParams const &) const;
///
void updateBuffer(ParIterator const & it, UpdateType);
///
void addToToc(DocIterator const &) const;
//@}
/// \name Static public methods obligated for InsetCommand derived classes
//@{
///
static ParamInfo const & findInfo(std::string const &);
///
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
//@{
///
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_;
};
} // namespace lyx
#endif