X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetText.h;h=1a6d123ac6981d98f116a26add9d18d956b1e4d6;hb=dae8555234f0e5c8358b91c307d91b219c664617;hp=1c8d5468fe918845d069376f83cf73fec006364e;hpb=2e81620979b24c62831f5172852a01f63a19d2fc;p=lyx.git diff --git a/src/insets/InsetText.h b/src/insets/InsetText.h index 1c8d5468fe..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. */ @@ -19,13 +19,11 @@ namespace lyx { -class Buffer; -class BufferParams; -class BufferView; class CompletionList; class CursorSlice; class Dimension; class ParagraphList; +class InsetCaption; class InsetTabular; /** @@ -34,8 +32,15 @@ class InsetTabular; */ class InsetText : public Inset { public: - /// - explicit InsetText(Buffer const & buffer); + 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 &); /// @@ -55,9 +60,7 @@ public: /// void draw(PainterInfo & pi, int x, int y) const; /// - docstring editMessage() const; - /// - EDITABLE editable() const { return HIGHLY_EDITABLE; } + bool editable() const { return true; } /// bool canTrackChanges() const { return true; } /// @@ -68,13 +71,30 @@ public: Text & text() { return text_; } Text const & text() const { return text_; } /// - int latex(odocstream &, OutputParams const &) const; + 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, @@ -94,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(ParagraphList &); /// - void addPreview(graphics::PreviewLoader &) const; + void addPreview(DocIterator const &, graphics::PreviewLoader &) const; /// void edit(Cursor & cur, bool front, EntryDirection entry_from); @@ -127,18 +148,31 @@ public: /// ParagraphList const & paragraphs() const; /// - bool insetAllowed(InsetCode) const { return true; } + bool insetAllowed(InsetCode) const; /// - bool allowSpellCheck() const { return true; } + 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(); } - // 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 addToToc(DocIterator const &); + void forOutliner(docstring &, size_t) const; + /// + void addToToc(DocIterator const & di, bool output_active) const; /// Inset * clone() const { return new InsetText(*this); } /// @@ -162,26 +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; /// - virtual docstring contextMenu(BufferView const & bv, int x, int y) const; + std::string contextMenu(BufferView const &, int, int) const; + /// + std::string contextMenuName() const; /// void doDispatch(Cursor & cur, FuncRequest & cmd); -private: +protected: /// - void initParagraphs(); + InsetCaption const * getCaptionInset() const; /// - void setParagraphOwner(); + docstring getCaptionText(OutputParams const &) const; + /// + docstring getCaptionHTML(OutputParams const &) const; + /// + void iterateForToc(DocIterator const & cdit, bool output_active) const; +private: /// bool drawFrame_; /// ColorCode frame_color_; /// - mutable pit_type old_pit; - /// mutable Text text_; }; + +InsetText::XHTMLOptions operator|(InsetText::XHTMLOptions a1, InsetText::XHTMLOptions a2); + } // namespace lyx #endif