]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCommand.h
Move isMultiCell() to Cursor, and use it.
[lyx.git] / src / insets / InsetCommand.h
index b60e1d059d788d69b4a757f4e1c908d56f0b6f4c..55e8c4d6cf94db07b52328c13e5e0c2cd29e3b0c 100644 (file)
  * 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"
+#include "Cursor.h"
 
 
 namespace lyx {
 
 
+/////////////////////////////////////////////////////////////////////////
+//
+// 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();
+
+       /// returns true if params are successfully read
+       static bool string2params(std::string const &, std::string const & name,
+                                 InsetCommandParams &);
        ///
-       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); }
+       static std::string params2string(std::string const & name,
+                                              InsetCommandParams const &);
        ///
-       int latex(Buffer const &, odocstream &, OutputParams const &) const;
+       InsetCommandParams const & params() const { return p_; }
        ///
-       int plaintext(Buffer const &, odocstream &, OutputParams const &) const;
+       void setParams(InsetCommandParams const &);
        ///
-       int docbook(Buffer const &, odocstream &, OutputParams const & runparams) const;
+       void setParam(std::string const & name, docstring const & value);
        ///
-       InsetBase::Code lyxCode() const { return InsetBase::NO_CODE; }
+       docstring const & getParam(std::string const & name) const;
+       /// FIXME Remove
+       docstring const getFirstNonOptParam() const { return p_.getFirstNonOptParam(); }
+       /// update label and references.
+       virtual void updateCommand(docstring const &, bool) {}
 
-       ///
-       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:
-       ///
-       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);
+       void write(std::ostream & os) const { p_.write(os); }
        ///
-       RenderButton & button() const { return button_; }
-       ///
-       bool setMouseHover(bool mouse_hover);
-
-protected:
+       void read(Lexer & lex) { p_.read(lex); }
        ///
-       virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
+       void doDispatch(Cursor & cur, FuncRequest & cmd);
        ///
-       bool getStatus(LCursor & cur, FuncRequest const & cmd, FuncStatus &) const;
+       bool getStatus(Cursor & 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 setParams(InsetCommandParams const &);
-       /// This should provide the text for the button
-       virtual docstring const getScreenLabel(Buffer const &) const = 0;
+       void setCmdName(std::string const & n) { p_.setCmdName(n); }
 
 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:
+       void metrics(MetricsInfo &, Dimension &) const;
        ///
-       InsetCommandMailer(std::string const & name, InsetCommand & inset);
+       Dimension const dimension(BufferView const &) const { return button_.dimension(); }
        ///
-       virtual InsetBase & inset() const { return inset_; }
+       void draw(PainterInfo & pi, int x, int y) const;
        ///
-       virtual std::string const & name() const { return name_; }
+       int latex(odocstream &, OutputParams const &) const;
        ///
-       virtual std::string const inset2string(Buffer const &) const;
+       int plaintext(odocstream &, OutputParams const &) const;
        ///
-       static void string2params(std::string const &, std::string const & name,
-                                 InsetCommandParams &);
+       int docbook(odocstream &, OutputParams const & runparams) const;
        ///
-       static std::string const params2string(std::string const & name,
-                                              InsetCommandParams const &);
+       InsetCode lyxCode() const { return NO_CODE; }
+       ///
+       void edit(Cursor & cur, bool front, 
+               EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
+       ///
+       RenderButton & button() const { return button_; }
+       ///
+       bool setMouseHover(bool mouse_hover);
+       /// 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);
+       ///
+       docstring contextMenu(BufferView const & bv, int x, int y) const;
+       /// This should provide the text for the button
+       virtual docstring screenLabel() const = 0;
+
 private:
        ///
-       std::string const name_;
+       InsetCommandParams p_;
+       ///
+       std::string mailer_name_;
+       /// changes color when mouse enters/leaves this inset
+       bool mouse_hover_;
        ///
-       InsetCommand & inset_;
+       mutable RenderButton button_;
 };
 
 
-
 } // namespace lyx
 
 #endif