2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
7 * Copyright 1995-2001 the LyX Team.
9 * ====================================================== */
21 #include "commandtags.h"
38 /** This is not quite the correct place for this enum. I think
39 the correct would be to let each subclass of Inset declare
40 its own enum code. Actually the notion of an Inset::Code
41 should be avoided, but I am not sure how this could be done
47 TOC_CODE, // do these insets really need a code? (ale)
93 SPECIALCHAR_CODE, // 25
103 MATHMACRO_CODE, // 30
115 TEXT_TO_INSET_OFFSET = 2
129 Inset() : top_x(0), top_baseline(0), scx(0), id_(inset_id++), owner_(0) {}
130 /// Virtual base destructor
133 virtual int ascent(BufferView *, LyXFont const &) const = 0;
135 virtual int descent(BufferView *, LyXFont const &) const = 0;
137 virtual int width(BufferView *, LyXFont const &) const = 0;
139 virtual void draw(BufferView *, LyXFont const &,
140 int baseline, float & x, bool cleared) const = 0;
141 /// update the inset representation
142 virtual void update(BufferView *, LyXFont const &, bool = false)
145 virtual LyXFont const convertFont(LyXFont const & font) const;
146 /// what appears in the minibuffer when opening
147 virtual string const editMessage() const;
149 virtual void edit(BufferView *, int x, int y, unsigned int button);
151 virtual EDITABLE editable() const;
152 /// This is called when the user clicks inside an inset
153 virtual void insetButtonPress(BufferView *, int, int, int) {}
154 /// This is called when the user releases the button inside an inset
155 virtual void insetButtonRelease(BufferView *, int, int, int) {}
156 /// This is called when the user moves the mouse inside an inset
157 virtual void insetMotionNotify(BufferView *, int , int , int) {}
159 virtual bool isTextInset() const { return false; }
161 virtual bool doClearArea() const { return true; }
163 virtual bool autoDelete() const;
164 /// returns true the inset can hold an inset of given type
165 virtual bool insetAllowed(Inset::Code) const { return false; }
166 /// wrapper around the above
167 bool insetAllowed(Inset * in) const {
168 return insetAllowed(in->lyxCode());
171 virtual void write(Buffer const *, std::ostream &) const = 0;
173 virtual void read(Buffer const *, LyXLex & lex) = 0;
174 /** returns the number of rows (\n's) of generated tex code.
175 fragile == true means, that the inset should take care about
176 fragile commands by adding a \protect before.
177 If the free_spc (freespacing) variable is set, then this inset
178 is in a free-spacing paragraph.
180 virtual int latex(Buffer const *, std::ostream &, bool fragile,
181 bool free_spc) const = 0;
183 virtual int ascii(Buffer const *,
184 std::ostream &, int linelen = 0) const = 0;
186 virtual int linuxdoc(Buffer const *, std::ostream &) const = 0;
188 virtual int docBook(Buffer const *, std::ostream &) const = 0;
189 /// Updates needed features for this inset.
190 virtual void validate(LaTeXFeatures & features) const;
192 virtual bool deletable() const;
194 /// returns LyX code associated with the inset. Used for TOC, ...)
195 virtual Inset::Code lyxCode() const { return NO_CODE; }
197 virtual std::vector<string> const getLabelList() const {
198 return std::vector<string>();
202 virtual Inset * clone(Buffer const &, bool same_ids = false) const = 0;
204 /// returns true to override begin and end inset in file
205 virtual bool directWrite() const;
207 /// Returns true if the inset should be centered alone
208 virtual bool display() const { return false; }
209 /// Changes the display state of the inset
210 virtual void display(bool) {}
212 /// returns true if this inset needs a row on it's own
214 virtual bool needFullRow() const { return false; }
216 void setInsetName(string const & s) { name = s; }
218 string const getInsetName() const { return name; }
220 void setOwner(Inset * inset) { owner_ = inset; }
222 Inset * owner() const { return owner_; }
224 int x() const { return top_x; }
226 int y() const { return top_baseline; }
228 // because we could have fake text insets and have to call this
229 // inside them without cast!!!
231 virtual LyXText * getLyXText(BufferView const *,
232 bool const recursive = false) const;
234 virtual void deleteLyXText(BufferView *, bool = true) const {}
236 virtual void resizeLyXText(BufferView *, bool /*force*/= false) const {}
237 /// returns the actuall scroll-value
238 virtual int scroll(bool recursive=true) const {
239 if (!recursive || !owner_)
243 /// try to get a paragraph pointer from it's id if we have a
244 /// paragraph to give back!
245 virtual Paragraph * getParFromID(int /* id */) const {
248 /// try to get a inset pointer from it's id if we have
249 /// an inset to give back!
250 virtual Inset * getInsetFromID(int /* id */) const {
253 /// if this insets owns paragraphs (f.ex. InsetText) then it
254 /// should return it's very first one!
255 virtual Paragraph * firstParagraph() const {
258 /// return the cursor if we own one otherwise giv'em just the
259 /// BufferView cursor to work with.
260 virtual LyXCursor const & cursor(BufferView * bview) const;
265 /// used to toggle insets
266 // is the inset open?
267 virtual bool isOpen() const { return false; }
268 // open or close the inset, depending on the bool
269 virtual void open(BufferView *, bool) {}
274 mutable int top_baseline;
280 static unsigned int inset_id;
290 // Updatable Insets. These insets can be locked and receive
291 // directly user interaction. Currently used only for mathed.
292 // Note that all pure methods from Inset class are pure here too.
293 // [Alejandro 080596]
295 /** Extracted from Matthias notes:
297 * An inset can simple call LockInset in it's edit call and *ONLY*
300 * Unlocking is either done by LyX or the inset itself with a
303 * During the lock, all button and keyboard events will be modified
304 * and send to the inset through the following inset-features. Note that
305 * Inset::insetUnlock will be called from inside UnlockInset. It is meant
306 * to contain the code for restoring the menus and things like this.
308 * If a inset wishes any redraw and/or update it just has to call
311 * It's is completly irrelevant, where the inset is. UpdateInset will
312 * find it in any paragraph in any buffer.
313 * Of course the_locking_inset and the insets in the current paragraph/buffer
314 * are checked first, so no performance problem should occur.
316 class UpdatableInset : public Inset {
318 /** Dispatch result codes
319 Now that nested updatable insets are allowed, the local dispatch
320 becomes a bit complex, just two possible results (boolean)
323 DISPATCHED = the inset catched the action
324 DISPATCHED_NOUPDATE = the inset catched the action and no update
325 is needed here to redraw the inset
326 FINISHED = the inset must be unlocked as a result
328 UNDISPATCHED = the action was not catched, it should be
329 dispatched by lower level insets
338 /// To convert old binary dispatch results
339 RESULT DISPATCH_RESULT(bool b) {
340 return b ? DISPATCHED : FINISHED;
344 UpdatableInset() : cursor_visible_(false), block_drawing_(false) {}
347 virtual EDITABLE editable() const;
349 /// may call ToggleLockedInsetCursor
350 virtual void toggleInsetCursor(BufferView *);
352 virtual void showInsetCursor(BufferView *, bool show = true);
354 virtual void hideInsetCursor(BufferView *);
356 virtual void getCursorPos(BufferView *, int &, int &) const {}
358 virtual void insetButtonPress(BufferView *, int x, int y, int button);
360 virtual void insetButtonRelease(BufferView *,
361 int x, int y, int button);
363 virtual void insetKeyPress(XKeyEvent * ev);
365 virtual void insetMotionNotify(BufferView *, int x, int y, int state);
367 virtual void insetUnlock(BufferView *);
369 virtual void edit(BufferView *, int x, int y, unsigned int button);
371 virtual void draw(BufferView *, LyXFont const &,
372 int baseline, float & x, bool cleared) const;
374 virtual void setFont(BufferView *, LyXFont const &,
375 bool toggleall = false, bool selectall = false);
377 virtual bool insertInset(BufferView *, Inset *) { return false; }
379 virtual UpdatableInset * getLockingInset() const {
380 return const_cast<UpdatableInset *>(this);
383 virtual UpdatableInset * getFirstLockingInsetOfType(Inset::Code c)
384 { return (c == lyxCode()) ? this : 0; }
386 virtual unsigned int insetInInsetY() { return 0; }
388 virtual bool updateInsetInInset(BufferView *, Inset *)
391 virtual bool lockInsetInInset(BufferView *, UpdatableInset *)
394 virtual bool unlockInsetInInset(BufferView *, UpdatableInset *,
397 /// An updatable inset could handle lyx editing commands
398 virtual RESULT localDispatch(BufferView *, kb_action, string const &);
400 bool isCursorVisible() const { return cursor_visible_; }
402 virtual int getMaxWidth(BufferView * bv, UpdatableInset const *) const;
404 int scroll(bool recursive = true) const {
405 // We need this method to not clobber the real method in Inset
406 return Inset::scroll(recursive);
409 virtual bool showInsetDialog(BufferView *) const { return false; }
411 virtual void nodraw(bool b) {
415 virtual bool nodraw() const {
416 return block_drawing_;
419 // needed for spellchecking text
421 virtual string selectNextWord(BufferView *, float & value) const;
422 virtual void selectSelectedWord(BufferView *) { return; }
423 virtual void toggleSelection(BufferView *, bool /*kill_selection*/) {
429 void toggleCursorVisible() const {
430 cursor_visible_ = !cursor_visible_;
433 void setCursorVisible(bool b) const {
436 /// scrolls to absolute position in bufferview-workwidth * sx units
437 void scroll(BufferView *, float sx) const;
438 /// scrolls offset pixels
439 void scroll(BufferView *, int offset) const;
443 mutable bool cursor_visible_;