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