lyx_mirror/src/insets/insetcommand.h
Angus Leeming 0be0fcfd59 If I ever see another licence blurb again, it'll be too soon...
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@7598 a592a061-630c-0410-9148-cb99ea01b6c8
2003-08-23 00:17:00 +00:00

118 lines
2.9 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 "renderers.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}.
*/
///
class InsetCommand : public InsetOld {
public:
///
explicit
InsetCommand(InsetCommandParams const &);
///
void 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 *, 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 &,
LatexRunParams const &) const;
///
int ascii(Buffer const *, std::ostream &, int linelen) const;
///
virtual int linuxdoc(Buffer const *, std::ostream &) const;
///
virtual int docbook(Buffer const *, std::ostream &, bool) const;
///
InsetOld::Code lyxCode() const { return InsetOld::NO_CODE; }
///
InsetCommandParams const & params() const { return p_; }
///
virtual dispatch_result localDispatch(FuncRequest const & cmd);
///
string const & getContents() const { return p_.getContents(); }
///
void setContents(string const & c) { p_.setContents(c); }
///
string const & getOptions() const { return p_.getOptions(); }
protected:
///
string const getCommand() const { return p_.getCommand(); }
///
string const & getCmdName() const { return p_.getCmdName(); }
///
void setCmdName(string const & n) { p_.setCmdName(n); }
///
void setOptions(string const & o) { p_.setOptions(o); }
///
void setParams(InsetCommandParams const &);
///
virtual BufferView * view() const;
/// This should provide the text for the button
virtual string const getScreenLabel(Buffer const *) const = 0;
private:
///
InsetCommandParams p_;
mutable bool set_label_;
mutable ButtonRenderer button_;
};
class InsetCommandMailer : public MailInset {
public:
///
InsetCommandMailer(string const & name, InsetCommand & inset);
///
virtual InsetBase & inset() const { return inset_; }
///
virtual string const & name() const { return name_; }
///
virtual string const inset2string(Buffer const &) const;
///
static void string2params(string const &, InsetCommandParams &);
///
static string const params2string(string const & name,
InsetCommandParams const &);
private:
///
string const name_;
///
InsetCommand & inset_;
};
#endif