src/insets/insettext.h

   1 // -*- C++ -*-
   2 /**
   3  * \file insettext.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  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef INSETTEXT_H
  13 #define INSETTEXT_H
  14
  15 #include "inset.h"
  16 #include "RowList_fwd.h"
  17 #include "lyxfont.h"
  18 #include "lyxtext.h"
  19
  20 #include "support/types.h"
  21
  22 #include "frontends/mouse_state.h"
  23
  24 class Buffer;
  25 class BufferParams;
  26 class BufferView;
  27 class CursorSlice;
  28 class Dimension;
  29 class LColor_color;
  30 class ParagraphList;
  31
  32
  33 /**
  34  A text inset is like a TeX box to write full text
  35  (including styles and other insets) in a given space.
  36  */
  37 class InsetText : public InsetOld {
  38 public:
  39         ///
  40         explicit InsetText(BufferParams const &);
  41         ///
  42         InsetText();
  43         /// empty inset to empty par
  44         void clear();
  45         ///
  46         void read(Buffer const & buf, LyXLex & lex);
  47         ///
  48         void write(Buffer const & buf, std::ostream & os) const;
  49         ///
  50         void metrics(MetricsInfo & mi, Dimension & dim) const;
  51         ///
  52         void draw(PainterInfo & pi, int x, int y) const;
  53         /// draw inset selection
  54         void drawSelection(PainterInfo & pi, int x, int y) const;
  55         ///
  56         std::string const editMessage() const;
  57         ///
  58         EDITABLE editable() const { return HIGHLY_EDITABLE; }
  59         ///
  60         bool isTextInset() const { return true; }
  61         ///
  62         int latex(Buffer const &, std::ostream &,
  63                   OutputParams const &) const;
  64         ///
  65         int plaintext(Buffer const &, std::ostream &,
  66                   OutputParams const &) const;
  67         ///
  68         int linuxdoc(Buffer const &, std::ostream &,
  69                      OutputParams const &) const;
  70         ///
  71         int docbook(Buffer const &, std::ostream &,
  72                     OutputParams const &) const;
  73         ///
  74         void validate(LaTeXFeatures & features) const;
  75
  76         /// return x,y of given position relative to the inset's baseline
  77         void cursorPos(CursorSlice const & sl, bool boundary, int & x, int & y) const;
  78         ///
  79         Code lyxCode() const { return TEXT_CODE; }
  80         ///
  81         void setText(std::string const &, LyXFont const &);
  82         ///
  83         void setAutoBreakRows(bool);
  84         ///
  85         bool getAutoBreakRows() const { return text_.autoBreakRows_; }
  86         ///
  87         void setDrawFrame(bool);
  88         ///
  89         LColor_color frameColor() const;
  90         ///
  91         void setFrameColor(LColor_color);
  92         ///
  93         void setViewCache(BufferView const * bv) const;
  94         ///
  95         bool showInsetDialog(BufferView *) const;
  96         ///
  97         LyXText * getText(int i) const {
  98                 return (i == 0) ? const_cast<LyXText*>(&text_) : 0;
  99         }
 100         ///
 101         bool getStatus(LCursor & cur, FuncRequest const & cmd, FuncStatus &) const;
 102
 103         /// mark as erased for change tracking
 104         void markErased(bool erased);
 105
 106         /**
 107          * Mark as new. Used when pasting in tabular, and adding rows
 108          * or columns. Note that pasting will ensure that tracking already
 109          * happens, and this just resets the changes for the copied text,
 110          * whereas for row/col add, we need to start tracking changes
 111          * for the (empty) paragraph contained.
 112          */
 113         void markNew(bool track_changes = false);
 114
 115         /// append text onto the existing text
 116         void appendParagraphs(Buffer * bp, ParagraphList &);
 117
 118         ///
 119         void addPreview(lyx::graphics::PreviewLoader &) const;
 120
 121         ///
 122         void edit(LCursor & cur, bool left);
 123         ///
 124         InsetBase * editXY(LCursor & cur, int x, int y);
 125
 126         /// number of cells in this inset
 127         size_t nargs() const { return 1; }
 128         ///
 129         ParagraphList & paragraphs();
 130         ///
 131         ParagraphList const & paragraphs() const;
 132         ///
 133         bool insetAllowed(Code) const { return true; }
 134         ///
 135         bool allowSpellCheck() const { return true; }
 136         /// should paragraph indendation be ommitted in any case?
 137         bool neverIndent() const;
 138         ///
 139         InsetText(InsetText const &);
 140         ///
 141         bool & Wide() const { return wide_inset_; }
 142
 143 protected:
 144         ///
 145         virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
 146
 147 private:
 148         ///
 149         virtual std::auto_ptr<InsetBase> doClone() const;
 150         ///
 151         void init();
 152
 153         ///
 154         bool drawFrame_;
 155         /** We store the LColor::color value as an int to get LColor.h out
 156          *  of the header file.
 157          */
 158         int frame_color_;
 159         ///
 160         mutable lyx::pit_type old_pit;
 161         ///
 162         static int border_;
 163         ///
 164         mutable bool wide_inset_;
 165 public:
 166         ///
 167         mutable LyXText text_;
 168         ///
 169         mutable LyXFont font_;
 170 };
 171 #endif