X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetText.h;h=8c647fbff919e5d85bd64fdbf855ea05d01510ac;hb=239b9919ffe28338d789e6dc9122228f77ab77a7;hp=0101724cb1ae336ed1ca6277bc9acdd501a2d9f5;hpb=323e3b020742127d430a83a0dfa6d391a25f3cc8;p=lyx.git diff --git a/src/insets/InsetText.h b/src/insets/InsetText.h index 0101724cb1..8c647fbff9 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. */ @@ -17,66 +17,88 @@ #include "ColorCode.h" #include "Text.h" -#include "support/types.h" - -#include - namespace lyx { -class Buffer; -class BufferParams; -class BufferView; +class CompletionList; class CursorSlice; class Dimension; class ParagraphList; +class InsetCaption; class InsetTabular; -class WordList : public std::set {}; - /** A text inset is like a TeX box to write full text (including styles and other insets) in a given space. */ class InsetText : public Inset { public: - /// - explicit InsetText(BufferParams const &); - /// - 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 setBuffer(Buffer &); /// - Dimension const dimension(BufferView const &) const; + Dimension const dimensionHelper(BufferView const &) const; /// empty inset to empty par void clear(); /// - void read(Buffer const & buf, Lexer & lex); + void read(Lexer & lex); /// - void write(Buffer const & buf, std::ostream & os) const; + void write(std::ostream & os) const; /// 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 {} /// - virtual docstring const 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(Buffer const &, odocstream &, OutputParams const &) const; + Text & text() { return text_; } + Text const & text() const { return text_; } + /// + void latex(otexstream &, OutputParams const &) const; + /// + int plaintext(odocstringstream & ods, OutputParams const & op, + size_t max_length = INT_MAX) const; /// - int plaintext(Buffer const &, odocstream &, OutputParams const &) const; + int docbook(odocstream &, OutputParams const &) const; /// - int docbook(Buffer const &, 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, @@ -86,36 +108,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(Buffer * bp, ParagraphList &); + void appendParagraphs(ParagraphList &); /// - void addPreview(graphics::PreviewLoader &) const; + void addPreview(DocIterator const &, graphics::PreviewLoader &) const; /// void edit(Cursor & cur, bool front, EntryDirection entry_from); @@ -129,20 +148,39 @@ public: /// ParagraphList const & paragraphs() const; /// - bool insetAllowed(InsetCode) const { return true; } + bool insetAllowed(InsetCode) const; + /// + bool allowSpellCheck() const { return getLayout().spellcheck() && !getLayout().isPassThru(); } /// - bool allowSpellCheck() const { return true; } - /// should paragraph indendation be ommitted in any case? - bool neverIndent(Buffer const &) const; + virtual bool isMacroScope() const { return false; } /// - virtual bool isMacroScope(Buffer const &) const { return true; } + virtual bool allowMultiPar() const { return getLayout().isMultiPar(); } /// - virtual bool allowMultiPar() const { return true; } + /// 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 - virtual void updateLabels(Buffer const &, ParIterator const &); + /// Update the counters of this inset and of its contents + virtual void updateBuffer(ParIterator const &, UpdateType); + /// + void setMacrocontextPositionRecursive(DocIterator const & pos); /// - virtual Inset * clone() const; + void toString(odocstream &) const; + /// + void forOutliner(docstring &, size_t const, bool const) const; + /// + void addToToc(DocIterator const & di, bool output_active, + UpdateType utype) const; + /// + Inset * clone() const { return new InsetText(*this); } + /// + bool notifyCursorLeaves(Cursor const & old, Cursor & cur); /// bool completionSupported(Cursor const &) const; @@ -153,6 +191,8 @@ public: /// bool automaticPopupCompletion() const; /// + bool showCompletionCursor() const; + /// CompletionList const * createCompletionList(Cursor const & cur) const; /// docstring completionPrefix(Cursor const & cur) const; @@ -160,28 +200,47 @@ 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; + /// + std::string contextMenuName() const; + /// + void doDispatch(Cursor & cur, FuncRequest & cmd); protected: /// - virtual void doDispatch(Cursor & cur, FuncRequest & cmd); - + void iterateForToc(DocIterator const & cdit, bool output_active, + UpdateType utype) const; private: - /// - void setParagraphOwner(); + /// 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) const; + /// Close a toc item opened in start and closed in end + void closeAddToTocForParagraph(pit_type start, pit_type end) const; /// bool drawFrame_; /// ColorCode frame_color_; /// - mutable pit_type old_pit; - /// - docstring previousWord(Buffer const & buffer, CursorSlice const & sl) const; - -public: - /// - mutable Text text_; + Text text_; }; + +InsetText::XHTMLOptions operator|(InsetText::XHTMLOptions a1, InsetText::XHTMLOptions a2); + } // namespace lyx #endif