Cleanup mouse/selection/context-menu interactions.

[lyx.git] / src / insets / InsetCommand.h

diff --git a/src/insets/InsetCommand.h b/src/insets/InsetCommand.h
index b60e1d059d788d69b4a757f4e1c908d56f0b6f4c..9e946745ca098ddf98c482248f75119efa7b3158 100644 (file)
--- a/src/insets/InsetCommand.h
+++ b/src/insets/InsetCommand.h
@@ -17,61 +17,48 @@
 #include "InsetCommandParams.h"
 #include "RenderButton.h"
 #include "MailInset.h"
-#include "LCursor.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}.
+/** 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 metrics(MetricsInfo &, Dimension &) const;
+       ///
+       Dimension const dimension(BufferView const &) const { return button_.dimension(); }
        ///
        void draw(PainterInfo & pi, int x, int y) const;
        ///
-       void write(Buffer const &, std::ostream & os) const
-               { p_.write(os); }
+       void write(std::ostream & os) const { p_.write(os); }
        ///
-       virtual void read(Buffer const &, LyXLex & lex)
-               { p_.read(lex); }
+       void read(Lexer & lex) { p_.read(lex); }
        ///
-       int latex(Buffer const &, odocstream &, OutputParams const &) const;
+       int latex(odocstream &, OutputParams const &) const;
        ///
-       int plaintext(Buffer const &, odocstream &, OutputParams const &) const;
+       int plaintext(odocstream &, OutputParams const &) const;
        ///
-       int docbook(Buffer const &, odocstream &, OutputParams const & runparams) const;
+       int docbook(odocstream &, OutputParams const & runparams) const;
        ///
-       InsetBase::Code lyxCode() const { return InsetBase::NO_CODE; }
-
+       InsetCode lyxCode() const { return NO_CODE; }
        ///
        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:
+       /// FIXME Remove
+       docstring const getFirstNonOptParam() const { return p_.getFirstNonOptParam(); }
        ///
        void setParam(std::string const & name, docstring const & value)
        {
-               updateButtonLabel_ = true;
                p_[name] = value;
        }
        ///
@@ -79,40 +66,51 @@ public:
        {
                return p_[name];
        }
-       /// FIXME remove
-       virtual void replaceContents(std::string const & from, std::string const & to);
+       ///
+       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);
+       /// update label and references.
+       virtual void updateCommand(docstring const &, bool) {};
+       ///
+       virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
 
 protected:
        ///
-       virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
+       virtual 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 setCmdName(std::string const & n) { p_.setCmdName(n); }
        ///
        void setParams(InsetCommandParams const &);
        /// This should provide the text for the button
-       virtual docstring const getScreenLabel(Buffer const &) const = 0;
+       virtual docstring screenLabel() 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_;
 };
 
@@ -122,13 +120,13 @@ public:
        ///
        InsetCommandMailer(std::string const & name, InsetCommand & inset);
        ///
-       virtual InsetBase & inset() const { return inset_; }
+       virtual Inset & 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,
+       /// returns true if params are successfully read
+       static bool string2params(std::string const &, std::string const & name,
                                  InsetCommandParams &);
        ///
        static std::string const params2string(std::string const & name,