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
132 Inset() : top_x(0), top_baseline(0), scx(0), id_(inset_id++), owner_(0), background_color_(LColor::inherit) {}
133 /// Virtual base destructor
136 virtual int ascent(BufferView *, LyXFont const &) const = 0;
138 virtual int descent(BufferView *, LyXFont const &) const = 0;
140 virtual int width(BufferView *, LyXFont const &) const = 0;
142 virtual void draw(BufferView *, LyXFont const &,
143 int baseline, float & x, bool cleared) const = 0;
144 /// update the inset representation
145 virtual void update(BufferView *, LyXFont const &, bool = false)
148 virtual LyXFont const convertFont(LyXFont const & font) const;
149 /// what appears in the minibuffer when opening
150 virtual string const editMessage() const;
152 virtual void edit(BufferView *, int x, int y, unsigned int button);
154 virtual void edit(BufferView *, bool front = true);
156 virtual EDITABLE editable() const;
157 /// This is called when the user clicks inside an inset
158 virtual void insetButtonPress(BufferView *, int, int, int) {}
159 /// This is called when the user releases the button inside an inset
160 virtual void insetButtonRelease(BufferView *, int, int, int) {}
161 /// This is called when the user moves the mouse inside an inset
162 virtual void insetMotionNotify(BufferView *, int , int , int) {}
164 virtual bool isTextInset() const { return false; }
166 virtual bool doClearArea() const { return true; }
168 virtual bool autoDelete() const;
169 /// returns true the inset can hold an inset of given type
170 virtual bool insetAllowed(Inset::Code) const { return false; }
171 /// wrapper around the above
172 bool insetAllowed(Inset * in) const {
173 return insetAllowed(in->lyxCode());
176 virtual void write(Buffer const *, std::ostream &) const = 0;
178 virtual void read(Buffer const *, LyXLex & lex) = 0;
179 /** returns the number of rows (\n's) of generated tex code.
180 fragile == true means, that the inset should take care about
181 fragile commands by adding a \protect before.
182 If the free_spc (freespacing) variable is set, then this inset
183 is in a free-spacing paragraph.
185 virtual int latex(Buffer const *, std::ostream &, bool fragile,
186 bool free_spc) const = 0;
188 virtual int ascii(Buffer const *,
189 std::ostream &, int linelen = 0) const = 0;
191 virtual int linuxdoc(Buffer const *, std::ostream &) const = 0;
193 virtual int docBook(Buffer const *, std::ostream &) const = 0;
194 /// Updates needed features for this inset.
195 virtual void validate(LaTeXFeatures & features) const;
197 virtual bool deletable() const;
199 /// returns LyX code associated with the inset. Used for TOC, ...)
200 virtual Inset::Code lyxCode() const { return NO_CODE; }
202 virtual std::vector<string> const getLabelList() const {
203 return std::vector<string>();
207 virtual Inset * clone(Buffer const &, bool same_ids = false) const = 0;
209 /// returns true to override begin and end inset in file
210 virtual bool directWrite() const;
212 /// Returns true if the inset should be centered alone
213 virtual bool display() const { return false; }
214 /// Changes the display state of the inset
215 virtual void display(bool) {}
217 /// returns true if this inset needs a row on it's own
219 virtual bool needFullRow() const { return false; }
221 void setInsetName(string const & s) { name = s; }
223 string const getInsetName() const { return name; }
225 void setOwner(Inset * inset) { owner_ = inset; }
227 Inset * owner() const { return owner_; }
229 void setBackgroundColor(LColor::color);
231 LColor::color backgroundColor() const;
233 int x() const { return top_x; }
235 int y() const { return top_baseline; }
237 // because we could have fake text insets and have to call this
238 // inside them without cast!!!
240 virtual LyXText * getLyXText(BufferView const *,
241 bool const recursive = false) const;
243 virtual void deleteLyXText(BufferView *, bool = true) const {}
245 virtual void resizeLyXText(BufferView *, bool /*force*/= false) const {}
246 /// returns the actuall scroll-value
247 virtual int scroll(bool recursive=true) const {
248 if (!recursive || !owner_)
252 /// try to get a paragraph pointer from it's id if we have a
253 /// paragraph to give back!
254 virtual Paragraph * getParFromID(int /* id */) const {
257 /// try to get a inset pointer from it's id if we have
258 /// an inset to give back!
259 virtual Inset * getInsetFromID(int /* id */) const {
262 /// if this insets owns paragraphs (f.ex. InsetText) then it
263 /// should return it's very first one!
264 virtual Paragraph * firstParagraph() const {
267 /// return the cursor if we own one otherwise giv'em just the
268 /// BufferView cursor to work with.
269 virtual LyXCursor const & cursor(BufferView * bview) const;
274 /// used to toggle insets
275 // is the inset open?
276 virtual bool isOpen() const { return false; }
277 // open or close the inset, depending on the bool
278 virtual void open(BufferView *, bool) {}
283 mutable int top_baseline;
289 static unsigned int inset_id;
297 LColor::color background_color_;
301 // Updatable Insets. These insets can be locked and receive
302 // directly user interaction. Currently used only for mathed.
303 // Note that all pure methods from Inset class are pure here too.
304 // [Alejandro 080596]
306 /** Extracted from Matthias notes:
308 * An inset can simple call LockInset in it's edit call and *ONLY*
311 * Unlocking is either done by LyX or the inset itself with a
314 * During the lock, all button and keyboard events will be modified
315 * and send to the inset through the following inset-features. Note that
316 * Inset::insetUnlock will be called from inside UnlockInset. It is meant
317 * to contain the code for restoring the menus and things like this.
319 * If a inset wishes any redraw and/or update it just has to call
322 * It's is completly irrelevant, where the inset is. UpdateInset will
323 * find it in any paragraph in any buffer.
324 * Of course the_locking_inset and the insets in the current paragraph/buffer
325 * are checked first, so no performance problem should occur.
327 class UpdatableInset : public Inset {
329 /** Dispatch result codes
330 Now that nested updatable insets are allowed, the local dispatch
331 becomes a bit complex, just two possible results (boolean)
334 DISPATCHED = the inset catched the action
335 DISPATCHED_NOUPDATE = the inset catched the action and no update
336 is needed here to redraw the inset
337 FINISHED = the inset must be unlocked as a result
339 UNDISPATCHED = the action was not catched, it should be
340 dispatched by lower level insets
349 /// To convert old binary dispatch results
350 RESULT DISPATCH_RESULT(bool b) {
351 return b ? DISPATCHED : FINISHED;
355 UpdatableInset() : cursor_visible_(false), block_drawing_(false) {}
358 virtual EDITABLE editable() const;
360 /// may call ToggleLockedInsetCursor
361 virtual void toggleInsetCursor(BufferView *);
363 virtual void showInsetCursor(BufferView *, bool show = true);
365 virtual void hideInsetCursor(BufferView *);
367 virtual void fitInsetCursor(BufferView *) const;
369 virtual void getCursorPos(BufferView *, int &, int &) const {}
371 virtual void insetButtonPress(BufferView *, int x, int y, int button);
373 virtual void insetButtonRelease(BufferView *,
374 int x, int y, int button);
376 virtual void insetKeyPress(XKeyEvent * ev);
378 virtual void insetMotionNotify(BufferView *, int x, int y, int state);
380 virtual void insetUnlock(BufferView *);
382 virtual void edit(BufferView *, int x, int y, unsigned int button);
384 virtual void edit(BufferView *, bool front = true);
386 virtual void draw(BufferView *, LyXFont const &,
387 int baseline, float & x, bool cleared) const;
389 virtual void setFont(BufferView *, LyXFont const &,
390 bool toggleall = false, bool selectall = false);
392 virtual bool insertInset(BufferView *, Inset *) { return false; }
394 virtual UpdatableInset * getLockingInset() const {
395 return const_cast<UpdatableInset *>(this);
398 virtual UpdatableInset * getFirstLockingInsetOfType(Inset::Code c)
399 { return (c == lyxCode()) ? this : 0; }
401 virtual unsigned int insetInInsetY() { return 0; }
403 virtual bool updateInsetInInset(BufferView *, Inset *)
406 virtual bool lockInsetInInset(BufferView *, UpdatableInset *)
409 virtual bool unlockInsetInInset(BufferView *, UpdatableInset *,
412 /// An updatable inset could handle lyx editing commands
413 virtual RESULT localDispatch(BufferView *, kb_action, string const &);
415 bool isCursorVisible() const { return cursor_visible_; }
417 virtual int getMaxWidth(BufferView * bv, UpdatableInset const *) const;
419 int scroll(bool recursive = true) const {
420 // We need this method to not clobber the real method in Inset
421 return Inset::scroll(recursive);
424 virtual bool showInsetDialog(BufferView *) const { return false; }
426 virtual void nodraw(bool b) {
430 virtual bool nodraw() const {
431 return block_drawing_;
434 // needed for spellchecking text
436 virtual string selectNextWord(BufferView *, float & value) const;
437 virtual void selectSelectedWord(BufferView *) { return; }
438 virtual void toggleSelection(BufferView *, bool /*kill_selection*/) {
442 // needed for search/replace functionality
444 virtual bool searchForward(BufferView *, string const &,
445 bool const & = true, bool const & = false);
446 virtual bool searchBackward(BufferView *, string const &,
447 bool const & = true, bool const & = false);
451 void toggleCursorVisible() const {
452 cursor_visible_ = !cursor_visible_;
455 void setCursorVisible(bool b) const {
458 /// scrolls to absolute position in bufferview-workwidth * sx units
459 void scroll(BufferView *, float sx) const;
460 /// scrolls offset pixels
461 void scroll(BufferView *, int offset) const;
465 mutable bool cursor_visible_;