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.
16 #include "RowList_fwd.h"
20 #include "support/types.h"
22 #include "frontends/mouse_state.h"
37 A text inset is like a TeX box to write full text
38 (including styles and other insets) in a given space.
40 class InsetText : public InsetOld {
43 explicit InsetText(BufferParams const &);
47 /// empty inset to empty par
50 void read(Buffer const & buf, Lexer & lex);
52 void write(Buffer const & buf, std::ostream & os) const;
54 bool metrics(MetricsInfo & mi, Dimension & dim) const;
56 void draw(PainterInfo & pi, int x, int y) const;
57 /// draw inset selection
58 void drawSelection(PainterInfo & pi, int x, int y) const;
59 /// are we inside the area covered by the inset?
60 virtual bool covers(BufferView const & bv, int x, int y) const;
62 virtual docstring const editMessage() const;
64 EDITABLE editable() const { return HIGHLY_EDITABLE; }
66 bool canTrackChanges() const { return true; }
68 InsetText const * asTextInset() const { return this; }
70 int latex(Buffer const &, odocstream &, OutputParams const &) const;
72 int plaintext(Buffer const &, odocstream &, OutputParams const &) const;
74 int docbook(Buffer const &, odocstream &, OutputParams const &) const;
76 void validate(LaTeXFeatures & features) const;
78 /// return x,y of given position relative to the inset's baseline
79 void cursorPos(BufferView const & bv, CursorSlice const & sl,
80 bool boundary, int & x, int & y) const;
82 Code lyxCode() const { return TEXT_CODE; }
84 void setText(docstring const &, LyXFont const &, bool trackChanges);
86 void setAutoBreakRows(bool);
88 bool getAutoBreakRows() const { return text_.autoBreakRows_; }
90 void setDrawFrame(bool);
92 LColor_color frameColor() const;
94 void setFrameColor(LColor_color);
96 bool showInsetDialog(BufferView *) const;
98 LyXText * getText(int i) const {
99 return (i == 0) ? const_cast<LyXText*>(&text_) : 0;
102 virtual bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
104 /// set the change for the entire inset
105 void setChange(Change const & change);
106 /// accept the changes within the inset
107 void acceptChanges(BufferParams const & bparams);
108 /// reject the changes within the inset
109 void rejectChanges(BufferParams const & bparams);
111 /// append text onto the existing text
112 void appendParagraphs(Buffer * bp, ParagraphList &);
115 void addPreview(graphics::PreviewLoader &) const;
118 void edit(Cursor & cur, bool left);
120 InsetBase * editXY(Cursor & cur, int x, int y);
122 /// number of cells in this inset
123 size_t nargs() const { return 1; }
125 ParagraphList & paragraphs();
127 ParagraphList const & paragraphs() const;
129 bool insetAllowed(Code) const { return true; }
131 bool allowSpellCheck() const { return true; }
132 /// should paragraph indendation be ommitted in any case?
133 bool neverIndent(Buffer const &) const;
135 InsetText(InsetText const &);
137 virtual bool wide() const { return wide_inset_; }
139 void setWide(bool wide_inset) { wide_inset_ = wide_inset; }
143 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
147 virtual std::auto_ptr<InsetBase> doClone() const;
153 /** We store the LColor::color value as an int to get LColor.h out
154 * of the header file.
158 mutable pit_type old_pit;
163 mutable LyXText text_;
165 mutable LyXFont font_;