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"
31 A text inset is like a TeX box to write full text
32 (including styles and other insets) in a given space.
34 class InsetText : public Inset {
41 /// \param useplain whether to use the plain layout
42 /// This is needed because we cannot call the virtual function
43 /// usePlainLayout() from within the constructor.
44 explicit InsetText(Buffer * buffer, UsePlain type = DefaultLayout);
46 InsetText(InsetText const &);
48 void setBuffer(Buffer &);
51 Dimension const dimensionHelper(BufferView const &) const;
53 /// empty inset to empty par
56 void read(Lexer & lex);
58 void write(std::ostream & os) const;
60 void metrics(MetricsInfo & mi, Dimension & dim) const;
62 void draw(PainterInfo & pi, int x, int y) const;
63 /// Drawing background is handled in draw
64 virtual void drawBackground(PainterInfo &, int, int) const {}
66 bool editable() const { return true; }
68 bool canTrackChanges() const { return true; }
69 /// Rely on RowPainter to draw the cue of inline insets.
70 bool canPaintChange(BufferView const &) const { return allowMultiPar(); }
72 InsetText * asInsetText() { return this; }
74 InsetText const * asInsetText() const { return this; }
76 Text & text() { return text_; }
77 Text const & text() const { return text_; }
79 void latex(otexstream &, OutputParams const &) const;
81 int plaintext(odocstringstream & ods, OutputParams const & op,
82 size_t max_length = INT_MAX) const;
84 docstring xhtml(XMLStream &, OutputParams const &) const;
94 docstring insetAsXHTML(XMLStream &, OutputParams const &,
97 void docbook(XMLStream &, OutputParams const &, XHTMLOptions opts) const;
99 void docbook(XMLStream &, OutputParams const &) const;
101 void validate(LaTeXFeatures & features) const;
103 /// return the argument(s) only
104 void getArgs(otexstream & os, OutputParams const &, bool const post = false) const;
106 /// return x,y of given position relative to the inset's baseline
107 void cursorPos(BufferView const & bv, CursorSlice const & sl,
108 bool boundary, int & x, int & y) const;
110 InsetCode lyxCode() const { return TEXT_CODE; }
112 void setText(docstring const &, Font const &, bool trackChanges);
114 void setDrawFrame(bool);
116 ColorCode frameColor() const;
118 void setFrameColor(ColorCode);
120 Text * getText(int i) const {
121 return (i == 0) ? const_cast<Text*>(&text_) : 0;
124 virtual bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
127 void fixParagraphsFont();
129 /// does the inset contain changes ?
130 bool isChanged() const { return is_changed_; }
131 /// this is const because value is mutable
132 void isChanged(bool ic) const { is_changed_ = ic; }
133 /// set the change for the entire inset
134 void setChange(Change const & change);
135 /// accept the changes within the inset
136 void acceptChanges();
137 /// reject the changes within the inset
138 void rejectChanges();
140 /// append text onto the existing text
141 void appendParagraphs(ParagraphList &);
144 void addPreview(DocIterator const &, graphics::PreviewLoader &) const;
147 void edit(Cursor & cur, bool front, EntryDirection entry_from);
149 Inset * editXY(Cursor & cur, int x, int y);
151 /// number of cells in this inset
152 size_t nargs() const { return 1; }
154 ParagraphList & paragraphs();
156 ParagraphList const & paragraphs() const;
158 bool insetAllowed(InsetCode) const;
160 bool allowSpellCheck() const { return getLayout().spellcheck() && !getLayout().isPassThru(); }
162 virtual bool isMacroScope() const { return false; }
164 virtual bool allowMultiPar() const { return getLayout().isMultiPar(); }
166 bool isInTitle() const { return intitle_context_; }
168 /// should paragraphs be forced to use the empty layout?
169 virtual bool forcePlainLayout(idx_type = 0) const
170 { return getLayout().forcePlainLayout(); }
171 /// should the user be allowed to customize alignment, etc.?
172 virtual bool allowParagraphCustomization(idx_type = 0) const
173 { return getLayout().allowParagraphCustomization(); }
174 /// should paragraphs be forced to use a local font language switch?
175 virtual bool forceLocalFontSwitch() const
176 { return getLayout().forcelocalfontswitch(); }
178 /// Update the counters of this inset and of its contents
179 virtual void updateBuffer(ParIterator const &, UpdateType, bool const deleted = false);
181 void setMacrocontextPositionRecursive(DocIterator const & pos);
183 void toString(odocstream &) const;
185 void forOutliner(docstring &, size_t const, bool const) const;
187 void addToToc(DocIterator const & di, bool output_active,
188 UpdateType utype, TocBackend & backend) const;
190 Inset * clone() const { return new InsetText(*this); }
192 bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
195 bool completionSupported(Cursor const &) const;
197 bool inlineCompletionSupported(Cursor const & cur) const;
199 bool automaticInlineCompletion() const;
201 bool automaticPopupCompletion() const;
203 bool showCompletionCursor() const;
205 CompletionList const * createCompletionList(Cursor const & cur) const;
207 docstring completionPrefix(Cursor const & cur) const;
209 bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
211 void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
212 /// returns the text to be used as tooltip
213 /// \param prefix: a string that will precede the tooltip,
215 /// \param len: length of the resulting string
216 /// NOTE This routine is kind of slow. It's fine to use it within the
217 /// GUI, but definitely do not try to use it in updateBuffer or anything
218 /// of that sort. (Note: unnecessary internal copies have been removed
219 /// since the previous note. The efficiency would have to be assessed
220 /// again by profiling.)
221 docstring toolTipText(docstring prefix = empty_docstring(),
222 size_t len = 400) const;
225 std::string contextMenu(BufferView const &, int, int) const;
227 std::string contextMenuName() const;
229 void doDispatch(Cursor & cur, FuncRequest & cmd);
232 bool confirmDeletion() const { return !text().empty(); }
235 bool needsCProtection(bool const maintext = false,
236 bool const fragile = false) const;
238 bool hasCProtectContent(bool fragile = false) const;
242 void iterateForToc(DocIterator const & cdit, bool output_active,
243 UpdateType utype, TocBackend & backend) const;
245 /// Open the toc item for paragraph pit. Returns the paragraph index where
247 pit_type openAddToTocForParagraph(pit_type pit,
248 DocIterator const & dit,
250 TocBackend & backend) const;
251 /// Close a toc item opened in start and closed in end
252 void closeAddToTocForParagraph(pit_type start, pit_type end,
253 TocBackend & backend) const;
256 /// true if the inset contains change
257 mutable bool is_changed_;
259 bool intitle_context_;
261 ColorCode frame_color_;
267 InsetText::XHTMLOptions operator|(InsetText::XHTMLOptions a1, InsetText::XHTMLOptions a2);