* 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.
*/
#include "ColorCode.h"
#include "Text.h"
-#include "support/types.h"
+#include "insets/InsetLayout.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;
/// 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; }
///
///
InsetText const * asInsetText() const { return this; }
///
- int latex(Buffer const &, odocstream &, OutputParams const &) const;
+ Text & text() { return text_; }
+ Text const & text() const { return text_; }
+ ///
+ int latex(odocstream &, OutputParams const &) const;
+ ///
+ int plaintext(odocstream &, OutputParams const &) 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;
+ // FIXME XHTMLStream to be removed
+ docstring xhtml(odocstream &, OutputParams const &) const
+ { return docstring (); }
///
void validate(LaTeXFeatures & features) const;
///
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);
///
ParagraphList const & paragraphs() const;
///
- bool insetAllowed(InsetCode) const { return true; }
+ bool insetAllowed(InsetCode) const { return !getLayout().isPassThru(); }
+ /// Allow spellchecking, except for insets with latex_language
+ bool allowSpellCheck() const { return !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(); }
- // 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 updateLabels(ParIterator const &, bool);
+ /// the string that is passed to the TOC
+ void tocString(odocstream &) const;
+ ///
+ void addToToc(DocIterator const &);
+ ///
+ Inset * clone() const { return new InsetText(*this); }
///
- virtual Inset * clone() const;
+ bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
///
bool completionSupported(Cursor const &) const;
///
bool automaticPopupCompletion() const;
///
- CompletionListPtr completionList(Cursor const & cur) const;
+ bool showCompletionCursor() const;
+ ///
+ CompletionList const * createCompletionList(Cursor const & cur) const;
///
docstring completionPrefix(Cursor const & cur) const;
///
///
void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
+ ///
+ virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
+ ///
+ void doDispatch(Cursor & cur, FuncRequest & cmd);
protected:
///
- virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
-
+ InsetCaption const * getCaptionInset() const;
+ ///
+ docstring getCaptionText(OutputParams const &) const;
+ ///
+ docstring getCaptionHTML(OutputParams const &) const;
private:
+ ///
+ void initParagraphs(UsePlain type);
///
void setParagraphOwner();
///
ColorCode frame_color_;
///
mutable pit_type old_pit;
- ///
- docstring previousWord(Buffer const & buffer, CursorSlice const & sl) const;
-
-public:
///
mutable Text text_;
};
+
+InsetText::XHTMLOptions operator|(InsetText::XHTMLOptions a1, InsetText::XHTMLOptions a2);
+
} // namespace lyx
#endif
projects / lyx.git / blobdiff