* 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();
+
+ /// 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 write(Buffer const &, std::ostream & os) const
- { p_.write(os); }
+ void setParam(std::string const & name, docstring const & value);
///
- virtual void read(Buffer const &, Lexer & lex)
- { p_.read(lex); }
+ 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) {}
+
+protected:
///
- int latex(Buffer const &, odocstream &, OutputParams const &) const;
+ void write(std::ostream & os) const { p_.write(os); }
///
- int plaintext(Buffer const &, odocstream &, OutputParams const &) const;
+ void read(Lexer & lex) { p_.read(lex); }
///
- int docbook(Buffer const &, odocstream &, OutputParams const & runparams) const;
+ void doDispatch(Cursor & cur, FuncRequest & cmd);
///
- InsetCode lyxCode() const { return NO_CODE; }
+ bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
///
- InsetCommandParams const & params() const { return p_; }
- /// FIXME Remove
- docstring const getFirstNonOptParam() const { return p_.getFirstNonOptParam(); }
- /// Whether the button label should be recomputed.
- void refresh() { updateButtonLabel_ = true; }
+ docstring const getCommand() const { return p_.getCommand(); }
+ ///
+ std::string const & getCmdName() const { return p_.getCmdName(); }
+ ///
+ 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)
- {
- updateButtonLabel_ = true;
- 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,
- EntryDirectionType entry_from = IGNORE_ENTRY_DIRECTION);
+ int docbook(odocstream &, OutputParams const & runparams) const;
+ ///
+ InsetCode lyxCode() const { return NO_CODE; }
///
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 CommandInfo const * findInfo(std::string const & cmdName);
+ 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);
-
-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)
- {
- updateButtonLabel_ = true;
- 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 const getScreenLabel(Buffer const &) const = 0;
+ virtual docstring screenLabel() const = 0;
+ ///
+ bool showInsetDialog(BufferView * bv) const;
private:
///
/// 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 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_;
-};
-
-
-
} // namespace lyx
#endif
projects / lyx.git / blobdiff