X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetText.h;h=1a6d123ac6981d98f116a26add9d18d956b1e4d6;hb=dae8555234f0e5c8358b91c307d91b219c664617;hp=ed748c7680714cf544fae3fd32ef7d1e9bd95ad2;hpb=8c2149d3aae6cea1e7c67fd561c120bfcfe2664a;p=lyx.git diff --git a/src/insets/InsetText.h b/src/insets/InsetText.h index ed748c7680..1a6d123ac6 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,31 +17,34 @@ #include "ColorCode.h" #include "Text.h" -#include "support/types.h" - namespace lyx { -class Buffer; -class BufferParams; -class BufferView; +class CompletionList; class CursorSlice; class Dimension; class ParagraphList; +class InsetCaption; class InsetTabular; - /** 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; @@ -49,17 +52,15 @@ public: /// 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; /// - virtual docstring const editMessage() const; - /// - EDITABLE editable() const { return HIGHLY_EDITABLE; } + bool editable() const { return true; } /// bool canTrackChanges() const { return true; } /// @@ -67,13 +68,33 @@ public: /// 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 docbook(odocstream &, OutputParams const &) const; /// - int plaintext(Buffer const &, odocstream &, OutputParams const &) const; + docstring xhtml(XHTMLStream &, OutputParams const &) const; /// - int docbook(Buffer const &, odocstream &, 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, @@ -93,26 +114,27 @@ public: /// 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); @@ -126,20 +148,35 @@ public: /// ParagraphList const & paragraphs() const; /// - bool insetAllowed(InsetCode) const { return true; } + bool insetAllowed(InsetCode) const; /// - bool allowSpellCheck() const { return true; } - /// should paragraph indendation be ommitted in any case? - bool neverIndent(Buffer const &) const; + bool allowSpellCheck() const { return getLayout().spellcheck() && !getLayout().isPassThru(); } /// - virtual bool isMacroScope(Buffer const &) const { return true; } + 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(); } - // 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); + /// + void toString(odocstream &) const; + /// + void forOutliner(docstring &, size_t) const; + /// + void addToToc(DocIterator const & di, bool output_active) const; /// - virtual Inset * clone() const; + Inset * clone() const { return new InsetText(*this); } + /// + bool notifyCursorLeaves(Cursor const & old, Cursor & cur); /// bool completionSupported(Cursor const &) const; @@ -150,6 +187,8 @@ public: /// bool automaticPopupCompletion() const; /// + bool showCompletionCursor() const; + /// CompletionList const * createCompletionList(Cursor const & cur) const; /// docstring completionPrefix(Cursor const & cur) const; @@ -157,28 +196,41 @@ 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 numlines: the number of lines in the tooltip + /// \param len: length of those lines + docstring toolTipText(docstring prefix = empty_docstring(), + size_t numlines = 5, size_t len = 80) 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); - -private: + InsetCaption const * getCaptionInset() const; /// - void setParagraphOwner(); + docstring getCaptionText(OutputParams const &) const; /// - bool drawFrame_; + docstring getCaptionHTML(OutputParams const &) const; /// - ColorCode frame_color_; + void iterateForToc(DocIterator const & cdit, bool output_active) const; +private: /// - mutable pit_type old_pit; + bool drawFrame_; /// - docstring previousWord(Buffer const & buffer, CursorSlice const & sl) const; - -public: + ColorCode frame_color_; /// mutable Text text_; }; + +InsetText::XHTMLOptions operator|(InsetText::XHTMLOptions a1, InsetText::XHTMLOptions a2); + } // namespace lyx #endif