// -*- 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 "inset.h"
+#include "insetcommandparams.h"
+#include "render_button.h"
+#include "mailinset.h"
+#include "cursor.h"
+
+
+namespace lyx {
-#include "lyxinset.h"
-#include "LString.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 InsetCommand: public Inset {
+
+///
+class InsetCommand : public InsetOld {
public:
///
- InsetCommand();
+ InsetCommand(InsetCommandParams const &, std::string const & mailer_name);
///
- InsetCommand(string const & name, string const & arg = string(),
- string const & opt = string());
+ ~InsetCommand();
///
- int ascent(Painter &, LyXFont const &) const;
+ bool metrics(MetricsInfo &, Dimension &) const;
///
- int descent(Painter &, LyXFont const &) const;
+ void draw(PainterInfo & pi, int x, int y) const;
///
- int width(Painter &, LyXFont const &) const;
+ void write(Buffer const &, std::ostream & os) const
+ { p_.write(os); }
///
- void draw(Painter &, LyXFont const &, int baseline, float & x) const;
+ virtual void read(Buffer const &, LyXLex & lex)
+ { p_.read(lex); }
///
- void Write(ostream &);
- /// Parse the command.
- void scanCommand(string const & cmd);
- /// Will not be used when lyxf3
- void Read(LyXLex & lex);
- ///
- virtual int Latex(ostream &, signed char fragile);
+ virtual int latex(Buffer const &, odocstream &,
+ OutputParams const &) const;
///
- virtual int Latex(string & file, signed char fragile);
+ int plaintext(Buffer const &, odocstream &,
+ OutputParams const &) const;
///
- virtual int Linuxdoc(string & file);
+ virtual int docbook(Buffer const &, odocstream &,
+ OutputParams const & runparams) const;
///
- virtual int DocBook(string & file);
+ InsetBase::Code lyxCode() const { return InsetBase::NO_CODE; }
+
///
- Inset * Clone() const;
- ///
- Inset::Code LyxCode() const
+ InsetCommandParams const & params() const { return p_; }
+ /// FIXME remove
+ std::string const getContents() const { return p_.getContents(); }
+ /// FIXME remove
+ void setContents(std::string const & c)
{
- return Inset::NO_CODE;
+ updateButtonLabel_ = true;
+ p_.setContents(c);
}
-
- /** 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 getScreenLabel() const
+ ///
+ void setParam(std::string const & name, docstring const & value)
{
- return getCommand();
+ updateButtonLabel_ = true;
+ p_[name] = value;
}
-
- /// Build the complete LaTeX command
- string getCommand() const;
///
- string const & getCmdName() const {
- return command;
+ docstring const & getParam(std::string const & name) const
+ {
+ return p_[name];
}
+ /// FIXME remove
+ virtual void replaceContents(std::string const & from, std::string const & to);
+ /// FIXME remove
+ std::string const getOptions() const { return p_.getOptions(); }
+ /// FIXME remove
+ std::string const getSecOptions() const { return p_.getSecOptions(); }
///
- string const & getOptions() const {
- return options;
- }
+ RenderButton & button() const { return button_; }
///
- string const & getContents() const {
- return contents;
- }
+ bool setMouseHover(bool mouse_hover);
+
+protected:
+ ///
+ virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
+ ///
+ bool getStatus(LCursor & cur, FuncRequest const & cmd, FuncStatus &) const;
+ ///
+ docstring const getCommand() const { return p_.getCommand(); }
///
- void setCmdName(string const & n) {
- command = n;
+ std::string const & getCmdName() const { return p_.getCmdName(); }
+ ///
+ void setCmdName(std::string const & n)
+ {
+ updateButtonLabel_ = true;
+ p_.setCmdName(n);
}
///
- void setOptions(string const & o) {
- options = o;
+ void setOptions(std::string const & o)
+ {
+ updateButtonLabel_ = true;
+ p_.setOptions(o);
}
///
- virtual void setContents(string const & c) {
- contents = c;
+ void setSecOptions(std::string const & s)
+ {
+ updateButtonLabel_ = true;
+ p_.setSecOptions(s);
}
-protected:
- ///
- string command;
- ///
- string options;
- ///
- string contents;
+ ///
+ void setParams(InsetCommandParams const &);
+ /// This should provide the text for the button
+ virtual docstring const getScreenLabel(Buffer const &) 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_;
+};
+
+
+class InsetCommandMailer : public MailInset {
+public:
+ ///
+ InsetCommandMailer(std::string const & name, InsetCommand & inset);
+ ///
+ virtual InsetBase & 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,
+ InsetCommandParams &);
+ ///
+ static std::string const params2string(std::string const & name,
+ InsetCommandParams const &);
+private:
+ ///
+ std::string const name_;
+ ///
+ InsetCommand & inset_;
};
+
+
+} // namespace lyx
+
#endif
projects / lyx.git / blobdiff