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 bool insetAllowed(Inset::Code) const;
157 UpdatableInset * getLockingInset() const;
159 UpdatableInset * getFirstLockingInsetOfType(Inset::Code);
161 void setFont(BufferView *, LyXFont const &,
162 bool toggleall = false,
163 bool selectall = false);
165 int getMaxWidth(BufferView *, UpdatableInset const *) const;
167 void init(InsetText const * ins = 0, bool same_id = false);
169 void writeParagraphData(Buffer const *, std::ostream &) const;
171 void setParagraphData(Paragraph *);
173 void setText(string const &);
175 void setAutoBreakRows(bool);
177 void setDrawFrame(BufferView *, DrawFrame);
179 void setFrameColor(BufferView *, LColor::color);
181 LyXText * getLyXText(BufferView const *,
182 bool const recursive = false) const;
184 void deleteLyXText(BufferView *, bool recursive = true) const;
186 void resizeLyXText(BufferView *, bool force = false) const;
188 bool showInsetDialog(BufferView *) const;
190 std::vector<string> const getLabelList() const;
194 int scroll(bool recursive=true) const;
196 void scroll(BufferView *bv, float sx) const {
197 UpdatableInset::scroll(bv, sx);
200 void scroll(BufferView *bv, int offset) const {
201 UpdatableInset::scroll(bv, offset);
204 void selectAll(BufferView *bv);
206 void clearSelection(BufferView *bv);
208 Paragraph * getParFromID(int id) const;
210 Inset * getInsetFromID(int id) const;
212 Paragraph * firstParagraph() const;
214 LyXCursor const & cursor(BufferView *) const;
216 Paragraph * paragraph() const;
218 void paragraph(Paragraph *);
220 string selectNextWord(BufferView *, float & value) const;
221 void selectSelectedWord(BufferView *);
222 void toggleSelection(BufferView *, bool kill_selection);
224 mutable int need_update;
228 void updateLocal(BufferView *, int what, bool mark_dirty);
230 mutable int drawTextXOffset;
232 mutable int drawTextYOffset;
236 DrawFrame drawFrame_;
238 LColor::color frame_color;
242 InnerCache(boost::shared_ptr<LyXText>);
244 boost::shared_ptr<LyXText> text;
248 typedef std::map<BufferView *, struct InnerCache > Cache;
250 typedef Cache::value_type value_type;
252 int beginningOfMainBody(Buffer const *, Paragraph * par) const;
254 void showInsetCursor(BufferView *, bool show=true);
256 void hideInsetCursor(BufferView *);
258 UpdatableInset::RESULT moveRight(BufferView *,
259 bool activate_inset = true,
260 bool selecting = false);
262 UpdatableInset::RESULT moveLeft(BufferView *,
263 bool activate_inset = true,
264 bool selecting = false);
266 UpdatableInset::RESULT moveRightIntern(BufferView *, bool behind,
267 bool activate_inset = true,
268 bool selecting = false);
270 UpdatableInset::RESULT moveLeftIntern(BufferView *, bool behind,
271 bool activate_inset = true,
272 bool selecting = false);
275 UpdatableInset::RESULT moveUp(BufferView *);
277 UpdatableInset::RESULT moveDown(BufferView *);
279 void setCharFont(Buffer const *, int pos, LyXFont const & font);
281 string const getText(int);
283 bool checkAndActivateInset(BufferView * bv, bool behind);
285 bool checkAndActivateInset(BufferView * bv, int x = 0, int y = 0,
288 void removeNewlines();
290 int cx(BufferView *) const;
292 int cy(BufferView *) const;
294 Paragraph::size_type cpos(BufferView *) const;
296 Paragraph * cpar(BufferView *) const;
298 bool cboundary(BufferView *) const;
300 Row * crow(BufferView *) const;
302 void drawFrame(Painter &, bool cleared) const;
304 void clearFrame(Painter &, bool cleared) const;
306 void clearInset(Painter &, int baseline, bool & cleared) const;
308 void saveLyXTextState(LyXText *) const;
309 void restoreLyXTextState(BufferView *, LyXText *) const;
311 /* Private structures and variables */
317 mutable int insetAscent;
319 mutable int insetDescent;
321 mutable int insetWidth;
323 mutable int last_width;
325 mutable int last_height;
329 Paragraph * inset_par;
331 Paragraph::size_type inset_pos;
339 mutable unsigned int old_max_width;
345 UpdatableInset * the_locking_inset;
351 mutable int last_drawn_width;
353 mutable bool frame_is_visible;
355 mutable BufferView * cached_bview;
357 mutable boost::shared_ptr<LyXText> cached_text;
359 mutable struct save_state {
361 Paragraph * selstartpar;
362 Paragraph * selendpar;
363 Paragraph::size_type pos;
364 Paragraph::size_type selstartpos;
365 Paragraph::size_type selendpos;
367 bool selstartboundary;
373 // this is needed globally so we know that we're using it actually and
374 // so the LyXText-Cache is not erased until used!
375 mutable LyXText * lt;