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 &, LyXLex &);
  63         ///
  64         void write(Buffer const &, std::ostream &) const;
  65         ///
  66         void metrics(MetricsInfo &, Dimension &) const;
  67         ///
  68         int textWidth() const;
  69         ///
  70         void draw(PainterInfo & pi, int x, int y) const;
  71         ///
  72         std::string const editMessage() const;
  73         ///
  74         bool isTextInset() const { return true; }
  75         ///
  76         int latex(Buffer const &, std::ostream &,
  77                   OutputParams const &) const;
  78         ///
  79         int plaintext(Buffer const &, std::ostream &,
  80                   OutputParams const &) const;
  81         ///
  82         int linuxdoc(Buffer const &, std::ostream &,
  83                      OutputParams const &) const ;
  84         ///
  85         int docbook(Buffer const &, std::ostream &,
  86                     OutputParams const &) const ;
  87         ///
  88         void validate(LaTeXFeatures & features) const;
  89         ///
  90         InsetOld::Code lyxCode() const { return InsetOld::TEXT_CODE; }
  91         /// FIXME, document
  92         void getCursorPos(BufferView *, int & x, int & y) const;
  93         ///
  94         int insetInInsetY() const;
  95         ///
  96         bool insertInset(BufferView *, InsetOld *);
  97         ///
  98         bool insetAllowed(InsetOld::Code) const;
  99         ///
 100         void setFont(BufferView *, LyXFont const &,
 101                      bool toggleall = false,
 102                      bool selectall = false);
 103         ///
 104         void writeParagraphData(Buffer const &, std::ostream &) const;
 105         ///
 106         void setText(std::string const &, LyXFont const &);
 107         ///
 108         void setAutoBreakRows(bool);
 109         ///
 110         bool getAutoBreakRows() const { return autoBreakRows_; }
 111         ///
 112         void setDrawFrame(DrawFrame);
 113         ///
 114         LColor_color frameColor() const;
 115         ///
 116         void setFrameColor(LColor_color);
 117         ///
 118         void setViewCache(BufferView const * bv) const;
 119         ///
 120         bool showInsetDialog(BufferView *) const;
 121         /// Appends \c list with all labels found within this inset.
 122         void getLabelList(Buffer const &, std::vector<std::string> & list) const;
 123         ///
 124         int scroll(bool recursive = true) const;
 125         ///
 126         void scroll(BufferView * bv, float sx) const {
 127                 UpdatableInset::scroll(bv, sx);
 128         }
 129         ///
 130         void scroll(BufferView * bv, int offset) const {
 131                 UpdatableInset::scroll(bv, offset);
 132         }
 133         ///
 134         void clearSelection(BufferView * bv);
 135         ///
 136         ParagraphList * getParagraphs(int) const;
 137         ///
 138         LyXText * getText(int) const;
 139
 140         /// mark as erased for change tracking
 141         void markErased() { clear(true); };
 142         /**
 143          * Mark as new. Used when pasting in tabular, and adding rows
 144          * or columns. Note that pasting will ensure that tracking already
 145          * happens, and this just resets the changes for the copied text,
 146          * whereas for row/col add, we need to start tracking changes
 147          * for the (empty) paragraph contained.
 148          */
 149         void markNew(bool track_changes = false);
 150
 151         ///
 152         bool checkInsertChar(LyXFont &);
 153         ///
 154         void getDrawFont(LyXFont &) const;
 155         /// append text onto the existing text
 156         void appendParagraphs(Buffer * bp, ParagraphList &);
 157
 158         ///
 159         void addPreview(lyx::graphics::PreviewLoader &) const;
 160
 161         ///
 162         void edit(BufferView *, bool);
 163         ///
 164         void edit(BufferView *, int, int);
 165
 166         ///
 167         int numParagraphs() const { return 1; }
 168         ///
 169         mutable ParagraphList paragraphs;
 170 protected:
 171         ///
 172         DispatchResult
 173         priv_dispatch(FuncRequest const &, idx_type &, pos_type &);
 174         ///
 175         void updateLocal(BufferView *, bool mark_dirty);
 176
 177 private:
 178         ///
 179         void init();
 180         ///
 181         void lfunMousePress(FuncRequest const &);
 182         ///
 183         void lfunMouseMotion(FuncRequest const &);
 184         ///
 185         void lfunMouseRelease(FuncRequest const &);
 186         // If the inset is empty set the language of the current font to the
 187         // language to the surronding text (if different).
 188         void sanitizeEmptyText(BufferView *);
 189
 190         ///
 191         DispatchResult moveRight(BufferView *);
 192         ///
 193         DispatchResult moveLeft(BufferView *);
 194         ///
 195         DispatchResult moveRightIntern(BufferView *, bool front,
 196                                                bool activate_inset = true,
 197                                                bool selecting = false);
 198         ///
 199         DispatchResult moveLeftIntern(BufferView *, bool front,
 200                                               bool activate_inset = true,
 201                                               bool selecting = false);
 202
 203         ///
 204         DispatchResult moveUp(BufferView *);
 205         ///
 206         DispatchResult moveDown(BufferView *);
 207         ///
 208         void setCharFont(Buffer const &, int pos, LyXFont const & font);
 209         ///
 210         bool checkAndActivateInset(BufferView * bv, bool front);
 211         ///
 212         bool checkAndActivateInset(BufferView * bv, int x = 0, int y = 0);
 213         ///
 214         void removeNewlines();
 215         ///
 216         int cx() const;
 217         ///
 218         int cy() const;
 219         ///
 220         lyx::pos_type cpos() const;
 221         ///
 222         ParagraphList::iterator cpar() const;
 223         ///
 224         RowList::iterator crow() const;
 225         ///
 226         void drawFrame(Painter &, int x) const;
 227         ///
 228         void clearInset(BufferView *, int start_x, int baseline) const;
 229         ///
 230         void collapseParagraphs(BufferView *);
 231
 232         /* Private structures and variables */
 233         ///
 234         bool autoBreakRows_;
 235         ///
 236         DrawFrame drawFrame_;
 237         /** We store the LColor::color value as an int to get LColor.h out
 238          *  of the header file.
 239          */
 240         int frame_color_;
 241         ///
 242         bool no_selection;
 243         ///
 244         mutable lyx::paroffset_type old_par;
 245
 246         ///
 247         // to remember old painted frame dimensions to clear it on the right spot!
 248         ///
 249         mutable bool in_insetAllowed;
 250         ///
 251         // these are used to check for mouse movement in Motion selection code
 252         ///
 253         int mouse_x;
 254         int mouse_y;
 255 public:
 256         ///
 257         mutable LyXText text_;
 258         ///
 259         mutable int textwidth_;
 260 };
 261 #endif