lyx_mirror/src/insets/InsetCaption.h

120 lines
2.8 KiB
C
Raw Normal View History

// -*- C++ -*-
/**
* \file InsetCaption.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Lars Gullik Bj<EFBFBD>nnes
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSETCAPTION_H
#define INSETCAPTION_H
#include "InsetText.h"
namespace lyx {
class TextClass;
/** A caption inset
*/
class InsetCaption : public InsetText {
public:
///
InsetCaption(InsetCaption const &);
InsetCaption(BufferParams const &);
///
virtual ~InsetCaption() {}
///
void write(Buffer const & buf, std::ostream & os) const;
///
void read(Buffer const & buf, Lexer & lex);
///
virtual DisplayType display() const;
///
virtual bool neverIndent(Buffer const &) const { return true; }
///
virtual InsetCode lyxCode() const;
///
virtual docstring const editMessage() const;
///
virtual void cursorPos(BufferView const & bv,
CursorSlice const & sl, bool boundary, int & x, int & y) const;
///
bool descendable() const { return true; }
///
virtual void metrics(MetricsInfo & mi, Dimension & dim) const;
///
virtual void draw(PainterInfo & pi, int x, int y) const;
///
virtual void edit(Cursor & cur, bool left);
///
virtual Inset * editXY(Cursor & cur, int x, int y);
///
bool insetAllowed(InsetCode code) const;
///
virtual bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
Rewrite the label numbering code. * buffer_funcs.cpp (updateLabels): new function taking a buffer and a ParIterator as arguments. This one is used to update labels into an InsetText. Cleanup the code to reset depth. Call setLabel for each paragraph, and then updateLabel on each inset it contains. (setCaptionLabels, setCaptions): removed. (setLabel): use Counters::current_float to make caption paragraphs labels. * insets/Inset.h (updateLabels): new virtual method, empty by default; this numbers the inset itself (if relevant) and then all the paragraphs it may contain. * insets/InsetText.cpp (updateLabels): basically calls lyx::updateLabels from buffer_func.cpp. * insets/InsetCaption.cpp (addToToc): use the label constructed by updateLabels. (computeFullLabel): removed. (metrics, plaintext): don't use computeFullLabel. (updateLabels): new method; set the label from Counters::current_float. * insets/InsetWrap.cpp (updateLabels): * insets/InsetFloat.cpp (updateLabel): new method; sets Counters::current_float to the float type. * insets/InsetBranch.cpp (updateLabels): new method; the numbering is reset afterwards if the branch is inactive. (bug 2671) * insets/InsetNote.cpp (updateLabels): new method; the numbering is reset after the underlying InsetText has been numbered. (bug 2671) * insets/InsetTabular.cpp (updateLabels): new method (also handles longtable) * insets/InsetListings.cpp (updateLabels): new method; mimics what is done for Floats (although Listings are not floats technically) * insets/InsetInclude.cpp (getScreenLabel): in the listings case, use the computed label. (updateLabels): new method; that either renumbers the child document or number the current listing. * LyXFunc.cpp (menuNew): do not updateLabels on empty documents (why do we do that at all?) git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@19482 a592a061-630c-0410-9148-cb99ea01b6c8
2007-08-12 21:43:58 +00:00
// Update the counters of this inset and of its contents
virtual void updateLabels(Buffer const &, ParIterator const &);
///
int latex(Buffer const & buf, odocstream & os,
OutputParams const &) const;
///
int plaintext(Buffer const & buf, odocstream & os,
OutputParams const & runparams) const;
///
int docbook(Buffer const & buf, odocstream & os,
OutputParams const & runparams) const;
/// return the mandatory argument (LaTeX format) only
int getArgument(Buffer const & buf, odocstream & os,
OutputParams const &) const;
/// return the optional argument(s) only
int getOptArg(Buffer const & buf, odocstream & os,
OutputParams const &) const;
///
std::string const & type() const { return type_; }
///
void setType(std::string const & type) { type_ = type; }
///
void setCustomLabel(docstring const & label);
///
void addToToc(TocList &, Buffer const &, ParConstIterator const &) const;
/// Captions don't accept alignment, spacing, etc.
bool forceDefaultParagraphs(idx_type) const { return true; }
private:
///
virtual Inset * clone() const;
///
mutable docstring full_label_;
///
mutable int labelwidth_;
///
std::string type_;
///
docstring custom_label_;
///
TextClass const & textclass_;
};
inline
Inset::DisplayType InsetCaption::display() const
{
return AlignCenter;
}
inline
InsetCode InsetCaption::lyxCode() const
{
return CAPTION_CODE;
}
} // namespace lyx
#endif