X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInset.h;h=ecd171dc45de302844373c860c378171d198f662;hb=f924ef29660af5afd22b96744a3e0bb128e1a58d;hp=50c05645ee85192c7082d71a2afa67f4d08412c4;hpb=821cffab63909ca1025539dc5bfecd4dca963f3a;p=lyx.git diff --git a/src/insets/Inset.h b/src/insets/Inset.h index 50c05645ee..ecd171dc45 100644 --- a/src/insets/Inset.h +++ b/src/insets/Inset.h @@ -17,11 +17,15 @@ #include "ColorCode.h" #include "InsetCode.h" -#include "Layout.h" +#include "InsetLayout.h" +#include "LayoutEnums.h" #include "OutputEnums.h" #include "support/strfwd.h" #include "support/types.h" +#include "support/FileNameList.h" + +#include namespace lyx { @@ -35,10 +39,13 @@ class Cursor; class CursorSlice; class Dimension; class DocIterator; +class Encoding; class FuncRequest; class FuncStatus; -class InsetCollapsable; +class InsetArgument; +class InsetCollapsible; class InsetCommand; +class InsetGraphics; class InsetIterator; class InsetLayout; class InsetList; @@ -54,8 +61,10 @@ class PainterInfo; class ParConstIterator; class ParIterator; class Text; +class TocBackend; class TocList; class XHTMLStream; +class otexstream; namespace graphics { class PreviewLoader; } @@ -69,6 +78,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 = 120; /// Common base class to all insets @@ -82,7 +93,7 @@ public: enum EntryDirection { ENTRY_DIRECTION_IGNORE, ENTRY_DIRECTION_RIGHT, - ENTRY_DIRECTION_LEFT, + ENTRY_DIRECTION_LEFT }; /// typedef ptrdiff_t difference_type; @@ -102,26 +113,26 @@ 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; + Buffer & buffer(); + Buffer const & buffer() const; /// Returns true if buffer_ actually points to a Buffer that has /// been loaded into LyX and is still open. Note that this will - /// always return false for cloned Buffers. + /// always return false for cloned Buffers. If you want to allow + /// for the case of cloned Buffers, use isBufferValid(). bool isBufferLoaded() const; + /// Returns true if this is a loaded buffer or a cloned buffer. + bool isBufferValid() const; /// initialize view for this inset. /** * 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(); + virtual void initView() {} /// \return true if this inset is labeled. virtual bool isLabeled() const { return false; } @@ -135,10 +146,10 @@ public: virtual InsetText * asInsetText() { return 0; } /// is this inset based on the InsetText class? virtual InsetText const * asInsetText() const { return 0; } - /// is this inset based on the InsetCollapsable class? - virtual InsetCollapsable * asInsetCollapsable() { return 0; } - /// is this inset based on the InsetCollapsable class? - virtual InsetCollapsable const * asInsetCollapsable() const { return 0; } + /// is this inset based on the InsetCollapsible class? + virtual InsetCollapsible * asInsetCollapsible() { return 0; } + /// is this inset based on the InsetCollapsible class? + virtual InsetCollapsible const * asInsetCollapsible() const { return 0; } /// is this inset based on the InsetTabular class? virtual InsetTabular * asInsetTabular() { return 0; } /// is this inset based on the InsetTabular class? @@ -147,6 +158,12 @@ public: virtual InsetCommand * asInsetCommand() { return 0; } /// is this inset based on the InsetCommand class? virtual InsetCommand const * asInsetCommand() const { return 0; } + /// is this inset based on the InsetArgument class? + virtual InsetArgument const * asInsetArgument() const { return nullptr; } + /// is this inset based on the InsetGraphics class? + virtual InsetGraphics * asInsetGraphics() { return 0; } + /// is this inset based on the InsetGraphics class? + virtual InsetGraphics const * asInsetGraphics() const { return 0; } /// the real dispatcher void dispatch(Cursor & cur, FuncRequest & cmd); @@ -173,13 +190,18 @@ public: FuncStatus & status) const; /// cursor enters - virtual void edit(Cursor & cur, bool front, + virtual void edit(Cursor & cur, bool front, EntryDirection entry_from = ENTRY_DIRECTION_IGNORE); - /// cursor enters + /// sets cursor recursively descending into nested editable insets + /** + \return the inset pointer if x,y is covering that inset + \param x,y are absolute screen coordinates. + */ + /// Note: this method must preserve the selection status. See: + /// https://www.mail-archive.com/lyx-devel@lists.lyx.org/msg199001.html virtual Inset * editXY(Cursor & cur, int x, int y); /// compute the size of the object returned in dim - /// \retval true if metrics changed. virtual void metrics(MetricsInfo & mi, Dimension & dim) const = 0; /// draw inset and update (xo, yo)-cache virtual void draw(PainterInfo & pi, int x, int y) const = 0; @@ -187,33 +209,30 @@ 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; /// draw two angular markers - void drawMarkers2(PainterInfo & pi, int x, int y) const; + virtual void drawMarkers(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; @@ -222,8 +241,10 @@ public: virtual bool isFreeSpacing() const; /// Don't eliminate empty paragraphs virtual bool allowEmpty() const; - /// Force inset into LTR environment if surroundings are RTL? + /// 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; @@ -256,10 +277,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 @@ -267,29 +284,31 @@ public: /// number of columns in gridlike structures virtual size_t ncols() const { return 0; } /// Is called when the cursor leaves this inset. - /// Returns true if cursor is now invalid, e.g. if former - /// insets in higher cursor slices of \c old do not exist + /// Returns true if cursor is now invalid, e.g. if former + /// insets in higher cursor slices of \c old do not exist /// anymore. /// \c old is the old cursor, the last slice points to this. /// \c cur is the new cursor. Use the update flags to cause a redraw. virtual bool notifyCursorLeaves(Cursor const & /*old*/, Cursor & /*cur*/) { return false; } /// Is called when the cursor enters this inset. - /// Returns true if cursor is now invalid, e.g. if former - /// insets in higher cursor slices of \c old do not exist + /// 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 enter or leave this inset - /// return true if this inset needs repaint - virtual bool setMouseHover(bool) { 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) const + { return false; } /// return true if this inset is hovered (under mouse) - /// This is by now only used by mathed to draw corners + /// This is by now only used by mathed to draw corners /// (Inset::drawMarkers() and Inset::drawMarkers2()). - /// Other insets do not have to redefine this function to + /// Other insets do not have to redefine this function to /// return the correct status of mouseHovered. - virtual bool mouseHovered() const { return false; } + virtual bool mouseHovered(BufferView const *) const { return false; } /// request "external features" virtual void validate(LaTeXFeatures &) const {} @@ -307,7 +326,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 @@ -316,24 +336,41 @@ 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 forOutliner(docstring & str, + size_t const maxlen = TOC_ENTRY_LENGTH, + bool const shorten = true) const; + + /// Can a cursor be put in there ? + /// Forced to false for insets that have hidden contents, like + /// InsetMathCommand and InsetInfo. + virtual bool isActive() const { return nargs() > 0; } /// can the contents of the inset be edited on screen ? - // true for InsetCollapsables (not ButtonOnly) (not InsetInfo), InsetText + // equivalent to isActive except for closed InsetCollapsible virtual bool editable() const; /// has the Inset settings that can be modified in a dialog ? virtual bool hasSettings() const; /// can we go further down on mouse click? - // true for InsetCaption, InsetCollapsables (not ButtonOnly), InsetTabular + /// true for InsetCaption, InsetCollapsibles (not ButtonOnly), InsetTabular virtual bool descendable(BufferView const &) const { return false; } - /// is this an inset that can be moved into? - /// 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(BufferView const &, int, int) const { return false; } + /// Move one cell backwards + 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; @@ -342,7 +379,7 @@ public: /// Returns true if the inset supports inline completions at the /// cursor position. In this case the completion might be stored /// in the BufferView's inlineCompletion property. - virtual bool inlineCompletionSupported(Cursor const & /*cur*/) const + virtual bool inlineCompletionSupported(Cursor const & /*cur*/) const { return false; } /// Return true if the inline completion should be automatic. virtual bool automaticInlineCompletion() const { return true; } @@ -353,7 +390,7 @@ public: /// Returns completion suggestions at cursor position. Return an /// null pointer if no completion is a available or possible. /// The caller is responsible to free the returned object! - virtual CompletionList const * createCompletionList(Cursor const &) const + virtual CompletionList const * createCompletionList(Cursor const &) const { return 0; } /// Returns the completion prefix to filter the suggestions for completion. /// This is only called if completionList returned a non-null list. @@ -362,16 +399,16 @@ public: /// The completion does not contain the prefix. If finished is true, the /// completion is final. If finished is false, completion might only be /// a partial completion. - virtual bool insertCompletion(Cursor & /*cur*/, - docstring const & /*completion*/, bool /*finished*/) + virtual bool insertCompletion(Cursor & /*cur*/, + docstring const & /*completion*/, bool /*finished*/) { return false; } /// Get the completion inset position and size - virtual void completionPosAndDim(Cursor const &, int & /*x*/, int & /*y*/, + virtual void completionPosAndDim(Cursor const &, int & /*x*/, int & /*y*/, Dimension & /*dim*/) const {} /// returns true if the inset can hold an inset of given type virtual bool insetAllowed(InsetCode) const { return false; } - /// should this inset use the empty layout by default rather than + /// should this inset use the empty layout by default rather than /// the standard layout? (default: only if that is forced.) virtual bool usePlainLayout() const { return forcePlainLayout(); } /// if this inset has paragraphs should they be forced to use the @@ -379,43 +416,56 @@ 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; } + /// if this inset has paragraphs should they be forced to use a + /// local font language switch? + virtual bool forceLocalFontSwitch() const { return false; } + /// Does the inset force a specific encoding? + virtual Encoding const * forcedEncoding(Encoding const *, Encoding const *) const + { return 0; } + /// 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 + /// 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)? 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, @@ -426,11 +476,13 @@ public: /// should we have a non-filled line before this inset? virtual DisplayType display() const { return Inline; } + /// indentation before this inset (only needed for displayed hull insets with fleqn option) + virtual int indent(BufferView const &) const { return 0; } /// virtual LyXAlignment contentAlignment() const { return LYX_ALIGN_NONE; } /// should we break lines after this inset? virtual bool isLineSeparator() const { return false; } - /// should paragraph indendation be ommitted in any case? + /// should paragraph indendation be omitted in any case? virtual bool neverIndent() const { return false; } /// dumps content to lyxerr virtual void dump() const; @@ -442,9 +494,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; /// @@ -472,10 +523,22 @@ 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 + /// + /// \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? + /// + /// \param tocbackend : where to add the toc information. + virtual void addToToc(DocIterator const & /* di */, + bool /* output_active */, + UpdateType /* utype*/, + TocBackend & /* tocbackend */) const {} + /// Collect BibTeX information + virtual void collectBibKeys(InsetIterator const &, support::FileNameList &) const {} /// Update the counters of this inset and of its contents. /// The boolean indicates whether we are preparing for output, e.g., /// of XHTML. @@ -488,7 +551,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; } @@ -499,14 +562,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 &) {} @@ -515,10 +594,6 @@ public: /// reject the changes within the inset virtual void rejectChanges() {} - /// - virtual Dimension const dimension(BufferView const &) const; - /// - int scroll() const { return 0; } /// virtual ColorCode backgroundColor(PainterInfo const &) const; /// @@ -526,6 +601,10 @@ public: // enum { TEXT_TO_INSET_OFFSET = 4 }; + /// Determine the action of backspace and delete: do we select instead of + /// deleting if not already selected? + virtual bool confirmDeletion() const { return false; } + protected: /// Constructors Inset(Buffer * buf) : buffer_(buf) {} @@ -540,7 +619,7 @@ protected: * Gets normally called from Cursor::dispatch(). Cursor::dispatch() * assumes the common case of 'LFUN handled, need update'. * This has to be overriden by calling Cursor::undispatched() or - * Cursor::noUpdate() if appropriate. + * Cursor::noScreenUpdate() if appropriate. * If you need to call the dispatch method of some inset directly * you may have to explicitly request an update at that place. Don't * do it in doDispatch(), since that causes nested updates when