X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInset.h;h=5fcc892dba96cd2a8417f806434e4ad5f9afc708;hb=d044d6afa7192b2119784e1415e71dad644bc335;hp=85a1360c2c30fc1b7540a7779afa7a0eb1d850c8;hpb=e7f2bbe1eec4752ae2c88481bd77320186bbb8fb;p=lyx.git diff --git a/src/insets/Inset.h b/src/insets/Inset.h index 85a1360c2c..5fcc892dba 100644 --- a/src/insets/Inset.h +++ b/src/insets/Inset.h @@ -17,12 +17,15 @@ #include "ColorCode.h" #include "InsetCode.h" +#include "InsetLayout.h" #include "LayoutEnums.h" #include "OutputEnums.h" #include "support/strfwd.h" #include "support/types.h" +#include + namespace lyx { @@ -56,6 +59,7 @@ class ParIterator; class Text; class TocList; class XHTMLStream; +class otexstream; namespace graphics { class PreviewLoader; } @@ -69,6 +73,8 @@ std::string insetName(InsetCode); /// returns the Inset name corresponding to the \c InsetCode. /// Eg, insetDisplayName(BRANCH_CODE) == _("Branch") docstring insetDisplayName(InsetCode); +/// +static int const TOC_ENTRY_LENGTH = 40; /// Common base class to all insets @@ -82,7 +88,7 @@ public: enum EntryDirection { ENTRY_DIRECTION_IGNORE, ENTRY_DIRECTION_RIGHT, - ENTRY_DIRECTION_LEFT, + ENTRY_DIRECTION_LEFT }; /// typedef ptrdiff_t difference_type; @@ -102,8 +108,6 @@ public: /// change associated Buffer virtual void setBuffer(Buffer & buffer); - /// remove the buffer reference - void resetBuffer() { setBuffer( *static_cast(0)); } /// retrieve associated Buffer virtual Buffer & buffer(); virtual Buffer const & buffer() const; @@ -121,7 +125,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; } @@ -257,10 +261,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 @@ -310,7 +310,8 @@ public: /// plain text output in ucs4 encoding /// return the number of characters; in case of multiple lines of /// output, add PLAINTEXT_NEWLINE to the number of chars in the last line - virtual int plaintext(odocstream &, OutputParams const &) const = 0; + virtual int plaintext(odocstringstream &, OutputParams const &, + size_t max_length = INT_MAX) const = 0; /// docbook output virtual int docbook(odocstream & os, OutputParams const &) const; /// XHTML output @@ -320,11 +321,14 @@ public: /// paragraph closes. this is appropriate e.g. for floats. virtual docstring xhtml(XHTMLStream & xs, OutputParams const &) const; - // FIXME This method is used for things other than generating strings - // for the TOC. E.g., it is called by Paragraph::asString() to get the - // contents of the inset. These two functions should be disentangled. - /// the string that is passed to the TOC - virtual void tocString(odocstream &) const {} + /// Writes a string representation of the inset to the odocstream. + /// This one should be called when you want the whole contents of + /// the inset. + virtual void toString(odocstream &) const {} + /// Appends a potentially abbreviated version of the inset to + /// \param str. Intended for use by the TOC. + virtual void forOutliner(docstring & str, + size_t maxlen = TOC_ENTRY_LENGTH) const; /// can the contents of the inset be edited on screen ? // true for InsetCollapsables (not ButtonOnly) (not InsetInfo), InsetText @@ -340,6 +344,8 @@ public: virtual bool isActive() const { return nargs() > 0; } /// can we click at the specified position ? virtual bool clickable(int, int) const { return false; } + /// Move one cell backwards + virtual bool allowsCaptionVariation(std::string const &) const { return false; } /// does this contain text that can be change track marked in DVI? virtual bool canTrackChanges() const { return false; } @@ -402,35 +408,31 @@ public: /// \return Context menu identifier. This function determines /// whose Inset's menu should be shown for the given position. - virtual docstring contextMenu(BufferView const & bv, int x, int y) const; + virtual std::string contextMenu(BufferView const & bv, int x, int y) const; /// \return Context menu identifier for this inset. /// This default implementation returns an empty string. - virtual docstring contextMenuName() const; + virtual std::string contextMenuName() const; - // FIXME This should really disappear in favor of - // docstring name() const { return from_ascii(insetName(lyxCode()))); } - // There's no reason to be using different names in different places. - // But to do this we would need to change the file format, since the names - // used there don't correspond to what is used here. - /// - virtual docstring name() const; + virtual docstring layoutName() const; /// virtual InsetLayout const & getLayout() const; + /// + virtual bool isPassThru() const { return getLayout().isPassThru(); } /// Is this inset's layout defined in the document's textclass? bool undefined() const; - /// used to toggle insets - /// is the inset open? - /// should this inset be handled like a normal charater + /// should this inset be handled like a normal character? + /// (a character can be a letter or punctuation) virtual bool isChar() const { return false; } /// is this equivalent to a letter? + /// (a letter is a character that is considered part of a word) virtual bool isLetter() const { return false; } /// 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, @@ -457,9 +459,8 @@ public: * Don't use a temporary stringstream if the final output is * supposed to go to a file. * \sa Buffer::writeLaTeXSource for the reason. - * \return the number of rows (\n's) of generated LaTeX code. */ - virtual int latex(odocstream &, OutputParams const &) const { return 0; } + virtual void latex(otexstream &, OutputParams const &) const {} /// returns true to override begin and end inset in file virtual bool directWrite() const; /// @@ -487,10 +488,11 @@ public: virtual void initUnicodeMath() const {} /// Add an entry to the TocList - /// pit is the ParConstIterator of the paragraph containing the inset - virtual void addToToc(DocIterator const &) {} - /// Fill keys with BibTeX information - virtual void fillWithBibKeys(BiblioInfo &, InsetIterator const &) const {} + /// Pass a DocIterator that points at the paragraph containing + /// the inset + virtual void addToToc(DocIterator const & /* di */, bool /* output_active */) const {} + /// Collect BibTeX information + virtual void collectBibKeys(InsetIterator const &) const {} /// Update the counters of this inset and of its contents. /// The boolean indicates whether we are preparing for output, e.g., /// of XHTML. @@ -514,14 +516,30 @@ public: /// returns whether this inset is allowed in other insets of given mode virtual bool allowedIn(mode_type) const { return true; } /** - * Is this inset allowed within a font change? - * - * FIXME: noFontChange means currently that the font change is closed - * in LaTeX before the inset, and that the contents of the inset - * will be in default font. This should be changed so that the inset - * changes the font again. + * The font is inherited from the parent for LaTeX export if this + * method returns true. No open font changes are closed in front of + * the inset for LaTeX export, and the font is inherited for all other + * exports as well as on screen. + * If this method returns false all open font changes are closed in + * front of the inset for LaTeX export. The default font is used + * inside the inset for all exports and on screen. + */ + virtual bool inheritFont() const { return true; } + /** + * If this method returns true all explicitly set font attributes + * are reset during editing operations. + * 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 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 noFontChange() const { return false; } + virtual bool resetFontEdit() const; /// set the change for the entire inset virtual void setChange(Change const &) {} @@ -533,8 +551,6 @@ public: /// virtual Dimension const dimension(BufferView const &) const; /// - int scroll() const { return 0; } - /// virtual ColorCode backgroundColor(PainterInfo const &) const; /// virtual ColorCode labelColor() const;