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 "LColor.h"
  17 #include "ParagraphList_fwd.h"
  18 #include "RowList_fwd.h"
  19 #include "lyxtext.h"
  20
  21 #include "support/types.h"
  22
  23 #include "frontends/mouse_state.h"
  24
  25 #include "support/std_string.h"
  26
  27 class Buffer;
  28 class BufferParams;
  29 class BufferView;
  30 class Dimension;
  31 class EnumLColor;
  32 class LyXCursor;
  33 class Painter;
  34 class Paragraph;
  35 class Row;
  36
  37 /**
  38  A text inset is like a TeX box to write full text
  39  (including styles and other insets) in a given space.
  40  @author: Jürgen Vigna
  41  */
  42 class InsetText : public UpdatableInset {
  43 public:
  44         ///
  45         enum DrawFrame {
  46                 ///
  47                 NEVER = 0,
  48                 ///
  49                 LOCKED,
  50                 ///
  51                 ALWAYS
  52         };
  53         ///
  54         InsetText(BufferParams const &);
  55         ///
  56         explicit InsetText(InsetText const &);
  57         ///
  58         virtual std::auto_ptr<InsetBase> clone() const;
  59         ///
  60         InsetText & operator=(InsetText const & it);
  61         /// empty inset to empty par, or just mark as erased
  62         void clear(bool just_mark_erased);
  63         ///
  64         void read(Buffer const &, LyXLex &);
  65         ///
  66         void write(Buffer const &, std::ostream &) const;
  67         ///
  68         void metrics(MetricsInfo &, Dimension &) const;
  69         ///
  70         int textWidth() const;
  71         ///
  72         void draw(PainterInfo & pi, int x, int y) const;
  73         ///
  74         string const editMessage() const;
  75         ///
  76         bool isTextInset() const { return true; }
  77         ///
  78         void insetUnlock(BufferView *);
  79         ///
  80         bool lockInsetInInset(BufferView *, UpdatableInset *);
  81         ///
  82         bool unlockInsetInInset(BufferView *,
  83                                 UpdatableInset *, bool lr = false);
  84         ///
  85         RESULT localDispatch(FuncRequest const &);
  86         ///
  87         int latex(Buffer const &, std::ostream &,
  88                   LatexRunParams const &) const;
  89         ///
  90         int ascii(Buffer const &, std::ostream &, int linelen) const;
  91         ///
  92         int linuxdoc(Buffer const &, std::ostream &) const ;
  93         ///
  94         int docbook(Buffer const &, std::ostream &, bool mixcont) const ;
  95         ///
  96         void validate(LaTeXFeatures & features) const;
  97         ///
  98         InsetOld::Code lyxCode() const { return InsetOld::TEXT_CODE; }
  99         /// FIXME, document
 100         void getCursorPos(BufferView *, int & x, int & y) const;
 101         /// Get the absolute document x,y of the cursor
 102         virtual void getCursor(BufferView &, int &, int &) const;
 103         ///
 104         int insetInInsetY() const;
 105         ///
 106         void fitInsetCursor(BufferView *) const;
 107         ///
 108         bool insertInset(BufferView *, InsetOld *);
 109         ///
 110         bool insetAllowed(InsetOld::Code) const;
 111         ///
 112         UpdatableInset * getLockingInset() const;
 113         ///
 114         UpdatableInset * getFirstLockingInsetOfType(InsetOld::Code);
 115         ///
 116         void setFont(BufferView *, LyXFont const &,
 117                      bool toggleall = false,
 118                      bool selectall = false);
 119         ///
 120         void init(InsetText const * ins);
 121         ///
 122         void writeParagraphData(Buffer const &, std::ostream &) const;
 123         ///
 124         void setText(string const &, LyXFont const &);
 125         ///
 126         void setAutoBreakRows(bool);
 127         ///
 128         bool getAutoBreakRows() const { return autoBreakRows_; }
 129         ///
 130         void setDrawFrame(DrawFrame);
 131         ///
 132         void setFrameColor(EnumLColor);
 133         ///
 134         LyXText * getLyXText(BufferView const *,
 135                              bool const recursive = false) const;
 136         ///
 137         void setViewCache(BufferView const * bv) const;
 138         ///
 139         void deleteLyXText(BufferView *, bool recursive = true) const;
 140         ///
 141         bool showInsetDialog(BufferView *) const;
 142         ///
 143         void getLabelList(std::vector<string> &) const;
 144         ///
 145         int scroll(bool recursive = true) const;
 146         ///
 147         void scroll(BufferView * bv, float sx) const {
 148                 UpdatableInset::scroll(bv, sx);
 149         }
 150         ///
 151         void scroll(BufferView * bv, int offset) const {
 152                 UpdatableInset::scroll(bv, offset);
 153         }
 154         ///
 155         void clearSelection(BufferView * bv);
 156         ///
 157         InsetOld * getInsetFromID(int id) const;
 158         ///
 159         ParagraphList * getParagraphs(int) const;
 160         ///
 161         LyXCursor const & cursor(BufferView *) const;
 162         ///
 163         bool allowSpellcheck() const { return true; }
 164         ///
 165         WordLangTuple const
 166         selectNextWordToSpellcheck(BufferView *, float & value) const;
 167         ///
 168         void selectSelectedWord(BufferView *);
 169
 170         /// mark as erased for change tracking
 171         void markErased() { clear(true); };
 172         /**
 173          * Mark as new. Used when pasting in tabular, and adding rows
 174          * or columns. Note that pasting will ensure that tracking already
 175          * happens, and this just resets the changes for the copied text,
 176          * whereas for row/col add, we need to start tracking changes
 177          * for the (empty) paragraph contained.
 178          */
 179         void markNew(bool track_changes = false);
 180         /// find next change
 181         bool nextChange(BufferView *, lyx::pos_type & length);
 182
 183         ///
 184         bool searchForward(BufferView *, string const &,
 185                            bool = true, bool = false);
 186         ///
 187         bool searchBackward(BufferView *, string const &,
 188                             bool = true, bool = false);
 189         ///
 190         bool checkInsertChar(LyXFont &);
 191         ///
 192         void getDrawFont(LyXFont &) const;
 193         /// append text onto the existing text
 194         void appendParagraphs(Buffer * bp, ParagraphList &);
 195
 196         ///
 197         void addPreview(lyx::graphics::PreviewLoader &) const;
 198
 199         ///
 200         bool haveParagraphs() const {
 201                 return true;
 202         }
 203         ///
 204         mutable ParagraphList paragraphs;
 205 protected:
 206         ///
 207         void updateLocal(BufferView *, bool mark_dirty);
 208         /// set parameters for an initial lock of this inset
 209         void lockInset(BufferView *);
 210         /// lock an inset inside this one
 211         void lockInset(BufferView *, UpdatableInset *);
 212
 213 private:
 214         ///
 215         void lfunMousePress(FuncRequest const &);
 216         ///
 217         bool lfunMouseRelease(FuncRequest const &);
 218         ///
 219         void lfunMouseMotion(FuncRequest const &);
 220
 221         ///
 222         RESULT moveRight(BufferView *);
 223         ///
 224         RESULT moveLeft(BufferView *);
 225         ///
 226         RESULT moveRightIntern(BufferView *, bool front,
 227                                                bool activate_inset = true,
 228                                                bool selecting = false);
 229         ///
 230         RESULT moveLeftIntern(BufferView *, bool front,
 231                                               bool activate_inset = true,
 232                                               bool selecting = false);
 233
 234         ///
 235         RESULT moveUp(BufferView *);
 236         ///
 237         RESULT moveDown(BufferView *);
 238         ///
 239         void setCharFont(Buffer const &, int pos, LyXFont const & font);
 240         ///
 241         bool checkAndActivateInset(BufferView * bv, bool front);
 242         ///
 243         bool checkAndActivateInset(BufferView * bv, int x = 0, int y = 0,
 244                                    mouse_button::state button = mouse_button::none);
 245         ///
 246         void removeNewlines();
 247         ///
 248         int cx() const;
 249         ///
 250         int cy() const;
 251         ///
 252         lyx::pos_type cpos() const;
 253         ///
 254         ParagraphList::iterator cpar() const;
 255         ///
 256         bool cboundary() const;
 257         ///
 258         RowList::iterator crow() const;
 259         ///
 260         void drawFrame(Painter &, int x) const;
 261         ///
 262         void clearInset(BufferView *, int start_x, int baseline) const;
 263         ///
 264         void collapseParagraphs(BufferView *);
 265
 266         /* Private structures and variables */
 267         ///
 268         bool autoBreakRows_;
 269         ///
 270         DrawFrame drawFrame_;
 271         ///
 272         LColor::color frame_color_;
 273         ///
 274         mutable bool locked;
 275         ///
 276         mutable int top_y;
 277         ///
 278         ParagraphList::iterator inset_par;
 279         ///
 280         lyx::pos_type inset_pos;
 281         ///
 282         bool inset_boundary;
 283         ///
 284         mutable int inset_x;
 285         ///
 286         mutable int inset_y;
 287         ///
 288         bool no_selection;
 289         ///
 290         UpdatableInset * the_locking_inset;
 291         ///
 292         mutable ParagraphList::iterator old_par;
 293
 294         ///
 295         // to remember old painted frame dimensions to clear it on the right spot!
 296         ///
 297         mutable bool in_insetAllowed;
 298         ///
 299         // these are used to check for mouse movement in Motion selection code
 300         ///
 301         int mouse_x;
 302         int mouse_y;
 303 public:
 304         ///
 305         mutable LyXText text_;
 306         ///
 307         mutable int textwidth_;
 308 };
 309 #endif