2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
7 * Copyright 1995 Matthias Ettrich
8 * Copyright 1995-1999 the LyX Team.
10 * ====================================================== */
22 #include "lyxscreen.h"
24 //#define USE_PAINTER 1
36 /** This is not quite the correct place for this enum. I think
37 the correct would be to let each subclass of Inset declare
38 its own enum code. Actually the notion of an Inset::Code
39 should be avoided, but I am not sure how this could be done
45 TOC_CODE, // do these insets really need a code? (ale)
90 virtual int ascent(Painter &, LyXFont const &) const = 0;
92 virtual int descent(Painter &, LyXFont const &) const = 0;
94 virtual int width(Painter &, LyXFont const &) const = 0;
96 virtual void draw(Painter &, LyXFont const &,
97 int baseline, float & x) const = 0;
100 virtual int Ascent(LyXFont const & font) const = 0;
102 virtual int Descent(LyXFont const & font) const = 0;
104 virtual int Width(LyXFont const & font) const = 0;
106 virtual void Draw(LyXFont font, LyXScreen & scr,
107 int baseline, float & x) = 0;
110 virtual LyXFont ConvertFont(LyXFont font);
111 /// what appears in the minibuffer when opening
112 virtual char const * EditMessage() const {return _("Opened inset");}
114 virtual void Edit(int, int);
116 virtual unsigned char Editable() const;
118 virtual bool AutoDelete() const;
120 virtual void Write(ostream &) = 0;
122 virtual void Read(LyXLex & lex) = 0;
123 /** returns the number of rows (\n's) of generated tex code.
124 fragile != 0 means, that the inset should take care about
125 fragile commands by adding a \protect before.
127 virtual int Latex(ostream &, signed char fragile) = 0;
129 virtual int Latex(string & file, signed char fragile) = 0;
131 virtual int Linuxdoc(string & /*file*/) = 0;
133 virtual int DocBook(string & /*file*/) = 0;
134 /// Updates needed features for this inset.
135 virtual void Validate(LaTeXFeatures & features) const;
137 virtual bool Deletable() const;
139 /// returns LyX code associated with the inset. Used for TOC, ...)
140 virtual Inset::Code LyxCode() const = 0;
142 /// Get the label that appears at screen
143 virtual string getLabel(int) const {
148 virtual Inset * Clone() const = 0;
150 /// returns true to override begin and end inset in file
151 virtual bool DirectWrite() const;
153 /// Returns true if the inset should be centered alone
154 virtual bool display() const { return false; }
155 /// Changes the display state of the inset
156 virtual void display(bool) {}
158 virtual int GetNumberOfLabels() const {
165 // Updatable Insets. These insets can be locked and receive
166 // directly user interaction. Currently used only for mathed.
167 // Note that all pure methods from Inset class are pure here too.
168 // [Alejandro 080596]
170 /** Extracted from Matthias notes:
172 * An inset can simple call LockInset in it's edit call and *ONLY*
175 * Unlocking is either done by LyX or the inset itself with a
178 * During the lock, all button and keyboard events will be modified
179 * and send to the inset through the following inset-features. Note that
180 * Inset::InsetUnlock will be called from inside UnlockInset. It is meant
181 * to contain the code for restoring the menus and things like this.
183 * If a inset wishes any redraw and/or update it just has to call
186 * It's is completly irrelevant, where the inset is. UpdateInset will
187 * find it in any paragraph in any buffer.
188 * Of course the_locking_inset and the insets in the current paragraph/buffer
189 * are checked first, so no performance problem should occur.
191 class UpdatableInset: public Inset {
194 //virtual ~UpdatableInset() {}
196 virtual unsigned char Editable() const;
198 /// may call ToggleLockedInsetCursor
199 virtual void ToggleInsetCursor();
201 virtual void GetCursorPos(int &, int &) const {}
203 virtual void InsetButtonPress(int x, int y, int button);
205 virtual void InsetButtonRelease(int x, int y, int button);
208 virtual void InsetKeyPress(XKeyEvent * ev);
210 virtual void InsetMotionNotify(int x, int y, int state);
212 virtual void InsetUnlock();
214 /// An updatable inset could handle lyx editing commands
215 virtual bool LocalDispatch(int, char const *) { return false; };
217 bool isCursorVisible() const { return cursor_visible; }
220 mutable bool cursor_visible;