X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInset.h;h=ab35584e126c06a830b3cee11fa294ec4008c474;hb=62af7ee772f16f154225d2d0b65d77f4376b6001;hp=0922b4a3f485081e88570bd9d27316ec9eec4800;hpb=2de30c62f8d671a8c8d4d52a6a7310e2c5ca84de;p=lyx.git diff --git a/src/insets/Inset.h b/src/insets/Inset.h index 0922b4a3f4..ab35584e12 100644 --- a/src/insets/Inset.h +++ b/src/insets/Inset.h @@ -20,9 +20,11 @@ #include "InsetLayout.h" #include "LayoutEnums.h" #include "OutputEnums.h" +#include "OutputParams.h" #include "support/strfwd.h" #include "support/types.h" +#include "support/FileNameList.h" #include @@ -38,10 +40,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; @@ -57,6 +62,7 @@ class PainterInfo; class ParConstIterator; class ParIterator; class Text; +class TocBackend; class TocList; class XHTMLStream; class otexstream; @@ -111,8 +117,8 @@ public: /// 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. If you want to allow @@ -125,7 +131,7 @@ public: /** * This is typically used after this inset is created interactively. * Intented purpose is to sanitize internal state with regard to current - * Buffer. + * Buffer. **/ virtual void initView() {} /// \return true if this inset is labeled. @@ -141,10 +147,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? @@ -153,6 +159,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); @@ -179,11 +191,28 @@ 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); + /// The default margin inside text insets + static int textOffset(BufferView const *) { return 4; } + /// + virtual int topOffset(BufferView const *bv) const { return textOffset(bv); } + /// + virtual int bottomOffset(BufferView const *bv) const { return textOffset(bv); } + /// + virtual int leftOffset(BufferView const *bv) const { return textOffset(bv); } + /// + virtual int rightOffset(BufferView const *bv) const { return textOffset(bv); } + /// compute the size of the object returned in dim virtual void metrics(MetricsInfo & mi, Dimension & dim) const = 0; /// draw inset and update (xo, yo)-cache @@ -198,17 +227,15 @@ public: /// 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; @@ -227,7 +254,7 @@ public: /// Don't eliminate empty paragraphs virtual bool allowEmpty() const; /// Force inset into LTR environment if surroundings are RTL - virtual bool forceLTR() const; + virtual bool forceLTR(OutputParams const &) const; /// whether to include this inset in the strings generated for the TOC virtual bool isInToc() const; @@ -269,16 +296,16 @@ 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. @@ -289,9 +316,9 @@ public: 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(BufferView const *) const { return false; } @@ -332,18 +359,18 @@ public: 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 @@ -364,7 +391,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; } @@ -375,7 +402,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. @@ -384,16 +411,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 @@ -408,6 +435,14 @@ public: /// if this inset has paragraphs should they be forced to use a /// local font language switch? virtual bool forceLocalFontSwitch() const { return false; } + /// if this inset has paragraphs should they be forced to use a + /// font language switch that switches paragraph directions + /// (relevant with polyglossia only)? + virtual bool forceParDirectionSwitch() 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; } @@ -419,7 +454,7 @@ public: /// 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; @@ -448,6 +483,8 @@ public: /// does this inset try to use all available space (like \\hfill does)? virtual bool isHfill() const { return false; } + virtual OutputParams::CtObject CtObject(OutputParams const &) const { return OutputParams::CT_NORMAL; } + enum DisplayType { Inline = 0, AlignLeft, @@ -457,11 +494,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; @@ -510,11 +549,14 @@ public: /// /// \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*/) const {} + UpdateType /* utype*/, + TocBackend & /* tocbackend */) const {} /// Collect BibTeX information - virtual void collectBibKeys(InsetIterator const &) const {} + 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. @@ -563,6 +605,8 @@ public: */ virtual bool resetFontEdit() const; + /// does the inset contain changes ? + virtual bool isChanged() const { return false; } /// set the change for the entire inset virtual void setChange(Change const &) {} /// accept the changes within the inset @@ -570,12 +614,17 @@ public: /// reject the changes within the inset virtual void rejectChanges() {} + /// + virtual bool needsCProtection(bool const, bool const) const { return false; } + /// virtual ColorCode backgroundColor(PainterInfo const &) const; /// virtual ColorCode labelColor() const; - // - 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