X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInset.h;h=b1070d8a33d051b960568dbeb03e36f5be75084e;hb=25ef8e7eef8dfb2b6d6d4f2935ae6775ebf2ba60;hp=fca566f29daab1a3b9eecf656fd44ef77ca0f673;hpb=14015ec434f7dd90ebd72b2db3812e31fba040b6;p=lyx.git diff --git a/src/insets/Inset.h b/src/insets/Inset.h index fca566f29d..b1070d8a33 100644 --- a/src/insets/Inset.h +++ b/src/insets/Inset.h @@ -17,7 +17,8 @@ #include "ColorCode.h" #include "InsetCode.h" -#include "Layout.h" +#include "InsetLayout.h" +#include "LayoutEnums.h" #include "OutputEnums.h" #include "support/strfwd.h" @@ -56,6 +57,7 @@ class ParIterator; class Text; class TocList; class XHTMLStream; +class otexstream; namespace graphics { class PreviewLoader; } @@ -69,6 +71,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 +86,7 @@ public: enum EntryDirection { ENTRY_DIRECTION_IGNORE, ENTRY_DIRECTION_RIGHT, - ENTRY_DIRECTION_LEFT, + ENTRY_DIRECTION_LEFT }; /// typedef ptrdiff_t difference_type; @@ -119,10 +123,7 @@ public: /** * This is typically used after this inset is created interactively. * Intented purpose is to sanitize internal state with regard to current - * Buffer. The default implementation calls buffer().updateBuffer() if - * the inset is labeled. - * - * \sa isLabeled() + * Buffer. **/ virtual void initView() {}; /// \return true if this inset is labeled. @@ -226,6 +227,8 @@ public: virtual bool allowEmpty() const; /// Force inset into LTR environment if surroundings are RTL virtual bool forceLTR() const; + /// whether to include this inset in the strings generated for the TOC + virtual bool isInToc() const; /// Where should we go when we press the up or down cursor key? virtual bool idxUpDown(Cursor & cur, bool up) const; @@ -280,12 +283,14 @@ public: /// Returns true if cursor is now invalid, e.g. if former /// insets in higher cursor slices of \c old do not exist /// anymore. - /// \c cur is the new cursor, some slice points to this. Use the update flags to cause a redraw. + /// \c cur is the new cursor, some slice points to this. Use the update + /// flags to cause a redraw. virtual bool notifyCursorEnters(Cursor & /*cur*/) { return false; } /// is called when the mouse enters or leaves this inset /// return true if this inset needs a repaint - virtual bool setMouseHover(BufferView const *, bool) { return false; } + virtual bool setMouseHover(BufferView const *, bool) const + { return false; } /// return true if this inset is hovered (under mouse) /// This is by now only used by mathed to draw corners /// (Inset::drawMarkers() and Inset::drawMarkers2()). @@ -318,8 +323,15 @@ public: /// normal stream, and which will in fact be written after the current /// paragraph closes. this is appropriate e.g. for floats. virtual docstring xhtml(XHTMLStream & xs, OutputParams const &) const; - /// 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 forToc(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 @@ -333,6 +345,8 @@ public: /// FIXME: merge with editable() // 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; } /// does this contain text that can be change track marked in DVI? virtual bool canTrackChanges() const { return false; } @@ -381,7 +395,8 @@ public: virtual bool forcePlainLayout(idx_type = 0) const { return false; } /// if this inset has paragraphs should the user be allowed to /// customize alignment, etc? - virtual bool allowParagraphCustomization(idx_type = 0) const { return true; } + virtual bool allowParagraphCustomization(idx_type = 0) const + { return true; } /// Is the width forced to some value? virtual bool hasFixedWidth() const { return false; } @@ -392,26 +407,27 @@ public: /// This default implementation returns an empty string. virtual docstring toolTip(BufferView const & bv, int x, int y) const; + /// \return Context menu identifier. This function determines + /// whose Inset's menu should be shown for the given position. + 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 contextMenu(BufferView const & bv, int x, int y) 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)? @@ -444,9 +460,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; /// @@ -474,10 +489,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 &) 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. @@ -501,14 +517,29 @@ 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 noFontChange() const { return false; } + virtual bool inheritFont() const { return true; } + /** + * 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 + * 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(), + * 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(); } /// set the change for the entire inset virtual void setChange(Change const &) {} @@ -520,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;