lyx_mirror/src/insets/insetminipage.h

// -*- C++ -*-
/**
 * \file insetminipage.h
 * This file is part of LyX, the document processor.
 * Licence details can be found in the file COPYING.
 *
 * \author J<EFBFBD>rgen Vigna
 * \author Lars Gullik Bj<EFBFBD>nnes
 *
 * Full author contact details are available in file CREDITS
 */

#ifndef InsetMinipage_H
#define InsetMinipage_H


#include "insetcollapsable.h"
#include "lyxlength.h"

/** The minipage inset

*/
class InsetMinipage : public InsetCollapsable {
public:
	///
	enum Position {
		top,
		center,
		bottom
	};
	///
	enum InnerPosition {
		inner_center,
		inner_top,
		inner_bottom,
		inner_stretch
	};

	///
	struct Params {
		///
		Params();
		///
		Position pos;
		///
		InnerPosition inner_pos;
		///
		LyXLength height;
		///
		LyXLength width;
		///
		void write(std::ostream & os) const;
		///
		void read(LyXLex & lex);
	};

	///
	InsetMinipage(BufferParams const &);
	///
	InsetMinipage(InsetMinipage const &, bool same_id = false);
	///
	~InsetMinipage();
	///
	virtual dispatch_result localDispatch(FuncRequest const & cmd);	
	///
	void write(Buffer const * buf, std::ostream & os) const;
	///
	void read(Buffer const * buf, LyXLex & lex);
	///
	Inset * clone(Buffer const &, bool same_id = false) const;
	///
	int ascent(BufferView *, LyXFont const &) const;
	///
	int descent(BufferView *, LyXFont const &) const;
	///
	Inset::Code lyxCode() const { return Inset::MINIPAGE_CODE; }
	///
	int latex(Buffer const *, std::ostream &, bool fragile, bool fp) const;
	///
	string const editMessage() const;
	///
	bool insetAllowed(Inset::Code) const;
	///
	Position pos() const;
	///
	void pos(Position);
	///
	InnerPosition innerPos() const;
	///
	void innerPos(InnerPosition);
	///
	LyXLength const & pageHeight() const;
	///
	void pageHeight(LyXLength const &);
	///
	LyXLength const & pageWidth() const;
	///
	void pageWidth(LyXLength const &);
	///
	int getMaxWidth(BufferView *, UpdatableInset const *) const;
	///
	bool needFullRow() const { return false; }
	/** returns true if, when outputing LaTeX, font changes should
	    be closed before generating this inset. This is needed for
	    insets that may contain several paragraphs */
	bool noFontChange() const { return true; }
	///
	bool showInsetDialog(BufferView *) const;
	///
	int latexTextWidth(BufferView *) const;
	///
	void params(Params const & p) { params_ = p; }
	///
	Params const & params() const { return params_; }
private:
	///
	Params params_;
};


#include "mailinset.h"


class InsetMinipageMailer : public MailInset {
public:
	///
	InsetMinipageMailer(InsetMinipage & inset);
	///
	virtual Inset & inset() const { return inset_; }
	///
	virtual string const & name() const { return name_; }
	///
	virtual string const inset2string() const;
	///
	static void string2params(string const &, InsetMinipage::Params &);
	///
	static string const params2string(InsetMinipage::Params const &);
private:
	///
	static string const name_;
	///
	InsetMinipage & inset_;
};

#endif