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 "updatableinset.h"
  16 #include "ParagraphList_fwd.h"
  17 #include "RowList_fwd.h"
  18 #include "lyxtext.h"
  19
  20 #include "support/types.h"
  21
  22 #include "frontends/mouse_state.h"
  23
  24
  25 class Buffer;
  26 class BufferParams;
  27 class BufferView;
  28 class Dimension;
  29 class LColor_color;
  30 class LyXCursor;
  31 class Painter;
  32 class Paragraph;
  33 class Row;
  34
  35 /**
  36  A text inset is like a TeX box to write full text
  37  (including styles and other insets) in a given space.
  38  @author: Jürgen Vigna
  39  */
  40 class InsetText : public UpdatableInset {
  41 public:
  42         ///
  43         enum DrawFrame {
  44                 ///
  45                 NEVER = 0,
  46                 ///
  47                 LOCKED,
  48                 ///
  49                 ALWAYS
  50         };
  51         ///
  52         explicit InsetText(BufferParams const &);
  53         ///
  54         InsetText(InsetText const &);
  55         ///
  56         virtual std::auto_ptr<InsetBase> clone() const;
  57         ///
  58         void operator=(InsetText const & it);
  59         /// empty inset to empty par, or just mark as erased
  60         void clear(bool just_mark_erased);
  61         ///
  62         void read(Buffer const & buf, LyXLex & lex);
  63         ///
  64         void write(Buffer const & buf, std::ostream & os) const;
  65         ///
  66         void metrics(MetricsInfo & mi, Dimension & dim) const;
  67         ///
  68         void draw(PainterInfo & pi, int x, int y) const;
  69         ///
  70         std::string const editMessage() const;
  71         ///
  72         bool isTextInset() const { return true; }
  73         ///
  74         int latex(Buffer const &, std::ostream &,
  75                   OutputParams const &) const;
  76         ///
  77         int plaintext(Buffer const &, std::ostream &,
  78                   OutputParams const &) const;
  79         ///
  80         int linuxdoc(Buffer const &, std::ostream &,
  81                      OutputParams const &) const ;
  82         ///
  83         int docbook(Buffer const &, std::ostream &,
  84                     OutputParams const &) const ;
  85         ///
  86         void validate(LaTeXFeatures & features) const;
  87         ///
  88         InsetOld::Code lyxCode() const { return InsetOld::TEXT_CODE; }
  89         /// FIXME, document
  90         void getCursorPos(int & x, int & y) const;
  91         ///
  92         bool insertInset(BufferView *, InsetOld *);
  93         ///
  94         bool insetAllowed(InsetOld::Code) const;
  95         ///
  96         void setFont(BufferView *, LyXFont const &,
  97                      bool toggleall = false,
  98                      bool selectall = false);
  99         ///
 100         void setText(std::string const &, LyXFont const &);
 101         ///
 102         void setAutoBreakRows(bool);
 103         ///
 104         bool getAutoBreakRows() const { return autoBreakRows_; }
 105         ///
 106         void setDrawFrame(DrawFrame);
 107         ///
 108         LColor_color frameColor() const;
 109         ///
 110         void setFrameColor(LColor_color);
 111         ///
 112         void setViewCache(BufferView const * bv) const;
 113         ///
 114         bool showInsetDialog(BufferView *) const;
 115         /// Appends \c list with all labels found within this inset.
 116         void getLabelList(Buffer const &, std::vector<std::string> & list) const;
 117         ///
 118         int scroll(bool recursive = true) const;
 119         ///
 120         void scroll(BufferView * bv, float sx) const {
 121                 UpdatableInset::scroll(bv, sx);
 122         }
 123         ///
 124         void scroll(BufferView * bv, int offset) const {
 125                 UpdatableInset::scroll(bv, offset);
 126         }
 127         ///
 128         ParagraphList * getParagraphs(int) const;
 129         ///
 130         LyXText * getText(int) const;
 131
 132         /// mark as erased for change tracking
 133         void markErased() { clear(true); };
 134         /**
 135          * Mark as new. Used when pasting in tabular, and adding rows
 136          * or columns. Note that pasting will ensure that tracking already
 137          * happens, and this just resets the changes for the copied text,
 138          * whereas for row/col add, we need to start tracking changes
 139          * for the (empty) paragraph contained.
 140          */
 141         void markNew(bool track_changes = false);
 142
 143         ///
 144         void getDrawFont(LyXFont &) const;
 145         /// append text onto the existing text
 146         void appendParagraphs(Buffer * bp, ParagraphList &);
 147
 148         ///
 149         void addPreview(lyx::graphics::PreviewLoader &) const;
 150
 151         ///
 152         void edit(BufferView *, bool);
 153         ///
 154         void edit(BufferView *, int, int);
 155
 156         ///
 157         int numParagraphs() const { return 1; }
 158         ///
 159         ParagraphList & paragraphs() const;
 160
 161 private:
 162         ///
 163         DispatchResult
 164         priv_dispatch(FuncRequest const &, idx_type &, pos_type &);
 165         ///
 166         void updateLocal(BufferView *);
 167         ///
 168         void init();
 169         // If the inset is empty set the language of the current font to the
 170         // language to the surronding text (if different).
 171         void sanitizeEmptyText(BufferView *);
 172         ///
 173         void setCharFont(Buffer const &, int pos, LyXFont const & font);
 174         ///
 175         void removeNewlines();
 176         ///
 177         void drawFrame(Painter &, int x) const;
 178         ///
 179         void clearInset(Painter &, int x, int y) const;
 180         ///
 181         void collapseParagraphs(BufferView *);
 182
 183         /* Private structures and variables */
 184         ///
 185         bool autoBreakRows_;
 186         ///
 187         DrawFrame drawFrame_;
 188         /** We store the LColor::color value as an int to get LColor.h out
 189          *  of the header file.
 190          */
 191         int frame_color_;
 192         ///
 193         mutable lyx::paroffset_type old_par;
 194
 195         /** to remember old painted frame dimensions to clear it on
 196          *  the right spot!
 197          */
 198         mutable bool in_insetAllowed;
 199 public:
 200         ///
 201         mutable LyXText text_;
 202 };
 203 #endif