]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insetcommand.h
Final touch 'inset display()'; fix 'is a bit silly' bug
[lyx.git] / src / insets / insetcommand.h
index d0fb7a5c9fabb6c2a9c90e7015d8cbb8ce2a7203..969f987da073b53f902ec245907b8b9b6acc5625 100644 (file)
 // -*- C++ -*-
-/* This file is part of*
- * ====================================================== 
+/**
+ * \file insetcommand.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *           LyX, The Document Processor
- *      
- *           Copyright 1995 Matthias Ettrich
- *           Copyright 1995-2000 The LyX Team.
+ * \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
 
-#ifdef __GNUG__
-#pragma interface
-#endif
 
-#include "insetbutton.h"
-#include <sigc++/signal_system.h>
-#include <boost/utility.hpp>
-
-#ifdef SIGC_CXX_NAMESPACES
-using SigC::Signal0;
-#endif
+#include "inset.h"
+#include "insetcommandparams.h"
+#include "render_button.h"
+#include "mailinset.h"
 
 // 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}. 
+ *   LaTeX command: \name[options]{contents}.
  */
-class InsetCommandParams {
+
+///
+class InsetCommand : public InsetOld {
 public:
-       ///
-       InsetCommandParams();
        ///
        explicit
-       InsetCommandParams( string const & n,
-                           string const & c = string(),
-                           string const & o = string());
-       ///
-       bool operator==(InsetCommandParams const &) const;
-       ///
-       bool operator!=(InsetCommandParams const &) const;
+       InsetCommand(InsetCommandParams const &);
        ///
-       void Read(LyXLex &);
-       /// Parse the command
-       void scanCommand(string const &);
+       void metrics(MetricsInfo &, Dimension &) const;
        ///
-       void Write(std::ostream &) const;
-       /// Build the complete LaTeX command
-       string const getCommand() const;
+       void draw(PainterInfo & pi, int x, int y) const;
        ///
-       string const & getCmdName() const { return cmdname; }
+       void write(Buffer const &, std::ostream & os) const
+               { p_.write(os); }
        ///
-       string const & getOptions() const { return options; }
+       virtual void read(Buffer const &, LyXLex & lex)
+               { p_.read(lex); }
+       /// Can remove one InsetBibKey is modified
+       void scanCommand(std::string const & c) { p_.scanCommand(c); };
        ///
-       string const & getContents() const { return contents; }
+       virtual int latex(Buffer const &, std::ostream &,
+                         LatexRunParams const &) const;
        ///
-       void setCmdName( string const & n) { cmdname = n; }
+       int ascii(Buffer const &, std::ostream &, int linelen) const;
        ///
-       void setOptions(string const & o) { options = o; }
+       virtual int linuxdoc(Buffer const &, std::ostream &) const;
        ///
-       void setContents(string const & c) { contents = c; }
+       virtual int docbook(Buffer const &, std::ostream &, bool) const;
        ///
-       string const getAsString() const;
+       InsetOld::Code lyxCode() const { return InsetOld::NO_CODE; }
        ///
-       void setFromString( string const & );
-private:
-       ///    
-       string cmdname;
-       ///    
-       string contents;
-       ///    
-       string options;
-};
-
-
-///
-class InsetCommand : public InsetButton, public noncopyable {
-public:
+       virtual bool display() const { return true; }
+       
        ///
-       explicit
-       InsetCommand(InsetCommandParams const &);
+       InsetCommandParams const & params() const { return p_; }
        ///
-       virtual ~InsetCommand() { hideDialog(); }
+       std::string const & getContents() const { return p_.getContents(); }
        ///
-       void Write(Buffer const *, std::ostream & os) const
-               { p_.Write( os ); }
+       void setContents(std::string const & c) { p_.setContents(c); }
        ///
-       virtual void Read(Buffer const *, LyXLex & lex)
-               { p_.Read( lex ); }
-       /// Can remove one InsetBibKey is modified
-       void scanCommand(string const & c) { p_.scanCommand( c ); };
-       /// 
-       virtual int Latex(Buffer const *, std::ostream &,
-                         bool fragile, bool free_spc) const;
+       std::string const & getOptions() const { return p_.getOptions(); }
        ///
-       int Ascii(Buffer const *, std::ostream &, int linelen) const;
+       RenderButton & button() const { return button_; }
+
+protected:
        ///
-       virtual int Linuxdoc(Buffer const *, std::ostream &) const;
+       virtual
+       dispatch_result
+       priv_dispatch(FuncRequest const & cmd, idx_type &, pos_type &);
        ///
-       virtual int DocBook(Buffer const *, std::ostream &) const;
+       std::string const getCommand() const { return p_.getCommand(); }
        ///
-       Inset::Code LyxCode() const { return Inset::NO_CODE; }
-       
-       /** Get the label that appears at screen.
-         
-         I thought it was enough to eliminate the argument to avoid
-         confusion with lyxinset::getLabel(int), but I've seen that
-         it wasn't. I hope you never confuse again both methods.  (ale)
-        */
-       virtual string const getScreenLabel() const = 0;
+       std::string const & getCmdName() const { return p_.getCmdName(); }
        ///
-       string const getCommand() const { return p_.getCommand(); }
+       void setCmdName(std::string const & n) { p_.setCmdName(n); }
        ///
-       string const & getCmdName() const { return p_.getCmdName(); }
+       void setOptions(std::string const & o) { p_.setOptions(o); }
        ///
-       string const & getOptions() const { return p_.getOptions(); }
+       void setParams(InsetCommandParams const &);
+       /// This should provide the text for the button
+       virtual std::string const getScreenLabel(Buffer const &) const = 0;
+
+private:
        ///
-       string const & getContents() const { return p_.getContents(); }
+       InsetCommandParams p_;
+       mutable bool set_label_;
+       mutable RenderButton button_;
+};
+
+
+class InsetCommandMailer : public MailInset {
+public:
        ///
-       void setCmdName(string const & n) { p_.setCmdName(n); }
+       InsetCommandMailer(std::string const & name, InsetCommand & inset);
        ///
-       void setOptions(string const & o) { p_.setOptions(o); }
+       virtual InsetBase & inset() const { return inset_; }
        ///
-       void setContents(string const & c) { p_.setContents(c); }
+       virtual std::string const & name() const { return name_; }
        ///
-       InsetCommandParams const & params() const { return p_; }
+       virtual std::string const inset2string(Buffer const &) const;
        ///
-       void setParams(InsetCommandParams const &);
+       static void string2params(std::string const &, InsetCommandParams &);
        ///
-       Signal0<void> hideDialog;
+       static std::string const params2string(std::string const & name,
+                                         InsetCommandParams const &);
 private:
        ///
-       InsetCommandParams p_;
+       std::string const name_;
+       ///
+       InsetCommand & inset_;
 };
 
+
 #endif