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