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 bool isTextInset() const { return true; }
112 bool doClearArea() const;
114 void insetUnlock(BufferView *);
116 bool lockInsetInInset(BufferView *, UpdatableInset *);
118 bool unlockInsetInInset(BufferView *,
119 UpdatableInset *, bool lr = false);
121 bool updateInsetInInset(BufferView *, Inset *);
123 void insetButtonRelease(BufferView *, int, int, int);
125 void insetButtonPress(BufferView *, int, int, int);
127 void insetMotionNotify(BufferView *, int, int, int);
129 void insetKeyPress(XKeyEvent *);
131 UpdatableInset::RESULT localDispatch(BufferView *,
132 kb_action, string const &);
134 int latex(Buffer const *, std::ostream &,
135 bool fragile, bool free_spc) const;
137 int ascii(Buffer const *, std::ostream &, int linelen) const;
139 int linuxdoc(Buffer const *, std::ostream &) const { return 0; }
141 int docBook(Buffer const *, std::ostream &) const ;
143 void validate(LaTeXFeatures & features) const;
145 Inset::Code lyxCode() const { return Inset::TEXT_CODE; }
147 void getCursorPos(BufferView *, int & x, int & y) const;
149 unsigned int insetInInsetY();
151 void toggleInsetCursor(BufferView *);
153 bool insertInset(BufferView *, Inset *);
155 UpdatableInset * getLockingInset();
157 UpdatableInset * getFirstLockingInsetOfType(Inset::Code);
159 void setFont(BufferView *, LyXFont const &,
160 bool toggleall = false,
161 bool selectall = false);
163 int getMaxWidth(BufferView *, UpdatableInset const *) const;
165 void init(InsetText const * ins = 0, bool same_id = false);
167 void writeParagraphData(Buffer const *, std::ostream &) const;
169 void setParagraphData(Paragraph *);
171 void setText(string const &);
173 void setAutoBreakRows(bool);
175 void setDrawFrame(BufferView *, DrawFrame);
177 void setFrameColor(BufferView *, LColor::color);
179 LyXText * getLyXText(BufferView const *,
180 bool const recursive = false) const;
182 void deleteLyXText(BufferView *, bool recursive = true) const;
184 void resizeLyXText(BufferView *, bool force = false) const;
186 bool showInsetDialog(BufferView *) const;
188 std::vector<string> const getLabelList() const;
192 int scroll(bool recursive=true) const;
194 void scroll(BufferView *bv, float sx) const {
195 UpdatableInset::scroll(bv, sx);
198 void scroll(BufferView *bv, int offset) const {
199 UpdatableInset::scroll(bv, offset);
202 void selectAll(BufferView *bv);
204 void clearSelection(BufferView *bv);
206 Paragraph * getParFromID(int id) const;
208 Inset * getInsetFromID(int id) const;
210 Paragraph * firstParagraph() const;
212 LyXCursor const & cursor(BufferView *) const;
214 Paragraph * paragraph() const;
216 void paragraph(Paragraph *);
218 mutable int need_update;
222 void updateLocal(BufferView *, int what, bool mark_dirty);
224 mutable int drawTextXOffset;
226 mutable int drawTextYOffset;
230 DrawFrame drawFrame_;
232 LColor::color frame_color;
236 typedef std::map<BufferView *, boost::shared_ptr<LyXText> > Cache;
238 typedef Cache::value_type value_type;
240 int beginningOfMainBody(Buffer const *, Paragraph * par) const;
242 void showInsetCursor(BufferView *, bool show=true);
244 void hideInsetCursor(BufferView *);
246 UpdatableInset::RESULT moveRight(BufferView *,
247 bool activate_inset = true,
248 bool selecting = false);
250 UpdatableInset::RESULT moveLeft(BufferView *,
251 bool activate_inset = true,
252 bool selecting = false);
254 UpdatableInset::RESULT moveRightIntern(BufferView *, bool behind,
255 bool activate_inset = true,
256 bool selecting = false);
258 UpdatableInset::RESULT moveLeftIntern(BufferView *, bool behind,
259 bool activate_inset = true,
260 bool selecting = false);
263 UpdatableInset::RESULT moveUp(BufferView *);
265 UpdatableInset::RESULT moveDown(BufferView *);
267 void setCharFont(Buffer const *, int pos, LyXFont const & font);
269 string const getText(int);
271 bool checkAndActivateInset(BufferView * bv, bool behind);
273 bool checkAndActivateInset(BufferView * bv, int x = 0, int y = 0,
276 void removeNewlines();
278 int cx(BufferView *) const;
280 int cy(BufferView *) const;
282 Paragraph::size_type cpos(BufferView *) const;
284 Paragraph * cpar(BufferView *) const;
286 bool cboundary(BufferView *) const;
288 Row * crow(BufferView *) const;
290 void drawFrame(Painter &, bool cleared) const;
292 void clearFrame(Painter &, bool cleared) const;
294 void clearInset(Painter &, int baseline, bool & cleared) const;
296 /* Private structures and variables */
302 mutable int insetAscent;
304 mutable int insetDescent;
306 mutable int insetWidth;
308 mutable int last_width;
310 mutable int last_height;
314 Paragraph * inset_par;
316 Paragraph::size_type inset_pos;
324 mutable unsigned int old_max_width;
330 UpdatableInset * the_locking_inset;
336 mutable int last_drawn_width;
338 mutable bool frame_is_visible;
340 mutable BufferView * cached_bview;
342 mutable boost::shared_ptr<LyXText> cached_text;