* 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.
*/
#define INSETTEXT_H
#include "Inset.h"
-#include "Font.h"
-#include "Text.h"
-
-#include "support/types.h"
-
-#include "frontends/mouse_state.h"
+#include "ColorCode.h"
+#include "Text.h"
namespace lyx {
-class Buffer;
-class BufferParams;
-class BufferView;
+class CompletionList;
class CursorSlice;
class Dimension;
-class Color_color;
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:
+ 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 &);
///
- explicit InsetText(BufferParams const &);
+ void setBuffer(Buffer &);
+
///
- InsetText();
+ 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;
///
- bool metrics(MetricsInfo & mi, Dimension & dim) const;
+ void metrics(MetricsInfo & mi, Dimension & dim) const;
///
void draw(PainterInfo & pi, int x, int y) const;
- /// draw inset selection
- void drawSelection(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 * asTextInset() { return this; }
+ InsetText * asInsetText() { return this; }
+ ///
+ InsetText const * asInsetText() const { return this; }
+ ///
+ Text & text() { return text_; }
+ Text const & text() const { return text_; }
+ ///
+ void latex(otexstream &, OutputParams const &) const;
///
- InsetText const * asTextInset() const { return this; }
+ int plaintext(odocstringstream & ods, OutputParams const & op,
+ size_t max_length = INT_MAX) const;
///
- int latex(Buffer const &, odocstream &, OutputParams const &) 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,
bool boundary, int & x, int & y) const;
///
- Code lyxCode() const { return TEXT_CODE; }
+ InsetCode lyxCode() const { return TEXT_CODE; }
///
void setText(docstring const &, Font const &, bool trackChanges);
///
///
void setDrawFrame(bool);
///
- Color_color frameColor() const;
- ///
- void setFrameColor(Color_color);
+ ColorCode frameColor() const;
///
- bool showInsetDialog(BufferView *) const;
+ void setFrameColor(ColorCode);
///
Text * getText(int i) const {
return (i == 0) ? const_cast<Text*>(&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 left);
+ void edit(Cursor & cur, bool front, EntryDirection entry_from);
///
Inset * editXY(Cursor & cur, int x, int y);
///
ParagraphList const & paragraphs() const;
///
- bool insetAllowed(Code) 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(); }
///
- InsetText(InsetText const &);
-
- // Update the counters of this inset and of its contents
- virtual void updateLabels(Buffer const &, ParIterator const &);
+ virtual bool isMacroScope() const { return false; }
///
- virtual Inset * clone() const;
-
-protected:
+ virtual bool allowMultiPar() const { return getLayout().isMultiPar(); }
///
- virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
+ /// 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(); }
-private:
+ /// 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;
///
- void init();
+ Inset * clone() const { return new InsetText(*this); }
+ ///
+ bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
///
- bool drawFrame_;
- /** We store the Color::color value as an int to get Color.h out
- * of the header file.
- */
- int frame_color_;
+ bool completionSupported(Cursor const &) const;
+ ///
+ bool inlineCompletionSupported(Cursor const & cur) const;
+ ///
+ bool automaticInlineCompletion() const;
+ ///
+ bool automaticPopupCompletion() const;
+ ///
+ bool showCompletionCursor() const;
///
- mutable pit_type old_pit;
+ CompletionList const * createCompletionList(Cursor const & cur) const;
+ ///
+ docstring completionPrefix(Cursor const & cur) const;
+ ///
+ 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;
-public:
///
- mutable Text text_;
+ std::string contextMenu(BufferView const &, int, int) const;
+ ///
+ std::string contextMenuName() const;
///
- mutable Font font_;
+ void doDispatch(Cursor & cur, FuncRequest & cmd);
+protected:
+ ///
+ InsetCaption const * getCaptionInset() const;
+ ///
+ docstring getCaptionText(OutputParams const &) const;
+ ///
+ docstring getCaptionHTML(OutputParams const &) const;
+ ///
+ void iterateForToc(DocIterator const & cdit, bool output_active) const;
+private:
///
- static int border_;
+ bool drawFrame_;
+ ///
+ ColorCode frame_color_;
+ ///
+ mutable Text text_;
};
+
+InsetText::XHTMLOptions operator|(InsetText::XHTMLOptions a1, InsetText::XHTMLOptions a2);
+
} // namespace lyx
#endif
projects / lyx.git / blobdiff