src/insets/lyxinset.h

   1 // -*- C++ -*-
   2 /* This file is part of
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *
   7  *           Copyright 1995-2000 the LyX Team.
   8  *
   9  * ====================================================== */
  10
  11 #ifndef LYXINSET_H
  12 #define LYXINSET_H
  13
  14 #ifdef __GNUG__
  15 #pragma interface
  16 #endif
  17
  18 #include <vector>
  19
  20 #include <X11/Xlib.h>
  21
  22 #include "gettext.h"
  23 #include "lyxfont.h"
  24 #include "lyxlex.h"
  25
  26 class Painter;
  27 class BufferView;
  28 class Buffer;
  29
  30 struct LaTeXFeatures;
  31
  32
  33
  34 /// Insets
  35 class Inset {
  36 public:
  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
  41             in a cleaner way. */
  42         enum Code {
  43                 ///
  44                 NO_CODE,
  45                 ///
  46                 TOC_CODE,  // do these insets really need a code? (ale)
  47                 ///
  48                 LOF_CODE,
  49                 ///
  50                 LOT_CODE,
  51                 ///
  52                 LOA_CODE,
  53                 ///
  54                 QUOTE_CODE,
  55                 ///
  56                 MARK_CODE,
  57                 ///
  58                 REF_CODE,
  59                 ///
  60                 URL_CODE,
  61                 ///
  62                 HTMLURL_CODE,
  63                 ///
  64                 SEPARATOR_CODE,
  65                 ///
  66                 ENDING_CODE,
  67                 ///
  68                 LABEL_CODE,
  69                 ///
  70                 IGNORE_CODE,
  71                 ///
  72                 ACCENT_CODE,
  73                 ///
  74                 MATH_CODE,
  75                 ///
  76                 INDEX_CODE,
  77                 ///
  78                 INCLUDE_CODE,
  79                 ///
  80                 GRAPHICS_CODE,
  81                 ///
  82                 PARENT_CODE,
  83                 ///
  84                 BIBTEX_CODE,
  85                 ///
  86                 TEXT_CODE,
  87                 ///
  88                 ERT_CODE,
  89                 ///
  90                 FOOT_CODE,
  91                 ///
  92                 MARGIN_CODE,
  93                 ///
  94                 SPECIALCHAR_CODE,
  95                 ///
  96                 TABULAR_CODE,
  97                 ///
  98                 EXTERNAL_CODE
  99         };
 100
 101         enum EDITABLE {
 102             NOT_EDITABLE = 0,
 103             IS_EDITABLE,
 104             HIGHLY_EDITABLE
 105         };
 106
 107         ///
 108         Inset() { owner_ = 0; top_x = top_baseline = 0; }
 109         ///
 110         virtual ~Inset() {}
 111         ///
 112         virtual int ascent(Painter &, LyXFont const &) const = 0;
 113         ///
 114         virtual int descent(Painter &, LyXFont const &) const = 0;
 115         ///
 116         virtual int width(Painter &, LyXFont const &) const = 0;
 117         ///
 118         virtual void draw(Painter &, LyXFont const &,
 119                           int baseline, float & x) const = 0;
 120         ///
 121         virtual LyXFont ConvertFont(LyXFont font);
 122         /// what appears in the minibuffer when opening
 123         virtual const char * EditMessage() const;
 124         ///
 125         virtual void Edit(BufferView *, int x, int y, unsigned int button);
 126         ///
 127         virtual EDITABLE Editable() const;
 128         /// This is called when the user clicks inside an inset
 129         virtual void InsetButtonPress(BufferView *, int, int, int) {}
 130         /// This is called when the user releases the button inside an inset
 131         virtual void InsetButtonRelease(BufferView *, int, int, int) {}
 132         /// This is caleld when the user moves the mouse inside an inset
 133         virtual void InsetMotionNotify(BufferView *, int , int , int) {}
 134         ///
 135         bool IsTextInset() const;
 136         ///
 137         virtual bool AutoDelete() const;
 138         ///
 139         virtual void Write(Buffer const *, std::ostream &) const = 0;
 140         ///
 141         virtual void Read(Buffer const *, LyXLex & lex) = 0;
 142         /** returns the number of rows (\n's) of generated tex code.
 143          fragile == true means, that the inset should take care about
 144          fragile commands by adding a \protect before.
 145          If the free_spc (freespacing) variable is set, then this inset
 146          is in a free-spacing paragraph.
 147          */
 148         virtual int Latex(Buffer const *, std::ostream &, bool fragile,
 149                           bool free_spc) const = 0;
 150         ///
 151         virtual int Ascii(Buffer const *, std::ostream &) const = 0;
 152         ///
 153         virtual int Linuxdoc(Buffer const *, std::ostream &) const = 0;
 154         ///
 155         virtual int DocBook(Buffer const *, std::ostream &) const = 0;
 156         /// Updates needed features for this inset.
 157         virtual void Validate(LaTeXFeatures & features) const;
 158         ///
 159         virtual bool Deletable() const;
 160
 161         /// returns LyX code associated with the inset. Used for TOC, ...)
 162         virtual Inset::Code LyxCode() const { return NO_CODE; }
 163
 164         virtual std::vector<string> getLabelList() const {
 165                 return std::vector<string>();
 166         }
 167
 168         ///
 169         virtual Inset * Clone() const = 0;
 170
 171         /// returns true to override begin and end inset in file
 172         virtual bool DirectWrite() const;
 173
 174         /// Returns true if the inset should be centered alone
 175         virtual bool display() const { return false; }
 176         /// Changes the display state of the inset
 177         virtual void display(bool) {}
 178         ///
 179         virtual bool InsertInsetAllowed(Inset *) const { return false; }
 180         ///
 181         virtual void setInsetName(const char * s) { name = s; }
 182         ///
 183         virtual string getInsetName() const { return name; }
 184         ///
 185         virtual void setOwner(Inset * inset) { owner_ = inset; }
 186         ///
 187         virtual Inset * owner() const { return owner_; }
 188         ///
 189         int x() const { return top_x; }
 190         ///
 191         int y() const { return top_baseline; }
 192
 193 protected:
 194         ///
 195         mutable int top_x;
 196         mutable int top_baseline;
 197
 198 private:
 199         ///
 200         Inset * owner_;
 201         ///
 202         string name;
 203 };
 204
 205
 206 //  Updatable Insets. These insets can be locked and receive
 207 //  directly user interaction. Currently used only for mathed.
 208 //  Note that all pure methods from Inset class are pure here too.
 209 //  [Alejandro 080596]
 210
 211 /** Extracted from Matthias notes:
 212   *
 213   * An inset can simple call LockInset in it's edit call and *ONLY*
 214   * in it's edit call.
 215   *
 216   * Unlocking is either done by LyX or the inset itself with a
 217   * UnlockInset-call
 218   *
 219   * During the lock, all button and keyboard events will be modified
 220   * and send to the inset through the following inset-features. Note that
 221   * Inset::InsetUnlock will be called from inside UnlockInset. It is meant
 222   * to contain the code for restoring the menus and things like this.
 223   *
 224   * If a inset wishes any redraw and/or update it just has to call
 225   * UpdateInset(this).
 226   *
 227   * It's is completly irrelevant, where the inset is. UpdateInset will
 228   * find it in any paragraph in any buffer.
 229   * Of course the_locking_inset and the insets in the current paragraph/buffer
 230   *  are checked first, so no performance problem should occur.
 231   */
 232 class UpdatableInset: public Inset {
 233 public:
 234         /** Dispatch result codes
 235             Now that nested updatable insets are allowed, the local dispatch
 236             becomes a bit complex, just two possible results (boolean)
 237             are not enough.
 238
 239             DISPATCHED   = the inset catched the action
 240             DISPATCHED_NOUPDATE = the inset catched the action and no update
 241                                   is needed here to redraw the inset
 242             FINISHED     = the inset must be unlocked as a result
 243                            of the action
 244             UNDISPATCHED = the action was not catched, it should be
 245                            dispatched by lower level insets
 246         */
 247         enum RESULT {
 248             UNDISPATCHED = 0,
 249             DISPATCHED,
 250             DISPATCHED_NOUPDATE,
 251             FINISHED
 252         };
 253
 254         /// To convert old binary dispatch results
 255         RESULT DISPATCH_RESULT(bool b) {
 256                 return b ? DISPATCHED : FINISHED;
 257         }
 258
 259         ///
 260         UpdatableInset() { scx = mx_scx = 0; }
 261         ///
 262         //virtual ~UpdatableInset() {}
 263         ///
 264         virtual EDITABLE Editable() const;
 265
 266         /// may call ToggleLockedInsetCursor
 267         virtual void ToggleInsetCursor(BufferView *);
 268         ///
 269         virtual void ShowInsetCursor(BufferView *);
 270         ///
 271         virtual void HideInsetCursor(BufferView *);
 272         ///
 273         virtual void GetCursorPos(int &, int &) const {}
 274         ///
 275         virtual void InsetButtonPress(BufferView *, int x, int y, int button);
 276         ///
 277         virtual void InsetButtonRelease(BufferView *,
 278                                         int x, int y, int button);
 279         ///
 280         virtual void InsetKeyPress(XKeyEvent * ev);
 281         ///
 282         virtual void InsetMotionNotify(BufferView *, int x, int y, int state);
 283         ///
 284         virtual void InsetUnlock(BufferView *);
 285         ///
 286         virtual void Edit(BufferView *, int x, int y, unsigned int button);
 287         ///
 288         virtual void draw(Painter &, LyXFont const &,
 289                           int baseline, float & x) const;
 290         ///
 291         virtual void SetFont(BufferView *, LyXFont const &,
 292                              bool toggleall = false);
 293         ///
 294         virtual bool InsertInset(BufferView *, Inset *) { return false; }
 295         ///
 296         virtual bool InsertInsetAllowed(Inset *) const { return true; }
 297         ///
 298         virtual UpdatableInset * GetLockingInset() { return this; }
 299         ///
 300         virtual UpdatableInset * GetFirstLockingInsetOfType(Inset::Code c)
 301                 { return (c == LyxCode()) ? this : 0; }
 302         ///
 303         virtual int InsetInInsetY() { return 0; }
 304         ///
 305         virtual bool UpdateInsetInInset(BufferView *, Inset *)
 306                 { return false; }
 307         ///
 308         virtual bool LockInsetInInset(BufferView *, UpdatableInset *)
 309                 { return false; }
 310         ///
 311         virtual bool UnlockInsetInInset(BufferView *, UpdatableInset *,
 312                                         bool /*lr*/ = false)
 313                 { return false; }
 314         ///  An updatable inset could handle lyx editing commands
 315         virtual RESULT LocalDispatch(BufferView *, int, string const &);
 316         ///
 317         virtual bool isCursorVisible() const { return cursor_visible; }
 318         ///
 319         virtual int getMaxWidth(Painter & pain, UpdatableInset const *) const;
 320
 321 protected:
 322         ///
 323         mutable bool cursor_visible;
 324
 325 private:
 326         ///
 327         int mx_scx;
 328         mutable int scx;
 329 };
 330 #endif