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