// -*- C++ -*-
/**
 * \file InsetNewpage.h
 * This file is part of LyX, the document processor.
 * Licence details can be found in the file COPYING.
 *
 * \author André Pönitz
 *
 * Full author contact details are available in file CREDITS.
 */

#ifndef INSET_NEWPAGE_H
#define INSET_NEWPAGE_H

#include "Inset.h"

#include "support/docstring.h"
#include "support/gettext.h"


namespace lyx {

class InsetNewpage : public Inset
{
public:
	///
	InsetNewpage() {}
	///
	InsetCode lyxCode() const { return NEWPAGE_CODE; }
	///
	void metrics(MetricsInfo &, Dimension &) const;
	///
	void draw(PainterInfo & pi, int x, int y) const;
	///
	int latex(odocstream &, OutputParams const &) const;
	///
	int plaintext(odocstream &, OutputParams const &) const;
	///
	int docbook(odocstream &, OutputParams const &) const;
	///
	void read(Lexer & lex); 
	///
	void write(std::ostream & os) const;
	/// We don't need \begin_inset and \end_inset
	bool directWrite() const { return true; }
	///
	DisplayType display() const { return AlignCenter; }
	///
	docstring insetLabel() const { return _("New Page"); }
	///
	std::string getCmdName() const { return "\\newpage"; }
	///
	ColorCode ColorName() const { return Color_newpage; }
private:
	///
	Inset * clone() const { return new InsetNewpage(*this); }
};


class InsetPagebreak : public InsetNewpage
{
public:
	///
	InsetPagebreak() {}
	///
	docstring insetLabel() const { return _("Page Break"); }
	///
	std::string getCmdName() const { return "\\pagebreak"; }
	///
	ColorCode ColorName() const { return Color_pagebreak; }
private:
	///
	Inset * clone() const { return new InsetPagebreak(*this); }
};


class InsetClearPage : public InsetNewpage
{
public:
	///
	InsetClearPage() {}
	///
	docstring insetLabel() const { return _("Clear Page"); }
	///
	std::string getCmdName() const { return "\\clearpage"; }

private:
	///
	Inset * clone() const { return new InsetClearPage(*this); }
};


class InsetClearDoublePage : public InsetNewpage
{
public:
	///
	InsetClearDoublePage() {}
	///
	docstring insetLabel() const { return _("Clear Double Page"); }
	///
	std::string getCmdName() const { return "\\cleardoublepage"; }

private:
	///
	Inset * clone() const { return new InsetClearDoublePage(*this); }
};

} // namespace lyx

#endif // INSET_NEWPAGE_H