X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetCommand.h;h=c3b5005d2716580cf2474b41a09eb0fbbe2a2b53;hb=62d36bf04d436c83ddace8aeaf4dbd493d674cdf;hp=503c8124e79fb90759d0c6bc68f4bf6b41b36e7b;hpb=f9b81e51e943bcaac885d74edbce41a9d74ad3dd;p=lyx.git

diff --git a/src/insets/InsetCommand.h b/src/insets/InsetCommand.h
index 503c8124e7..c3b5005d27 100644
--- a/src/insets/InsetCommand.h
+++ b/src/insets/InsetCommand.h
@@ -5,7 +5,7 @@
  * 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.
  */
@@ -16,11 +16,11 @@
 #include "Inset.h"
 #include "InsetCommandParams.h"
 #include "RenderButton.h"
-#include "Cursor.h"
 
 
 namespace lyx {
 
+class Cursor;
 
 /////////////////////////////////////////////////////////////////////////
 //
@@ -35,65 +35,96 @@ class InsetCommand : public Inset
 {
 public:
 	///
-	InsetCommand(InsetCommandParams const &, std::string const & mailer_name);
+	InsetCommand(Buffer *, InsetCommandParams const &);
 	///
-	~InsetCommand();
+	InsetCommand(InsetCommand const & rhs);
+	///
+	virtual ~InsetCommand();
+	///
+	InsetCommand * asInsetCommand() { return this; }
+	///
+	InsetCommand const * asInsetCommand() const { return this; }
 
-	/// returns true if params are successfully read
-	static bool string2params(std::string const &, std::string const & name,
+	/// \return true if params are successfully read
+	static bool string2params(std::string const & data,
 				  InsetCommandParams &);
 	///
-	static std::string params2string(std::string const & name,
-					       InsetCommandParams const &);
+	static std::string params2string(InsetCommandParams const &);
 	///
 	InsetCommandParams const & params() const { return p_; }
 	///
 	void setParams(InsetCommandParams const &);
 	///
-	void setParam(std::string const & name, docstring const & value);
-	///
 	docstring const & getParam(std::string const & name) const;
+	///
+	void setParam(std::string const & name, docstring const & value);
 	/// FIXME Remove
 	docstring const getFirstNonOptParam() const { return p_.getFirstNonOptParam(); }
-	/// update label and references.
-	virtual void updateCommand(docstring const &, bool) {}
 
-protected:
+	/// \name Public functions inherited from Inset class
+	//@{
 	///
 	void write(std::ostream & os) const { p_.write(os); }
 	///
-	void read(Lexer & lex) { p_.read(lex); }
+	void read(Lexer & lex, Buffer const * buf) { p_.read(lex, buf); }
 	///
 	void doDispatch(Cursor & cur, FuncRequest & cmd);
 	///
-	docstring const getCommand() const { return p_.getCommand(); }
-	///
-	std::string const & getCmdName() const { return p_.getCmdName(); }
-	///
-	void setCmdName(std::string const & n) { p_.setCmdName(n); }
-
-private:
+	bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
 	///
 	void metrics(MetricsInfo &, Dimension &) const;
 	///
-	Dimension const dimension(BufferView const &) const { return button_.dimension(); }
-	///
 	void draw(PainterInfo & pi, int x, int y) const;
 	///
-	int latex(odocstream &, OutputParams const &) const;
+	void latex(otexstream &, OutputParams const &) const;
 	///
-	int plaintext(odocstream &, OutputParams const &) const;
+	int plaintext(odocstringstream & ods, OutputParams const & op,
+	              size_t max_length = INT_MAX) const;
 	///
 	int docbook(odocstream &, OutputParams const & runparams) const;
 	///
-	InsetCode lyxCode() const { return NO_CODE; }
+	bool setMouseHover(BufferView const * bv, bool mouse_hover) const;
 	///
-	void edit(Cursor & cur, bool front, 
-		EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
+	bool clickable(int, int) const { return hasSettings(); }
+	//@}
+
+protected:
+	/// \name Methods relaying to the InsetCommandParams p_
+	//@{
 	///
-	RenderButton & button() const { return button_; }
+	std::string contextMenuName() const;
 	///
-	bool setMouseHover(bool mouse_hover);
+	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:
+	///
+	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);
@@ -103,24 +134,19 @@ private:
 	/// 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);
-	///
-	docstring contextMenu(BufferView const & bv, int x, int y) const;
-	///
-	bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
-	/// This should provide the text for the button
-	virtual docstring screenLabel() const = 0;
+	//@}
 
-private:
 	///
 	InsetCommandParams p_;
-	///
-	std::string mailer_name_;
 	/// changes color when mouse enters/leaves this inset
-	bool mouse_hover_;
+	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