src/insets/Inset.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Inset.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Alejandro Aguilar Sierra
   8  * \author Jürgen Vigna
   9  * \author Lars Gullik Bjønnes
  10  * \author Matthias Ettrich
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #ifndef INSETBASE_H
  16 #define INSETBASE_H
  17
  18 #include "ColorCode.h"
  19 #include "InsetCode.h"
  20 #include "InsetLayout.h"
  21 #include "LayoutEnums.h"
  22 #include "OutputEnums.h"
  23
  24 #include "support/strfwd.h"
  25 #include "support/types.h"
  26
  27 #include <climits>
  28
  29
  30 namespace lyx {
  31
  32 class BiblioInfo;
  33 class Buffer;
  34 class BufferView;
  35 class Change;
  36 class CompletionList;
  37 class Cursor;
  38 class CursorSlice;
  39 class Dimension;
  40 class DocIterator;
  41 class FuncRequest;
  42 class FuncStatus;
  43 class InsetCollapsable;
  44 class InsetCommand;
  45 class InsetIterator;
  46 class InsetLayout;
  47 class InsetList;
  48 class InsetMath;
  49 class InsetTabular;
  50 class InsetText;
  51 class LaTeXFeatures;
  52 class Lexer;
  53 class MathAtom;
  54 class MetricsInfo;
  55 class OutputParams;
  56 class PainterInfo;
  57 class ParConstIterator;
  58 class ParIterator;
  59 class Text;
  60 class TocList;
  61 class XHTMLStream;
  62 class otexstream;
  63
  64 namespace graphics { class PreviewLoader; }
  65
  66
  67 /// returns the InsetCode corresponding to the \c name.
  68 /// Eg, insetCode("branch") == BRANCH_CODE
  69 InsetCode insetCode(std::string const & name);
  70 /// returns the Inset name corresponding to the \c InsetCode.
  71 /// Eg, insetName(BRANCH_CODE) == "branch"
  72 std::string insetName(InsetCode);
  73 /// returns the Inset name corresponding to the \c InsetCode.
  74 /// Eg, insetDisplayName(BRANCH_CODE) == _("Branch")
  75 docstring insetDisplayName(InsetCode);
  76 ///
  77 static int const TOC_ENTRY_LENGTH = 120;
  78
  79 /// Common base class to all insets
  80
  81 // Do not add _any_ (non-static) data members as this would inflate
  82 // everything storing large quantities of insets. Mathed e.g. would
  83 // suffer.
  84
  85 class Inset {
  86 public:
  87         ///
  88         enum EntryDirection {
  89                 ENTRY_DIRECTION_IGNORE,
  90                 ENTRY_DIRECTION_RIGHT,
  91                 ENTRY_DIRECTION_LEFT
  92         };
  93         ///
  94         typedef ptrdiff_t  difference_type;
  95         /// short of anything else reasonable
  96         typedef size_t     size_type;
  97         /// type for cell indices
  98         typedef size_t     idx_type;
  99         /// type for cursor positions
 100         typedef ptrdiff_t  pos_type;
 101         /// type for row numbers
 102         typedef size_t     row_type;
 103         /// type for column numbers
 104         typedef size_t     col_type;
 105
 106         /// virtual base class destructor
 107         virtual ~Inset() {}
 108
 109         /// change associated Buffer
 110         virtual void setBuffer(Buffer & buffer);
 111         /// retrieve associated Buffer
 112         virtual Buffer & buffer();
 113         virtual Buffer const & buffer() const;
 114         /// Returns true if buffer_ actually points to a Buffer that has
 115         /// been loaded into LyX and is still open. Note that this will
 116         /// always return false for cloned Buffers. If you want to allow
 117         /// for the case of cloned Buffers, use isBufferValid().
 118         bool isBufferLoaded() const;
 119         /// Returns true if this is a loaded buffer or a cloned buffer.
 120         bool isBufferValid() const;
 121
 122         /// initialize view for this inset.
 123         /**
 124           * This is typically used after this inset is created interactively.
 125           * Intented purpose is to sanitize internal state with regard to current
 126           * Buffer.
 127           **/
 128         virtual void initView() {}
 129         /// \return true if this inset is labeled.
 130         virtual bool isLabeled() const { return false; }
 131
 132         /// identification as math inset
 133         virtual InsetMath * asInsetMath() { return 0; }
 134         /// identification as math inset
 135         virtual InsetMath const * asInsetMath() const { return 0; }
 136         /// true for 'math' math inset, but not for e.g. mbox
 137         virtual bool inMathed() const { return false; }
 138         /// is this inset based on the InsetText class?
 139         virtual InsetText * asInsetText() { return 0; }
 140         /// is this inset based on the InsetText class?
 141         virtual InsetText const * asInsetText() const { return 0; }
 142         /// is this inset based on the InsetCollapsable class?
 143         virtual InsetCollapsable * asInsetCollapsable() { return 0; }
 144         /// is this inset based on the InsetCollapsable class?
 145         virtual InsetCollapsable const * asInsetCollapsable() const { return 0; }
 146         /// is this inset based on the InsetTabular class?
 147         virtual InsetTabular * asInsetTabular() { return 0; }
 148         /// is this inset based on the InsetTabular class?
 149         virtual InsetTabular const * asInsetTabular() const { return 0; }
 150         /// is this inset based on the InsetCommand class?
 151         virtual InsetCommand * asInsetCommand() { return 0; }
 152         /// is this inset based on the InsetCommand class?
 153         virtual InsetCommand const * asInsetCommand() const { return 0; }
 154
 155         /// the real dispatcher
 156         void dispatch(Cursor & cur, FuncRequest & cmd);
 157         /**
 158          * \returns true if this function made a definitive decision on
 159          * whether the inset wants to handle the request \p cmd or not.
 160          * The result of this decision is put into \p status.
 161          *
 162          * Every request that is enabled in this method needs to be handled
 163          * in doDispatch(). Normally we have a 1:1 relationship between the
 164          * requests handled in getStatus() and doDispatch(), but there are
 165          * some exceptions:
 166          * - A request that is disabled in getStatus() does not need to
 167          *   appear in doDispatch(). It is guaranteed that doDispatch()
 168          *   is never called with this request.
 169          * - A few requests are en- or disabled in Inset::getStatus().
 170          *   These need to be handled in the doDispatch() methods of the
 171          *   derived insets, since Inset::doDispatch() has not enough
 172          *   information to handle them.
 173          * - LFUN_MOUSE_* need not to be handled in getStatus(), because these
 174          *   are dispatched directly
 175          */
 176         virtual bool getStatus(Cursor & cur, FuncRequest const & cmd,
 177                 FuncStatus & status) const;
 178
 179         /// cursor enters
 180         virtual void edit(Cursor & cur, bool front,
 181                 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
 182         /// cursor enters
 183         virtual Inset * editXY(Cursor & cur, int x, int y);
 184
 185         /// compute the size of the object returned in dim
 186         virtual void metrics(MetricsInfo & mi, Dimension & dim) const = 0;
 187         /// draw inset and update (xo, yo)-cache
 188         virtual void draw(PainterInfo & pi, int x, int y) const = 0;
 189         /// draw inset selection if necessary
 190         virtual void drawSelection(PainterInfo &, int, int) const {}
 191         /// draw inset background if the inset has an own background and a
 192         /// selection is drawn by drawSelection.
 193         virtual void drawBackground(PainterInfo &, int, int) const {}
 194         ///
 195         virtual bool editing(BufferView const * bv) const;
 196         ///
 197         virtual bool showInsetDialog(BufferView *) const;
 198
 199         /// draw inset decoration if necessary.
 200         /// This can use \c drawMarkers() for example.
 201         virtual void drawDecoration(PainterInfo &, int, int) const {}
 202         /// draw four angular markers
 203         void drawMarkers(PainterInfo & pi, int x, int y) const;
 204         /// draw two angular markers
 205         void drawMarkers2(PainterInfo & pi, int x, int y) const;
 206         /// add space for markers
 207         void metricsMarkers(Dimension & dim, int framesize = 1) const;
 208         /// add space for markers
 209         void metricsMarkers2(Dimension & dim, int framesize = 1) const;
 210         /// last drawn position for 'important' insets
 211         int xo(BufferView const & bv) const;
 212         /// last drawn position for 'important' insets
 213         int yo(BufferView const & bv) const;
 214         /// set x/y drawing position cache if available
 215         virtual void setPosCache(PainterInfo const &, int, int) const;
 216         ///
 217         void setDimCache(MetricsInfo const &, Dimension const &) const;
 218         /// do we cover screen position x/y?
 219         virtual bool covers(BufferView const & bv, int x, int y) const;
 220         /// get the screen positions of the cursor (see note in Cursor.cpp)
 221         virtual void cursorPos(BufferView const & bv,
 222                 CursorSlice const & sl, bool boundary, int & x, int & y) const;
 223
 224         /// Allow multiple blanks
 225         virtual bool isFreeSpacing() const;
 226         /// Don't eliminate empty paragraphs
 227         virtual bool allowEmpty() const;
 228         /// Force inset into LTR environment if surroundings are RTL
 229         virtual bool forceLTR() const;
 230         /// whether to include this inset in the strings generated for the TOC
 231         virtual bool isInToc() const;
 232
 233         /// Where should we go when we press the up or down cursor key?
 234         virtual bool idxUpDown(Cursor & cur, bool up) const;
 235         /// Move one cell backwards
 236         virtual bool idxBackward(Cursor &) const { return false; }
 237         /// Move one cell forward
 238         virtual bool idxForward(Cursor &) const { return false; }
 239
 240         /// Move to the next cell
 241         virtual bool idxNext(Cursor &) const { return false; }
 242         /// Move to the previous cell
 243         virtual bool idxPrev(Cursor &) const { return false; }
 244
 245         /// Target pos when we enter the inset while moving forward
 246         virtual bool idxFirst(Cursor &) const { return false; }
 247         /// Target pos when we enter the inset while moving backwards
 248         virtual bool idxLast(Cursor &) const { return false; }
 249
 250         /// Delete a cell and move cursor
 251         virtual bool idxDelete(idx_type &) { return false; }
 252         /// pulls cell after pressing erase
 253         virtual void idxGlue(idx_type) {}
 254         /// returns list of cell indices that are "between" from and to for
 255         /// selection purposes
 256         virtual bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
 257
 258         /// to which column belongs a cell with a given index?
 259         virtual col_type col(idx_type) const { return 0; }
 260         /// to which row belongs a cell with a given index?
 261         virtual row_type row(idx_type) const { return 0; }
 262         /// cell index corresponding to row and column;
 263         virtual idx_type index(row_type row, col_type col) const;
 264         /// number of embedded cells
 265         virtual size_t nargs() const { return 0; }
 266         /// number of rows in gridlike structures
 267         virtual size_t nrows() const { return 0; }
 268         /// number of columns in gridlike structures
 269         virtual size_t ncols() const { return 0; }
 270         /// Is called when the cursor leaves this inset.
 271         /// Returns true if cursor is now invalid, e.g. if former
 272         /// insets in higher cursor slices of \c old do not exist
 273         /// anymore.
 274         /// \c old is the old cursor, the last slice points to this.
 275         /// \c cur is the new cursor. Use the update flags to cause a redraw.
 276         virtual bool notifyCursorLeaves(Cursor const & /*old*/, Cursor & /*cur*/)
 277                 { return false; }
 278         /// Is called when the cursor enters this inset.
 279         /// Returns true if cursor is now invalid, e.g. if former
 280         /// insets in higher cursor slices of \c old do not exist
 281         /// anymore.
 282         /// \c cur is the new cursor, some slice points to this. Use the update
 283         /// flags to cause a redraw.
 284         virtual bool notifyCursorEnters(Cursor & /*cur*/)
 285                 { return false; }
 286         /// is called when the mouse enters or leaves this inset
 287         /// return true if this inset needs a repaint
 288         virtual bool setMouseHover(BufferView const *, bool) const
 289                 { return false; }
 290         /// return true if this inset is hovered (under mouse)
 291         /// This is by now only used by mathed to draw corners
 292         /// (Inset::drawMarkers() and Inset::drawMarkers2()).
 293         /// Other insets do not have to redefine this function to
 294         /// return the correct status of mouseHovered.
 295         virtual bool mouseHovered(BufferView const *) const { return false; }
 296
 297         /// request "external features"
 298         virtual void validate(LaTeXFeatures &) const {}
 299
 300         /// Validate LFUN_INSET_MODIFY argument.
 301         virtual bool validateModifyArgument(docstring const &) const { return true; }
 302
 303         /// describe content if cursor inside
 304         virtual void infoize(odocstream &) const {}
 305         /// describe content if cursor behind
 306         virtual void infoize2(odocstream &) const {}
 307
 308         enum { PLAINTEXT_NEWLINE = 10000 };
 309
 310         /// plain text output in ucs4 encoding
 311         /// return the number of characters; in case of multiple lines of
 312         /// output, add PLAINTEXT_NEWLINE to the number of chars in the last line
 313         virtual int plaintext(odocstringstream &, OutputParams const &,
 314                               size_t max_length = INT_MAX) const = 0;
 315         /// docbook output
 316         virtual int docbook(odocstream & os, OutputParams const &) const;
 317         /// XHTML output
 318         /// the inset is expected to write XHTML to the XHTMLStream
 319         /// \return any "deferred" material that should be written outside the
 320         /// normal stream, and which will in fact be written after the current
 321         /// paragraph closes. this is appropriate e.g. for floats.
 322         virtual docstring xhtml(XHTMLStream & xs, OutputParams const &) const;
 323
 324         /// Writes a string representation of the inset to the odocstream.
 325         /// This one should be called when you want the whole contents of
 326         /// the inset.
 327         virtual void toString(odocstream &) const {}
 328         /// Appends a potentially abbreviated version of the inset to
 329         /// \param str. Intended for use by the TOC.
 330         virtual void forOutliner(docstring & str,
 331                                                          size_t const maxlen = TOC_ENTRY_LENGTH,
 332                                                          bool const shorten = true) const;
 333
 334         /// can the contents of the inset be edited on screen ?
 335         // true for InsetCollapsables (not ButtonOnly) (not InsetInfo), InsetText
 336         virtual bool editable() const;
 337         /// has the Inset settings that can be modified in a dialog ?
 338         virtual bool hasSettings() const;
 339         /// can we go further down on mouse click?
 340         // true for InsetCaption, InsetCollapsables (not ButtonOnly), InsetTabular
 341         virtual bool descendable(BufferView const &) const { return false; }
 342         /// is this an inset that can be moved into?
 343         /// FIXME: merge with editable()
 344         // true for InsetTabular & InsetText
 345         virtual bool isActive() const { return nargs() > 0; }
 346         /// can we click at the specified position ?
 347         virtual bool clickable(BufferView const &, int, int) const { return false; }
 348         /// Move one cell backwards
 349         virtual bool allowsCaptionVariation(std::string const &) const { return false; }
 350         // true for insets that have a table structure (InsetMathGrid, InsetTabular)
 351         virtual bool isTable() const { return false; }
 352
 353         /// does this contain text that can be change track marked in DVI?
 354         virtual bool canTrackChanges() const { return false; }
 355         /// Will this inset paint its own change tracking status (in the parent
 356         /// paragraph) or will it let RowPainter handle it?
 357         virtual bool canPaintChange(BufferView const &) const { return false; }
 358         /// return true if the inset should be removed automatically
 359         virtual bool autoDelete() const;
 360
 361         /// Returns true if the inset supports completions.
 362         virtual bool completionSupported(Cursor const &) const { return false; }
 363         /// Returns true if the inset supports inline completions at the
 364         /// cursor position. In this case the completion might be stored
 365         /// in the BufferView's inlineCompletion property.
 366         virtual bool inlineCompletionSupported(Cursor const & /*cur*/) const
 367                 { return false; }
 368         /// Return true if the inline completion should be automatic.
 369         virtual bool automaticInlineCompletion() const { return true; }
 370         /// Return true if the popup completion should be automatic.
 371         virtual bool automaticPopupCompletion() const { return true; }
 372         /// Return true if the cursor should indicate a completion.
 373         virtual bool showCompletionCursor() const { return true; }
 374         /// Returns completion suggestions at cursor position. Return an
 375         /// null pointer if no completion is a available or possible.
 376         /// The caller is responsible to free the returned object!
 377         virtual CompletionList const * createCompletionList(Cursor const &) const
 378                 { return 0; }
 379         /// Returns the completion prefix to filter the suggestions for completion.
 380         /// This is only called if completionList returned a non-null list.
 381         virtual docstring completionPrefix(Cursor const &) const;
 382         /// Do a completion at the cursor position. Return true on success.
 383         /// The completion does not contain the prefix. If finished is true, the
 384         /// completion is final. If finished is false, completion might only be
 385         /// a partial completion.
 386         virtual bool insertCompletion(Cursor & /*cur*/,
 387                 docstring const & /*completion*/, bool /*finished*/)
 388                 { return false; }
 389         /// Get the completion inset position and size
 390         virtual void completionPosAndDim(Cursor const &, int & /*x*/, int & /*y*/,
 391                 Dimension & /*dim*/) const {}
 392
 393         /// returns true if the inset can hold an inset of given type
 394         virtual bool insetAllowed(InsetCode) const { return false; }
 395         /// should this inset use the empty layout by default rather than
 396         /// the standard layout? (default: only if that is forced.)
 397         virtual bool usePlainLayout() const { return forcePlainLayout(); }
 398         /// if this inset has paragraphs should they be forced to use the
 399         /// empty layout?
 400         virtual bool forcePlainLayout(idx_type = 0) const { return false; }
 401         /// if this inset has paragraphs should the user be allowed to
 402         /// customize alignment, etc?
 403         virtual bool allowParagraphCustomization(idx_type = 0) const
 404                 { return true; }
 405         /// Is the width forced to some value?
 406         virtual bool hasFixedWidth() const { return false; }
 407         /// if this inset has paragraphs should they be forced to use a
 408         /// local font language switch?
 409         virtual bool forceLocalFontSwitch() const { return false; }
 410
 411         /// Is the content of this inset part of the output document?
 412         virtual bool producesOutput() const { return true; }
 413
 414         /// \return Tool tip for this inset.
 415         /// This default implementation returns an empty string.
 416         virtual docstring toolTip(BufferView const & bv, int x, int y) const;
 417
 418         /// \return Context menu identifier. This function determines
 419         /// whose Inset's menu should be shown for the given position.
 420         virtual std::string contextMenu(BufferView const & bv, int x, int y) const;
 421
 422         /// \return Context menu identifier for this inset.
 423         /// This default implementation returns an empty string.
 424         virtual std::string contextMenuName() const;
 425
 426
 427         virtual docstring layoutName() const;
 428         ///
 429         virtual InsetLayout const & getLayout() const;
 430         ///
 431         virtual bool isPassThru() const { return getLayout().isPassThru(); }
 432         /// Is this inset's layout defined in the document's textclass?
 433         bool undefined() const;
 434         /// should this inset be handled like a normal character?
 435         /// (a character can be a letter or punctuation)
 436         virtual bool isChar() const { return false; }
 437         /// is this equivalent to a letter?
 438         /// (a letter is a character that is considered part of a word)
 439         virtual bool isLetter() const { return false; }
 440         /// is this equivalent to a space (which is BTW different from
 441         /// a line separator)?
 442         virtual bool isSpace() const { return false; }
 443         /// does this inset try to use all available space (like \\hfill does)?
 444         virtual bool isHfill() const { return false; }
 445
 446         enum DisplayType {
 447                 Inline = 0,
 448                 AlignLeft,
 449                 AlignCenter,
 450                 AlignRight
 451         };
 452
 453         /// should we have a non-filled line before this inset?
 454         virtual DisplayType display() const { return Inline; }
 455         ///
 456         virtual LyXAlignment contentAlignment() const { return LYX_ALIGN_NONE; }
 457         /// should we break lines after this inset?
 458         virtual bool isLineSeparator() const { return false; }
 459         /// should paragraph indendation be ommitted in any case?
 460         virtual bool neverIndent() const { return false; }
 461         /// dumps content to lyxerr
 462         virtual void dump() const;
 463         /// write inset in .lyx format
 464         virtual void write(std::ostream &) const {}
 465         /// read inset in .lyx format
 466         virtual void read(Lexer &) {}
 467         /** Export the inset to LaTeX.
 468          *  Don't use a temporary stringstream if the final output is
 469          *  supposed to go to a file.
 470          *  \sa Buffer::writeLaTeXSource for the reason.
 471          */
 472         virtual void latex(otexstream &, OutputParams const &) const {}
 473         /// returns true to override begin and end inset in file
 474         virtual bool directWrite() const;
 475         ///
 476         virtual bool allowSpellCheck() const { return false; }
 477
 478         /// if this insets owns text cells (e.g. InsetText) return cell num
 479         virtual Text * getText(int /*num*/) const { return 0; }
 480
 481         /** Adds a LaTeX snippet to the Preview Loader for transformation
 482          *  into a bitmap image. Does not start the laoding process.
 483          *
 484          *  Most insets have no interest in this capability, so the method
 485          *  defaults to empty.
 486          */
 487         virtual void addPreview(DocIterator const &,
 488                 graphics::PreviewLoader &) const {}
 489
 490         /** Classifies the unicode characters appearing in a math inset
 491          *  depending on whether they are to be translated as latex
 492          *  math/text commands or used as math symbols without translation.
 493          *
 494          *  Only math insets have interest in this classification, so the
 495          *  method defaults to empty.
 496          */
 497         virtual void initUnicodeMath() const {}
 498
 499         /// Add an entry to the TocList
 500         /// Pass a DocIterator that points at the paragraph containing
 501         /// the inset
 502         ///
 503         /// \param output_active : is the inset active or is it in an inactive
 504         /// branch or a note?
 505         ///
 506         /// \param utype : is the toc being generated for use by the output
 507         /// routines?
 508         virtual void addToToc(DocIterator const & /* di */,
 509                                                   bool /* output_active */,
 510                                                   UpdateType /* utype*/) const {}
 511         /// Collect BibTeX information
 512         virtual void collectBibKeys(InsetIterator const &) const {}
 513         /// Update the counters of this inset and of its contents.
 514         /// The boolean indicates whether we are preparing for output, e.g.,
 515         /// of XHTML.
 516         virtual void updateBuffer(ParIterator const &, UpdateType) {}
 517
 518         /// Updates the inset's dialog
 519         virtual Buffer const * updateFrontend() const;
 520
 521 public:
 522         /// returns LyX code associated with the inset. Used for TOC, ...)
 523         virtual InsetCode lyxCode() const { return NO_CODE; }
 524
 525         /// -1: text mode, 1: math mode, 0 undecided
 526         enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
 527         /// return text or mathmode if that is possible to determine
 528         virtual mode_type currentMode() const { return UNDECIDED_MODE; }
 529         /// returns whether changing mode during latex export is forbidden
 530         virtual bool lockedMode() const { return false; }
 531         /// returns whether only ascii chars are allowed during latex export
 532         virtual bool asciiOnly() const { return false; }
 533         /// returns whether this inset is allowed in other insets of given mode
 534         virtual bool allowedIn(mode_type) const { return true; }
 535         /**
 536          * The font is inherited from the parent for LaTeX export if this
 537          * method returns true. No open font changes are closed in front of
 538          * the inset for LaTeX export, and the font is inherited for all other
 539          * exports as well as on screen.
 540          * If this method returns false all open font changes are closed in
 541          * front of the inset for LaTeX export. The default font is used
 542          * inside the inset for all exports and on screen.
 543          */
 544         virtual bool inheritFont() const { return true; }
 545         /**
 546          * If this method returns true all explicitly set font attributes
 547          * are reset during editing operations.
 548          * For copy/paste operations the language is never changed, since
 549          * the language of a given text never changes if the text is
 550          * formatted differently, while other font attribues like size may
 551          * need to change if the text is copied from one environment to
 552          * another one.
 553          * If this method returns false no font attribute is reset.
 554          * The default implementation returns true if the resetFont layout
 555          * tag is set and otherwise the negation of inheritFont(),
 556          * since inherited inset font attributes do not need to be changed,
 557          * and non-inherited ones need to be set explicitly.
 558          */
 559         virtual bool resetFontEdit() const;
 560
 561         /// set the change for the entire inset
 562         virtual void setChange(Change const &) {}
 563         /// accept the changes within the inset
 564         virtual void acceptChanges() {}
 565         /// reject the changes within the inset
 566         virtual void rejectChanges() {}
 567
 568         ///
 569         virtual Dimension const dimension(BufferView const &) const;
 570         ///
 571         virtual ColorCode backgroundColor(PainterInfo const &) const;
 572         ///
 573         virtual ColorCode labelColor() const;
 574         //
 575         enum { TEXT_TO_INSET_OFFSET = 4 };
 576
 577 protected:
 578         /// Constructors
 579         Inset(Buffer * buf) : buffer_(buf) {}
 580         Inset(Inset const &) : buffer_(0) {}
 581
 582         /// replicate ourselves
 583         friend class InsetList;
 584         friend class MathAtom;
 585         virtual Inset * clone() const = 0;
 586
 587         /** The real dispatcher.
 588          *  Gets normally called from Cursor::dispatch(). Cursor::dispatch()
 589          *  assumes the common case of 'LFUN handled, need update'.
 590          *  This has to be overriden by calling Cursor::undispatched() or
 591          *  Cursor::noScreenUpdate() if appropriate.
 592          *  If you need to call the dispatch method of some inset directly
 593          *  you may have to explicitly request an update at that place. Don't
 594          *  do it in doDispatch(), since that causes nested updates when
 595          *  called from Cursor::dispatch(), and these can lead to crashes.
 596          *  \sa getStatus
 597          */
 598         virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
 599
 600         Buffer * buffer_;
 601 };
 602
 603 } // namespace lyx
 604
 605 #endif