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"
30 /** This is not quite the correct place for this enum. I think
31 the correct would be to let each subclass of Inset declare
32 its own enum code. Actually the notion of an Inset::Code
33 should be avoided, but I am not sure how this could be done
39 TOC_CODE, // do these insets really need a code? (ale)
83 virtual int Ascent(LyXFont const & font) const = 0;
85 virtual int Descent(LyXFont const & font) const = 0;
87 virtual int Width(LyXFont const & font) const = 0;
89 virtual LyXFont ConvertFont(LyXFont font);
91 virtual void Draw(LyXFont font, LyXScreen & scr,
92 int baseline, float & x) = 0;
93 /// what appears in the minibuffer when opening
94 virtual char const * EditMessage() {return _("Opened inset");}
96 virtual void Edit(int, int);
98 virtual unsigned char Editable() const;
100 virtual bool AutoDelete() const;
102 virtual void Write(FILE * file)= 0;
104 virtual void Read(LyXLex & lex)= 0;
105 /** returns the number of rows (\n's) of generated tex code.
106 fragile != 0 means, that the inset should take care about
107 fragile commands by adding a \protect before.
109 virtual int Latex(FILE * file, signed char fragile) = 0;
110 virtual int Latex(string & file, signed char fragile) = 0;
112 virtual int Linuxdoc(string & /*file*/) = 0;
114 virtual int DocBook(string & /*file*/) = 0;
115 /// Updates needed features for this inset.
116 virtual void Validate(LaTeXFeatures & features) const;
118 virtual bool Deletable() const;
120 /// returns LyX code associated with the inset. Used for TOC, ...)
121 virtual Inset::Code LyxCode() const = 0;
123 /// Get the label that appears at screen
124 virtual string getLabel(int) const {
128 /// used for autocorrection
129 virtual bool IsEqual(Inset * /*other*/){
134 virtual Inset * Clone() = 0;
136 /// returns true to override begin and end inset in file
137 virtual bool DirectWrite() const;
139 /// Returns true if the inset should be centered alone
140 virtual bool Display() const { return false; }
142 /// Changes the display state of the inset
143 virtual void SetDisplay(bool) { }
145 virtual int GetNumberOfLabels() const {
152 // Updatable Insets. These insets can be locked and receive
153 // directly user interaction. Currently used only for mathed.
154 // Note that all pure methods from Inset class are pure here too.
155 // [Alejandro 080596]
157 /** Extracted from Matthias notes:
159 * An inset can simple call LockInset in it's edit call and *ONLY*
162 * Unlocking is either done by LyX or the inset itself with a
165 * During the lock, all button and keyboard events will be modified
166 * and send to the inset through the following inset-features. Note that
167 * Inset::InsetUnlock will be called from inside UnlockInset. It is meant
168 * to contain the code for restoring the menus and things like this.
170 * If a inset wishes any redraw and/or update it just has to call
173 * It's is completly irrelevant, where the inset is. UpdateInset will
174 * find it in any paragraph in any buffer.
175 * Of course the_locking_inset and the insets in the current paragraph/buffer
176 * are checked first, so no performance problem should occur.
178 class UpdatableInset: public Inset {
181 virtual ~UpdatableInset() {}
183 virtual unsigned char Editable() const;
185 /// may call ToggleLockedInsetCursor
186 virtual void ToggleInsetCursor();
188 virtual void GetCursorPos(int &, int &) {}
190 virtual void InsetButtonPress(int x, int y, int button);
192 virtual void InsetButtonRelease(int x, int y, int button);
195 virtual void InsetKeyPress(XKeyEvent * ev);
197 virtual void InsetMotionNotify(int x, int y, int state);
199 virtual void InsetUnlock();
201 /// An updatable inset could handle lyx editing commands
202 virtual bool LocalDispatch(int, char const *) { return false; };
204 bool isCursorVisible() const { return cursor_visible; }