src/insets/insettext.h

   1 // -*- C++ -*-
   2 /* This file is part of
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *
   7  *           Copyright 1998 The LyX Team.
   8  *
   9  *
  10  *======================================================
  11  */
  12 // The pristine updatable inset: Text
  13
  14
  15 #ifndef INSETTEXT_H
  16 #define INSETTEXT_H
  17
  18 #ifdef __GNUG__
  19 #pragma interface
  20 #endif
  21
  22 #include "inset.h"
  23 #include "LString.h"
  24 #include "LColor.h"
  25 #include "paragraph.h"
  26 #include "lyxcursor.h"
  27 #include <boost/smart_ptr.hpp>
  28
  29 class Painter;
  30 class BufferView;
  31 class Buffer;
  32 class LyXCursor;
  33 class LyXText;
  34 class LyXScreen;
  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         /// numbers need because of test if codeA < codeB
  46         ///
  47         enum UpdateCodes {
  48                 ///
  49                 NONE = 0,
  50                 ///
  51                 CURSOR = 1,
  52                 ///
  53                 CLEAR_FRAME = 2,
  54                 ///
  55                 DRAW_FRAME = 4,
  56                 ///
  57                 SELECTION = 8,
  58                 ///
  59                 CURSOR_PAR = 16,
  60                 ///
  61                 FULL = 32,
  62                 ///
  63                 INIT = 64
  64         };
  65         ///
  66         enum DrawFrame {
  67                 ///
  68                 NEVER = 0,
  69                 ///
  70                 LOCKED,
  71                 ///
  72                 ALWAYS
  73         };
  74         ///
  75         InsetText();
  76         ///
  77         explicit
  78         InsetText(InsetText const &, bool same_id = false);
  79         ///
  80         ~InsetText();
  81         ///
  82         Inset * clone(Buffer const &, bool same_id = false) const;
  83         ///
  84         InsetText & operator=(InsetText const & it);
  85         ///
  86         void clear();
  87         ///
  88         void read(Buffer const *, LyXLex &);
  89         ///
  90         void write(Buffer const *, std::ostream &) const;
  91         ///
  92         int ascent(BufferView *, LyXFont const &) const;
  93         ///
  94         int descent(BufferView *, LyXFont const &) const;
  95         ///
  96         int width(BufferView *, LyXFont const & f) const;
  97         ///
  98         int textWidth(BufferView *) const;
  99         ///
 100         void draw(BufferView *, LyXFont const &, int , float &, bool) const;
 101         ///
 102         void update(BufferView *, LyXFont const &, bool =false);
 103         ///
 104         void setUpdateStatus(BufferView *, int what) const;
 105         ///
 106         string const editMessage() const;
 107         ///
 108         void edit(BufferView *, int, int, unsigned int);
 109         ///
 110         void edit(BufferView *, bool front = true);
 111         ///
 112         bool isTextInset() const { return true; }
 113         ///
 114         bool doClearArea() const;
 115         ///
 116         void insetUnlock(BufferView *);
 117         ///
 118         bool lockInsetInInset(BufferView *, UpdatableInset *);
 119         ///
 120         bool unlockInsetInInset(BufferView *,
 121                                 UpdatableInset *, bool lr = false);
 122         ///
 123         bool updateInsetInInset(BufferView *, Inset *);
 124         ///
 125         void insetButtonRelease(BufferView *, int, int, int);
 126         ///
 127         void insetButtonPress(BufferView *, int, int, int);
 128         ///
 129         void insetMotionNotify(BufferView *, int, int, int);
 130         ///
 131         void insetKeyPress(XKeyEvent *);
 132         ///
 133         UpdatableInset::RESULT localDispatch(BufferView *,
 134                                              kb_action, string const &);
 135         ///
 136         int latex(Buffer const *, std::ostream &,
 137                   bool fragile, bool free_spc) const;
 138         ///
 139         int ascii(Buffer const *, std::ostream &, int linelen) const;
 140         ///
 141         int linuxdoc(Buffer const *, std::ostream &) const { return 0; }
 142         ///
 143         int docBook(Buffer const *, std::ostream &) const ;
 144         ///
 145         void validate(LaTeXFeatures & features) const;
 146         ///
 147         Inset::Code lyxCode() const { return Inset::TEXT_CODE; }
 148         ///
 149         void getCursorPos(BufferView *, int & x, int & y) const;
 150         ///
 151         unsigned int insetInInsetY();
 152         ///
 153         void toggleInsetCursor(BufferView *);
 154         ///
 155         void showInsetCursor(BufferView *, bool show=true);
 156         ///
 157         void hideInsetCursor(BufferView *);
 158         ///
 159         void fitInsetCursor(BufferView *) const;
 160         ///
 161         bool insertInset(BufferView *, Inset *);
 162         ///
 163         bool insetAllowed(Inset::Code) const;
 164         ///
 165         UpdatableInset * getLockingInset() const;
 166         ///
 167         UpdatableInset * getFirstLockingInsetOfType(Inset::Code);
 168         ///
 169         void setFont(BufferView *, LyXFont const &,
 170                      bool toggleall = false,
 171                      bool selectall = false);
 172         ///
 173         int getMaxWidth(BufferView *, UpdatableInset const *) const;
 174         ///
 175         void init(InsetText const * ins = 0, bool same_id = false);
 176         ///
 177         void writeParagraphData(Buffer const *, std::ostream &) const;
 178         ///
 179         void setParagraphData(Paragraph *);
 180         ///
 181         void setText(string const &);
 182         ///
 183         void setAutoBreakRows(bool);
 184         ///
 185         void setDrawFrame(BufferView *, DrawFrame);
 186         ///
 187         void setFrameColor(BufferView *, LColor::color);
 188         ///
 189         LyXText * getLyXText(BufferView const *,
 190                              bool const recursive = false) const;
 191         ///
 192         void deleteLyXText(BufferView *, bool recursive = true) const;
 193         ///
 194         void resizeLyXText(BufferView *, bool force = false) const;
 195         ///
 196         bool showInsetDialog(BufferView *) const;
 197         ///
 198         std::vector<string> const getLabelList() const;
 199         ///
 200         bool nodraw() const;
 201         ///
 202         int scroll(bool recursive=true) const;
 203         ///
 204         void scroll(BufferView *bv, float sx) const {
 205                 UpdatableInset::scroll(bv, sx);
 206         }
 207         ///
 208         void scroll(BufferView *bv, int offset) const {
 209                 UpdatableInset::scroll(bv, offset);
 210         }
 211         ///
 212         void selectAll(BufferView *bv);
 213         ///
 214         void clearSelection(BufferView *bv);
 215         ///
 216         Paragraph * getParFromID(int id) const;
 217         ///
 218         Inset * getInsetFromID(int id) const;
 219         ///
 220         Paragraph * firstParagraph() const;
 221         ///
 222         LyXCursor const & cursor(BufferView *) const;
 223         ///
 224         Paragraph * paragraph() const;
 225         ///
 226         void paragraph(Paragraph *);
 227         ///
 228         string selectNextWord(BufferView *, float & value) const;
 229         void selectSelectedWord(BufferView *);
 230         void toggleSelection(BufferView *, bool kill_selection);
 231         ///
 232         bool searchForward(BufferView *, string const &,
 233                            bool const & = true, bool const & = false);
 234         bool searchBackward(BufferView *, string const &,
 235                             bool const & = true, bool const & = false);
 236
 237         //
 238         // Public structures and variables
 239         ///
 240         mutable int need_update;
 241
 242 protected:
 243         ///
 244         void updateLocal(BufferView *, int what, bool mark_dirty) const;
 245         ///
 246         mutable int drawTextXOffset;
 247         ///
 248         mutable int drawTextYOffset;
 249         ///
 250         bool autoBreakRows;
 251         ///
 252         DrawFrame drawFrame_;
 253         ///
 254         LColor::color frame_color;
 255
 256 private:
 257         struct InnerCache {
 258                 InnerCache(boost::shared_ptr<LyXText>);
 259
 260                 boost::shared_ptr<LyXText> text;
 261                 bool remove;
 262         };
 263         ///
 264         typedef std::map<BufferView *, struct InnerCache > Cache;
 265         ///
 266         typedef Cache::value_type value_type;
 267         ///
 268         int beginningOfMainBody(Buffer const *, Paragraph * par) const;
 269         ///
 270         UpdatableInset::RESULT moveRight(BufferView *,
 271                                          bool activate_inset = true,
 272                                          bool selecting = false);
 273         ///
 274         UpdatableInset::RESULT moveLeft(BufferView *,
 275                                         bool activate_inset = true,
 276                                         bool selecting = false);
 277         ///
 278         UpdatableInset::RESULT moveRightIntern(BufferView *, bool behind,
 279                                                bool activate_inset = true,
 280                                                bool selecting = false);
 281         ///
 282         UpdatableInset::RESULT moveLeftIntern(BufferView *, bool behind,
 283                                               bool activate_inset = true,
 284                                               bool selecting = false);
 285
 286         ///
 287         UpdatableInset::RESULT moveUp(BufferView *);
 288         ///
 289         UpdatableInset::RESULT moveDown(BufferView *);
 290         ///
 291         void setCharFont(Buffer const *, int pos, LyXFont const & font);
 292 #if 0
 293         ///What's that ??? Not used, not implemented!
 294         ///
 295         string const getText(int);
 296 #endif
 297         ///
 298         bool checkAndActivateInset(BufferView * bv, bool behind);
 299         ///
 300         bool checkAndActivateInset(BufferView * bv, int x = 0, int y = 0,
 301                                    int button = 0);
 302         ///
 303         void removeNewlines();
 304         ///
 305         int cx(BufferView *) const;
 306         ///
 307         int cy(BufferView *) const;
 308         ///
 309         Paragraph::size_type cpos(BufferView *) const;
 310         ///
 311         Paragraph * cpar(BufferView *) const;
 312         ///
 313         bool cboundary(BufferView *) const;
 314         ///
 315         Row * crow(BufferView *) const;
 316         ///
 317         void drawFrame(Painter &, bool cleared) const;
 318         ///
 319         void clearFrame(Painter &, bool cleared) const;
 320         ///
 321         void clearInset(Painter &, int baseline, bool & cleared) const;
 322         ///
 323         void saveLyXTextState(LyXText *) const;
 324         void restoreLyXTextState(BufferView *, LyXText *) const;
 325
 326         /* Private structures and variables */
 327         ///
 328         Paragraph * par;
 329         ///
 330         mutable bool locked;
 331         ///
 332         mutable int insetAscent;
 333         ///
 334         mutable int insetDescent;
 335         ///
 336         mutable int insetWidth;
 337         ///
 338         mutable int last_width;
 339         ///
 340         mutable int last_height;
 341         ///
 342         mutable int top_y;
 343         ///
 344         Paragraph * inset_par;
 345         ///
 346         Paragraph::size_type inset_pos;
 347         ///
 348         bool inset_boundary;
 349         ///
 350         mutable int inset_x;
 351         ///
 352         mutable int inset_y;
 353         ///
 354         mutable unsigned int old_max_width;
 355         ///
 356         bool no_selection;
 357         ///
 358         mutable float xpos;
 359         ///
 360         UpdatableInset * the_locking_inset;
 361         ///
 362         mutable Paragraph * old_par;
 363         /// The cache.
 364         mutable Cache cache;
 365         ///
 366         mutable int last_drawn_width;
 367         ///
 368         mutable bool frame_is_visible;
 369         ///
 370         mutable BufferView * cached_bview;
 371         ///
 372         mutable boost::shared_ptr<LyXText> cached_text;
 373         ///
 374         mutable struct save_state {
 375                 Paragraph * lpar;
 376                 Paragraph * selstartpar;
 377                 Paragraph * selendpar;
 378                 Paragraph::size_type pos;
 379                 Paragraph::size_type selstartpos;
 380                 Paragraph::size_type selendpos;
 381                 bool boundary;
 382                 bool selstartboundary;
 383                 bool selendboundary;
 384                 bool selection;
 385                 bool mark_set;
 386         } sstate;
 387         ///
 388         // this is needed globally so we know that we're using it actually and
 389         // so the LyXText-Cache is not erased until used!
 390         mutable LyXText * lt;
 391 };
 392 #endif