2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
7 * Copyright 1998 The LyX Team.
10 *======================================================
12 // The pristine updatable inset: Text
25 #include "paragraph.h"
26 #include "lyxcursor.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 {
47 /// numbers need because of test if codeA < codeB
77 InsetText(BufferParams const &);
80 InsetText(InsetText const &, bool same_id = false);
84 Inset * clone(Buffer const &, bool same_id = false) const;
86 InsetText & operator=(InsetText const & it);
90 void read(Buffer const *, LyXLex &);
92 void write(Buffer const *, std::ostream &) const;
94 int ascent(BufferView *, LyXFont const &) const;
96 int descent(BufferView *, LyXFont const &) const;
98 int width(BufferView *, LyXFont const & f) const;
100 int textWidth(BufferView *, bool fordraw = false) const;
102 void draw(BufferView *, LyXFont const &, int , float &, bool) const;
104 void update(BufferView *, LyXFont const &, bool = false);
106 void setUpdateStatus(BufferView *, int what) const;
108 string const editMessage() const;
110 void edit(BufferView *, int, int, mouse_button::state);
112 void edit(BufferView *, bool front = true);
114 bool isTextInset() const { return true; }
116 bool doClearArea() const;
118 void insetUnlock(BufferView *);
120 bool lockInsetInInset(BufferView *, UpdatableInset *);
122 bool unlockInsetInInset(BufferView *,
123 UpdatableInset *, bool lr = false);
125 bool updateInsetInInset(BufferView *, Inset *);
127 bool insetButtonRelease(BufferView *, int, int, mouse_button::state);
129 void insetButtonPress(BufferView *, int, int, mouse_button::state);
131 void insetMotionNotify(BufferView *, int, int, mouse_button::state);
133 UpdatableInset::RESULT localDispatch(BufferView *,
134 kb_action, string const &);
136 int latex(Buffer const *, std::ostream &,
137 bool fragile, bool free_spc) const;
139 int ascii(Buffer const *, std::ostream &, int linelen) const;
141 int linuxdoc(Buffer const *, std::ostream &) const { return 0; }
143 int docbook(Buffer const *, std::ostream &) const ;
145 void validate(LaTeXFeatures & features) const;
147 Inset::Code lyxCode() const { return Inset::TEXT_CODE; }
149 void getCursorPos(BufferView *, int & x, int & y) const;
151 int insetInInsetY() const;
153 void toggleInsetCursor(BufferView *);
155 void showInsetCursor(BufferView *, bool show = true);
157 void hideInsetCursor(BufferView *);
159 void fitInsetCursor(BufferView *) const;
161 bool insertInset(BufferView *, Inset *);
163 bool insetAllowed(Inset::Code) const;
165 UpdatableInset * getLockingInset() const;
167 UpdatableInset * getFirstLockingInsetOfType(Inset::Code);
169 void setFont(BufferView *, LyXFont const &,
170 bool toggleall = false,
171 bool selectall = false);
173 int getMaxWidth(BufferView *, UpdatableInset const *) const;
175 void init(InsetText const * ins = 0, bool same_id = false);
177 void writeParagraphData(Buffer const *, std::ostream &) const;
179 void setParagraphData(Paragraph *, bool same_id = false);
181 void setText(string const &, LyXFont const &);
183 void setAutoBreakRows(bool);
185 bool getAutoBreakRows() const { return autoBreakRows; }
187 void setDrawFrame(BufferView *, DrawFrame);
189 void setFrameColor(BufferView *, LColor::color);
191 LyXText * getLyXText(BufferView const *,
192 bool const recursive = false) const;
194 void deleteLyXText(BufferView *, bool recursive = true) const;
196 void resizeLyXText(BufferView *, bool force = false) const;
198 bool showInsetDialog(BufferView *) const;
200 std::vector<string> const getLabelList() const;
204 int scroll(bool recursive = true) const;
206 void scroll(BufferView * bv, float sx) const {
207 UpdatableInset::scroll(bv, sx);
210 void scroll(BufferView * bv, int offset) const {
211 UpdatableInset::scroll(bv, offset);
214 void selectAll(BufferView * bv);
216 void clearSelection(BufferView * bv);
218 Paragraph * getParFromID(int id) const;
220 Inset * getInsetFromID(int id) const;
222 Paragraph * firstParagraph() const;
224 Paragraph * getFirstParagraph(int) const;
226 LyXCursor const & cursor(BufferView *) const;
228 Paragraph * paragraph() const;
230 void paragraph(Paragraph *);
232 bool allowSpellcheck() { return true; }
234 string const selectNextWordToSpellcheck(BufferView *,
235 float & value) const;
236 void selectSelectedWord(BufferView *);
238 void toggleSelection(BufferView *, bool kill_selection);
240 bool searchForward(BufferView *, string const &,
241 bool = true, bool = false);
243 bool searchBackward(BufferView *, string const &,
244 bool = true, bool = false);
246 bool checkInsertChar(LyXFont &);
248 void getDrawFont(LyXFont &) const;
250 void appendParagraphs(BufferParams const & bparams, Paragraph *);
253 // Public structures and variables
255 mutable int need_update;
259 void updateLocal(BufferView *, int what, bool mark_dirty) const;
260 /// set parameters for an initial lock of this inset
261 void lockInset(BufferView *);
262 /// lock an inset inside this one
263 void lockInset(BufferView *, UpdatableInset *);
265 mutable int drawTextXOffset;
267 mutable int drawTextYOffset;
271 DrawFrame drawFrame_;
273 LColor::color frame_color;
279 InnerCache(boost::shared_ptr<LyXText>);
281 boost::shared_ptr<LyXText> text;
286 typedef std::map<BufferView *, InnerCache> Cache;
288 typedef Cache::value_type value_type;
290 int beginningOfMainBody(Buffer const *, Paragraph * par) const;
292 UpdatableInset::RESULT moveRight(BufferView *,
293 bool activate_inset = true,
294 bool selecting = false);
296 UpdatableInset::RESULT moveLeft(BufferView *,
297 bool activate_inset = true,
298 bool selecting = false);
300 UpdatableInset::RESULT moveRightIntern(BufferView *, bool front,
301 bool activate_inset = true,
302 bool selecting = false);
304 UpdatableInset::RESULT moveLeftIntern(BufferView *, bool front,
305 bool activate_inset = true,
306 bool selecting = false);
309 UpdatableInset::RESULT moveUp(BufferView *);
311 UpdatableInset::RESULT moveDown(BufferView *);
313 void setCharFont(Buffer const *, int pos, LyXFont const & font);
315 bool checkAndActivateInset(BufferView * bv, bool front);
317 bool checkAndActivateInset(BufferView * bv, int x = 0, int y = 0,
318 mouse_button::state button = mouse_button::none);
320 void removeNewlines();
322 int cx(BufferView *) const;
324 int cix(BufferView *) const;
326 int cy(BufferView *) const;
328 int ciy(BufferView *) const;
330 lyx::pos_type cpos(BufferView *) const;
332 Paragraph * cpar(BufferView *) const;
334 bool cboundary(BufferView *) const;
336 Row * crow(BufferView *) const;
338 void drawFrame(Painter &, bool cleared) const;
340 void clearFrame(Painter &, bool cleared) const;
342 void clearInset(BufferView *, int baseline, bool & cleared) const;
344 void saveLyXTextState(LyXText *) const;
346 void restoreLyXTextState(BufferView *, LyXText *) const;
348 void reinitLyXText() const;
350 void collapseParagraphs(BufferView *) const;
352 /* Private structures and variables */
358 mutable int insetAscent;
360 mutable int insetDescent;
362 mutable int insetWidth;
366 Paragraph * inset_par;
368 lyx::pos_type inset_pos;
376 mutable int old_max_width;
382 UpdatableInset * the_locking_inset;
384 mutable Paragraph * old_par;
388 mutable int last_drawn_width;
390 mutable bool frame_is_visible;
392 mutable BufferView * cached_bview;
394 mutable boost::shared_ptr<LyXText> cached_text;
398 Paragraph * selstartpar;
399 Paragraph * selendpar;
401 lyx::pos_type selstartpos;
402 lyx::pos_type selendpos;
404 bool selstartboundary;
411 mutable save_state sstate;
414 // this is needed globally so we know that we're using it actually and
415 // so the LyXText-Cache is not erased until used!
416 mutable LyXText * lt;
418 // to remember old painted frame dimensions to clear it on the right spot!
425 bool in_update; /* as update is not reentrant! */
426 mutable BufferView * do_resize;
427 mutable bool do_reinit;
428 mutable bool in_insetAllowed;
430 // these are used to check for mouse movement in Motion selection code