X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInset.h;h=0783ec1ffbb0c1dea4d130b1a39358d072e9036f;hb=239b9919ffe28338d789e6dc9122228f77ab77a7;hp=36a0f929d8b38c445e0d7fb5b0ca3dd274c566bc;hpb=86994bf75320524ec656fd70950633c83d445a6c;p=lyx.git diff --git a/src/insets/Inset.h b/src/insets/Inset.h index 36a0f929d8..0783ec1ffb 100644 --- a/src/insets/Inset.h +++ b/src/insets/Inset.h @@ -74,7 +74,7 @@ std::string insetName(InsetCode); /// Eg, insetDisplayName(BRANCH_CODE) == _("Branch") docstring insetDisplayName(InsetCode); /// -static int const TOC_ENTRY_LENGTH = 40; +static int const TOC_ENTRY_LENGTH = 120; /// Common base class to all insets @@ -108,8 +108,8 @@ public: /// change associated Buffer virtual void setBuffer(Buffer & buffer); - /// remove the buffer reference - void resetBuffer() { setBuffer( *static_cast(0)); } + /// reset associated Buffer to null value + virtual void resetBuffer(); /// retrieve associated Buffer virtual Buffer & buffer(); virtual Buffer const & buffer() const; @@ -127,7 +127,7 @@ public: * Intented purpose is to sanitize internal state with regard to current * Buffer. **/ - virtual void initView() {}; + virtual void initView() {} /// \return true if this inset is labeled. virtual bool isLabeled() const { return false; } @@ -192,33 +192,34 @@ public: virtual void drawSelection(PainterInfo &, int, int) const {} /// draw inset background if the inset has an own background and a /// selection is drawn by drawSelection. - virtual void drawBackground(PainterInfo &, int, int) const {} + virtual void drawBackground(PainterInfo &, int, int) const; /// virtual bool editing(BufferView const * bv) const; /// virtual bool showInsetDialog(BufferView *) const; - /// draw inset decoration if necessary. - /// This can use \c drawMarkers() for example. - virtual void drawDecoration(PainterInfo &, int, int) const {} - /// draw four angular markers - void drawMarkers(PainterInfo & pi, int x, int y) const; + // The possible marker types for insets + enum marker_type { NO_MARKER, MARKER2, MARKER }; /// draw two angular markers + void drawMarkers(PainterInfo & pi, int x, int y) const; + /// draw four angular markers void drawMarkers2(PainterInfo & pi, int x, int y) const; /// add space for markers void metricsMarkers(Dimension & dim, int framesize = 1) const; /// add space for markers void metricsMarkers2(Dimension & dim, int framesize = 1) const; + /// draw inset decoration if necessary. + /// This can use \c drawMarkers() for example. + virtual void drawDecoration(PainterInfo &, int, int) const {} + + /// last metrics computed for the inset + Dimension const dimension(BufferView const &) const; /// last drawn position for 'important' insets int xo(BufferView const & bv) const; /// last drawn position for 'important' insets int yo(BufferView const & bv) const; - /// set x/y drawing position cache if available - virtual void setPosCache(PainterInfo const &, int, int) const; - /// - void setDimCache(MetricsInfo const &, Dimension const &) const; /// do we cover screen position x/y? - virtual bool covers(BufferView const & bv, int x, int y) const; + bool covers(BufferView const & bv, int x, int y) const; /// get the screen positions of the cursor (see note in Cursor.cpp) virtual void cursorPos(BufferView const & bv, CursorSlice const & sl, bool boundary, int & x, int & y) const; @@ -263,10 +264,6 @@ public: virtual row_type row(idx_type) const { return 0; } /// cell index corresponding to row and column; virtual idx_type index(row_type row, col_type col) const; - /// any additional x-offset when drawing a cell? - virtual int cellXOffset(idx_type) const { return 0; } - /// any additional y-offset when drawing a cell? - virtual int cellYOffset(idx_type) const { return 0; } /// number of embedded cells virtual size_t nargs() const { return 0; } /// number of rows in gridlike structures @@ -333,8 +330,9 @@ public: virtual void toString(odocstream &) const {} /// Appends a potentially abbreviated version of the inset to /// \param str. Intended for use by the TOC. - virtual void forToc(docstring & str, - size_t maxlen = TOC_ENTRY_LENGTH) const; + virtual void forOutliner(docstring & str, + size_t const maxlen = TOC_ENTRY_LENGTH, + bool const shorten = true) const; /// can the contents of the inset be edited on screen ? // true for InsetCollapsables (not ButtonOnly) (not InsetInfo), InsetText @@ -349,12 +347,17 @@ public: // true for InsetTabular & InsetText virtual bool isActive() const { return nargs() > 0; } /// can we click at the specified position ? - virtual bool clickable(int, int) const { return false; } + virtual bool clickable(BufferView const &, int, int) const { return false; } /// Move one cell backwards - virtual bool allowsCaptionVariation() const { return false; } + virtual bool allowsCaptionVariation(std::string const &) const { return false; } + // true for insets that have a table structure (InsetMathGrid, InsetTabular) + virtual bool isTable() const { return false; } /// does this contain text that can be change track marked in DVI? virtual bool canTrackChanges() const { return false; } + /// Will this inset paint its own change tracking status (in the parent + /// paragraph) or will it let RowPainter handle it? + virtual bool canPaintChange(BufferView const &) const { return false; } /// return true if the inset should be removed automatically virtual bool autoDelete() const; @@ -404,12 +407,19 @@ public: { return true; } /// Is the width forced to some value? virtual bool hasFixedWidth() const { return false; } + /// if this inset has paragraphs should they be forced to use a + /// local font language switch? + virtual bool forceLocalFontSwitch() const { return false; } /// Is the content of this inset part of the output document? virtual bool producesOutput() const { return true; } + /// Is the content of this inset part of the immediate (visible) text sequence? + virtual bool isPartOfTextSequence() const { return producesOutput(); } /// \return Tool tip for this inset. - /// This default implementation returns an empty string. + /// This default implementation returns an empty string. This can be + /// either plain text or Qt html, and formatToolTip will be called + /// on it before display in both cases. virtual docstring toolTip(BufferView const & bv, int x, int y) const; /// \return Context menu identifier. This function determines @@ -437,8 +447,8 @@ public: /// is this equivalent to a space (which is BTW different from /// a line separator)? virtual bool isSpace() const { return false; } - /// is this an expandible space (rubber length)? - virtual bool isStretchableSpace() const { return false; } + /// does this inset try to use all available space (like \\hfill does)? + virtual bool isHfill() const { return false; } enum DisplayType { Inline = 0, @@ -496,7 +506,15 @@ public: /// Add an entry to the TocList /// Pass a DocIterator that points at the paragraph containing /// the inset - virtual void addToToc(DocIterator const & /* di */, bool /* output_active */) const {} + /// + /// \param output_active : is the inset active or is it in an inactive + /// branch or a note? + /// + /// \param utype : is the toc being generated for use by the output + /// routines? + virtual void addToToc(DocIterator const & /* di */, + bool /* output_active */, + UpdateType /* utype*/) const {} /// Collect BibTeX information virtual void collectBibKeys(InsetIterator const &) const {} /// Update the counters of this inset and of its contents. @@ -511,7 +529,7 @@ public: /// returns LyX code associated with the inset. Used for TOC, ...) virtual InsetCode lyxCode() const { return NO_CODE; } - /// -1: text mode, 1: math mode, 0 undecided + /// enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE}; /// return text or mathmode if that is possible to determine virtual mode_type currentMode() const { return UNDECIDED_MODE; } @@ -534,17 +552,18 @@ public: /** * If this method returns true all explicitly set font attributes * are reset during editing operations. - * For copy/paste the operations the language is never changed, since + * For copy/paste operations the language is never changed, since * the language of a given text never changes if the text is * formatted differently, while other font attribues like size may * need to change if the text is copied from one environment to * another one. - * If it returns false no font attribute is reset. - * The default implementation returns the negation of inheritFont(), + * If this method returns false no font attribute is reset. + * The default implementation returns true if the resetFont layout + * tag is set and otherwise the negation of inheritFont(), * since inherited inset font attributes do not need to be changed, * and non-inherited ones need to be set explicitly. */ - virtual bool resetFontEdit() const { return !inheritFont(); } + virtual bool resetFontEdit() const; /// set the change for the entire inset virtual void setChange(Change const &) {} @@ -553,8 +572,6 @@ public: /// reject the changes within the inset virtual void rejectChanges() {} - /// - virtual Dimension const dimension(BufferView const &) const; /// virtual ColorCode backgroundColor(PainterInfo const &) const; ///