lyx_mirror/src/insets/insetcaption.h

// -*- 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"

/** A caption inset
*/
class InsetCaption : public InsetText {
public:
	///
	InsetCaption(BufferParams const &);
	///
	void write(Buffer const * buf, std::ostream & os) const;
	///
	void read(Buffer const * buf, LyXLex & lex);
	///
	virtual bool display() const;
	///
	virtual bool needFullRow() const;
	///
	virtual Inset::Code lyxCode() const;
	///
	virtual string const editMessage() const;
	///
	virtual void draw(BufferView * bv, LyXFont const & f,
			  int baseline, float & x) const;
	///
	virtual int latex(Buffer const * buf, std::ostream & os, LatexRunParams const &,
			  bool fragile, bool free_spc) const;
	///
	int ascii(Buffer const * buf, std::ostream & os, int linelen) const;
	///
	int docbook(Buffer const * buf, std::ostream & os, bool mixcont) const;
};


inline
bool InsetCaption::display() const
{
	return true;
}


inline
bool InsetCaption::needFullRow() const
{
	return true;
}


inline
Inset::Code InsetCaption::lyxCode() const
{
	return CAPTION_CODE;
}

#endif