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