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         EDITABLE editable() const;
  65         ///
  66         int latex(Buffer const &, std::ostream &,
  67                   OutputParams const &) const;
  68         ///
  69         int plaintext(Buffer const &, std::ostream &,
  70                   OutputParams const & runparams) const;
  71         ///
  72         int linuxdoc(Buffer const &, std::ostream &,
  73                      OutputParams const &) const;
  74         ///
  75         int docbook(Buffer const &, std::ostream &,
  76                     OutputParams const & runparams) const;
  77         ///
  78         void validate(LaTeXFeatures &) const {}
  79         ///
  80         bool checkInsertChar(LyXFont &);
  81         ///
  82         // these are needed here because of the label/inlined functionallity
  83         ///
  84         bool isOpen() const { return status_ == Open || status_ == Inlined; }
  85         ///
  86         bool inlined() const { return status_ == Inlined; }
  87         ///
  88         ERTStatus status() const { return status_; }
  89         ///
  90         void open();
  91         ///
  92         void close() const;
  93         ///
  94         void metrics(MetricsInfo &, Dimension &) const;
  95         ///
  96         void draw(PainterInfo & pi, int x, int y) const;
  97         /// set the status of the inset
  98         void status(ERTStatus const st) const;
  99         ///
 100         bool showInsetDialog(BufferView *) const;
 101         ///
 102         void getDrawFont(LyXFont &) const;
 103         ///
 104         bool forceDefaultParagraphs(InsetOld const *) const { return true; }
 105 protected:
 106         ///
 107         virtual
 108         DispatchResult
 109         priv_dispatch(FuncRequest const &, idx_type &, pos_type &);
 110 private:
 111         ///
 112         void lfunMousePress(FuncRequest const &);
 113         ///
 114         // the bool return is used to see if we opened a dialog so that we can
 115         // check this from an outer inset and open the dialog of the outer inset
 116         // if that one has one!
 117         ///
 118         bool lfunMouseRelease(FuncRequest const &);
 119         ///
 120         void lfunMouseMotion(FuncRequest const &);
 121         ///
 122         void init();
 123         ///
 124         std::string const getNewLabel() const;
 125         ///
 126         void setButtonLabel() const;
 127         ///
 128         void setLatexFont(BufferView *);
 129         /// update status on button
 130         void updateStatus(bool = false) const;
 131         ///
 132         void edit(BufferView * bv, bool left);
 133         ///
 134         bool allowSpellCheck() const { return false; }
 135
 136         ///
 137         mutable ERTStatus status_;
 138 };
 139
 140
 141 #include "mailinset.h"
 142
 143 class InsetERTMailer : public MailInset {
 144 public:
 145         ///
 146         InsetERTMailer(InsetERT & inset);
 147         ///
 148         virtual InsetBase & inset() const { return inset_; }
 149         ///
 150         virtual std::string const & name() const { return name_; }
 151         ///
 152         virtual std::string const inset2string(Buffer const &) const;
 153         ///
 154         static void string2params(std::string const &, InsetERT::ERTStatus &);
 155         ///
 156         static std::string const params2string(InsetERT::ERTStatus);
 157 private:
 158         ///
 159         static std::string const name_;
 160         ///
 161         InsetERT & inset_;
 162 };
 163
 164 #endif