lyx_mirror/src/insets/InsetLabel.h
Richard Heck 996505c2ae This patch introduces an optional argument to Buffer::updateLabels(), so
as to allow us to call the routine when we are preparing for output and
so to do certain things we might not want to do every time. 

This is an abuse of updateLabels(), in a way, but updateLabels() long
ago became the general recurse-through-the-Buffer routine, and to
implement the sort of thing I want to do here in validate(), say, much
of the code in updateLabels()---in particular, the counter-update
code---would have to be duplicated. So I believe this is the best, and
easiest, way to go.

Actual use of the new argument will follow.


git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@32318 a592a061-630c-0410-9148-cb99ea01b6c8
2009-12-04 03:03:38 +00:00

77 lines
1.6 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 InsetLabel : public InsetCommand {
public:
///
InsetLabel(Buffer * buf, InsetCommandParams const &);
/// verify label and update references.
/**
* Overloaded from Inset::initView.
**/
void initView();
///
bool isLabeled() const { return true; }
///
docstring screenLabel() const;
///
bool hasSettings() const { return true; }
///
InsetCode lyxCode() const { return LABEL_CODE; }
///
int latex(odocstream &, OutputParams const &) const;
///
int plaintext(odocstream &, OutputParams const &) const;
///
int docbook(odocstream &, OutputParams const &) const;
///
docstring xhtml(XHTMLStream &, OutputParams const &) const;
///
static ParamInfo const & findInfo(std::string const &);
///
static std::string defaultCommand() { return "label"; }
///
static bool isCompatibleCommand(std::string const & s)
{ return s == "label"; }
///
void updateLabels(ParIterator const & it, bool);
///
void addToToc(DocIterator const &);
///
void updateCommand(docstring const & new_label, bool updaterefs = true);
///
bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus & status) const;
protected:
///
void doDispatch(Cursor & cur, FuncRequest & cmd);
private:
///
Inset * clone() const { return new InsetLabel(*this); }
///
docstring screen_label_;
};
} // namespace lyx
#endif