4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS
15 #include "updatableinset.h"
16 #include "textcursor.h"
19 #include "ParagraphList.h"
21 #include "dimension.h"
24 #include "support/types.h"
26 #include "frontends/mouse_state.h"
28 #include <boost/shared_ptr.hpp>
40 A text inset is like a TeX box to write full text
41 (including styles and other insets) in a given space.
44 class InsetText : public UpdatableInset {
56 InsetText(BufferParams const &);
58 explicit InsetText(InsetText const &);
60 virtual std::auto_ptr<InsetBase> clone() const;
62 InsetText & operator=(InsetText const & it);
63 /// empty inset to empty par, or just mark as erased
64 void clear(bool just_mark_erased);
66 void read(Buffer const *, LyXLex &);
68 void write(Buffer const *, std::ostream &) const;
70 void metrics(MetricsInfo &, Dimension &) const;
72 int textWidth() const;
74 void draw(PainterInfo & pi, int x, int y) const;
76 string const editMessage() const;
78 bool isTextInset() const { return true; }
80 void insetUnlock(BufferView *);
82 bool lockInsetInInset(BufferView *, UpdatableInset *);
84 bool unlockInsetInInset(BufferView *,
85 UpdatableInset *, bool lr = false);
87 bool updateInsetInInset(BufferView *, InsetOld *);
89 RESULT localDispatch(FuncRequest const &);
91 int latex(Buffer const *, std::ostream &,
92 LatexRunParams const &) const;
94 int ascii(Buffer const *, std::ostream &, int linelen) const;
96 int linuxdoc(Buffer const *, std::ostream &) const ;
98 int docbook(Buffer const *, std::ostream &, bool mixcont) const ;
100 void validate(LaTeXFeatures & features) const;
102 InsetOld::Code lyxCode() const { return InsetOld::TEXT_CODE; }
104 void getCursorPos(BufferView *, int & x, int & y) const;
105 /// Get the absolute document x,y of the cursor
106 virtual void getCursor(BufferView &, int &, int &) const;
108 int insetInInsetY() const;
110 void fitInsetCursor(BufferView *) const;
112 bool insertInset(BufferView *, InsetOld *);
114 bool insetAllowed(InsetOld::Code) const;
116 UpdatableInset * getLockingInset() const;
118 UpdatableInset * getFirstLockingInsetOfType(InsetOld::Code);
120 void setFont(BufferView *, LyXFont const &,
121 bool toggleall = false,
122 bool selectall = false);
124 void init(InsetText const * ins);
126 void writeParagraphData(Buffer const *, std::ostream &) const;
128 void setParagraphData(ParagraphList const &);
130 void setText(string const &, LyXFont const &);
132 void setAutoBreakRows(bool);
134 bool getAutoBreakRows() const { return autoBreakRows; }
136 void setDrawFrame(BufferView *, DrawFrame);
138 void setFrameColor(BufferView *, LColor::color);
140 LyXText * getLyXText(BufferView const *,
141 bool const recursive = false) const;
143 void setViewCache(BufferView const * bv) const;
145 void deleteLyXText(BufferView *, bool recursive = true) const;
147 void resizeLyXText(BufferView *, bool force = false) const;
149 bool showInsetDialog(BufferView *) const;
151 void getLabelList(std::vector<string> &) const;
153 int scroll(bool recursive = true) const;
155 void scroll(BufferView * bv, float sx) const {
156 UpdatableInset::scroll(bv, sx);
159 void scroll(BufferView * bv, int offset) const {
160 UpdatableInset::scroll(bv, offset);
163 void clearSelection(BufferView * bv);
165 InsetOld * getInsetFromID(int id) const;
167 ParagraphList * getParagraphs(int) const;
169 LyXCursor const & cursor(BufferView *) const;
171 bool allowSpellcheck() const { return true; }
174 selectNextWordToSpellcheck(BufferView *, float & value) const;
176 void selectSelectedWord(BufferView *);
178 /// mark as erased for change tracking
179 void markErased() { clear(true); };
181 * Mark as new. Used when pasting in tabular, and adding rows
182 * or columns. Note that pasting will ensure that tracking already
183 * happens, and this just resets the changes for the copied text,
184 * whereas for row/col add, we need to start tracking changes
185 * for the (empty) paragraph contained.
187 void markNew(bool track_changes = false);
189 bool nextChange(BufferView *, lyx::pos_type & length);
192 bool searchForward(BufferView *, string const &,
193 bool = true, bool = false);
195 bool searchBackward(BufferView *, string const &,
196 bool = true, bool = false);
198 bool checkInsertChar(LyXFont &);
200 void getDrawFont(LyXFont &) const;
201 /// append text onto the existing text
202 void appendParagraphs(Buffer * bp, ParagraphList &);
205 void addPreview(lyx::graphics::PreviewLoader &) const;
208 bool haveParagraphs() const {
212 ParagraphList paragraphs;
215 void updateLocal(BufferView *, bool mark_dirty);
216 /// set parameters for an initial lock of this inset
217 void lockInset(BufferView *);
218 /// lock an inset inside this one
219 void lockInset(BufferView *, UpdatableInset *);
221 mutable int drawTextXOffset;
223 mutable int drawTextYOffset;
227 DrawFrame drawFrame_;
229 LColor::color frame_color;
233 void lfunMousePress(FuncRequest const &);
235 bool lfunMouseRelease(FuncRequest const &);
237 void lfunMouseMotion(FuncRequest const &);
240 RESULT moveRight(BufferView *,
241 bool activate_inset = true,
242 bool selecting = false);
244 RESULT moveLeft(BufferView *,
245 bool activate_inset = true,
246 bool selecting = false);
248 RESULT moveRightIntern(BufferView *, bool front,
249 bool activate_inset = true,
250 bool selecting = false);
252 RESULT moveLeftIntern(BufferView *, bool front,
253 bool activate_inset = true,
254 bool selecting = false);
257 RESULT moveUp(BufferView *);
259 RESULT moveDown(BufferView *);
261 void setCharFont(Buffer const *, int pos, LyXFont const & font);
263 bool checkAndActivateInset(BufferView * bv, bool front);
265 bool checkAndActivateInset(BufferView * bv, int x = 0, int y = 0,
266 mouse_button::state button = mouse_button::none);
268 void removeNewlines();
278 lyx::pos_type cpos() const;
280 ParagraphList::iterator cpar() const;
282 bool cboundary() const;
284 RowList::iterator crow() const;
286 void drawFrame(Painter &, int x) const;
288 void clearInset(BufferView *, int start_x, int baseline) const;
290 void saveLyXTextState() const;
292 void restoreLyXTextState() const;
294 void collapseParagraphs(BufferView *);
296 /* Private structures and variables */
302 ParagraphList::iterator inset_par;
304 lyx::pos_type inset_pos;
314 UpdatableInset * the_locking_inset;
316 mutable ParagraphList::iterator old_par;
318 mutable int last_drawn_width;
320 /// some funny 'temporarily saved state'
321 mutable TextCursor sstate;
324 // to remember old painted frame dimensions to clear it on the right spot!
330 mutable bool in_insetAllowed;
332 // these are used to check for mouse movement in Motion selection code
338 void reinitLyXText() const;
340 mutable LyXText text_;
342 mutable int textwidth_;