src/insets/insetert.h

   1 // -*- C++ -*-
   2 /**
   3  * \file insetert.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Jürgen Vigna
   8  * \author Lars Gullik Bjønnes
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef INSETERT_H
  14 #define INSETERT_H
  15
  16
  17 #include "insetcollapsable.h"
  18
  19 /** A collapsable text inset for LaTeX insertions.
  20
  21   To write full ert (including styles and other insets) in a given
  22   space.
  23
  24   Note that collapsed_ encompasses both the inline and collapsed button
  25   versions of this inset.
  26 */
  27
  28 class Language;
  29
  30 class InsetERT : public InsetCollapsable {
  31 public:
  32         ///
  33         enum ERTStatus {
  34                 Open,
  35                 Collapsed,
  36                 Inlined
  37         };
  38         ///
  39         InsetERT(BufferParams const &, bool collapsed = false);
  40         ///
  41         InsetERT(InsetERT const &);
  42         ///
  43         virtual std::auto_ptr<InsetBase> clone() const;
  44         ///
  45         InsetERT(BufferParams const &,
  46                  Language const *, std::string const & contents, bool collapsed);
  47         ///
  48         ~InsetERT();
  49         ///
  50         InsetOld::Code lyxCode() const { return InsetOld::ERT_CODE; }
  51         ///
  52         void read(Buffer const & buf, LyXLex & lex);
  53         ///
  54         void write(Buffer const & buf, std::ostream & os) const;
  55         ///
  56         std::string const editMessage() const;
  57         ///
  58         bool insertInset(BufferView *, InsetOld *);
  59         ///
  60         bool insetAllowed(InsetOld::Code code) const {
  61                 return code == InsetOld::NEWLINE_CODE;
  62         }
  63         ///
  64         void setFont(BufferView *, LyXFont const &,
  65                              bool toggleall = false, bool selectall = false);
  66         ///
  67         EDITABLE editable() const;
  68         ///
  69         int latex(Buffer const &, std::ostream &,
  70                   OutputParams const &) const;
  71         ///
  72         int plaintext(Buffer const &, std::ostream &,
  73                   OutputParams const & runparams) const;
  74         ///
  75         int linuxdoc(Buffer const &, std::ostream &,
  76                      OutputParams const &) const;
  77         ///
  78         int docbook(Buffer const &, std::ostream &,
  79                     OutputParams const & runparams) const;
  80         ///
  81         void validate(LaTeXFeatures &) const {}
  82         ///
  83         bool checkInsertChar(LyXFont &);
  84         ///
  85         // these are needed here because of the label/inlined functionallity
  86         ///
  87         bool isOpen() const { return status_ == Open || status_ == Inlined; }
  88         ///
  89         bool inlined() const { return status_ == Inlined; }
  90         ///
  91         ERTStatus status() const { return status_; }
  92         ///
  93         void open();
  94         ///
  95         void close() const;
  96         ///
  97         void metrics(MetricsInfo &, Dimension &) const;
  98         ///
  99         void draw(PainterInfo & pi, int x, int y) const;
 100         /// set the status of the inset
 101         void status(ERTStatus const st) const;
 102         ///
 103         bool showInsetDialog(BufferView *) const;
 104         ///
 105         void getDrawFont(LyXFont &) const;
 106         ///
 107         bool forceDefaultParagraphs(InsetOld const *) const { return true; }
 108 protected:
 109         ///
 110         virtual
 111         DispatchResult
 112         priv_dispatch(FuncRequest const &, idx_type &, pos_type &);
 113 private:
 114         ///
 115         void lfunMousePress(FuncRequest const &);
 116         ///
 117         // the bool return is used to see if we opened a dialog so that we can
 118         // check this from an outer inset and open the dialog of the outer inset
 119         // if that one has one!
 120         ///
 121         bool lfunMouseRelease(FuncRequest const &);
 122         ///
 123         void lfunMouseMotion(FuncRequest const &);
 124         ///
 125         void init();
 126         ///
 127         std::string const getNewLabel() const;
 128         ///
 129         void setButtonLabel() const;
 130         ///
 131         void setLatexFont(BufferView *);
 132         /// update status on button
 133         void updateStatus(bool = false) const;
 134         ///
 135         void edit(BufferView * bv, bool left);
 136         ///
 137         bool allowSpellCheck() const { return false; }
 138
 139         ///
 140         mutable ERTStatus status_;
 141 };
 142
 143
 144 #include "mailinset.h"
 145
 146 class InsetERTMailer : public MailInset {
 147 public:
 148         ///
 149         InsetERTMailer(InsetERT & inset);
 150         ///
 151         virtual InsetBase & inset() const { return inset_; }
 152         ///
 153         virtual std::string const & name() const { return name_; }
 154         ///
 155         virtual std::string const inset2string(Buffer const &) const;
 156         ///
 157         static void string2params(std::string const &, InsetERT::ERTStatus &);
 158         ///
 159         static std::string const params2string(InsetERT::ERTStatus);
 160 private:
 161         ///
 162         static std::string const name_;
 163         ///
 164         InsetERT & inset_;
 165 };
 166
 167 #endif