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