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
106 MATHMACRO_CODE, // 30
120 TEXT_TO_INSET_OFFSET = 2
136 Inset(Inset const & in, bool same_id = false);
140 virtual int ascent(BufferView *, LyXFont const &) const = 0;
142 virtual int descent(BufferView *, LyXFont const &) const = 0;
144 virtual int width(BufferView *, LyXFont const &) const = 0;
146 virtual void draw(BufferView *, LyXFont const &,
147 int baseline, float & x, bool cleared) const = 0;
148 /// update the inset representation
149 virtual void update(BufferView *, LyXFont const &, bool = false)
152 virtual LyXFont const convertFont(LyXFont const & font) const;
153 /// what appears in the minibuffer when opening
154 virtual string const editMessage() const;
156 virtual void edit(BufferView *, int x, int y, unsigned int button);
158 virtual void edit(BufferView *, bool front = true);
160 virtual EDITABLE editable() const;
161 /// This is called when the user clicks inside an inset
162 virtual void insetButtonPress(BufferView *, int, int, int) {}
163 /// This is called when the user releases the button inside an inset
164 virtual void insetButtonRelease(BufferView *, int, int, int) {}
165 /// This is called when the user moves the mouse inside an inset
166 virtual void insetMotionNotify(BufferView *, int , int , int) {}
168 virtual bool isTextInset() const { return false; }
170 virtual bool doClearArea() const { return true; }
172 virtual bool autoDelete() const;
173 /// returns true the inset can hold an inset of given type
174 virtual bool insetAllowed(Inset::Code) const { return false; }
175 /// wrapper around the above
176 bool insetAllowed(Inset * in) const {
177 return insetAllowed(in->lyxCode());
180 virtual void write(Buffer const *, std::ostream &) const = 0;
182 virtual void read(Buffer const *, LyXLex & lex) = 0;
183 /** returns the number of rows (\n's) of generated tex code.
184 fragile == true means, that the inset should take care about
185 fragile commands by adding a \protect before.
186 If the free_spc (freespacing) variable is set, then this inset
187 is in a free-spacing paragraph.
189 virtual int latex(Buffer const *, std::ostream &, bool fragile,
190 bool free_spc) const = 0;
192 virtual int ascii(Buffer const *,
193 std::ostream &, int linelen = 0) const = 0;
195 virtual int linuxdoc(Buffer const *, std::ostream &) const = 0;
197 virtual int docBook(Buffer const *, std::ostream &) const = 0;
198 /// Updates needed features for this inset.
199 virtual void validate(LaTeXFeatures & features) const;
201 virtual bool deletable() const;
203 /// returns LyX code associated with the inset. Used for TOC, ...)
204 virtual Inset::Code lyxCode() const { return NO_CODE; }
206 virtual std::vector<string> const getLabelList() const {
207 return std::vector<string>();
211 virtual Inset * clone(Buffer const &, bool same_ids = false) const = 0;
213 /// returns true to override begin and end inset in file
214 virtual bool directWrite() const;
216 /// Returns true if the inset should be centered alone
217 virtual bool display() const { return false; }
218 /// Changes the display state of the inset
219 virtual void display(bool) {}
221 /// returns true if this inset needs a row on it's own
223 virtual bool needFullRow() const { return false; }
225 void setInsetName(string const & s) { name_ = s; }
227 string const & getInsetName() const { return name_; }
229 void setOwner(Inset * inset) { owner_ = inset; }
231 Inset * owner() const { return owner_; }
233 void setBackgroundColor(LColor::color);
235 LColor::color backgroundColor() const;
237 int x() const { return top_x; }
239 int y() const { return top_baseline; }
241 // because we could have fake text insets and have to call this
242 // inside them without cast!!!
244 virtual LyXText * getLyXText(BufferView const *,
245 bool const recursive = false) const;
247 virtual void deleteLyXText(BufferView *, bool = true) const {}
249 virtual void resizeLyXText(BufferView *, bool /*force*/= false) const {}
250 /// returns the actuall scroll-value
251 virtual int scroll(bool recursive=true) const {
252 if (!recursive || !owner_)
256 /// try to get a paragraph pointer from it's id if we have a
257 /// paragraph to give back!
258 virtual Paragraph * getParFromID(int /* id */) const {
261 /// try to get a inset pointer from it's id if we have
262 /// an inset to give back!
263 virtual Inset * getInsetFromID(int /* id */) const {
266 /// if this insets owns paragraphs (f.ex. InsetText) then it
267 /// should return it's very first one!
268 virtual Paragraph * firstParagraph() const {
271 /// return the cursor if we own one otherwise giv'em just the
272 /// BufferView cursor to work with.
273 virtual LyXCursor const & cursor(BufferView * bview) const;
278 /// used to toggle insets
279 // is the inset open?
280 virtual bool isOpen() const { return false; }
282 /// open or close the inset, depending on the bool
283 virtual void open(BufferView *, bool) {}
286 virtual void open(BufferView *) {}
289 virtual void close(BufferView *) {}
295 mutable int top_baseline;
301 static unsigned int inset_id;
309 LColor::color background_color_;
313 // Updatable Insets. These insets can be locked and receive
314 // directly user interaction. Currently used only for mathed.
315 // Note that all pure methods from Inset class are pure here too.
316 // [Alejandro 080596]
318 /** Extracted from Matthias notes:
320 * An inset can simple call LockInset in it's edit call and *ONLY*
323 * Unlocking is either done by LyX or the inset itself with a
326 * During the lock, all button and keyboard events will be modified
327 * and send to the inset through the following inset-features. Note that
328 * Inset::insetUnlock will be called from inside UnlockInset. It is meant
329 * to contain the code for restoring the menus and things like this.
331 * If a inset wishes any redraw and/or update it just has to call
334 * It's is completly irrelevant, where the inset is. UpdateInset will
335 * find it in any paragraph in any buffer.
336 * Of course the_locking_inset and the insets in the current paragraph/buffer
337 * are checked first, so no performance problem should occur.
339 class UpdatableInset : public Inset {
341 /** Dispatch result codes
342 Now that nested updatable insets are allowed, the local dispatch
343 becomes a bit complex, just two possible results (boolean)
346 DISPATCHED = the inset catched the action
347 DISPATCHED_NOUPDATE = the inset catched the action and no update
348 is needed here to redraw the inset
349 FINISHED = the inset must be unlocked as a result
351 UNDISPATCHED = the action was not catched, it should be
352 dispatched by lower level insets
361 /// To convert old binary dispatch results
362 RESULT DISPATCH_RESULT(bool b) {
363 return b ? DISPATCHED : FINISHED;
369 UpdatableInset(UpdatableInset const & in, bool same_id = false);
372 virtual EDITABLE editable() const;
374 /// may call ToggleLockedInsetCursor
375 virtual void toggleInsetCursor(BufferView *);
377 virtual void showInsetCursor(BufferView *, bool show = true);
379 virtual void hideInsetCursor(BufferView *);
381 virtual void fitInsetCursor(BufferView *) const;
383 virtual void getCursorPos(BufferView *, int &, int &) const {}
385 virtual void insetButtonPress(BufferView *, int x, int y, int button);
387 virtual void insetButtonRelease(BufferView *,
388 int x, int y, int button);
390 virtual void insetKeyPress(XKeyEvent * ev);
392 virtual void insetMotionNotify(BufferView *, int x, int y, int state);
394 virtual void insetUnlock(BufferView *);
396 virtual void edit(BufferView *, int x, int y, unsigned int button);
398 virtual void edit(BufferView *, bool front = true);
400 virtual void draw(BufferView *, LyXFont const &,
401 int baseline, float & x, bool cleared) const;
403 virtual void setFont(BufferView *, LyXFont const &,
404 bool toggleall = false, bool selectall = false);
406 virtual bool insertInset(BufferView *, Inset *) { return false; }
408 virtual UpdatableInset * getLockingInset() const {
409 return const_cast<UpdatableInset *>(this);
412 virtual UpdatableInset * getFirstLockingInsetOfType(Inset::Code c)
413 { return (c == lyxCode()) ? this : 0; }
415 virtual unsigned int insetInInsetY() { return 0; }
417 virtual bool updateInsetInInset(BufferView *, Inset *)
420 virtual bool lockInsetInInset(BufferView *, UpdatableInset *)
423 virtual bool unlockInsetInInset(BufferView *, UpdatableInset *,
426 /// An updatable inset could handle lyx editing commands
427 virtual RESULT localDispatch(BufferView *, kb_action, string const &);
429 bool isCursorVisible() const { return cursor_visible_; }
431 virtual int getMaxWidth(BufferView * bv, UpdatableInset const *) const;
433 int scroll(bool recursive = true) const {
434 // We need this method to not clobber the real method in Inset
435 return Inset::scroll(recursive);
438 virtual bool showInsetDialog(BufferView *) const { return false; }
440 virtual void nodraw(bool b) {
444 virtual bool nodraw() const {
445 return block_drawing_;
448 // needed for spellchecking text
450 virtual string const selectNextWord(BufferView *, float & value) const;
451 virtual void selectSelectedWord(BufferView *) { return; }
452 virtual void toggleSelection(BufferView *, bool /*kill_selection*/) {
456 // needed for search/replace functionality
458 virtual bool searchForward(BufferView *, string const &,
459 bool const & = true, bool const & = false);
460 virtual bool searchBackward(BufferView *, string const &,
461 bool const & = true, bool const & = false);
465 void toggleCursorVisible() const {
466 cursor_visible_ = !cursor_visible_;
469 void setCursorVisible(bool b) const {
472 /// scrolls to absolute position in bufferview-workwidth * sx units
473 void scroll(BufferView *, float sx) const;
474 /// scrolls offset pixels
475 void scroll(BufferView *, int offset) const;
479 mutable bool cursor_visible_;