X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetCommand.h;h=39b1cbbef36ae745633b307033de70cd3d192e85;hb=815e6c9f2fefccf698f92fb07f9c6a5ba574f65d;hp=9dec77c3af4f0afd5380809c0e93a38005703e95;hpb=39e79d8602920eefe36e898c9f415afb979521b2;p=lyx.git

diff --git a/src/insets/InsetCommand.h b/src/insets/InsetCommand.h
index 9dec77c3af..39b1cbbef3 100644
--- a/src/insets/InsetCommand.h
+++ b/src/insets/InsetCommand.h
@@ -5,142 +5,150 @@
  * Licence details can be found in the file COPYING.
  *
  * \author Angus Leeming
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
  *
  * Full author contact details are available in file CREDITS.
  */
 
-#ifndef INSET_LATEXCOMMAND_H
-#define INSET_LATEXCOMMAND_H
+#ifndef INSETCOMMAND_H
+#define INSETCOMMAND_H
 
 #include "Inset.h"
 #include "InsetCommandParams.h"
 #include "RenderButton.h"
-#include "MailInset.h"
-#include "LCursor.h"
 
 
 namespace lyx {
 
+class Cursor;
+
+/////////////////////////////////////////////////////////////////////////
+//
+// InsetCommand
+//
+/////////////////////////////////////////////////////////////////////////
 
 // 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}.
- */
+// Used to insert a LaTeX command automatically.
 
-///
-class InsetCommand : public InsetOld {
+class InsetCommand : public Inset
+{
 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); }
+	InsetCommand(Buffer *, InsetCommandParams const &);
 	///
-	virtual void read(Buffer const &, Lexer & lex)
-		{ p_.read(lex); }
+	InsetCommand(InsetCommand const & rhs);
 	///
-	int latex(Buffer const &, odocstream &, OutputParams const &) const;
+	InsetCommand & operator=(InsetCommand const & rhs);
 	///
-	int plaintext(Buffer const &, odocstream &, OutputParams const &) const;
+	virtual ~InsetCommand();
 	///
-	int docbook(Buffer const &, odocstream &, OutputParams const & runparams) const;
+	InsetCommand * asInsetCommand() { return this; }
 	///
-	InsetBase::Code lyxCode() const { return InsetBase::NO_CODE; }
+	InsetCommand const * asInsetCommand() const { return this; }
 
+	/// \return true if params are successfully read
+	static bool string2params(std::string const & data,
+				  InsetCommandParams &);
 	///
-	InsetCommandParams const & params() const { return p_; }
-	/// FIXME remove
-	std::string const getContents() const { return p_.getContents(); }
-protected:
-	/// FIXME remove
-	void setContents(std::string const & c)
-	{
-		updateButtonLabel_ = true;
-		p_.setContents(c);
-	}
-public:
+	static std::string params2string(InsetCommandParams const &);
 	///
-	void setParam(std::string const & name, docstring const & value)
-	{
-		updateButtonLabel_ = true;
-		p_[name] = value;
-	}
+	InsetCommandParams const & params() const { return p_; }
 	///
-	docstring const & getParam(std::string const & name) const
-	{
-		return p_[name];
-	}
-	/// FIXME remove
-	virtual void replaceContents(std::string const & from, std::string const & to);
+	void setParams(InsetCommandParams const &);
 	///
-	RenderButton & button() const { return button_; }
+	docstring const & getParam(std::string const & name) const;
 	///
-	bool setMouseHover(bool mouse_hover);
+	void setParam(std::string const & name, docstring const & value);
+	/// FIXME Remove
+	docstring const getFirstNonOptParam() const { return p_.getFirstNonOptParam(); }
 
-protected:
+	/// \name Public functions inherited from Inset class
+	//@{
 	///
-	virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
+	void write(std::ostream & os) const { p_.write(os); }
 	///
-	bool getStatus(LCursor & cur, FuncRequest const & cmd, FuncStatus &) const;
+	void read(Lexer & lex) { p_.Read(lex, &buffer()); }
 	///
-	docstring const getCommand() const { return p_.getCommand(); }
+	void doDispatch(Cursor & cur, FuncRequest & cmd);
 	///
-	std::string const & getCmdName() const { return p_.getCmdName(); }
+	bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
 	///
-	void setCmdName(std::string const & n)
-	{
-		updateButtonLabel_ = true;
-		p_.setCmdName(n);
-	}
+	void metrics(MetricsInfo &, Dimension &) const;
 	///
-	void setParams(InsetCommandParams const &);
-	/// This should provide the text for the button
-	virtual docstring const getScreenLabel(Buffer const &) const = 0;
-
-private:
+	void draw(PainterInfo & pi, int x, int y) const;
 	///
-	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:
+	void latex(otexstream &, OutputParams const &) const;
 	///
-	InsetCommandMailer(std::string const & name, InsetCommand & inset);
+	int plaintext(odocstringstream & ods, OutputParams const & op,
+	              size_t max_length = INT_MAX) const;
 	///
-	virtual InsetBase & inset() const { return inset_; }
+	int docbook(odocstream &, OutputParams const & runparams) const;
 	///
-	virtual std::string const & name() const { return name_; }
+	bool setMouseHover(BufferView const * bv, bool mouse_hover) const;
 	///
-	virtual std::string const inset2string(Buffer const &) const;
+	bool clickable(BufferView const &, int, int) const { return hasSettings(); }
+	//@}
+
+protected:
+	/// \name Methods relaying to the InsetCommandParams p_
+	//@{
 	///
-	static void string2params(std::string const &, std::string const & name,
-				  InsetCommandParams &);
+	std::string contextMenuName() const;
 	///
-	static std::string const params2string(std::string const & name,
-					       InsetCommandParams const &);
+	bool showInsetDialog(BufferView * bv) const;
+	///
+	Dimension const dimension(BufferView const &) const 
+		{ return button_.dimension(); }
+	//@}
+
+protected:
+	/// \name Functions relaying to the InsetCommandParams
+	//@{
+	/// Build the complete LaTeX command
+	/// \see InsetCommandParams::getCommand
+	docstring const getCommand(OutputParams const & rp) const 
+		{ return p_.getCommand(rp); }
+	/// Return the command name
+	/// \see InsetCommandParams::getCmdName
+	std::string const & getCmdName() const { return p_.getCmdName(); }
+	/// Set the name to \p n. This must be a known name. All parameters
+	/// are cleared except those that exist also in the new command.
+	/// What matters here is the parameter name, not position.
+	/// \see InsetCommandParams::setCmdName
+	void setCmdName(std::string const & n) { p_.setCmdName(n); }
+	//@}
+
 private:
 	///
-	std::string const name_;
+	RenderButton & button() const { return button_; }
+	/// This should provide the text for the button
+	virtual docstring screenLabel() const = 0;
+
+	/// \name Static public methods obligated for InsetCommand derived classes
+	//@{
+	/// Return parameter information for command cmdName.
+	/// Not implemented here. Must be implemented in derived class.
+	static ParamInfo const & findInfo(std::string const & cmdName);
+	/// Return default command for this inset.
+	/// Not implemented here. Must be implemented in derived class.
+	static std::string defaultCommand();
+	/// Whether this is a command this inset can represent.
+	/// Not implemented here. Must be implemented in derived class.
+	static bool isCompatibleCommand(std::string const & cmd);
+	//@}
+
 	///
-	InsetCommand & inset_;
+	InsetCommandParams p_;
+	/// changes color when mouse enters/leaves this inset
+	mutable std::map<BufferView const *, bool> mouse_hover_;
+	///
+	mutable RenderButton button_;
 };
 
-
+/// Decode InsetCommand considering Inset name and data.
+bool decodeInsetParam(std::string const & name, std::string & data,
+	Buffer const & buffer);
 
 } // namespace lyx