4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
17 #include "ColorCode.h"
30 A text inset is like a TeX box to write full text
31 (including styles and other insets) in a given space.
33 class InsetText : public Inset {
40 /// \param useplain whether to use the plain layout
41 /// This is needed because we cannot call the virtual function
42 /// usePlainLayout() from within the constructor.
43 explicit InsetText(Buffer * buffer, UsePlain type = DefaultLayout);
45 InsetText(InsetText const &);
47 void setBuffer(Buffer &);
50 Dimension const dimensionHelper(BufferView const &) const;
52 /// empty inset to empty par
55 void read(Lexer & lex);
57 void write(std::ostream & os) const;
59 void metrics(MetricsInfo & mi, Dimension & dim) const;
61 void draw(PainterInfo & pi, int x, int y) const;
62 /// Drawing background is handled in draw
63 virtual void drawBackground(PainterInfo &, int, int) const {}
65 bool editable() const { return true; }
67 bool canTrackChanges() const { return true; }
68 /// Rely on RowPainter to draw the cue of inline insets.
69 bool canPaintChange(BufferView const &) const { return allowMultiPar(); }
71 InsetText * asInsetText() { return this; }
73 InsetText const * asInsetText() const { return this; }
75 Text & text() { return text_; }
76 Text const & text() const { return text_; }
78 void latex(otexstream &, OutputParams const &) const;
80 int plaintext(odocstringstream & ods, OutputParams const & op,
81 size_t max_length = INT_MAX) const;
83 int docbook(odocstream &, OutputParams const &) const;
85 docstring xhtml(XHTMLStream &, OutputParams const &) const;
95 docstring insetAsXHTML(XHTMLStream &, OutputParams const &,
98 void validate(LaTeXFeatures & features) const;
100 /// return the argument(s) only
101 void getArgs(otexstream & os, OutputParams const &, bool const post = false) const;
103 /// return x,y of given position relative to the inset's baseline
104 void cursorPos(BufferView const & bv, CursorSlice const & sl,
105 bool boundary, int & x, int & y) const;
107 InsetCode lyxCode() const { return TEXT_CODE; }
109 void setText(docstring const &, Font const &, bool trackChanges);
111 void setDrawFrame(bool);
113 ColorCode frameColor() const;
115 void setFrameColor(ColorCode);
117 Text * getText(int i) const {
118 return (i == 0) ? const_cast<Text*>(&text_) : 0;
121 virtual bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
124 void fixParagraphsFont();
126 /// set the change for the entire inset
127 void setChange(Change const & change);
128 /// accept the changes within the inset
129 void acceptChanges();
130 /// reject the changes within the inset
131 void rejectChanges();
133 /// append text onto the existing text
134 void appendParagraphs(ParagraphList &);
137 void addPreview(DocIterator const &, graphics::PreviewLoader &) const;
140 void edit(Cursor & cur, bool front, EntryDirection entry_from);
142 Inset * editXY(Cursor & cur, int x, int y);
144 /// number of cells in this inset
145 size_t nargs() const { return 1; }
147 ParagraphList & paragraphs();
149 ParagraphList const & paragraphs() const;
151 bool insetAllowed(InsetCode) const;
153 bool allowSpellCheck() const { return getLayout().spellcheck() && !getLayout().isPassThru(); }
155 virtual bool isMacroScope() const { return false; }
157 virtual bool allowMultiPar() const { return getLayout().isMultiPar(); }
159 /// should paragraphs be forced to use the empty layout?
160 virtual bool forcePlainLayout(idx_type = 0) const
161 { return getLayout().forcePlainLayout(); }
162 /// should the user be allowed to customize alignment, etc.?
163 virtual bool allowParagraphCustomization(idx_type = 0) const
164 { return getLayout().allowParagraphCustomization(); }
165 /// should paragraphs be forced to use a local font language switch?
166 virtual bool forceLocalFontSwitch() const
167 { return getLayout().forcelocalfontswitch(); }
169 /// Update the counters of this inset and of its contents
170 virtual void updateBuffer(ParIterator const &, UpdateType);
172 void setMacrocontextPositionRecursive(DocIterator const & pos);
174 void toString(odocstream &) const;
176 void forOutliner(docstring &, size_t const, bool const) const;
178 void addToToc(DocIterator const & di, bool output_active,
179 UpdateType utype) const;
181 Inset * clone() const { return new InsetText(*this); }
183 bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
186 bool completionSupported(Cursor const &) const;
188 bool inlineCompletionSupported(Cursor const & cur) const;
190 bool automaticInlineCompletion() const;
192 bool automaticPopupCompletion() const;
194 bool showCompletionCursor() const;
196 CompletionList const * createCompletionList(Cursor const & cur) const;
198 docstring completionPrefix(Cursor const & cur) const;
200 bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
202 void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
203 /// returns the text to be used as tooltip
204 /// \param prefix: a string that will preced the tooltip,
206 /// \param len: length of the resulting string
207 /// NOTE This routine is kind of slow. It's fine to use it within the
208 /// GUI, but definitely do not try to use it in updateBuffer or anything
209 /// of that sort. (Note: unnecessary internal copies have been removed
210 /// since the previous note. The efficiency would have to be assessed
211 /// again by profiling.)
212 docstring toolTipText(docstring prefix = empty_docstring(),
213 size_t len = 400) const;
216 std::string contextMenu(BufferView const &, int, int) const;
218 std::string contextMenuName() const;
220 void doDispatch(Cursor & cur, FuncRequest & cmd);
223 void iterateForToc(DocIterator const & cdit, bool output_active,
224 UpdateType utype) const;
229 ColorCode frame_color_;
235 InsetText::XHTMLOptions operator|(InsetText::XHTMLOptions a1, InsetText::XHTMLOptions a2);