X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetText.h;h=eb52bc81b66020c1e68de411a831d3f6d869a18e;hb=f365a650686cc27487f686a7803968df1f24e0b8;hp=ffd4bad18c9913d6425ecb5f7fcda588ba20e188;hpb=7a5576c13b6d19df50583ad650d19d89e07c4179;p=lyx.git diff --git a/src/insets/InsetText.h b/src/insets/InsetText.h index ffd4bad18c..eb52bc81b6 100644 --- a/src/insets/InsetText.h +++ b/src/insets/InsetText.h @@ -4,7 +4,7 @@ * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * - * \author Jürgen Vigna + * \author Jürgen Vigna * * Full author contact details are available in file CREDITS. */ @@ -19,13 +19,13 @@ namespace lyx { -class Buffer; -class BufferParams; -class BufferView; +class CompletionList; class CursorSlice; class Dimension; class ParagraphList; +class InsetCaption; class InsetTabular; +class TocBuilder; /** A text inset is like a TeX box to write full text @@ -33,17 +33,22 @@ class InsetTabular; */ class InsetText : public Inset { public: - /// - explicit InsetText(Buffer const & buffer); - /// - InsetText(); + enum UsePlain { + DefaultLayout, + PlainLayout + }; + /// \param buffer + /// \param useplain whether to use the plain layout + /// This is needed because we cannot call the virtual function + /// usePlainLayout() from within the constructor. + explicit InsetText(Buffer * buffer, UsePlain type = DefaultLayout); /// InsetText(InsetText const &); /// - void initParagraphs(Buffer const & buffer); + void setBuffer(Buffer &); /// - Dimension const dimension(BufferView const &) const; + Dimension const dimensionHelper(BufferView const &) const; /// empty inset to empty par void clear(); @@ -55,24 +60,46 @@ public: void metrics(MetricsInfo & mi, Dimension & dim) const; /// void draw(PainterInfo & pi, int x, int y) const; + /// Drawing background is handled in draw + virtual void drawBackground(PainterInfo &, int, int) const {} /// - docstring editMessage() const; - /// - EDITABLE editable() const { return HIGHLY_EDITABLE; } + bool editable() const { return true; } /// bool canTrackChanges() const { return true; } + /// Rely on RowPainter to draw the cue of inline insets. + bool canPaintChange(BufferView const &) const { return allowMultiPar(); } /// InsetText * asInsetText() { return this; } /// InsetText const * asInsetText() const { return this; } /// - int latex(odocstream &, OutputParams const &) const; + Text & text() { return text_; } + Text const & text() const { return text_; } + /// + void latex(otexstream &, OutputParams const &) const; /// - int plaintext(odocstream &, OutputParams const &) const; + int plaintext(odocstringstream & ods, OutputParams const & op, + size_t max_length = INT_MAX) const; /// int docbook(odocstream &, OutputParams const &) const; /// + docstring xhtml(XHTMLStream &, OutputParams const &) const; + /// + enum XHTMLOptions { + JustText = 0, + WriteOuterTag = 1, + WriteLabel = 2, + WriteInnerTag = 4, + WriteEverything = 7 + }; + /// + docstring insetAsXHTML(XHTMLStream &, OutputParams const &, + XHTMLOptions) const; + /// void validate(LaTeXFeatures & features) const; + + /// return the argument(s) only + void getArgs(otexstream & os, OutputParams const &, bool const post = false) const; /// return x,y of given position relative to the inset's baseline void cursorPos(BufferView const & bv, CursorSlice const & sl, @@ -82,36 +109,33 @@ public: /// void setText(docstring const &, Font const &, bool trackChanges); /// - void setAutoBreakRows(bool); - /// - bool getAutoBreakRows() const { return text_.autoBreakRows_; } - /// void setDrawFrame(bool); /// ColorCode frameColor() const; /// void setFrameColor(ColorCode); /// - bool showInsetDialog(BufferView *) const; - /// Text * getText(int i) const { return (i == 0) ? const_cast(&text_) : 0; } /// virtual bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const; + /// + void fixParagraphsFont(); + /// set the change for the entire inset void setChange(Change const & change); /// accept the changes within the inset - void acceptChanges(BufferParams const & bparams); + void acceptChanges(); /// reject the changes within the inset - void rejectChanges(BufferParams const & bparams); + void rejectChanges(); /// append text onto the existing text void appendParagraphs(ParagraphList &); /// - void addPreview(graphics::PreviewLoader &) const; + void addPreview(DocIterator const &, graphics::PreviewLoader &) const; /// void edit(Cursor & cur, bool front, EntryDirection entry_from); @@ -125,20 +149,35 @@ public: /// ParagraphList const & paragraphs() const; /// - bool insetAllowed(InsetCode) const { return true; } + bool insetAllowed(InsetCode) const; /// - bool allowSpellCheck() const { return true; } - /// - bool isTableCell() const; - /// should paragraph indendation be ommitted in any case? - bool neverIndent() const; + bool allowSpellCheck() const { return getLayout().spellcheck() && !getLayout().isPassThru(); } /// virtual bool isMacroScope() const { return false; } /// - virtual bool allowMultiPar() const { return true; } + virtual bool allowMultiPar() const { return getLayout().isMultiPar(); } + /// + /// should paragraphs be forced to use the empty layout? + virtual bool forcePlainLayout(idx_type = 0) const + { return getLayout().forcePlainLayout(); } + /// should the user be allowed to customize alignment, etc.? + virtual bool allowParagraphCustomization(idx_type = 0) const + { return getLayout().allowParagraphCustomization(); } + /// should paragraphs be forced to use a local font language switch? + virtual bool forceLocalFontSwitch() const + { return getLayout().forcelocalfontswitch(); } - // Update the counters of this inset and of its contents - void updateLabels(ParIterator const &); + /// Update the counters of this inset and of its contents + virtual void updateBuffer(ParIterator const &, UpdateType); + /// + void setMacrocontextPositionRecursive(DocIterator const & pos); + /// + void toString(odocstream &) const; + /// + void forOutliner(docstring &, size_t const, bool const) const; + /// + void addToToc(DocIterator const & di, bool output_active, + UpdateType utype, TocBackend & backend) const; /// Inset * clone() const { return new InsetText(*this); } /// @@ -153,6 +192,8 @@ public: /// bool automaticPopupCompletion() const; /// + bool showCompletionCursor() const; + /// CompletionList const * createCompletionList(Cursor const & cur) const; /// docstring completionPrefix(Cursor const & cur) const; @@ -160,27 +201,53 @@ public: bool insertCompletion(Cursor & cur, docstring const & s, bool finished); /// void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const; + /// returns the text to be used as tooltip + /// \param prefix: a string that will preced the tooltip, + /// e.g., "Index: ". + /// \param len: length of the resulting string + /// NOTE This routine is kind of slow. It's fine to use it within the + /// GUI, but definitely do not try to use it in updateBuffer or anything + /// of that sort. (Note: unnecessary internal copies have been removed + /// since the previous note. The efficiency would have to be assessed + /// again by profiling.) + docstring toolTipText(docstring prefix = empty_docstring(), + size_t len = 400) const; + + /// + std::string contextMenu(BufferView const &, int, int) const; /// - virtual docstring contextMenu(BufferView const & bv, int x, int y) const; + std::string contextMenuName() const; /// void doDispatch(Cursor & cur, FuncRequest & cmd); -private: + /// - void setParagraphOwner(); + bool confirmDeletion() const { return !text().empty(); } + +protected: + /// + void iterateForToc(DocIterator const & cdit, bool output_active, + UpdateType utype, TocBackend & backend) const; +private: + /// Open the toc item for paragraph pit. Returns the paragraph index where + /// it should end. + pit_type openAddToTocForParagraph(pit_type pit, + DocIterator const & dit, + bool output_active, + TocBackend & backend) const; + /// Close a toc item opened in start and closed in end + void closeAddToTocForParagraph(pit_type start, pit_type end, + TocBackend & backend) const; /// bool drawFrame_; /// ColorCode frame_color_; /// - mutable pit_type old_pit; - /// - docstring previousWord(CursorSlice const & sl) const; - -public: - /// - mutable Text text_; + Text text_; }; + +InsetText::XHTMLOptions operator|(InsetText::XHTMLOptions a1, InsetText::XHTMLOptions a2); + } // namespace lyx #endif