* 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.
*/
-#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 "Cursor.h"
namespace lyx {
+/////////////////////////////////////////////////////////////////////////
+//
+// InsetCommand
+//
+/////////////////////////////////////////////////////////////////////////
+
// Created by Alejandro 970222
-/** Used to insert a LaTeX command automatically.
- */
+// Used to insert a LaTeX command automatically.
-///
-class InsetCommand : public Inset {
+class InsetCommand : public Inset
+{
public:
///
- InsetCommand(InsetCommandParams const &, std::string const & mailer_name);
+ InsetCommand(Buffer *, 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 &);
///
- void metrics(MetricsInfo &, Dimension &) const;
+ static std::string params2string(std::string const & name,
+ InsetCommandParams const &);
///
- Dimension const dimension(BufferView const &) const { return button_.dimension(); }
+ InsetCommandParams const & params() const { return p_; }
///
- void draw(PainterInfo & pi, int x, int y) const;
+ void setParams(InsetCommandParams const &);
+ ///
+ void setParam(std::string const & name, docstring const & value);
+ ///
+ 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) {}
+ ///
+ virtual InsetCommand * asInsetCommand() { return this; }
+ ///
+ virtual InsetCommand const * asInsetCommand() const { return this; }
+ /// whether to include this inset in the strings generated for the TOC
+ virtual bool isInToc() const { return false; }
+
+protected:
///
void write(std::ostream & os) const { p_.write(os); }
///
void read(Lexer & lex) { p_.read(lex); }
///
- int latex(odocstream &, OutputParams const &) const;
+ void doDispatch(Cursor & cur, FuncRequest & cmd);
///
- int plaintext(odocstream &, OutputParams const &) const;
+ bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
///
- int docbook(odocstream &, OutputParams const & runparams) const;
+ docstring const getCommand() const { return p_.getCommand(); }
///
- InsetCode lyxCode() const { return NO_CODE; }
+ std::string const & getCmdName() const { return p_.getCmdName(); }
///
- InsetCommandParams const & params() const { return p_; }
- /// FIXME Remove
- docstring const getFirstNonOptParam() const { return p_.getFirstNonOptParam(); }
+ void setCmdName(std::string const & n) { p_.setCmdName(n); }
+
+private:
+ ///
+ void metrics(MetricsInfo &, Dimension &) const;
+ ///
+ Dimension const dimension(BufferView const &) const { return button_.dimension(); }
+ ///
+ void draw(PainterInfo & pi, int x, int y) const;
///
- void setParam(std::string const & name, docstring const & value)
- {
- p_[name] = value;
- }
+ int latex(odocstream &, OutputParams const &) const;
///
- docstring const & getParam(std::string const & name) const
- {
- return p_[name];
- }
+ int plaintext(odocstream &, OutputParams const &) const;
///
- void edit(Cursor & cur, bool front,
- EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
+ int docbook(odocstream &, OutputParams const & runparams) const;
+ ///
+ InsetCode lyxCode() const { return NO_CODE; }
///
RenderButton & button() const { return button_; }
///
/// 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) {};
-
-protected:
///
- virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
- ///
- 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) { p_.setCmdName(n); }
- ///
- void setParams(InsetCommandParams const &);
+ docstring contextMenu(BufferView const & bv, int x, int y) const;
/// This should provide the text for the button
virtual docstring screenLabel() const = 0;
-
-private:
+ ///
+ bool showInsetDialog(BufferView * bv) const;
///
InsetCommandParams p_;
///
mutable RenderButton button_;
};
-
-class InsetCommandMailer : public MailInset {
-public:
- ///
- InsetCommandMailer(std::string const & name, InsetCommand & inset);
- ///
- virtual Inset & inset() const { return inset_; }
- ///
- virtual std::string const & name() const { return name_; }
- ///
- virtual std::string const inset2string(Buffer const &) const;
- /// 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,
- InsetCommandParams const &);
-private:
- ///
- std::string const name_;
- ///
- InsetCommand & inset_;
-};
-
-
+/// Decode InsetCommand considering Inset name and data.
+bool decodeInsetParam(std::string const & name, std::string & data,
+ Buffer const & buffer);
} // namespace lyx