src/insets/lyxinset.h

   1 // -*- C++ -*-
   2 /* This file is part of
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *
   7  *           Copyright 1995 Matthias Ettrich
   8  *           Copyright 1995-1999 the LyX Team.
   9  *
  10  * ====================================================== */
  11
  12 #ifndef LYXINSET_H
  13 #define LYXINSET_H
  14
  15 #ifdef __GNUG__
  16 #pragma interface
  17 #endif
  18
  19 #include "gettext.h"
  20 #include "lyxfont.h"
  21 #include "lyxlex.h"
  22 #include "lyxscreen.h"
  23
  24 class Buffer;
  25 struct LaTeXFeatures;
  26
  27 /// Insets
  28 class Inset {
  29 public:
  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
  34             in a cleaner way. */
  35         enum Code {
  36                 ///
  37                 NO_CODE,
  38                 ///
  39                 TOC_CODE,  // do these insets really need a code? (ale)
  40                 ///
  41                 LOF_CODE,
  42                 ///
  43                 LOT_CODE,
  44                 ///
  45                 LOA_CODE,
  46                 ///
  47                 QUOTE_CODE,
  48                 ///
  49                 MARK_CODE,
  50                 ///
  51                 REF_CODE,
  52                 ///
  53                 URL_CODE,
  54                 ///
  55                 HTMLURL_CODE,
  56                 ///
  57                 SEPARATOR_CODE,
  58                 ///
  59                 ENDING_CODE,
  60                 ///
  61                 LABEL_CODE,
  62                 ///
  63                 IGNORE_CODE,
  64                 ///
  65                 ACCENT_CODE,
  66                 ///
  67                 MATH_CODE,
  68                 ///
  69                 INDEX_CODE,
  70                 ///
  71                 INCLUDE_CODE,
  72                 ///
  73                 GRAPHICS_CODE,
  74                 ///
  75                 PARENT_CODE,
  76                 ///
  77                 BIBTEX_CODE
  78         };
  79
  80         ///
  81         virtual ~Inset() {}
  82         ///
  83         virtual int Ascent(LyXFont const & font) const = 0;
  84         ///
  85         virtual int Descent(LyXFont const & font) const = 0;
  86         ///
  87         virtual int Width(LyXFont const & font) const = 0;
  88         ///
  89         virtual LyXFont ConvertFont(LyXFont font);
  90         ///
  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() const {return _("Opened inset");}
  95         ///
  96         virtual void Edit(int, int);
  97         ///
  98         virtual unsigned char Editable() const;
  99         ///
 100         virtual bool AutoDelete() const;
 101         ///
 102         virtual void Write(FILE * file) = 0;
 103         ///
 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.
 108          */
 109         virtual int Latex(FILE * file, signed char fragile) = 0;
 110         virtual int Latex(string & file, signed char fragile) = 0;
 111         ///
 112         virtual int Linuxdoc(string & /*file*/) = 0;
 113         ///
 114         virtual int DocBook(string & /*file*/) = 0;
 115         /// Updates needed features for this inset.
 116         virtual void Validate(LaTeXFeatures & features) const;
 117         ///
 118         virtual bool Deletable() const;
 119
 120         /// returns LyX code associated with the inset. Used for TOC, ...)
 121         virtual Inset::Code LyxCode() const = 0;
 122
 123         /// Get the label that appears at screen
 124         virtual string getLabel(int) const {
 125                 return string();
 126         }
 127
 128         ///
 129         virtual Inset * Clone() const = 0;
 130
 131         /// returns true to override begin and end inset in file
 132         virtual bool DirectWrite() const;
 133
 134         /// Returns true if the inset should be centered alone
 135         virtual bool display() const { return false; }
 136         /// Changes the display state of the inset
 137         virtual void display(bool) {}
 138         ///
 139         virtual int GetNumberOfLabels() const {
 140                 return 0;
 141         }
 142
 143 };
 144
 145
 146 //  Updatable Insets. These insets can be locked and receive
 147 //  directly user interaction. Currently used only for mathed.
 148 //  Note that all pure methods from Inset class are pure here too.
 149 //  [Alejandro 080596]
 150
 151 /** Extracted from Matthias notes:
 152   *
 153   * An inset can simple call LockInset in it's edit call and *ONLY*
 154   * in it's edit call.
 155   *
 156   * Unlocking is either done by LyX or the inset itself with a
 157   * UnlockInset-call
 158   *
 159   * During the lock, all button and keyboard events will be modified
 160   * and send to the inset through the following inset-features. Note that
 161   * Inset::InsetUnlock will be called from inside UnlockInset. It is meant
 162   * to contain the code for restoring the menus and things like this.
 163   *
 164   * If a inset wishes any redraw and/or update it just has to call
 165   * UpdateInset(this).
 166   *
 167   * It's is completly irrelevant, where the inset is. UpdateInset will
 168   * find it in any paragraph in any buffer.
 169   * Of course the_locking_inset and the insets in the current paragraph/buffer
 170   *  are checked first, so no performance problem should occur.
 171   */
 172 class UpdatableInset: public Inset {
 173 public:
 174         ///
 175         //virtual ~UpdatableInset() {}
 176         ///
 177         virtual unsigned char Editable() const;
 178
 179         /// may call ToggleLockedInsetCursor
 180         virtual void ToggleInsetCursor();
 181         ///
 182         virtual void GetCursorPos(int &, int &) const {}
 183         ///
 184         virtual void InsetButtonPress(int x, int y, int button);
 185         ///
 186         virtual void InsetButtonRelease(int x, int y, int button);
 187
 188         ///
 189         virtual void InsetKeyPress(XKeyEvent * ev);
 190         ///
 191         virtual void InsetMotionNotify(int x, int y, int state);
 192         ///
 193         virtual void InsetUnlock();
 194
 195         ///  An updatable inset could handle lyx editing commands
 196         virtual bool LocalDispatch(int, char const *) { return false; };
 197         //
 198         bool isCursorVisible() const { return cursor_visible; }
 199 protected:
 200         ///
 201         bool cursor_visible;
 202 };
 203 #endif