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"
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 {
38 explicit InsetText(Buffer const & buffer);
40 InsetText(InsetText const &);
42 void setBuffer(Buffer &);
45 Dimension const dimension(BufferView const &) const;
47 /// empty inset to empty par
50 void read(Lexer & lex);
52 void write(std::ostream & os) const;
54 void metrics(MetricsInfo & mi, Dimension & dim) const;
56 void draw(PainterInfo & pi, int x, int y) const;
58 docstring editMessage() const;
60 EDITABLE editable() const { return HIGHLY_EDITABLE; }
62 bool canTrackChanges() const { return true; }
64 InsetText * asInsetText() { return this; }
66 InsetText const * asInsetText() const { return this; }
68 Text & text() { return text_; }
69 Text const & text() const { return text_; }
71 int latex(odocstream &, OutputParams const &) const;
73 int plaintext(odocstream &, OutputParams const &) const;
75 int docbook(odocstream &, OutputParams const &) const;
77 void validate(LaTeXFeatures & features) const;
79 /// return x,y of given position relative to the inset's baseline
80 void cursorPos(BufferView const & bv, CursorSlice const & sl,
81 bool boundary, int & x, int & y) const;
83 InsetCode lyxCode() const { return TEXT_CODE; }
85 void setText(docstring const &, Font const &, bool trackChanges);
87 void setAutoBreakRows(bool);
89 bool getAutoBreakRows() const { return text_.autoBreakRows_; }
91 void setDrawFrame(bool);
93 ColorCode frameColor() const;
95 void setFrameColor(ColorCode);
97 bool showInsetDialog(BufferView *) const;
99 Text * getText(int i) const {
100 return (i == 0) ? const_cast<Text*>(&text_) : 0;
103 virtual bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
105 /// set the change for the entire inset
106 void setChange(Change const & change);
107 /// accept the changes within the inset
108 void acceptChanges(BufferParams const & bparams);
109 /// reject the changes within the inset
110 void rejectChanges(BufferParams const & bparams);
112 /// append text onto the existing text
113 void appendParagraphs(ParagraphList &);
116 void addPreview(graphics::PreviewLoader &) const;
119 void edit(Cursor & cur, bool front, EntryDirection entry_from);
121 Inset * editXY(Cursor & cur, int x, int y);
123 /// number of cells in this inset
124 size_t nargs() const { return 1; }
126 ParagraphList & paragraphs();
128 ParagraphList const & paragraphs() const;
130 bool insetAllowed(InsetCode) const { return true; }
132 bool allowSpellCheck() const { return true; }
134 virtual bool isMacroScope() const { return false; }
136 virtual bool allowMultiPar() const { return true; }
138 // Update the counters of this inset and of its contents
139 void updateLabels(ParIterator const &);
141 void addToToc(DocIterator const &);
143 Inset * clone() const { return new InsetText(*this); }
145 bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
148 bool completionSupported(Cursor const &) const;
150 bool inlineCompletionSupported(Cursor const & cur) const;
152 bool automaticInlineCompletion() const;
154 bool automaticPopupCompletion() const;
156 bool showCompletionCursor() const;
158 CompletionList const * createCompletionList(Cursor const & cur) const;
160 docstring completionPrefix(Cursor const & cur) const;
162 bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
164 void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
167 virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
169 void doDispatch(Cursor & cur, FuncRequest & cmd);
172 void initParagraphs(BufferParams const &);
174 void setParagraphOwner();
178 ColorCode frame_color_;
180 mutable pit_type old_pit;