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"
20 #include "insets/InsetLayout.h"
32 A text inset is like a TeX box to write full text
33 (including styles and other insets) in a given space.
35 class InsetText : public Inset {
42 /// \param useplain whether to use the plain layout
43 /// This is needed because we cannot call the virtual function
44 /// usePlainLayout() from within the constructor.
45 explicit InsetText(Buffer * buffer, UsePlain type = DefaultLayout);
47 InsetText(InsetText const &);
49 void setBuffer(Buffer &);
52 Dimension const dimension(BufferView const &) const;
54 /// empty inset to empty par
57 void read(Lexer & lex);
59 void write(std::ostream & os) const;
61 void metrics(MetricsInfo & mi, Dimension & dim) const;
63 void draw(PainterInfo & pi, int x, int y) const;
65 bool editable() const { return true; }
67 bool canTrackChanges() const { return true; }
69 InsetText * asInsetText() { return this; }
71 InsetText const * asInsetText() const { return this; }
73 Text & text() { return text_; }
74 Text const & text() const { return text_; }
76 int latex(odocstream &, OutputParams const &) const;
78 int plaintext(odocstream &, OutputParams const &) const;
80 int docbook(odocstream &, OutputParams const &) const;
82 docstring xhtml(XHTMLStream &, OutputParams const &) const;
92 docstring insetAsXHTML(XHTMLStream &, OutputParams const &,
94 // FIXME XHTMLStream to be removed
95 docstring xhtml(odocstream &, OutputParams const &) const
96 { return docstring (); }
98 void validate(LaTeXFeatures & features) const;
100 /// return x,y of given position relative to the inset's baseline
101 void cursorPos(BufferView const & bv, CursorSlice const & sl,
102 bool boundary, int & x, int & y) const;
104 InsetCode lyxCode() const { return TEXT_CODE; }
106 void setText(docstring const &, Font const &, bool trackChanges);
108 void setAutoBreakRows(bool);
110 bool getAutoBreakRows() const { return text_.autoBreakRows_; }
112 void setDrawFrame(bool);
114 ColorCode frameColor() const;
116 void setFrameColor(ColorCode);
118 bool showInsetDialog(BufferView *) const;
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 /// set the change for the entire inset
130 void setChange(Change const & change);
131 /// accept the changes within the inset
132 void acceptChanges();
133 /// reject the changes within the inset
134 void rejectChanges();
136 /// append text onto the existing text
137 void appendParagraphs(ParagraphList &);
140 void addPreview(graphics::PreviewLoader &) const;
143 void edit(Cursor & cur, bool front, EntryDirection entry_from);
145 Inset * editXY(Cursor & cur, int x, int y);
147 /// number of cells in this inset
148 size_t nargs() const { return 1; }
150 ParagraphList & paragraphs();
152 ParagraphList const & paragraphs() const;
154 bool insetAllowed(InsetCode) const { return !getLayout().isPassThru(); }
155 /// Allow spellchecking, except for insets with latex_language
156 bool allowSpellCheck() const { return !getLayout().isPassThru(); }
158 virtual bool isMacroScope() const { return false; }
160 virtual bool allowMultiPar() const { return getLayout().isMultiPar(); }
162 /// should paragraphs be forced to use the empty layout?
163 virtual bool forcePlainLayout(idx_type = 0) const
164 { return getLayout().forcePlainLayout(); }
165 /// should the user be allowed to customize alignment, etc.?
166 virtual bool allowParagraphCustomization(idx_type = 0) const
167 { return getLayout().allowParagraphCustomization(); }
169 /// Update the counters of this inset and of its contents
170 virtual void updateLabels(ParIterator const &);
171 /// the string that is passed to the TOC
172 void tocString(odocstream &) const;
174 void addToToc(DocIterator const &);
176 Inset * clone() const { return new InsetText(*this); }
178 bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
181 bool completionSupported(Cursor const &) const;
183 bool inlineCompletionSupported(Cursor const & cur) const;
185 bool automaticInlineCompletion() const;
187 bool automaticPopupCompletion() const;
189 bool showCompletionCursor() const;
191 CompletionList const * createCompletionList(Cursor const & cur) const;
193 docstring completionPrefix(Cursor const & cur) const;
195 bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
197 void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
200 virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
202 void doDispatch(Cursor & cur, FuncRequest & cmd);
205 InsetCaption const * getCaptionInset() const;
207 docstring getCaptionText(OutputParams const &) const;
209 docstring getCaptionHTML(OutputParams const &) const;
212 void initParagraphs(UsePlain type);
214 void setParagraphOwner();
218 ColorCode frame_color_;
220 mutable pit_type old_pit;