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"
19 #include "ParagraphList_fwd.h"
21 #include "support/types.h"
23 #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 &);
46 /// empty inset to empty par
49 void read(Buffer const & buf, LyXLex & lex);
51 void write(Buffer const & buf, std::ostream & os) const;
53 void metrics(MetricsInfo & mi, Dimension & dim) const;
55 void draw(PainterInfo & pi, int x, int y) const;
56 /// draw inset selection
57 void drawSelection(PainterInfo & pi, int x, int y) const;
58 /// are we inside the area covered by the inset?
59 virtual bool covers(BufferView const & bv, int x, int y) const;
61 virtual docstring const editMessage() const;
63 EDITABLE editable() const { return HIGHLY_EDITABLE; }
65 bool canTrackChanges() const { return true; }
67 InsetText const * asTextInset() const { return this; }
69 int latex(Buffer const &, odocstream &, OutputParams const &) const;
71 int plaintext(Buffer const &, odocstream &, OutputParams const &) const;
73 int docbook(Buffer const &, odocstream &, OutputParams const &) const;
75 void validate(LaTeXFeatures & features) const;
77 /// return x,y of given position relative to the inset's baseline
78 void cursorPos(BufferView const & bv, CursorSlice const & sl,
79 bool boundary, int & x, int & y) const;
81 Code lyxCode() const { return TEXT_CODE; }
83 void setText(docstring const &, LyXFont const &, bool trackChanges);
85 void setAutoBreakRows(bool);
87 bool getAutoBreakRows() const { return text_.autoBreakRows_; }
89 void setDrawFrame(bool);
91 LColor_color frameColor() const;
93 void setFrameColor(LColor_color);
95 bool showInsetDialog(BufferView *) const;
97 LyXText * getText(int i) const {
98 return (i == 0) ? const_cast<LyXText*>(&text_) : 0;
101 bool getStatus(LCursor & cur, FuncRequest const & cmd, FuncStatus &) const;
103 /// set the change for the entire inset
104 void setChange(Change const & change);
105 /// accept the changes within the inset
106 void acceptChanges();
107 /// reject the changes within the inset
108 void rejectChanges();
110 /// append text onto the existing text
111 void appendParagraphs(Buffer * bp, ParagraphList &);
114 void addPreview(graphics::PreviewLoader &) const;
117 void edit(LCursor & cur, bool left);
119 InsetBase * editXY(LCursor & cur, int x, int y);
121 /// number of cells in this inset
122 size_t nargs() const { return 1; }
124 ParagraphList & paragraphs();
126 ParagraphList const & paragraphs() const;
128 bool insetAllowed(Code) const { return true; }
130 bool allowSpellCheck() const { return true; }
131 /// should paragraph indendation be ommitted in any case?
132 bool neverIndent(Buffer const &) const;
134 InsetText(InsetText const &);
136 bool & Wide() const { return wide_inset_; }
140 virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
144 virtual std::auto_ptr<InsetBase> doClone() const;
150 /** We store the LColor::color value as an int to get LColor.h out
151 * of the header file.
155 mutable pit_type old_pit;
159 mutable bool wide_inset_;
162 mutable LyXText text_;
164 mutable LyXFont font_;