2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
7 * Copyright 1995-2001 the LyX Team.
9 * ====================================================== */
21 #include "commandtags.h"
39 /** This is not quite the correct place for this enum. I think
40 the correct would be to let each subclass of Inset declare
41 its own enum code. Actually the notion of an Inset::Code
42 should be avoided, but I am not sure how this could be done
48 TOC_CODE, // do these insets really need a code? (ale)
94 SPECIALCHAR_CODE, // 25
104 MATHMACRO_CODE, // 30
118 TEXT_TO_INSET_OFFSET = 2
134 Inset(Inset const & in, bool same_id = false);
138 virtual int ascent(BufferView *, LyXFont const &) const = 0;
140 virtual int descent(BufferView *, LyXFont const &) const = 0;
142 virtual int width(BufferView *, LyXFont const &) const = 0;
144 virtual void draw(BufferView *, LyXFont const &,
145 int baseline, float & x, bool cleared) const = 0;
146 /// update the inset representation
147 virtual void update(BufferView *, LyXFont const &, bool = false)
150 virtual LyXFont const convertFont(LyXFont const & font) const;
151 /// what appears in the minibuffer when opening
152 virtual string const editMessage() const;
154 virtual void edit(BufferView *, int x, int y, unsigned int button);
156 virtual void edit(BufferView *, bool front = true);
158 virtual EDITABLE editable() const;
159 /// This is called when the user clicks inside an inset
160 virtual void insetButtonPress(BufferView *, int, int, int) {}
161 /// This is called when the user releases the button inside an inset
162 virtual void insetButtonRelease(BufferView *, int, int, int) {}
163 /// This is called when the user moves the mouse inside an inset
164 virtual void insetMotionNotify(BufferView *, int , int , int) {}
166 virtual bool isTextInset() const { return false; }
168 virtual bool doClearArea() const { return true; }
170 virtual bool autoDelete() const;
171 /// returns true the inset can hold an inset of given type
172 virtual bool insetAllowed(Inset::Code) const { return false; }
173 /// wrapper around the above
174 bool insetAllowed(Inset * in) const {
175 return insetAllowed(in->lyxCode());
178 virtual void write(Buffer const *, std::ostream &) const = 0;
180 virtual void read(Buffer const *, LyXLex & lex) = 0;
181 /** returns the number of rows (\n's) of generated tex code.
182 fragile == true means, that the inset should take care about
183 fragile commands by adding a \protect before.
184 If the free_spc (freespacing) variable is set, then this inset
185 is in a free-spacing paragraph.
187 virtual int latex(Buffer const *, std::ostream &, bool fragile,
188 bool free_spc) const = 0;
190 virtual int ascii(Buffer const *,
191 std::ostream &, int linelen = 0) const = 0;
193 virtual int linuxdoc(Buffer const *, std::ostream &) const = 0;
195 virtual int docBook(Buffer const *, std::ostream &) const = 0;
196 /// Updates needed features for this inset.
197 virtual void validate(LaTeXFeatures & features) const;
199 virtual bool deletable() const;
201 /// returns LyX code associated with the inset. Used for TOC, ...)
202 virtual Inset::Code lyxCode() const { return NO_CODE; }
204 virtual std::vector<string> const getLabelList() const {
205 return std::vector<string>();
209 virtual Inset * clone(Buffer const &, bool same_ids = false) const = 0;
211 /// returns true to override begin and end inset in file
212 virtual bool directWrite() const;
214 /// Returns true if the inset should be centered alone
215 virtual bool display() const { return false; }
216 /// Changes the display state of the inset
217 virtual void display(bool) {}
219 /// returns true if this inset needs a row on it's own
221 virtual bool needFullRow() const { return false; }
223 void setInsetName(string const & s) { name = s; }
225 string const getInsetName() const { return name; }
227 void setOwner(Inset * inset) { owner_ = inset; }
229 Inset * owner() const { return owner_; }
231 void setBackgroundColor(LColor::color);
233 LColor::color backgroundColor() const;
235 int x() const { return top_x; }
237 int y() const { return top_baseline; }
239 // because we could have fake text insets and have to call this
240 // inside them without cast!!!
242 virtual LyXText * getLyXText(BufferView const *,
243 bool const recursive = false) const;
245 virtual void deleteLyXText(BufferView *, bool = true) const {}
247 virtual void resizeLyXText(BufferView *, bool /*force*/= false) const {}
248 /// returns the actuall scroll-value
249 virtual int scroll(bool recursive=true) const {
250 if (!recursive || !owner_)
254 /// try to get a paragraph pointer from it's id if we have a
255 /// paragraph to give back!
256 virtual Paragraph * getParFromID(int /* id */) const {
259 /// try to get a inset pointer from it's id if we have
260 /// an inset to give back!
261 virtual Inset * getInsetFromID(int /* id */) const {
264 /// if this insets owns paragraphs (f.ex. InsetText) then it
265 /// should return it's very first one!
266 virtual Paragraph * firstParagraph() const {
269 /// return the cursor if we own one otherwise giv'em just the
270 /// BufferView cursor to work with.
271 virtual LyXCursor const & cursor(BufferView * bview) const;
276 /// used to toggle insets
277 // is the inset open?
278 virtual bool isOpen() const { return false; }
279 // open or close the inset, depending on the bool
280 virtual void open(BufferView *, bool) {}
285 mutable int top_baseline;
291 static unsigned int inset_id;
299 LColor::color background_color_;
303 // Updatable Insets. These insets can be locked and receive
304 // directly user interaction. Currently used only for mathed.
305 // Note that all pure methods from Inset class are pure here too.
306 // [Alejandro 080596]
308 /** Extracted from Matthias notes:
310 * An inset can simple call LockInset in it's edit call and *ONLY*
313 * Unlocking is either done by LyX or the inset itself with a
316 * During the lock, all button and keyboard events will be modified
317 * and send to the inset through the following inset-features. Note that
318 * Inset::insetUnlock will be called from inside UnlockInset. It is meant
319 * to contain the code for restoring the menus and things like this.
321 * If a inset wishes any redraw and/or update it just has to call
324 * It's is completly irrelevant, where the inset is. UpdateInset will
325 * find it in any paragraph in any buffer.
326 * Of course the_locking_inset and the insets in the current paragraph/buffer
327 * are checked first, so no performance problem should occur.
329 class UpdatableInset : public Inset {
331 /** Dispatch result codes
332 Now that nested updatable insets are allowed, the local dispatch
333 becomes a bit complex, just two possible results (boolean)
336 DISPATCHED = the inset catched the action
337 DISPATCHED_NOUPDATE = the inset catched the action and no update
338 is needed here to redraw the inset
339 FINISHED = the inset must be unlocked as a result
341 UNDISPATCHED = the action was not catched, it should be
342 dispatched by lower level insets
351 /// To convert old binary dispatch results
352 RESULT DISPATCH_RESULT(bool b) {
353 return b ? DISPATCHED : FINISHED;
359 UpdatableInset(UpdatableInset const & in, bool same_id = false);
362 virtual EDITABLE editable() const;
364 /// may call ToggleLockedInsetCursor
365 virtual void toggleInsetCursor(BufferView *);
367 virtual void showInsetCursor(BufferView *, bool show = true);
369 virtual void hideInsetCursor(BufferView *);
371 virtual void fitInsetCursor(BufferView *) const;
373 virtual void getCursorPos(BufferView *, int &, int &) const {}
375 virtual void insetButtonPress(BufferView *, int x, int y, int button);
377 virtual void insetButtonRelease(BufferView *,
378 int x, int y, int button);
380 virtual void insetKeyPress(XKeyEvent * ev);
382 virtual void insetMotionNotify(BufferView *, int x, int y, int state);
384 virtual void insetUnlock(BufferView *);
386 virtual void edit(BufferView *, int x, int y, unsigned int button);
388 virtual void edit(BufferView *, bool front = true);
390 virtual void draw(BufferView *, LyXFont const &,
391 int baseline, float & x, bool cleared) const;
393 virtual void setFont(BufferView *, LyXFont const &,
394 bool toggleall = false, bool selectall = false);
396 virtual bool insertInset(BufferView *, Inset *) { return false; }
398 virtual UpdatableInset * getLockingInset() const {
399 return const_cast<UpdatableInset *>(this);
402 virtual UpdatableInset * getFirstLockingInsetOfType(Inset::Code c)
403 { return (c == lyxCode()) ? this : 0; }
405 virtual unsigned int insetInInsetY() { return 0; }
407 virtual bool updateInsetInInset(BufferView *, Inset *)
410 virtual bool lockInsetInInset(BufferView *, UpdatableInset *)
413 virtual bool unlockInsetInInset(BufferView *, UpdatableInset *,
416 /// An updatable inset could handle lyx editing commands
417 virtual RESULT localDispatch(BufferView *, kb_action, string const &);
419 bool isCursorVisible() const { return cursor_visible_; }
421 virtual int getMaxWidth(BufferView * bv, UpdatableInset const *) const;
423 int scroll(bool recursive = true) const {
424 // We need this method to not clobber the real method in Inset
425 return Inset::scroll(recursive);
428 virtual bool showInsetDialog(BufferView *) const { return false; }
430 virtual void nodraw(bool b) {
434 virtual bool nodraw() const {
435 return block_drawing_;
438 // needed for spellchecking text
440 virtual string selectNextWord(BufferView *, float & value) const;
441 virtual void selectSelectedWord(BufferView *) { return; }
442 virtual void toggleSelection(BufferView *, bool /*kill_selection*/) {
446 // needed for search/replace functionality
448 virtual bool searchForward(BufferView *, string const &,
449 bool const & = true, bool const & = false);
450 virtual bool searchBackward(BufferView *, string const &,
451 bool const & = true, bool const & = false);
455 void toggleCursorVisible() const {
456 cursor_visible_ = !cursor_visible_;
459 void setCursorVisible(bool b) const {
462 /// scrolls to absolute position in bufferview-workwidth * sx units
463 void scroll(BufferView *, float sx) const;
464 /// scrolls offset pixels
465 void scroll(BufferView *, int offset) const;
469 mutable bool cursor_visible_;