// -*- 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 "textcursor.h"
#include "LString.h"
#include "LColor.h"
-#include "paragraph.h"
-#include "lyxcursor.h"
-#include <boost/smart_ptr.hpp>
+#include "ParagraphList.h"
+#include "RowList.h"
+#include "dimension.h"
+#include "lyxtext.h"
+
+#include "support/types.h"
+
+#include "frontends/mouse_state.h"
+
+#include <boost/shared_ptr.hpp>
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 {
///
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 {
ALWAYS
};
///
- InsetText();
+ InsetText(BufferParams const &);
///
- explicit
- InsetText(InsetText const &, bool same_id = false);
+ explicit InsetText(InsetText const &);
///
- ~InsetText();
- ///
- Inset * clone(Buffer const &, bool same_id = false) const;
+ virtual std::auto_ptr<InsetBase> clone() 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 metrics(MetricsInfo &, Dimension &) const;
///
- int textWidth(BufferView *, bool fordraw = false) const;
+ int textWidth() const;
///
- void draw(BufferView *, LyXFont const &, int , float &, bool) const;
+ void draw(PainterInfo & pi, int x, int y) const;
///
- void update(BufferView *, LyXFont const &, bool =false);
- ///
- void setUpdateStatus(BufferView *, int what) const;
+ void setUpdateStatus(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 *);
bool unlockInsetInInset(BufferView *,
UpdatableInset *, bool lr = false);
///
- bool updateInsetInInset(BufferView *, Inset *);
+ bool updateInsetInInset(BufferView *, InsetOld *);
///
- void 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 linuxdoc(Buffer const *, std::ostream &) const ;
///
- 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; }
- ///
+ 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;
///
- unsigned int insetInInsetY();
- ///
- void toggleInsetCursor(BufferView *);
- ///
- void showInsetCursor(BufferView *, bool show=true);
- ///
- void hideInsetCursor(BufferView *);
+ int insetInInsetY() const;
///
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;
+ bool selectall = false);
///
- void init(InsetText const * ins = 0, bool same_id = false);
+ void init(InsetText const * ins);
///
void writeParagraphData(Buffer const *, std::ostream &) const;
///
- void setParagraphData(Paragraph *, bool same_id = false);
+ void setParagraphData(ParagraphList const &);
///
- void setText(string const &);
+ void setText(string const &, LyXFont const &);
///
void setAutoBreakRows(bool);
///
LyXText * getLyXText(BufferView const *,
bool const recursive = false) const;
///
+ void setViewCache(BufferView const * bv) const;
+ ///
void deleteLyXText(BufferView *, bool recursive = true) const;
///
void resizeLyXText(BufferView *, bool force = false) const;
///
bool showInsetDialog(BufferView *) const;
///
- std::vector<string> const getLabelList() const;
+ void getLabelList(std::vector<string> &) const;
///
bool nodraw() const;
///
- int scroll(bool recursive=true) const;
+ int scroll(bool recursive = true) const;
///
- void scroll(BufferView *bv, float sx) const {
+ void scroll(BufferView * bv, float sx) const {
UpdatableInset::scroll(bv, sx);
}
///
- void scroll(BufferView *bv, int offset) const {
+ void scroll(BufferView * bv, int offset) const {
UpdatableInset::scroll(bv, offset);
}
///
- void selectAll(BufferView *bv);
- ///
- void clearSelection(BufferView *bv);
- ///
- Paragraph * getParFromID(int id) const;
- ///
- Inset * getInsetFromID(int id) const;
+ void clearSelection(BufferView * bv);
///
- 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; }
- 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 const & = true, bool const & = false);
+ bool = true, bool = false);
+ ///
bool searchBackward(BufferView *, string const &,
- bool const & = true, bool const & = 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(lyx::graphics::PreviewLoader &) const;
+
//
// Public structures and variables
///
mutable int need_update;
+ bool haveParagraphs() const {
+ return true;
+ }
+ ///
+ ParagraphList paragraphs;
protected:
///
- void updateLocal(BufferView *, int what, bool mark_dirty) const;
+ 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;
///
LColor::color frame_color;
private:
- struct InnerCache {
- InnerCache(boost::shared_ptr<LyXText>);
-
- boost::shared_ptr<LyXText> text;
- bool remove;
- };
///
- typedef std::map<BufferView *, struct InnerCache > Cache;
+ void lfunMousePress(FuncRequest const &);
///
- typedef Cache::value_type value_type;
+ bool lfunMouseRelease(FuncRequest const &);
///
- int beginningOfMainBody(Buffer const *, Paragraph * par) const;
+ void lfunMouseMotion(FuncRequest 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 cx() const;
///
- int cy(BufferView *) const;
+ int cix() const;
///
- lyx::pos_type cpos(BufferView *) const;
+ int cy() const;
///
- Paragraph * cpar(BufferView *) const;
+ int ciy() const;
///
- bool cboundary(BufferView *) const;
+ lyx::pos_type cpos() const;
///
- Row * crow(BufferView *) const;
+ ParagraphList::iterator cpar() const;
///
- void drawFrame(Painter &, bool cleared) const;
+ bool cboundary() const;
///
- void clearFrame(Painter &, bool cleared) const;
+ RowList::iterator crow() const;
///
- void clearInset(Painter &, int baseline, bool & cleared) const;
+ void drawFrame(Painter &, int x) const;
///
- void saveLyXTextState(LyXText *) const;
- void restoreLyXTextState(BufferView *, LyXText *) const;
+ void clearInset(BufferView *, int start_x, int baseline) const;
///
- void reinitLyXText() const;
-
- /* Private structures and variables */
- ///
- Paragraph * par;
- ///
- mutable bool locked;
+ void saveLyXTextState() const;
///
- mutable int insetAscent;
+ void restoreLyXTextState() const;
///
- mutable int insetDescent;
- ///
- mutable int insetWidth;
- ///
- mutable int last_width;
+ void collapseParagraphs(BufferView *);
+
+ /* Private structures and variables */
///
- mutable int last_height;
+ mutable bool locked;
///
mutable int top_y;
///
- Paragraph * inset_par;
+ ParagraphList::iterator inset_par;
///
lyx::pos_type inset_pos;
///
///
mutable int inset_y;
///
- mutable int old_max_width;
- ///
bool no_selection;
///
- mutable float xpos;
- ///
UpdatableInset * the_locking_inset;
///
- mutable Paragraph * old_par;
- /// The cache.
- mutable Cache cache;
+ mutable ParagraphList::iterator old_par;
///
mutable int last_drawn_width;
- ///
- mutable bool frame_is_visible;
- ///
- mutable BufferView * cached_bview;
- ///
- mutable boost::shared_ptr<LyXText> cached_text;
- ///
- mutable 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;
- } sstate;
- ///
- // 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;
+
+ /// some funny 'temporarily saved state'
+ mutable TextCursor sstate;
+
///
// to remember old painted frame dimensions to clear it on the right spot!
///
mutable int frame_y;
mutable int frame_w;
mutable int frame_h;
+ mutable bool in_insetAllowed;
+ ///
+ // these are used to check for mouse movement in Motion selection code
+ ///
+ int mouse_x;
+ int mouse_y;
+public:
+ ///
+ void reinitLyXText() const;
+ ///
+ mutable LyXText text_;
///
- bool in_update; /* as update is not reentrant! */
- mutable BufferView * do_resize;
- mutable bool do_reinit;
+ mutable int textwidth_;
};
#endif