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);
157 int getMaxWidth(BufferView *, UpdatableInset const *) const;
159 void init(InsetText const * ins = 0);
161 void WriteParagraphData(Buffer const *, std::ostream &) const;
163 void SetParagraphData(LyXParagraph *);
165 void SetText(string const &);
167 void SetAutoBreakRows(bool);
169 void SetDrawFrame(BufferView *, DrawFrame);
171 void SetFrameColor(BufferView *, LColor::color);
173 LyXText * getLyXText(BufferView const *, bool const recursive=false) const;
175 void deleteLyXText(BufferView *, bool recursive=true) const;
177 void resizeLyXText(BufferView *) const;
179 bool ShowInsetDialog(BufferView *) const;
181 std::vector<string> const getLabelList() const;
185 int scroll(bool recursive=true) const;
186 void scroll(BufferView *bv, float sx) const {
187 UpdatableInset::scroll(bv, sx);
189 void scroll(BufferView *bv, int offset) const {
190 UpdatableInset::scroll(bv, offset);
195 mutable int need_update;
199 void UpdateLocal(BufferView *, int what, bool mark_dirty);
201 mutable int drawTextXOffset;
203 mutable int drawTextYOffset;
207 DrawFrame drawFrame_;
209 LColor::color frame_color;
213 typedef std::map<BufferView *, LyXText *> Cache;
215 typedef Cache::value_type value_type;
217 int BeginningOfMainBody(Buffer const *, LyXParagraph * par) const;
219 void ShowInsetCursor(BufferView *, bool show=true);
221 void HideInsetCursor(BufferView *);
223 UpdatableInset::RESULT moveRight(BufferView *, bool activate_inset = true,
224 bool selecting = false);
226 UpdatableInset::RESULT moveLeft(BufferView *, bool activate_inset = true,
227 bool selecting = false);
229 UpdatableInset::RESULT moveRightIntern(BufferView *, bool behind,
230 bool activate_inset = true,
231 bool selecting = false);
233 UpdatableInset::RESULT moveLeftIntern(BufferView *, bool behind,
234 bool activate_inset = true,
235 bool selecting = false);
238 UpdatableInset::RESULT moveUp(BufferView *);
240 UpdatableInset::RESULT moveDown(BufferView *);
242 void SetCharFont(Buffer const *, int pos, LyXFont const & font);
244 string const getText(int);
246 bool checkAndActivateInset(BufferView * bv, bool behind);
248 bool checkAndActivateInset(BufferView * bv, int x = 0, int y = 0,
251 void removeNewlines();
253 int cx(BufferView *) const;
255 int cy(BufferView *) const;
257 LyXParagraph::size_type cpos(BufferView *) const;
259 LyXParagraph * cpar(BufferView *) const;
261 bool cboundary(BufferView *) const;
263 Row * crow(BufferView *) const;
265 /// This instead of a macro
266 LyXText * TEXT(BufferView * bv) const {
267 return getLyXText(bv);
270 void drawFrame(Painter &, bool cleared) const;
271 void clearFrame(Painter &, bool cleared) const;
274 /* Private structures and variables */
278 mutable int insetAscent;
280 mutable int insetDescent;
282 mutable int insetWidth;
284 mutable int last_width;
286 mutable int last_height;
290 LyXParagraph * inset_par;
292 LyXParagraph::size_type inset_pos;
306 UpdatableInset * the_locking_inset;
308 LyXParagraph * old_par;
312 mutable int last_drawn_width;
314 mutable bool frame_is_visible;