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(odocstream &, OutputParams const &) const;
84 void validate(LaTeXFeatures & features) const;
86 /// return x,y of given position relative to the inset's baseline
87 void cursorPos(BufferView const & bv, CursorSlice const & sl,
88 bool boundary, int & x, int & y) const;
90 InsetCode lyxCode() const { return TEXT_CODE; }
92 void setText(docstring const &, Font const &, bool trackChanges);
94 void setAutoBreakRows(bool);
96 bool getAutoBreakRows() const { return text_.autoBreakRows_; }
98 void setDrawFrame(bool);
100 ColorCode frameColor() const;
102 void setFrameColor(ColorCode);
104 bool showInsetDialog(BufferView *) const;
106 Text * getText(int i) const {
107 return (i == 0) ? const_cast<Text*>(&text_) : 0;
110 virtual bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
113 void fixParagraphsFont();
115 /// set the change for the entire inset
116 void setChange(Change const & change);
117 /// accept the changes within the inset
118 void acceptChanges();
119 /// reject the changes within the inset
120 void rejectChanges();
122 /// append text onto the existing text
123 void appendParagraphs(ParagraphList &);
126 void addPreview(graphics::PreviewLoader &) const;
129 void edit(Cursor & cur, bool front, EntryDirection entry_from);
131 Inset * editXY(Cursor & cur, int x, int y);
133 /// number of cells in this inset
134 size_t nargs() const { return 1; }
136 ParagraphList & paragraphs();
138 ParagraphList const & paragraphs() const;
140 bool insetAllowed(InsetCode) const { return !getLayout().isPassThru(); }
141 /// Allow spellchecking, except for insets with latex_language
142 bool allowSpellCheck() const { return !getLayout().isPassThru(); }
144 virtual bool isMacroScope() const { return false; }
146 virtual bool allowMultiPar() const { return getLayout().isMultiPar(); }
148 /// should paragraphs be forced to use the empty layout?
149 virtual bool forcePlainLayout(idx_type = 0) const
150 { return getLayout().forcePlainLayout(); }
151 /// should the user be allowed to customize alignment, etc.?
152 virtual bool allowParagraphCustomization(idx_type = 0) const
153 { return getLayout().allowParagraphCustomization(); }
155 /// Update the counters of this inset and of its contents
156 virtual void updateLabels(ParIterator const &);
157 /// the string that is passed to the TOC
158 void tocString(odocstream &) const;
160 void addToToc(DocIterator const &);
162 Inset * clone() const { return new InsetText(*this); }
164 bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
167 bool completionSupported(Cursor const &) const;
169 bool inlineCompletionSupported(Cursor const & cur) const;
171 bool automaticInlineCompletion() const;
173 bool automaticPopupCompletion() const;
175 bool showCompletionCursor() const;
177 CompletionList const * createCompletionList(Cursor const & cur) const;
179 docstring completionPrefix(Cursor const & cur) const;
181 bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
183 void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
186 virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
188 void doDispatch(Cursor & cur, FuncRequest & cmd);
191 InsetCaption const * getCaptionInset() const;
193 docstring getCaptionText(OutputParams const &) const;
195 docstring getCaptionHTML(OutputParams const &) const;
198 void initParagraphs(UsePlain type);
200 void setParagraphOwner();
204 ColorCode frame_color_;
206 mutable pit_type old_pit;