// -*- 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 "lyxinset.h"
+#include "updatableinset.h"
#include "LString.h"
-#include "lyxcursor.h"
+#include "LColor.h"
+#include "ParagraphList.h"
+#include "RowList.h"
+#include "frontends/mouse_state.h"
+
+#include "support/types.h"
+
+#include <boost/shared_ptr.hpp>
+#include <map>
class Painter;
class BufferView;
class Buffer;
+class BufferParams;
class LyXCursor;
-class LyXParagraph;
-class LColor;
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 {
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 {
- ///
- NEVER = 0,
- ///
- LOCKED,
- ///
- ALWAYS
- };
- ///
- InsetText();
- ///
- explicit
- InsetText(InsetText const &);
- ///
- ~InsetText();
- ///
- Inset * Clone(Buffer const &) const;
- ///
- InsetText & operator=(InsetText const & it);
- ///
- void clear();
- ///
- 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;
- ///
- int textWidth(Painter &) const;
- ///
- void draw(BufferView *, LyXFont const &, int , float &, bool) const;
- ///
- void update(BufferView *, LyXFont const &, bool =false);
- ///
- void SetUpdateStatus(BufferView *, int what);
- ///
- string const EditMessage() const;
- ///
- void Edit(BufferView *, int, int, unsigned int);
- ///
- bool IsTextInset() const { return true; }
- ///
- bool doClearArea() const { return !locked; }
- ///
- void InsetUnlock(BufferView *);
- ///
- bool LockInsetInInset(BufferView *, UpdatableInset *);
- ///
- bool UnlockInsetInInset(BufferView *, UpdatableInset *, bool lr = false);
- ///
- bool UpdateInsetInInset(BufferView *, Inset *);
- ///
- 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 &);
- ///
- int Latex(Buffer const *, std::ostream &,
- bool fragile, bool free_spc) 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 ;
- ///
- void Validate(LaTeXFeatures & features) const;
- ///
- Inset::Code LyxCode() const { return Inset::TEXT_CODE; }
- ///
- void GetCursorPos(BufferView *, int & x, int & y) const;
- ///
- unsigned int InsetInInsetY();
- ///
- void ToggleInsetCursor(BufferView *);
- ///
- bool InsertInset(BufferView *, Inset *);
- ///
- UpdatableInset * GetLockingInset();
- ///
- UpdatableInset * GetFirstLockingInsetOfType(Inset::Code);
- ///
- void SetFont(BufferView *, LyXFont const &, bool toggleall = false);
- ///
- int getMaxWidth(Painter &, UpdatableInset const *) const;
- ///
- void init(InsetText const * ins = 0);
- ///
- void WriteParagraphData(Buffer const *, std::ostream &) const;
- ///
- void SetParagraphData(LyXParagraph *);
- ///
- void SetText(string const &);
- ///
- void SetAutoBreakRows(bool);
- ///
- void SetDrawFrame(BufferView *, DrawFrame);
- ///
- void SetFrameColor(BufferView *, LColor::color);
- ///
- LyXText * getLyXText(BufferView const *, bool const recursive=false) const;
- ///
- void deleteLyXText(BufferView *, bool recursive=true) const;
- ///
- void resizeLyXText(BufferView *) const;
- ///
- LyXParagraph * par;
- ///
- mutable int need_update;
+ ///
+ /// numbers need because of test if codeA < codeB
+ ///
+ enum UpdateCodes {
+ ///
+ NONE = 0,
+ ///
+ CURSOR = 1,
+ ///
+ DRAW_FRAME = 2,
+ ///
+ SELECTION = 4,
+ ///
+ CURSOR_PAR = 8,
+ ///
+ FULL = 16,
+ ///
+ INIT = 32
+ };
+ ///
+ enum DrawFrame {
+ ///
+ NEVER = 0,
+ ///
+ LOCKED,
+ ///
+ ALWAYS
+ };
+ ///
+ InsetText(BufferParams const &);
+ ///
+ explicit
+ InsetText(InsetText const &, bool same_id = false);
+ ///
+ ~InsetText();
+ ///
+ Inset * clone(Buffer const &, bool same_id = false) const;
+ ///
+ InsetText & operator=(InsetText const & it);
+ /// 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;
+ ///
+ int textWidth(BufferView *, bool fordraw = false) const;
+ ///
+ void draw(BufferView *, LyXFont const &, int , float &) const;
+ ///
+ void update(BufferView *, bool = false);
+ ///
+ void setUpdateStatus(BufferView *, int what) const;
+ ///
+ string const editMessage() const;
+ ///
+ bool isTextInset() const { return true; }
+ ///
+ void insetUnlock(BufferView *);
+ ///
+ bool lockInsetInInset(BufferView *, UpdatableInset *);
+ ///
+ bool unlockInsetInInset(BufferView *,
+ UpdatableInset *, bool lr = false);
+ ///
+ bool updateInsetInInset(BufferView *, Inset *);
+ ///
+ RESULT localDispatch(FuncRequest const &);
+ ///
+ int latex(Buffer const *, std::ostream &,
+ bool fragile, bool free_spc) 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 &, 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;
+ ///
+ int insetInInsetY() const;
+ ///
+ void fitInsetCursor(BufferView *) const;
+ ///
+ bool insertInset(BufferView *, Inset *);
+ ///
+ bool insetAllowed(Inset::Code) const;
+ ///
+ UpdatableInset * getLockingInset() const;
+ ///
+ UpdatableInset * getFirstLockingInsetOfType(Inset::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 setParagraphData(ParagraphList const &, bool same_id = false);
+ ///
+ void setText(string const &, LyXFont const &);
+ ///
+ void setAutoBreakRows(bool);
+ ///
+ bool getAutoBreakRows() const { return autoBreakRows; }
+ ///
+ void setDrawFrame(BufferView *, DrawFrame);
+ ///
+ void setFrameColor(BufferView *, LColor::color);
+ ///
+ LyXText * getLyXText(BufferView const *,
+ bool const recursive = false) 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;
+ ///
+ bool nodraw() const;
+ ///
+ int scroll(bool recursive = true) const;
+ ///
+ void scroll(BufferView * bv, float sx) const {
+ UpdatableInset::scroll(bv, sx);
+ }
+ ///
+ void scroll(BufferView * bv, int offset) const {
+ UpdatableInset::scroll(bv, offset);
+ }
+ ///
+ void selectAll(BufferView * bv);
+ ///
+ void clearSelection(BufferView * bv);
+ ///
+ Inset * getInsetFromID(int id) const;
+ ///
+ ParagraphList * getParagraphs(int) const;
+ ///
+ LyXCursor const & cursor(BufferView *) const;
+ ///
+ void paragraph(Paragraph *);
+ ///
+ bool allowSpellcheck() const { return true; }
+ ///
+ WordLangTuple 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 searchBackward(BufferView *, string const &,
+ 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;
+
+ bool haveParagraphs() const {
+ return true;
+ }
+ ///
+ ParagraphList paragraphs;
protected:
- ///
- void UpdateLocal(BufferView *, int what, bool mark_dirty);
- ///
- mutable int drawTextXOffset;
- ///
- mutable int drawTextYOffset;
- ///
- bool autoBreakRows;
- ///
- DrawFrame drawFrame;
- ///
- LColor::color frame_color;
+ ///
+ 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;
+ ///
+ mutable int drawTextYOffset;
+ ///
+ bool autoBreakRows;
+ ///
+ DrawFrame drawFrame_;
+ ///
+ LColor::color frame_color;
private:
- ///
- typedef std::map<BufferView *, LyXText *> Cache;
- ///
- typedef Cache::value_type value_type;
- ///
- int BeginningOfMainBody(Buffer const *, LyXParagraph * par) const;
- ///
- void ShowInsetCursor(BufferView *, bool show=true);
- ///
- void HideInsetCursor(BufferView *);
- ///
- UpdatableInset::RESULT moveRight(BufferView *, bool activate_inset = true,
- bool selecting = false);
- ///
- UpdatableInset::RESULT moveLeft(BufferView *, bool activate_inset = true,
- bool selecting = false);
- ///
- UpdatableInset::RESULT moveRightIntern(BufferView *, bool behind,
- bool activate_inset = true,
- bool selecting = false);
- ///
- UpdatableInset::RESULT moveLeftIntern(BufferView *, bool behind,
- bool activate_inset = true,
- bool selecting = false);
+ ///
+ void lfunMousePress(FuncRequest const &);
+ ///
+ bool lfunMouseRelease(FuncRequest const &);
+ ///
+ void lfunMouseMotion(FuncRequest const &);
+
+ ///
+ struct InnerCache {
+ ///
+ InnerCache(boost::shared_ptr<LyXText>);
+ ///
+ boost::shared_ptr<LyXText> text;
+ ///
+ bool remove;
+ };
+ ///
+ typedef std::map<BufferView *, InnerCache> Cache;
+ ///
+ typedef Cache::value_type value_type;
+ ///
+ RESULT moveRight(BufferView *,
+ bool activate_inset = true,
+ bool selecting = false);
+ ///
+ RESULT moveLeft(BufferView *,
+ bool activate_inset = true,
+ bool selecting = false);
+ ///
+ RESULT moveRightIntern(BufferView *, bool front,
+ bool activate_inset = true,
+ bool selecting = false);
+ ///
+ RESULT moveLeftIntern(BufferView *, bool front,
+ bool activate_inset = true,
+ bool selecting = false);
- ///
- UpdatableInset::RESULT moveUp(BufferView *);
- ///
- UpdatableInset::RESULT moveDown(BufferView *);
- ///
- void SetCharFont(Buffer const *, int pos, LyXFont const & font);
- ///
- string const getText(int);
- ///
- bool checkAndActivateInset(BufferView * bv, bool behind);
- ///
- bool checkAndActivateInset(BufferView * bv, int x = 0, int y = 0,
- int button = 0);
- void removeNewlines();
+ ///
+ RESULT moveUp(BufferView *);
+ ///
+ RESULT moveDown(BufferView *);
+ ///
+ void setCharFont(Buffer const *, int pos, LyXFont const & font);
+ ///
+ bool checkAndActivateInset(BufferView * bv, bool front);
+ ///
+ bool checkAndActivateInset(BufferView * bv, int x = 0, int y = 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;
+ ///
+ ParagraphList::iterator cpar(BufferView *) const;
+ ///
+ bool cboundary(BufferView *) const;
+ ///
+ RowList::iterator crow(BufferView *) const;
+ ///
+ void drawFrame(Painter &, int x) const;
+ ///
+ void clearInset(BufferView *, int start_x, int baseline) const;
+ ///
+ void saveLyXTextState(LyXText *) const;
+ ///
+ void restoreLyXTextState(LyXText *) const;
+ ///
+ void reinitLyXText() const;
+ ///
+ void collapseParagraphs(BufferView *);
- ///
- int cx(BufferView *) const;
- ///
- int cy(BufferView *) const;
- ///
- LyXParagraph::size_type cpos(BufferView *) const;
- ///
- LyXParagraph * cpar(BufferView *) const;
- ///
- bool cboundary(BufferView *) const;
- ///
- Row * crow(BufferView *) const;
+ /* Private structures and variables */
+ ///
+ mutable bool locked;
+ ///
+ mutable int insetAscent;
+ ///
+ mutable int insetDescent;
+ ///
+ mutable int insetWidth;
+ ///
+ mutable int top_y;
+ ///
+ ParagraphList::iterator inset_par;
+ ///
+ lyx::pos_type inset_pos;
+ ///
+ bool inset_boundary;
+ ///
+ mutable int inset_x;
+ ///
+ mutable int inset_y;
+ ///
+ mutable int old_max_width;
+ ///
+ bool no_selection;
+ ///
+ UpdatableInset * the_locking_inset;
+ ///
+ mutable ParagraphList::iterator old_par;
+ /// The cache.
+ mutable Cache cache;
+ ///
+ mutable int last_drawn_width;
+ ///
+ 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;
+ };
+ ///
+ mutable save_state sstate;
- /// This instead of a macro
- LyXText * TEXT(BufferView * bv) const {
- return getLyXText(bv);
- }
-
- /* Private structures and variables */
- ///
- mutable bool locked;
- ///
- mutable int insetAscent;
- ///
- mutable int insetDescent;
- ///
- mutable int insetWidth;
- ///
- mutable int last_width;
- ///
- mutable int last_height;
- ///
- mutable int top_y;
- ///
- LyXParagraph * inset_par;
- ///
- LyXParagraph::size_type inset_pos;
- ///
- bool inset_boundary;
- ///
- mutable int inset_x;
- ///
- mutable int inset_y;
- ///
- int interline_space;
- ///
- bool no_selection;
- ///
- mutable float xpos;
- ///
- UpdatableInset * the_locking_inset;
- ///
- LyXParagraph * old_par;
- /// The cache.
- mutable Cache cache;
+ ///
+ // 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;
};
#endif
projects / lyx.git / blobdiff