lyx_mirror/src/insets/InsetCaption.h
Enrico Forestieri d866717ef7 Integrate texrow with otexstream in order to perform automatic line
counting when exporting to latex. This is done for the code comprised
between \begin{document} and \end{document}, while the preamble code
still needs manual calls to TexRow::newline() for registering new lines.


git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@37584 a592a061-630c-0410-9148-cb99ea01b6c8
2011-02-10 20:02:48 +00:00

102 lines
2.7 KiB
C++

// -*- 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ønnes
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSETCAPTION_H
#define INSETCAPTION_H
#include "InsetText.h"
namespace lyx {
/** A caption inset
*/
class InsetCaption : public InsetText {
public:
///
InsetCaption(Buffer *);
///
std::string const & type() const { return type_; }
///
docstring name() const;
/// return the mandatory argument (LaTeX format) only
void getArgument(otexstream & os, OutputParams const &) const;
/// return the optional argument(s) only
void getOptArg(otexstream & os, OutputParams const &) const;
/// return the caption text
int getCaptionAsPlaintext(odocstream & os, OutputParams const &) const;
/// return the caption text as HTML
docstring getCaptionAsHTML(XHTMLStream & os, OutputParams const &) const;
private:
///
void write(std::ostream & os) const;
///
void read(Lexer & lex);
///
DisplayType display() const { return AlignCenter; }
///
bool neverIndent() const { return true; }
///
InsetCode lyxCode() const { return CAPTION_CODE; }
///
void cursorPos(BufferView const & bv,
CursorSlice const & sl, bool boundary, int & x, int & y) const;
///
bool descendable(BufferView const &) const { return true; }
///
void metrics(MetricsInfo & mi, Dimension & dim) const;
///
void drawBackground(PainterInfo & pi, int x, int y) const;
///
void draw(PainterInfo & pi, int x, int y) const;
///
void edit(Cursor & cur, bool front, EntryDirection entry_from);
///
Inset * editXY(Cursor & cur, int x, int y);
///
bool insetAllowed(InsetCode code) const;
///
bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
// Update the counters of this inset and of its contents
void updateBuffer(ParIterator const &, UpdateType);
///
void latex(otexstream & os, OutputParams const &) const;
///
int plaintext(odocstream & os, OutputParams const & runparams) const;
///
int docbook(odocstream & os, OutputParams const & runparams) const;
///
docstring xhtml(XHTMLStream & os, OutputParams const & runparams) const;
///
void setCustomLabel(docstring const & label);
///
void addToToc(DocIterator const &) const;
///
virtual bool forcePlainLayout(idx_type = 0) const { return true; }
/// Captions don't accept alignment, spacing, etc.
virtual bool allowParagraphCustomization(idx_type = 0) const { return false; }
///
Inset * clone() const { return new InsetCaption(*this); }
///
mutable docstring full_label_;
///
mutable int labelwidth_;
///
std::string type_;
///
docstring custom_label_;
};
} // namespace lyx
#endif