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.
19 #include "support/types.h"
21 #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 Inset {
43 explicit InsetText(BufferParams const &);
48 Dimension const dimension(BufferView const &) const;
50 /// empty inset to empty par
53 void read(Buffer const & buf, Lexer & lex);
55 void write(Buffer const & buf, std::ostream & os) const;
57 bool metrics(MetricsInfo & mi, Dimension & dim) const;
59 void draw(PainterInfo & pi, 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 * asTextInset() { return this; }
69 InsetText const * asTextInset() const { return this; }
71 int latex(Buffer const &, odocstream &, OutputParams const &) const;
73 int plaintext(Buffer const &, odocstream &, OutputParams const &) const;
75 int docbook(Buffer const &, 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 Code 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 Color_color frameColor() const;
95 void setFrameColor(Color_color);
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(Buffer * bp, ParagraphList &);
116 void addPreview(graphics::PreviewLoader &) const;
119 void edit(Cursor & cur, bool left);
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(Code) const { return true; }
132 bool allowSpellCheck() const { return true; }
133 /// should paragraph indendation be ommitted in any case?
134 bool neverIndent(Buffer const &) const;
136 InsetText(InsetText const &);
138 // Update the counters of this inset and of its contents
139 virtual void updateLabels(Buffer const &, ParIterator const &);
141 virtual Inset * clone() const;
145 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
153 /** We store the Color::color value as an int to get Color.h out
154 * of the header file.
158 mutable pit_type old_pit;