// -*- C++ -*-
/* This file is part of
 * ======================================================
 * 
 *           LyX, The Document Processor
 *
 *           Copyright 2000-2001 The LyX Team.
 *
 *======================================================
 */


#ifndef INSETCAPTION_H
#define INSETCAPTION_H

#ifdef __GNUG__
#pragma interface
#endif

#include "insettext.h"

/** A caption inset
*/
class InsetCaption : public InsetText {
public:
	///
	InsetCaption();
	///
	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, bool cleared) const;
	///
	virtual
	int latex(Buffer const * buf, std::ostream & os,
			  bool fragile, bool free_spc) const;
	///
	virtual
	int ascii(Buffer const * buf, std::ostream & os, int linelen) const;
	///
	virtual
	int docBook(Buffer const * buf, std::ostream & os) const;
protected:
private:
};


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


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


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