lyx_mirror/src/insets/insetcommand.h

// -*- C++ -*-
/**
 * \file insetcommand.h
 * This file is part of LyX, the document processor.
 * Licence details can be found in the file COPYING.
 *
 * \author Angus Leeming
 * \author Lars Gullik Bjønnes
 *
 * Full author contact details are available in file CREDITS.
 */

#ifndef INSET_LATEXCOMMAND_H
#define INSET_LATEXCOMMAND_H

#include "inset.h"
#include "insetcommandparams.h"
#include "render_button.h"
#include "mailinset.h"
#include "cursor.h"


namespace lyx {


// Created by Alejandro 970222
/** Used to insert a LaTeX command automatically
 *
 * Similar to InsetLaTeX but having control of the basic structure of a
 *   LaTeX command: \name[options]{contents}.
 */

///
class InsetCommand : public InsetOld {
public:
	///
	InsetCommand(InsetCommandParams const &, std::string const & mailer_name);
	///
	~InsetCommand();
	///
	bool metrics(MetricsInfo &, Dimension &) const;
	///
	void draw(PainterInfo & pi, int x, int y) const;
	///
	void write(Buffer const &, std::ostream & os) const
		{ p_.write(os); }
	///
	virtual void read(Buffer const &, LyXLex & lex)
		{ p_.read(lex); }
	///
	virtual int latex(Buffer const &, odocstream &,
			  OutputParams const &) const;
	///
	int plaintext(Buffer const &, odocstream &,
		  OutputParams const &) const;
	///
	virtual int docbook(Buffer const &, odocstream &,
			    OutputParams const & runparams) const;
	///
	InsetBase::Code lyxCode() const { return InsetBase::NO_CODE; }

	///
	InsetCommandParams const & params() const { return p_; }
	/// FIXME remove
	std::string const getContents() const { return p_.getContents(); }
	/// FIXME remove
	void setContents(std::string const & c)
	{
		updateButtonLabel_ = true;
		p_.setContents(c);
	}
	///
	void setParam(std::string const & name, docstring const & value)
	{
		updateButtonLabel_ = true;
		p_[name] = value;
	}
	///
	docstring const & getParam(std::string const & name) const
	{
		return p_[name];
	}
	/// FIXME remove
	virtual void replaceContents(std::string const & from, std::string const & to);
	/// FIXME remove
	std::string const getOptions() const { return p_.getOptions(); }
	/// FIXME remove
	std::string const getSecOptions() const { return p_.getSecOptions(); }
	///
	RenderButton & button() const { return button_; }
	///
	bool setMouseHover(bool mouse_hover);

protected:
	///
	virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
	///
	bool getStatus(LCursor & cur, FuncRequest const & cmd, FuncStatus &) const;
	///
	docstring const getCommand() const { return p_.getCommand(); }
	///
	std::string const & getCmdName() const { return p_.getCmdName(); }
	///
	void setCmdName(std::string const & n)
	{
		updateButtonLabel_ = true;
		p_.setCmdName(n);
	}
	///
	void setOptions(std::string const & o)
	{
		updateButtonLabel_ = true;
		p_.setOptions(o);
	}
	///
	void setSecOptions(std::string const & s)
	{
		updateButtonLabel_ = true;
		p_.setSecOptions(s);
	}
	///
	void setParams(InsetCommandParams const &);
	/// This should provide the text for the button
	virtual docstring const getScreenLabel(Buffer const &) const = 0;

private:
	///
	InsetCommandParams p_;
	std::string mailer_name_;
	/// changes color when mouse enters/leaves this inset
	bool mouse_hover_;
	mutable bool updateButtonLabel_;
	mutable RenderButton button_;
};


class InsetCommandMailer : public MailInset {
public:
	///
	InsetCommandMailer(std::string const & name, InsetCommand & inset);
	///
	virtual InsetBase & inset() const { return inset_; }
	///
	virtual std::string const & name() const { return name_; }
	///
	virtual std::string const inset2string(Buffer const &) const;
	///
	static void string2params(std::string const &, std::string const & name,
				  InsetCommandParams &);
	///
	static std::string const params2string(std::string const & name,
					       InsetCommandParams const &);
private:
	///
	std::string const name_;
	///
	InsetCommand & inset_;
};



} // namespace lyx

#endif