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)
108 Inset() { owner_ = 0; top_x = top_baseline = 0; }
112 virtual int ascent(Painter &, LyXFont const &) const = 0;
114 virtual int descent(Painter &, LyXFont const &) const = 0;
116 virtual int width(Painter &, LyXFont const &) const = 0;
118 virtual void draw(BufferView *, LyXFont const &,
119 int baseline, float & x, bool cleared) const = 0;
120 /// update the inset representation
121 virtual void update(BufferView *, LyXFont const &, bool =false)
124 virtual LyXFont ConvertFont(LyXFont font);
125 /// what appears in the minibuffer when opening
126 virtual const char * EditMessage() const;
128 virtual void Edit(BufferView *, int x, int y, unsigned int button);
130 virtual EDITABLE Editable() const;
131 /// This is called when the user clicks inside an inset
132 virtual void InsetButtonPress(BufferView *, int, int, int) {}
133 /// This is called when the user releases the button inside an inset
134 virtual void InsetButtonRelease(BufferView *, int, int, int) {}
135 /// This is caleld when the user moves the mouse inside an inset
136 virtual void InsetMotionNotify(BufferView *, int , int , int) {}
138 virtual bool IsTextInset() const { return false; }
140 virtual bool doClearArea() const { return true; }
142 virtual bool AutoDelete() const;
144 virtual void Write(Buffer const *, std::ostream &) const = 0;
146 virtual void Read(Buffer const *, LyXLex & lex) = 0;
147 /** returns the number of rows (\n's) of generated tex code.
148 fragile == true means, that the inset should take care about
149 fragile commands by adding a \protect before.
150 If the free_spc (freespacing) variable is set, then this inset
151 is in a free-spacing paragraph.
153 virtual int Latex(Buffer const *, std::ostream &, bool fragile,
154 bool free_spc) const = 0;
156 virtual int Ascii(Buffer const *, std::ostream &) const = 0;
158 virtual int Linuxdoc(Buffer const *, std::ostream &) const = 0;
160 virtual int DocBook(Buffer const *, std::ostream &) const = 0;
161 /// Updates needed features for this inset.
162 virtual void Validate(LaTeXFeatures & features) const;
164 virtual bool Deletable() const;
166 /// returns LyX code associated with the inset. Used for TOC, ...)
167 virtual Inset::Code LyxCode() const { return NO_CODE; }
169 virtual std::vector<string> getLabelList() const {
170 return std::vector<string>();
174 virtual Inset * Clone() const = 0;
176 /// returns true to override begin and end inset in file
177 virtual bool DirectWrite() const;
179 /// Returns true if the inset should be centered alone
180 virtual bool display() const { return false; }
181 /// Changes the display state of the inset
182 virtual void display(bool) {}
184 virtual bool InsertInsetAllowed(Inset *) const { return false; }
186 virtual void setInsetName(const char * s) { name = s; }
188 virtual string getInsetName() const { return name; }
190 virtual void setOwner(Inset * inset) { owner_ = inset; }
192 virtual Inset * owner() const { return owner_; }
194 int x() const { return top_x; }
196 int y() const { return top_baseline; }
201 mutable int top_baseline;
211 // Updatable Insets. These insets can be locked and receive
212 // directly user interaction. Currently used only for mathed.
213 // Note that all pure methods from Inset class are pure here too.
214 // [Alejandro 080596]
216 /** Extracted from Matthias notes:
218 * An inset can simple call LockInset in it's edit call and *ONLY*
221 * Unlocking is either done by LyX or the inset itself with a
224 * During the lock, all button and keyboard events will be modified
225 * and send to the inset through the following inset-features. Note that
226 * Inset::InsetUnlock will be called from inside UnlockInset. It is meant
227 * to contain the code for restoring the menus and things like this.
229 * If a inset wishes any redraw and/or update it just has to call
232 * It's is completly irrelevant, where the inset is. UpdateInset will
233 * find it in any paragraph in any buffer.
234 * Of course the_locking_inset and the insets in the current paragraph/buffer
235 * are checked first, so no performance problem should occur.
237 class UpdatableInset: public Inset {
239 /** Dispatch result codes
240 Now that nested updatable insets are allowed, the local dispatch
241 becomes a bit complex, just two possible results (boolean)
244 DISPATCHED = the inset catched the action
245 DISPATCHED_NOUPDATE = the inset catched the action and no update
246 is needed here to redraw the inset
247 FINISHED = the inset must be unlocked as a result
249 UNDISPATCHED = the action was not catched, it should be
250 dispatched by lower level insets
259 /// To convert old binary dispatch results
260 RESULT DISPATCH_RESULT(bool b) {
261 return b ? DISPATCHED : FINISHED;
265 UpdatableInset() { scx = mx_scx = 0; }
267 //virtual ~UpdatableInset() {}
269 virtual EDITABLE Editable() const;
271 /// may call ToggleLockedInsetCursor
272 virtual void ToggleInsetCursor(BufferView *);
274 virtual void ShowInsetCursor(BufferView *);
276 virtual void HideInsetCursor(BufferView *);
278 virtual void GetCursorPos(BufferView *, int &, int &) const {}
280 virtual void InsetButtonPress(BufferView *, int x, int y, int button);
282 virtual void InsetButtonRelease(BufferView *,
283 int x, int y, int button);
285 virtual void InsetKeyPress(XKeyEvent * ev);
287 virtual void InsetMotionNotify(BufferView *, int x, int y, int state);
289 virtual void InsetUnlock(BufferView *);
291 virtual void Edit(BufferView *, int x, int y, unsigned int button);
293 virtual void draw(BufferView *, LyXFont const &,
294 int baseline, float & x) const;
296 virtual void SetFont(BufferView *, LyXFont const &,
297 bool toggleall = false);
299 virtual bool InsertInset(BufferView *, Inset *) { return false; }
301 virtual bool InsertInsetAllowed(Inset *) const { return true; }
303 virtual UpdatableInset * GetLockingInset() { return this; }
305 virtual UpdatableInset * GetFirstLockingInsetOfType(Inset::Code c)
306 { return (c == LyxCode()) ? this : 0; }
308 virtual int InsetInInsetY() { return 0; }
310 virtual bool UpdateInsetInInset(BufferView *, Inset *)
313 virtual bool LockInsetInInset(BufferView *, UpdatableInset *)
316 virtual bool UnlockInsetInInset(BufferView *, UpdatableInset *,
319 /// An updatable inset could handle lyx editing commands
320 virtual RESULT LocalDispatch(BufferView *, int, string const &);
322 virtual bool isCursorVisible() const { return cursor_visible; }
324 virtual int getMaxWidth(Painter & pain, UpdatableInset const *) const;
328 mutable bool cursor_visible;