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
24 #include "lyxcursor.h"
36 A text inset is like a TeX box to write full text
37 (including styles and other insets) in a given space.
40 class InsetText : public UpdatableInset {
43 /// numbers need because of test if codeA < codeB
76 InsetText(InsetText const &);
80 Inset * Clone(Buffer const &) const;
82 InsetText & operator=(InsetText const & it);
86 void Read(Buffer const *, LyXLex &);
88 void Write(Buffer const *, std::ostream &) const;
90 int ascent(BufferView *, LyXFont const &) const;
92 int descent(BufferView *, LyXFont const &) const;
94 int width(BufferView *, LyXFont const & f) const;
96 int textWidth(BufferView *) const;
98 void draw(BufferView *, LyXFont const &, int , float &, bool) const;
100 void update(BufferView *, LyXFont const &, bool =false);
102 void SetUpdateStatus(BufferView *, int what) const;
104 string const EditMessage() const;
106 void Edit(BufferView *, int, int, unsigned int);
108 bool IsTextInset() const { return true; }
110 bool doClearArea() const;
112 void InsetUnlock(BufferView *);
114 bool LockInsetInInset(BufferView *, UpdatableInset *);
116 bool UnlockInsetInInset(BufferView *, UpdatableInset *, bool lr = false);
118 bool UpdateInsetInInset(BufferView *, Inset *);
120 void InsetButtonRelease(BufferView *, int, int, int);
122 void InsetButtonPress(BufferView *, int, int, int);
124 void InsetMotionNotify(BufferView *, int, int, int);
126 void InsetKeyPress(XKeyEvent *);
128 UpdatableInset::RESULT LocalDispatch(BufferView *, kb_action, string const &);
130 int Latex(Buffer const *, std::ostream &,
131 bool fragile, bool free_spc) const;
133 int Ascii(Buffer const *, std::ostream &, int linelen) const;
135 int Linuxdoc(Buffer const *, std::ostream &) const { return 0; }
137 int DocBook(Buffer const *, std::ostream &) const ;
139 void Validate(LaTeXFeatures & features) const;
141 Inset::Code LyxCode() const { return Inset::TEXT_CODE; }
143 void GetCursorPos(BufferView *, int & x, int & y) const;
145 unsigned int InsetInInsetY();
147 void ToggleInsetCursor(BufferView *);
149 bool InsertInset(BufferView *, Inset *);
151 UpdatableInset * GetLockingInset();
153 UpdatableInset * GetFirstLockingInsetOfType(Inset::Code);
155 void SetFont(BufferView *, LyXFont const &, bool toggleall = false,
156 bool selectall = false);
158 int getMaxWidth(BufferView *, UpdatableInset const *) const;
160 void init(InsetText const * ins = 0);
162 void WriteParagraphData(Buffer const *, std::ostream &) const;
164 void SetParagraphData(Paragraph *);
166 void SetText(string const &);
168 void SetAutoBreakRows(bool);
170 void SetDrawFrame(BufferView *, DrawFrame);
172 void SetFrameColor(BufferView *, LColor::color);
174 LyXText * getLyXText(BufferView const *,
175 bool const recursive = false) const;
177 void deleteLyXText(BufferView *, bool recursive = true) const;
179 void resizeLyXText(BufferView *, bool force = false) const;
181 bool ShowInsetDialog(BufferView *) const;
183 std::vector<string> const getLabelList() const;
187 int scroll(bool recursive=true) const;
189 void scroll(BufferView *bv, float sx) const {
190 UpdatableInset::scroll(bv, sx);
193 void scroll(BufferView *bv, int offset) const {
194 UpdatableInset::scroll(bv, offset);
197 void selectAll(BufferView *bv);
199 void clearSelection(BufferView *bv);
203 mutable int need_update;
207 void UpdateLocal(BufferView *, int what, bool mark_dirty);
209 mutable int drawTextXOffset;
211 mutable int drawTextYOffset;
215 DrawFrame drawFrame_;
217 LColor::color frame_color;
221 typedef std::map<BufferView *, LyXText *> Cache;
223 typedef Cache::value_type value_type;
225 int BeginningOfMainBody(Buffer const *, Paragraph * par) const;
227 void ShowInsetCursor(BufferView *, bool show=true);
229 void HideInsetCursor(BufferView *);
231 UpdatableInset::RESULT moveRight(BufferView *, bool activate_inset = true,
232 bool selecting = false);
234 UpdatableInset::RESULT moveLeft(BufferView *, bool activate_inset = true,
235 bool selecting = false);
237 UpdatableInset::RESULT moveRightIntern(BufferView *, bool behind,
238 bool activate_inset = true,
239 bool selecting = false);
241 UpdatableInset::RESULT moveLeftIntern(BufferView *, bool behind,
242 bool activate_inset = true,
243 bool selecting = false);
246 UpdatableInset::RESULT moveUp(BufferView *);
248 UpdatableInset::RESULT moveDown(BufferView *);
250 void SetCharFont(Buffer const *, int pos, LyXFont const & font);
252 string const getText(int);
254 bool checkAndActivateInset(BufferView * bv, bool behind);
256 bool checkAndActivateInset(BufferView * bv, int x = 0, int y = 0,
259 void removeNewlines();
261 int cx(BufferView *) const;
263 int cy(BufferView *) const;
265 Paragraph::size_type cpos(BufferView *) const;
267 Paragraph * cpar(BufferView *) const;
269 bool cboundary(BufferView *) const;
271 Row * crow(BufferView *) const;
273 /// This instead of a macro
274 LyXText * TEXT(BufferView * bv) const {
275 return getLyXText(bv);
278 void drawFrame(Painter &, bool cleared) const;
279 void clearFrame(Painter &, bool cleared) const;
281 void clearInset(Painter &, int baseline, bool & cleared) const;
283 /* Private structures and variables */
287 mutable int insetAscent;
289 mutable int insetDescent;
291 mutable int insetWidth;
293 mutable int last_width;
295 mutable int last_height;
299 Paragraph * inset_par;
301 Paragraph::size_type inset_pos;
309 mutable unsigned int old_max_width;
315 UpdatableInset * the_locking_inset;
321 mutable int last_drawn_width;
323 mutable bool frame_is_visible;