]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insettext.h
ws changes only
[lyx.git] / src / insets / insettext.h
index 06c320c0d377f7552eb227aaad2ed5c2b6e7b803..614e8f996e3754e1ddd53089804f5258c1c9e2c2 100644 (file)
@@ -1,41 +1,36 @@
 // -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- *           LyX, The Document Processor
- *
- *           Copyright 1998 The LyX Team.
+/**
+ * \file insettext.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
+ * \author Jürgen Vigna
  *
- *======================================================
+ * Full author contact details are available in file CREDITS.
  */
-// The pristine updatable inset: Text
-
 
 #ifndef INSETTEXT_H
 #define INSETTEXT_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "inset.h"
-#include "LString.h"
-#include "LColor.h"
-#include "ParagraphList.h"
+#include "updatableinset.h"
+#include "ParagraphList_fwd.h"
+#include "RowList_fwd.h"
+#include "lyxtext.h"
 
 #include "support/types.h"
 
-#include <boost/shared_ptr.hpp>
+#include "frontends/mouse_state.h"
+
 
-class Painter;
-class BufferView;
 class Buffer;
 class BufferParams;
+class BufferView;
+class Dimension;
+class LColor_color;
 class LyXCursor;
-class LyXText;
-class Row;
+class Painter;
 class Paragraph;
+class Row;
 
 /**
  A text inset is like a TeX box to write full text
@@ -44,27 +39,6 @@ class Paragraph;
  */
 class InsetText : public UpdatableInset {
 public:
-       ///
-       /// numbers need because of test if codeA < codeB
-       ///
-       enum UpdateCodes {
-               ///
-               NONE = 0,
-               ///
-               CURSOR = 1,
-               ///
-               CLEAR_FRAME = 2,
-               ///
-               DRAW_FRAME = 4,
-               ///
-               SELECTION = 8,
-               ///
-               CURSOR_PAR = 16,
-               ///
-               FULL = 32,
-               ///
-               INIT = 64
-       };
        ///
        enum DrawFrame {
                ///
@@ -75,47 +49,30 @@ public:
                ALWAYS
        };
        ///
-       InsetText(BufferParams const &);
+       explicit InsetText(BufferParams const &);
        ///
-       explicit
-       InsetText(InsetText const &, bool same_id = false);
+       InsetText(InsetText const &);
        ///
-       ~InsetText();
+       virtual std::auto_ptr<InsetBase> clone() const;
        ///
-       Inset * clone(Buffer const &, bool same_id = false) const;
+       void operator=(InsetText const & it);
+       /// empty inset to empty par, or just mark as erased
+       void clear(bool just_mark_erased);
        ///
-       InsetText & operator=(InsetText const & it);
+       void read(Buffer const &, LyXLex &);
        ///
-       void clear();
+       void write(Buffer const &, std::ostream &) const;
        ///
-       void read(Buffer const *, LyXLex &);
+       void metrics(MetricsInfo &, Dimension &) const;
        ///
-       void write(Buffer const *, std::ostream &) const;
+       int textWidth() const;
        ///
-       int ascent(BufferView *, LyXFont const &) const;
+       void draw(PainterInfo & pi, int x, int y) const;
        ///
-       int descent(BufferView *, LyXFont const &) const;
-       ///
-       int width(BufferView *, LyXFont const & f) const;
-       ///
-       int textWidth(BufferView *, bool fordraw = false) const;
-       ///
-       void draw(BufferView *, LyXFont const &, int , float &, bool) const;
-       ///
-       void update(BufferView *, LyXFont const &, bool = false);
-       ///
-       void setUpdateStatus(BufferView *, int what) const;
-       ///
-       string const editMessage() const;
-       ///
-       void edit(BufferView *, int, int, mouse_button::state);
-       ///
-       void edit(BufferView *, bool front = true);
+       std::string const editMessage() const;
        ///
        bool isTextInset() const { return true; }
        ///
-       bool doClearArea() const;
-       ///
        void insetUnlock(BufferView *);
        ///
        bool lockInsetInInset(BufferView *, UpdatableInset *);
@@ -123,83 +80,64 @@ public:
        bool unlockInsetInInset(BufferView *,
                                UpdatableInset *, bool lr = false);
        ///
-       bool updateInsetInInset(BufferView *, Inset *);
-       ///
-       bool insetButtonRelease(BufferView *, int, int, mouse_button::state);
-       ///
-       void insetButtonPress(BufferView *, int, int, mouse_button::state);
-       ///
-       void insetMotionNotify(BufferView *, int, int, mouse_button::state);
+       dispatch_result localDispatch(FuncRequest const &);
        ///
-       UpdatableInset::RESULT localDispatch(BufferView *, FuncRequest const &);
+       int latex(Buffer const &, std::ostream &,
+                 LatexRunParams const &) const;
        ///
-       int latex(Buffer const *, std::ostream &,
-                 bool fragile, bool free_spc) const;
+       int ascii(Buffer const &, std::ostream &, int linelen) const;
        ///
-       int ascii(Buffer const *, std::ostream &, int linelen) const;
+       int linuxdoc(Buffer const &, std::ostream &) const ;
        ///
-       int linuxdoc(Buffer const *, std::ostream &) const { return 0; }
-       ///
-       int docbook(Buffer const *, std::ostream &, bool mixcont) const ;
+       int docbook(Buffer const &, std::ostream &, bool mixcont) const ;
        ///
        void validate(LaTeXFeatures & features) const;
        ///
-       Inset::Code lyxCode() const { return Inset::TEXT_CODE; }
-       ///
+       InsetOld::Code lyxCode() const { return InsetOld::TEXT_CODE; }
+       /// FIXME, document
        void getCursorPos(BufferView *, int & x, int & y) const;
+       /// Get the absolute document x,y of the cursor
+       virtual void getCursor(BufferView &, int &, int &) const;
        ///
        int insetInInsetY() const;
        ///
-       void toggleInsetCursor(BufferView *);
-       ///
-       void showInsetCursor(BufferView *, bool show = true);
-       ///
-       void hideInsetCursor(BufferView *);
-       ///
        void fitInsetCursor(BufferView *) const;
        ///
-       bool insertInset(BufferView *, Inset *);
+       bool insertInset(BufferView *, InsetOld *);
        ///
-       bool insetAllowed(Inset::Code) const;
+       bool insetAllowed(InsetOld::Code) const;
        ///
        UpdatableInset * getLockingInset() const;
        ///
-       UpdatableInset * getFirstLockingInsetOfType(Inset::Code);
+       UpdatableInset * getFirstLockingInsetOfType(InsetOld::Code);
        ///
        void setFont(BufferView *, LyXFont const &,
                     bool toggleall = false,
                     bool selectall = false);
        ///
-       int getMaxWidth(BufferView *, UpdatableInset const *) const;
-       ///
-       void init(InsetText const * ins = 0, bool same_id = false);
+       void writeParagraphData(Buffer const &, std::ostream &) const;
        ///
-       void writeParagraphData(Buffer const *, std::ostream &) const;
-       ///
-       void setParagraphData(Paragraph *, bool same_id = false);
-       ///
-       void setText(string const &, LyXFont const &);
+       void setText(std::string const &, LyXFont const &);
        ///
        void setAutoBreakRows(bool);
        ///
-       bool getAutoBreakRows() const { return autoBreakRows; }
+       bool getAutoBreakRows() const { return autoBreakRows_; }
        ///
-       void setDrawFrame(BufferView *, DrawFrame);
+       void setDrawFrame(DrawFrame);
        ///
-       void setFrameColor(BufferView *, LColor::color);
+       LColor_color frameColor() const;
+       void setFrameColor(LColor_color);
        ///
        LyXText * getLyXText(BufferView const *,
                             bool const recursive = false) const;
        ///
-       void deleteLyXText(BufferView *, bool recursive = true) const;
+       void setViewCache(BufferView const * bv) const;
        ///
-       void resizeLyXText(BufferView *, bool force = false) const;
+       void deleteLyXText(BufferView *, bool recursive = true) const;
        ///
        bool showInsetDialog(BufferView *) const;
-       ///
-       std::vector<string> const getLabelList() const;
-       ///
-       bool nodraw() const;
+       /// Appends \c list with all labels found within this inset.
+       void getLabelList(Buffer const &, std::vector<std::string> & list) const;
        ///
        int scroll(bool recursive = true) const;
        ///
@@ -211,108 +149,93 @@ public:
                UpdatableInset::scroll(bv, offset);
        }
        ///
-       void selectAll(BufferView * bv);
-       ///
        void clearSelection(BufferView * bv);
        ///
-       Paragraph * getParFromID(int id) const;
-       ///
-       Inset * getInsetFromID(int id) const;
-       ///
-       Paragraph * firstParagraph() const;
+       InsetOld * getInsetFromID(int id) const;
        ///
-       Paragraph * getFirstParagraph(int) const;
+       ParagraphList * getParagraphs(int) const;
        ///
        LyXCursor const & cursor(BufferView *) const;
        ///
-       Paragraph * paragraph() const;
+       bool allowSpellcheck() const { return true; }
        ///
-       void paragraph(Paragraph *);
+       WordLangTuple const
+       selectNextWordToSpellcheck(BufferView *, float & value) const;
        ///
-       bool allowSpellcheck() { return true; }
-       ///
-       WordLangTuple selectNextWordToSpellcheck(BufferView *,
-                                               float & value) const;
        void selectSelectedWord(BufferView *);
+
+       /// mark as erased for change tracking
+       void markErased() { clear(true); };
+       /**
+        * Mark as new. Used when pasting in tabular, and adding rows
+        * or columns. Note that pasting will ensure that tracking already
+        * happens, and this just resets the changes for the copied text,
+        * whereas for row/col add, we need to start tracking changes
+        * for the (empty) paragraph contained.
+        */
+       void markNew(bool track_changes = false);
+       /// find next change
+       bool nextChange(BufferView *, lyx::pos_type & length);
+
        ///
-       void toggleSelection(BufferView *, bool kill_selection);
-       ///
-       bool searchForward(BufferView *, string const &,
+       bool searchForward(BufferView *, std::string const &,
                           bool = true, bool = false);
        ///
-       bool searchBackward(BufferView *, string const &,
+       bool searchBackward(BufferView *, std::string const &,
                            bool = true, bool = false);
        ///
        bool checkInsertChar(LyXFont &);
        ///
        void getDrawFont(LyXFont &) const;
-       ///
-       void appendParagraphs(BufferParams const & bparams, Paragraph *);
-       ///
-       void addPreview(grfx::PreviewLoader &) const;
+       /// append text onto the existing text
+       void appendParagraphs(Buffer * bp, ParagraphList &);
 
-       //
-       // Public structures and variables
        ///
-       mutable int need_update;
+       void addPreview(lyx::graphics::PreviewLoader &) const;
 
+       ///
+       bool haveParagraphs() const {
+               return true;
+       }
+       ///
+       mutable ParagraphList paragraphs;
 protected:
        ///
-       void updateLocal(BufferView *, int what, bool mark_dirty) const;
+       void updateLocal(BufferView *, bool mark_dirty);
        /// set parameters for an initial lock of this inset
        void lockInset(BufferView *);
        /// lock an inset inside this one
        void lockInset(BufferView *, UpdatableInset *);
-       ///
-       mutable int drawTextXOffset;
-       ///
-       mutable int drawTextYOffset;
-       ///
-       bool autoBreakRows;
-       ///
-       DrawFrame drawFrame_;
-       ///
-       LColor::color frame_color;
 
 private:
        ///
-       struct InnerCache {
-               ///
-               InnerCache(boost::shared_ptr<LyXText>);
-               ///
-               boost::shared_ptr<LyXText> text;
-               ///
-               bool remove;
-       };
+       void init();
        ///
-       typedef std::map<BufferView *, InnerCache> Cache;
+       void lfunMousePress(FuncRequest const &);
        ///
-       typedef Cache::value_type value_type;
+       bool lfunMouseRelease(FuncRequest const &);
        ///
-       int beginningOfMainBody(Paragraph * par) const;
+       void lfunMouseMotion(FuncRequest const &);
+
        ///
-       UpdatableInset::RESULT moveRight(BufferView *,
-                                        bool activate_inset = true,
-                                        bool selecting = false);
+       dispatch_result moveRight(BufferView *);
        ///
-       UpdatableInset::RESULT moveLeft(BufferView *,
-                                       bool activate_inset = true,
-                                       bool selecting = false);
+       dispatch_result moveLeft(BufferView *);
        ///
-       UpdatableInset::RESULT moveRightIntern(BufferView *, bool front,
+       dispatch_result moveRightIntern(BufferView *, bool front,
                                               bool activate_inset = true,
                                               bool selecting = false);
        ///
-       UpdatableInset::RESULT moveLeftIntern(BufferView *, bool front,
+       dispatch_result moveLeftIntern(BufferView *, bool front,
                                              bool activate_inset = true,
                                              bool selecting = false);
 
        ///
-       UpdatableInset::RESULT moveUp(BufferView *);
+       dispatch_result moveUp(BufferView *);
        ///
-       UpdatableInset::RESULT moveDown(BufferView *);
+        dispatch_result moveDown(BufferView *);
        ///
-       void setCharFont(Buffer const *, int pos, LyXFont const & font);
+       void setCharFont(Buffer const &, int pos, LyXFont const & font);
        ///
        bool checkAndActivateInset(BufferView * bv, bool front);
        ///
@@ -321,51 +244,39 @@ private:
        ///
        void removeNewlines();
        ///
-       int cx(BufferView *) const;
-       ///
-       int cix(BufferView *) const;
+       int cx() const;
        ///
-       int cy(BufferView *) const;
+       int cy() const;
        ///
-       int ciy(BufferView *) const;
+       lyx::pos_type cpos() const;
        ///
-       lyx::pos_type cpos(BufferView *) const;
+       ParagraphList::iterator cpar() const;
        ///
-       Paragraph * cpar(BufferView *) const;
+       bool cboundary() const;
        ///
-       bool cboundary(BufferView *) const;
+       RowList::iterator crow() const;
        ///
-       Row * crow(BufferView *) const;
+       void drawFrame(Painter &, int x) const;
        ///
-       void drawFrame(Painter &, bool cleared) const;
+       void clearInset(BufferView *, int start_x, int baseline) const;
        ///
-       void clearFrame(Painter &, bool cleared) const;
-       ///
-       void clearInset(BufferView *, int baseline, bool & cleared) const;
-       ///
-       void saveLyXTextState(LyXText *) const;
-       ///
-       void restoreLyXTextState(BufferView *, LyXText *) const;
-       ///
-       void reinitLyXText() const;
-       ///
-       void collapseParagraphs(BufferView *) const;
+       void collapseParagraphs(BufferView *);
 
        /* Private structures and variables */
        ///
-       ParagraphList paragraphs;
-       ///
-       mutable bool locked;
-       ///
-       mutable int insetAscent;
+       bool autoBreakRows_;
        ///
-       mutable int insetDescent;
+       DrawFrame drawFrame_;
+       /** We store the LColor::color value as an int to get LColor.h out
+        *  of the header file.
+        */
+       int frame_color_;
        ///
-       mutable int insetWidth;
+       mutable bool locked;
        ///
        mutable int top_y;
        ///
-       Paragraph * inset_par;
+       lyx::paroffset_type inset_par;
        ///
        lyx::pos_type inset_pos;
        ///
@@ -375,61 +286,25 @@ private:
        ///
        mutable int inset_y;
        ///
-       mutable int old_max_width;
-       ///
        bool no_selection;
        ///
        UpdatableInset * the_locking_inset;
        ///
-       mutable Paragraph * old_par;
-       /// The cache.
-       mutable Cache cache;
-       ///
-       mutable int last_drawn_width;
-       ///
-       mutable bool frame_is_visible;
-       ///
-       mutable BufferView * cached_bview;
-       ///
-       mutable boost::shared_ptr<LyXText> cached_text;
-       ///
-       struct save_state {
-               Paragraph * lpar;
-               Paragraph * selstartpar;
-               Paragraph * selendpar;
-               lyx::pos_type pos;
-               lyx::pos_type selstartpos;
-               lyx::pos_type selendpos;
-               bool boundary;
-               bool selstartboundary;
-               bool selendboundary;
-               bool selection;
-               bool mark_set;
-               bool refresh;
-       };
-       ///
-       mutable save_state sstate;
+       mutable lyx::paroffset_type old_par;
 
-       ///
-       // this is needed globally so we know that we're using it actually and
-       // so the LyXText-Cache is not erased until used!
-       mutable LyXText * lt;
        ///
        // to remember old painted frame dimensions to clear it on the right spot!
        ///
-       mutable int frame_x;
-       mutable int frame_y;
-       mutable int frame_w;
-       mutable int frame_h;
-       ///
-       bool in_update; /* as update is not reentrant! */
-       mutable BufferView * do_resize;
-       mutable bool do_reinit;
        mutable bool in_insetAllowed;
        ///
        // these are used to check for mouse movement in Motion selection code
        ///
        int mouse_x;
        int mouse_y;
+public:
+       ///
+       mutable LyXText text_;
+       ///
+       mutable int textwidth_;
 };
 #endif