2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
7 * Copyright 1995-2000 the LyX Team.
9 * ====================================================== */
37 /** This is not quite the correct place for this enum. I think
38 the correct would be to let each subclass of Inset declare
39 its own enum code. Actually the notion of an Inset::Code
40 should be avoided, but I am not sure how this could be done
46 TOC_CODE, // do these insets really need a code? (ale)
112 TEXT_TO_INSET_OFFSET = 2
126 Inset() { owner_ = 0; top_x = top_baseline = 0; scx = 0; }
130 virtual int ascent(BufferView *, LyXFont const &) const = 0;
132 virtual int descent(BufferView *, LyXFont const &) const = 0;
134 virtual int width(BufferView *, LyXFont const &) const = 0;
136 virtual void draw(BufferView *, LyXFont const &,
137 int baseline, float & x, bool cleared) const = 0;
138 /// update the inset representation
139 virtual void update(BufferView *, LyXFont const &, bool = false)
142 virtual LyXFont const ConvertFont(LyXFont const & font) const;
143 /// what appears in the minibuffer when opening
144 virtual string const EditMessage() const;
146 virtual void Edit(BufferView *, int x, int y, unsigned int button);
148 virtual EDITABLE Editable() const;
149 /// This is called when the user clicks inside an inset
150 virtual void InsetButtonPress(BufferView *, int, int, int) {}
151 /// This is called when the user releases the button inside an inset
152 virtual void InsetButtonRelease(BufferView *, int, int, int) {}
153 /// This is caleld when the user moves the mouse inside an inset
154 virtual void InsetMotionNotify(BufferView *, int , int , int) {}
156 virtual bool IsTextInset() const { return false; }
158 virtual bool doClearArea() const { return true; }
160 virtual bool AutoDelete() const;
162 virtual void Write(Buffer const *, std::ostream &) const = 0;
164 virtual void Read(Buffer const *, LyXLex & lex) = 0;
165 /** returns the number of rows (\n's) of generated tex code.
166 fragile == true means, that the inset should take care about
167 fragile commands by adding a \protect before.
168 If the free_spc (freespacing) variable is set, then this inset
169 is in a free-spacing paragraph.
171 virtual int Latex(Buffer const *, std::ostream &, bool fragile,
172 bool free_spc) const = 0;
174 virtual int Ascii(Buffer const *, std::ostream &) const = 0;
176 virtual int Linuxdoc(Buffer const *, std::ostream &) const = 0;
178 virtual int DocBook(Buffer const *, std::ostream &) const = 0;
179 /// Updates needed features for this inset.
180 virtual void Validate(LaTeXFeatures & features) const;
182 virtual bool Deletable() const;
184 /// returns LyX code associated with the inset. Used for TOC, ...)
185 virtual Inset::Code LyxCode() const { return NO_CODE; }
187 virtual std::vector<string> const getLabelList() const {
188 return std::vector<string>();
192 virtual Inset * Clone() const = 0;
194 /// returns true to override begin and end inset in file
195 virtual bool DirectWrite() const;
197 /// Returns true if the inset should be centered alone
198 virtual bool display() const { return false; }
199 /// Changes the display state of the inset
200 virtual void display(bool) {}
202 /// returns true if this inset needs a row on it's own
204 virtual bool needFullRow() const { return false; }
206 virtual bool InsertInsetAllowed(Inset *) const { return false; }
208 void setInsetName(string const & s) { name = s; }
210 string const getInsetName() const { return name; }
212 void setOwner(Inset * inset) { owner_ = inset; }
214 Inset * owner() const { return owner_; }
216 int x() const { return top_x; }
218 int y() const { return top_baseline; }
220 // because we could have fake text insets and have to call this
221 // inside them without cast!!!
223 virtual LyXText * getLyXText(BufferView *) const;
225 virtual void deleteLyXText(BufferView *, bool = true) const {}
227 virtual void resizeLyXText(BufferView *) const {}
228 /// returns the actuall scroll-value
229 int scroll() const { return scx; }
234 mutable int top_baseline;
245 // Updatable Insets. These insets can be locked and receive
246 // directly user interaction. Currently used only for mathed.
247 // Note that all pure methods from Inset class are pure here too.
248 // [Alejandro 080596]
250 /** Extracted from Matthias notes:
252 * An inset can simple call LockInset in it's edit call and *ONLY*
255 * Unlocking is either done by LyX or the inset itself with a
258 * During the lock, all button and keyboard events will be modified
259 * and send to the inset through the following inset-features. Note that
260 * Inset::InsetUnlock will be called from inside UnlockInset. It is meant
261 * to contain the code for restoring the menus and things like this.
263 * If a inset wishes any redraw and/or update it just has to call
266 * It's is completly irrelevant, where the inset is. UpdateInset will
267 * find it in any paragraph in any buffer.
268 * Of course the_locking_inset and the insets in the current paragraph/buffer
269 * are checked first, so no performance problem should occur.
271 class UpdatableInset: public Inset {
273 /** Dispatch result codes
274 Now that nested updatable insets are allowed, the local dispatch
275 becomes a bit complex, just two possible results (boolean)
278 DISPATCHED = the inset catched the action
279 DISPATCHED_NOUPDATE = the inset catched the action and no update
280 is needed here to redraw the inset
281 FINISHED = the inset must be unlocked as a result
283 UNDISPATCHED = the action was not catched, it should be
284 dispatched by lower level insets
293 /// To convert old binary dispatch results
294 RESULT DISPATCH_RESULT(bool b) {
295 return b ? DISPATCHED : FINISHED;
301 virtual EDITABLE Editable() const;
303 /// may call ToggleLockedInsetCursor
304 virtual void ToggleInsetCursor(BufferView *);
306 virtual void ShowInsetCursor(BufferView *);
308 virtual void HideInsetCursor(BufferView *);
310 virtual void GetCursorPos(BufferView *, int &, int &) const {}
312 virtual void InsetButtonPress(BufferView *, int x, int y, int button);
314 virtual void InsetButtonRelease(BufferView *,
315 int x, int y, int button);
317 virtual void InsetKeyPress(XKeyEvent * ev);
319 virtual void InsetMotionNotify(BufferView *, int x, int y, int state);
321 virtual void InsetUnlock(BufferView *);
323 virtual void Edit(BufferView *, int x, int y, unsigned int button);
325 virtual void draw(BufferView *, LyXFont const &,
326 int baseline, float & x, bool cleared) const;
328 virtual void SetFont(BufferView *, LyXFont const &,
329 bool toggleall = false);
331 virtual bool InsertInset(BufferView *, Inset *) { return false; }
333 virtual bool InsertInsetAllowed(Inset *) const { return true; }
335 virtual UpdatableInset * GetLockingInset() { return this; }
337 virtual UpdatableInset * GetFirstLockingInsetOfType(Inset::Code c)
338 { return (c == LyxCode()) ? this : 0; }
340 virtual int InsetInInsetY() { return 0; }
342 virtual bool UpdateInsetInInset(BufferView *, Inset *)
345 virtual bool LockInsetInInset(BufferView *, UpdatableInset *)
348 virtual bool UnlockInsetInInset(BufferView *, UpdatableInset *,
351 /// An updatable inset could handle lyx editing commands
352 virtual RESULT LocalDispatch(BufferView *, int, string const &);
354 virtual bool isCursorVisible() const { return cursor_visible; }
356 virtual int getMaxWidth(Painter & pain, UpdatableInset const *) const;
358 int scroll() const { return scx; }
362 mutable bool cursor_visible;
364 // scrolls to absolute position in bufferview-workwidth * sx units
365 void scroll(BufferView *, float sx) const;
366 // scrolls offset pixels
367 void scroll(BufferView *, int offset) const;