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"
27 #include <boost/smart_ptr.hpp>
38 A text inset is like a TeX box to write full text
39 (including styles and other insets) in a given space.
42 class InsetText : public UpdatableInset {
45 /// numbers need because of test if codeA < codeB
78 InsetText(InsetText const &, bool same_id = false);
82 Inset * clone(Buffer const &, bool same_id = false) const;
84 InsetText & operator=(InsetText const & it);
88 void read(Buffer const *, LyXLex &);
90 void write(Buffer const *, std::ostream &) const;
92 int ascent(BufferView *, LyXFont const &) const;
94 int descent(BufferView *, LyXFont const &) const;
96 int width(BufferView *, LyXFont const & f) const;
98 int textWidth(BufferView *) const;
100 void draw(BufferView *, LyXFont const &, int , float &, bool) const;
102 void update(BufferView *, LyXFont const &, bool =false);
104 void setUpdateStatus(BufferView *, int what) const;
106 string const editMessage() const;
108 void edit(BufferView *, int, int, unsigned int);
110 void edit(BufferView *, bool front = true);
112 bool isTextInset() const { return true; }
114 bool doClearArea() const;
116 void insetUnlock(BufferView *);
118 bool lockInsetInInset(BufferView *, UpdatableInset *);
120 bool unlockInsetInInset(BufferView *,
121 UpdatableInset *, bool lr = false);
123 bool updateInsetInInset(BufferView *, Inset *);
125 void insetButtonRelease(BufferView *, int, int, int);
127 void insetButtonPress(BufferView *, int, int, int);
129 void insetMotionNotify(BufferView *, int, int, int);
131 void insetKeyPress(XKeyEvent *);
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 unsigned int insetInInsetY();
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 *);
181 void setText(string const &);
183 void setAutoBreakRows(bool);
185 void setDrawFrame(BufferView *, DrawFrame);
187 void setFrameColor(BufferView *, LColor::color);
189 LyXText * getLyXText(BufferView const *,
190 bool const recursive = false) const;
192 void deleteLyXText(BufferView *, bool recursive = true) const;
194 void resizeLyXText(BufferView *, bool force = false) const;
196 bool showInsetDialog(BufferView *) const;
198 std::vector<string> const getLabelList() const;
202 int scroll(bool recursive=true) const;
204 void scroll(BufferView *bv, float sx) const {
205 UpdatableInset::scroll(bv, sx);
208 void scroll(BufferView *bv, int offset) const {
209 UpdatableInset::scroll(bv, offset);
212 void selectAll(BufferView *bv);
214 void clearSelection(BufferView *bv);
216 Paragraph * getParFromID(int id) const;
218 Inset * getInsetFromID(int id) const;
220 Paragraph * firstParagraph() const;
222 LyXCursor const & cursor(BufferView *) const;
224 Paragraph * paragraph() const;
226 void paragraph(Paragraph *);
228 string const selectNextWord(BufferView *, float & value) const;
229 void selectSelectedWord(BufferView *);
230 void toggleSelection(BufferView *, bool kill_selection);
232 bool searchForward(BufferView *, string const &,
233 bool const & = true, bool const & = false);
234 bool searchBackward(BufferView *, string const &,
235 bool const & = true, bool const & = false);
238 // Public structures and variables
240 mutable int need_update;
244 void updateLocal(BufferView *, int what, bool mark_dirty) const;
246 mutable int drawTextXOffset;
248 mutable int drawTextYOffset;
252 DrawFrame drawFrame_;
254 LColor::color frame_color;
258 InnerCache(boost::shared_ptr<LyXText>);
260 boost::shared_ptr<LyXText> text;
264 typedef std::map<BufferView *, struct InnerCache > Cache;
266 typedef Cache::value_type value_type;
268 int beginningOfMainBody(Buffer const *, Paragraph * par) const;
270 UpdatableInset::RESULT moveRight(BufferView *,
271 bool activate_inset = true,
272 bool selecting = false);
274 UpdatableInset::RESULT moveLeft(BufferView *,
275 bool activate_inset = true,
276 bool selecting = false);
278 UpdatableInset::RESULT moveRightIntern(BufferView *, bool behind,
279 bool activate_inset = true,
280 bool selecting = false);
282 UpdatableInset::RESULT moveLeftIntern(BufferView *, bool behind,
283 bool activate_inset = true,
284 bool selecting = false);
287 UpdatableInset::RESULT moveUp(BufferView *);
289 UpdatableInset::RESULT moveDown(BufferView *);
291 void setCharFont(Buffer const *, int pos, LyXFont const & font);
293 ///What's that ??? Not used, not implemented!
295 string const getText(int);
298 bool checkAndActivateInset(BufferView * bv, bool behind);
300 bool checkAndActivateInset(BufferView * bv, int x = 0, int y = 0,
303 void removeNewlines();
305 int cx(BufferView *) const;
307 int cy(BufferView *) const;
309 Paragraph::size_type cpos(BufferView *) const;
311 Paragraph * cpar(BufferView *) const;
313 bool cboundary(BufferView *) const;
315 Row * crow(BufferView *) const;
317 void drawFrame(Painter &, bool cleared) const;
319 void clearFrame(Painter &, bool cleared) const;
321 void clearInset(Painter &, int baseline, bool & cleared) const;
323 void saveLyXTextState(LyXText *) const;
324 void restoreLyXTextState(BufferView *, LyXText *) const;
326 /* Private structures and variables */
332 mutable int insetAscent;
334 mutable int insetDescent;
336 mutable int insetWidth;
338 mutable int last_width;
340 mutable int last_height;
344 Paragraph * inset_par;
346 Paragraph::size_type inset_pos;
354 mutable unsigned int old_max_width;
360 UpdatableInset * the_locking_inset;
362 mutable Paragraph * old_par;
366 mutable int last_drawn_width;
368 mutable bool frame_is_visible;
370 mutable BufferView * cached_bview;
372 mutable boost::shared_ptr<LyXText> cached_text;
374 mutable struct save_state {
376 Paragraph * selstartpar;
377 Paragraph * selendpar;
378 Paragraph::size_type pos;
379 Paragraph::size_type selstartpos;
380 Paragraph::size_type selendpos;
382 bool selstartboundary;
388 // this is needed globally so we know that we're using it actually and
389 // so the LyXText-Cache is not erased until used!
390 mutable LyXText * lt;