]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insettext.h
Rename LatexRunParams::fragile as moving_arg.
[lyx.git] / src / insets / insettext.h
index 716d1b3fb34157d31c95925d7250e0903243d35c..c42a2d0bae9387b7fa4ac337290d29861aa0bb8e 100644 (file)
@@ -1,43 +1,42 @@
 // -*- 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 "updatableinset.h"
 #include "LString.h"
 #include "LColor.h"
-#include "paragraph.h"
-#include "lyxcursor.h"
+#include "ParagraphList.h"
+#include "RowList.h"
+#include "dimension.h"
+#include "frontends/mouse_state.h"
+
+#include "support/types.h"
 
-#include <boost/smart_ptr.hpp>
+#include <boost/shared_ptr.hpp>
+#include <map>
 
 class Painter;
 class BufferView;
 class Buffer;
+class BufferParams;
 class LyXCursor;
 class LyXText;
-class LyXScreen;
 class Row;
+class Paragraph;
 
 /**
  A text inset is like a TeX box to write full text
- (including styles and other insets) in a given space. 
+ (including styles and other insets) in a given space.
  @author: Jürgen Vigna
  */
 class InsetText : public UpdatableInset {
@@ -51,17 +50,15 @@ public:
                ///
                CURSOR = 1,
                ///
-               CLEAR_FRAME = 2,
-               ///
-               DRAW_FRAME = 4,
+               DRAW_FRAME = 2,
                ///
-               SELECTION = 8,
+               SELECTION = 4,
                ///
-               CURSOR_PAR = 16,
+               CURSOR_PAR = 8,
                ///
-               FULL = 32,
+               FULL = 16,
                ///
-               INIT = 64
+               INIT = 32
        };
        ///
        enum DrawFrame {
@@ -73,7 +70,7 @@ public:
                ALWAYS
        };
        ///
-       InsetText();
+       InsetText(BufferParams const &);
        ///
        explicit
        InsetText(InsetText const &, bool same_id = false);
@@ -83,37 +80,27 @@ public:
        Inset * clone(Buffer const &, bool same_id = false) const;
        ///
        InsetText & operator=(InsetText const & it);
-       ///
-       void clear();
+       /// empty inset to empty par, or just mark as erased
+       void clear(bool just_mark_erased);
        ///
        void read(Buffer const *, LyXLex &);
        ///
        void write(Buffer const *, std::ostream &) const;
        ///
-       int ascent(BufferView *, LyXFont const &) const;
-       ///
-       int descent(BufferView *, LyXFont const &) const;
-       ///
-       int width(BufferView *, LyXFont const & f) const;
+       void dimension(BufferView *, LyXFont const &, Dimension &) const;
        ///
        int textWidth(BufferView *, bool fordraw = false) const;
        ///
-       void draw(BufferView *, LyXFont const &, int , float &, bool) const;
+       void draw(BufferView *, LyXFont const &, int , float &) const;
        ///
-       void update(BufferView *, LyXFont const &, bool = false);
+       void update(BufferView *, bool = false);
        ///
        void setUpdateStatus(BufferView *, int what) const;
        ///
        string const editMessage() const;
        ///
-       void edit(BufferView *, int, int, unsigned int);
-       ///
-       void edit(BufferView *, bool front = true);
-       ///
        bool isTextInset() const { return true; }
        ///
-       bool doClearArea() const;
-       ///
        void insetUnlock(BufferView *);
        ///
        bool lockInsetInInset(BufferView *, UpdatableInset *);
@@ -123,39 +110,26 @@ public:
        ///
        bool updateInsetInInset(BufferView *, Inset *);
        ///
-       bool insetButtonRelease(BufferView *, int, int, int);
-       ///
-       void insetButtonPress(BufferView *, int, int, int);
-       ///
-       void insetMotionNotify(BufferView *, int, int, int);
-       ///
-       void insetKeyPress(XKeyEvent *);
-       ///
-       UpdatableInset::RESULT localDispatch(BufferView *,
-                                            kb_action, string const &);
+       RESULT localDispatch(FuncRequest const &);
        ///
        int latex(Buffer const *, std::ostream &,
-                 bool fragile, bool free_spc) const;
+                 LatexRunParams const &) const;
        ///
        int ascii(Buffer const *, std::ostream &, int linelen) const;
        ///
        int linuxdoc(Buffer const *, std::ostream &) const { return 0; }
        ///
-       int docbook(Buffer const *, std::ostream &) const ;
+       int docbook(Buffer const *, std::ostream &, bool mixcont) const ;
        ///
        void validate(LaTeXFeatures & features) const;
        ///
        Inset::Code lyxCode() const { return Inset::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;
        ///
-       unsigned int insetInInsetY();
-       ///
-       void toggleInsetCursor(BufferView *);
-       ///
-       void showInsetCursor(BufferView *, bool show = true);
-       ///
-       void hideInsetCursor(BufferView *);
+       int insetInInsetY() const;
        ///
        void fitInsetCursor(BufferView *) const;
        ///
@@ -169,7 +143,7 @@ public:
        ///
        void setFont(BufferView *, LyXFont const &,
                     bool toggleall = false,
-                    bool selectall = false);
+                    bool selectall = false);
        ///
        int getMaxWidth(BufferView *, UpdatableInset const *) const;
        ///
@@ -177,9 +151,9 @@ public:
        ///
        void writeParagraphData(Buffer const *, std::ostream &) const;
        ///
-       void setParagraphData(Paragraph *, bool same_id = false);
+       void setParagraphData(ParagraphList const &, bool same_id = false);
        ///
-       void setText(string const &);
+       void setText(string const &, LyXFont const &);
        ///
        void setAutoBreakRows(bool);
        ///
@@ -216,45 +190,66 @@ public:
        ///
        void clearSelection(BufferView * bv);
        ///
-       Paragraph * getParFromID(int id) const;
-       ///
        Inset * getInsetFromID(int id) const;
        ///
-       Paragraph * firstParagraph() const;
-       ///
-       Paragraph * getFirstParagraph(int) const;
+       ParagraphList * getParagraphs(int) const;
        ///
        LyXCursor const & cursor(BufferView *) const;
        ///
-       Paragraph * paragraph() const;
-       ///
-       void paragraph(Paragraph *);
+       bool allowSpellcheck() const { return true; }
        ///
-       bool allowSpellcheck() { return true; }
+       WordLangTuple const
+       selectNextWordToSpellcheck(BufferView *, float & value) const;
        ///
-       string const selectNextWordToSpellcheck(BufferView *,
-                                               float & value) const;
        void selectSelectedWord(BufferView *);
        ///
        void toggleSelection(BufferView *, bool kill_selection);
+
+       /// 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);
+
        ///
        bool searchForward(BufferView *, string const &,
-                          bool = true, bool = false);
+                          bool = true, bool = false);
        ///
        bool searchBackward(BufferView *, string const &,
-                           bool = true, bool = false);
+                           bool = true, bool = false);
        ///
        bool checkInsertChar(LyXFont &);
        ///
+       void getDrawFont(LyXFont &) const;
+       /// append text onto the existing text
+       void appendParagraphs(Buffer * bp, ParagraphList &);
+
+       ///
+       void addPreview(grfx::PreviewLoader &) const;
+
        //
        // Public structures and variables
        ///
        mutable int need_update;
 
-protected:
+       bool haveParagraphs() const {
+               return true;
+       }
        ///
-       void updateLocal(BufferView *, int what, bool mark_dirty) const;
+       ParagraphList paragraphs;
+protected:
        ///
+       void updateLocal(BufferView *, int what, 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;
@@ -268,6 +263,13 @@ protected:
        LColor::color frame_color;
 
 private:
+       ///
+       void lfunMousePress(FuncRequest const &);
+       ///
+       bool lfunMouseRelease(FuncRequest const &);
+       ///
+       void lfunMouseMotion(FuncRequest const &);
+
        ///
        struct InnerCache {
                ///
@@ -282,79 +284,73 @@ private:
        ///
        typedef Cache::value_type value_type;
        ///
-       int beginningOfMainBody(Buffer const *, Paragraph * par) const;
-       ///
-       UpdatableInset::RESULT moveRight(BufferView *,
+       RESULT moveRight(BufferView *,
                                         bool activate_inset = true,
                                         bool selecting = false);
        ///
-       UpdatableInset::RESULT moveLeft(BufferView *,
+       RESULT moveLeft(BufferView *,
                                        bool activate_inset = true,
                                        bool selecting = false);
        ///
-       UpdatableInset::RESULT moveRightIntern(BufferView *, bool behind,
+       RESULT moveRightIntern(BufferView *, bool front,
                                               bool activate_inset = true,
                                               bool selecting = false);
        ///
-       UpdatableInset::RESULT moveLeftIntern(BufferView *, bool behind, 
+       RESULT moveLeftIntern(BufferView *, bool front,
                                              bool activate_inset = true,
                                              bool selecting = false);
 
        ///
-       UpdatableInset::RESULT moveUp(BufferView *);
+       RESULT moveUp(BufferView *);
        ///
-       UpdatableInset::RESULT moveDown(BufferView *);
+       RESULT moveDown(BufferView *);
        ///
        void setCharFont(Buffer const *, int pos, LyXFont const & font);
        ///
-       bool checkAndActivateInset(BufferView * bv, bool behind);
+       bool checkAndActivateInset(BufferView * bv, bool front);
        ///
        bool checkAndActivateInset(BufferView * bv, int x = 0, int y = 0,
-                                  int button = 0);
+                                  mouse_button::state button = mouse_button::none);
        ///
        void removeNewlines();
        ///
        int cx(BufferView *) const;
        ///
+       int cix(BufferView *) const;
+       ///
        int cy(BufferView *) const;
        ///
+       int ciy(BufferView *) const;
+       ///
        lyx::pos_type cpos(BufferView *) const;
        ///
-       Paragraph * cpar(BufferView *) const;
+       ParagraphList::iterator cpar(BufferView *) const;
        ///
        bool cboundary(BufferView *) const;
        ///
-       Row * crow(BufferView *) const;
-       ///
-       void drawFrame(Painter &, bool cleared) const;
+       RowList::iterator crow(BufferView *) const;
        ///
-       void clearFrame(Painter &, bool cleared) const;
+       void drawFrame(Painter &, int x) const;
        ///
-       void clearInset(BufferView *, int baseline, bool & cleared) const;
+       void clearInset(BufferView *, int start_x, int baseline) const;
        ///
        void saveLyXTextState(LyXText *) const;
        ///
-       void restoreLyXTextState(BufferView *, LyXText *) const;
+       void restoreLyXTextState(LyXText *) const;
        ///
        void reinitLyXText() const;
        ///
-       void collapseParagraphs(BufferParams const & bparams) const;
-       
+       void collapseParagraphs(BufferView *);
+
        /* Private structures and variables */
        ///
-       Paragraph * par;
-       ///
        mutable bool locked;
        ///
-       mutable int insetAscent;
-       ///
-       mutable int insetDescent;
-       ///
-       mutable int insetWidth;
+       mutable Dimension dim_;
        ///
        mutable int top_y;
        ///
-       Paragraph * inset_par;
+       ParagraphList::iterator inset_par;
        ///
        lyx::pos_type inset_pos;
        ///
@@ -368,18 +364,14 @@ private:
        ///
        bool no_selection;
        ///
-       mutable float xpos;
-       ///
        UpdatableInset * the_locking_inset;
        ///
-       mutable Paragraph * old_par;
+       mutable ParagraphList::iterator 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;
@@ -396,11 +388,10 @@ private:
                bool selendboundary;
                bool selection;
                bool mark_set;
-               bool refresh;
        };
        ///
        mutable save_state sstate;
-       
+
        ///
        // this is needed globally so we know that we're using it actually and
        // so the LyXText-Cache is not erased until used!
@@ -417,5 +408,10 @@ private:
        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;
 };
 #endif