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