mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-11 05:33:33 +00:00
32871c1284
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@18089 a592a061-630c-0410-9148-cb99ea01b6c8
151 lines
3.4 KiB
C++
151 lines
3.4 KiB
C++
// -*- C++ -*-
|
|
/**
|
|
* \file InsetCommand.h
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \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
|
|
|
|
#include "Inset.h"
|
|
#include "InsetCommandParams.h"
|
|
#include "RenderButton.h"
|
|
#include "MailInset.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}.
|
|
*/
|
|
|
|
///
|
|
class InsetCommand : public Inset {
|
|
public:
|
|
///
|
|
InsetCommand(InsetCommandParams const &, std::string const & mailer_name);
|
|
///
|
|
~InsetCommand();
|
|
///
|
|
bool metrics(MetricsInfo &, Dimension &) const;
|
|
///
|
|
void draw(PainterInfo & pi, int x, int y) const;
|
|
///
|
|
void write(Buffer const &, std::ostream & os) const
|
|
{ p_.write(os); }
|
|
///
|
|
virtual void read(Buffer const &, Lexer & lex)
|
|
{ p_.read(lex); }
|
|
///
|
|
int latex(Buffer const &, odocstream &, OutputParams const &) const;
|
|
///
|
|
int plaintext(Buffer const &, odocstream &, OutputParams const &) const;
|
|
///
|
|
int docbook(Buffer const &, odocstream &, OutputParams const & runparams) const;
|
|
///
|
|
Inset::Code lyxCode() const { return Inset::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:
|
|
///
|
|
void setParam(std::string const & name, docstring const & value)
|
|
{
|
|
updateButtonLabel_ = true;
|
|
p_[name] = value;
|
|
}
|
|
///
|
|
docstring const & getParam(std::string const & name) const
|
|
{
|
|
return p_[name];
|
|
}
|
|
/// FIXME remove
|
|
virtual void replaceContents(std::string const & from, std::string const & to);
|
|
///
|
|
RenderButton & button() const { return button_; }
|
|
///
|
|
bool setMouseHover(bool mouse_hover);
|
|
|
|
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 &);
|
|
/// 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 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,
|
|
InsetCommandParams &);
|
|
///
|
|
static std::string const params2string(std::string const & name,
|
|
InsetCommandParams const &);
|
|
private:
|
|
///
|
|
std::string const name_;
|
|
///
|
|
InsetCommand & inset_;
|
|
};
|
|
|
|
|
|
|
|
} // namespace lyx
|
|
|
|
#endif
|