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"
36 A text inset is like a TeX box to write full text
37 (including styles and other insets) in a given space.
39 class InsetText : public Inset {
42 explicit InsetText(BufferParams const &);
46 /// empty inset to empty par
49 void read(Buffer const & buf, Lexer & lex);
51 void write(Buffer const & buf, std::ostream & os) const;
53 bool 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 * 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;
78 //FIXME The following should be removed when wide is.
79 /// Overridden to force an update if the inset was wide().
80 virtual bool notifyCursorLeaves(Cursor & cur);
82 /// return x,y of given position relative to the inset's baseline
83 void cursorPos(BufferView const & bv, CursorSlice const & sl,
84 bool boundary, int & x, int & y) const;
86 Code lyxCode() const { return TEXT_CODE; }
88 void setText(docstring const &, Font const &, bool trackChanges);
90 void setAutoBreakRows(bool);
92 bool getAutoBreakRows() const { return text_.autoBreakRows_; }
94 void setDrawFrame(bool);
96 Color_color frameColor() const;
98 void setFrameColor(Color_color);
100 bool showInsetDialog(BufferView *) const;
102 Text * getText(int i) const {
103 return (i == 0) ? const_cast<Text*>(&text_) : 0;
106 virtual bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
108 /// set the change for the entire inset
109 void setChange(Change const & change);
110 /// accept the changes within the inset
111 void acceptChanges(BufferParams const & bparams);
112 /// reject the changes within the inset
113 void rejectChanges(BufferParams const & bparams);
115 /// append text onto the existing text
116 void appendParagraphs(Buffer * bp, ParagraphList &);
119 void addPreview(graphics::PreviewLoader &) const;
122 void edit(Cursor & cur, bool left);
124 Inset * editXY(Cursor & cur, int x, int y);
126 /// number of cells in this inset
127 size_t nargs() const { return 1; }
129 ParagraphList & paragraphs();
131 ParagraphList const & paragraphs() const;
133 bool insetAllowed(Code) const { return true; }
135 bool allowSpellCheck() const { return true; }
136 /// should paragraph indendation be ommitted in any case?
137 bool neverIndent(Buffer const &) const;
139 InsetText(InsetText const &);
141 virtual bool wide() const { return wide_inset_; }
143 void setWide(bool wide_inset) { wide_inset_ = wide_inset; }
144 // Update the counters of this inset and of its contents
145 virtual void updateLabels(Buffer const &, ParIterator const &);
149 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
153 virtual std::auto_ptr<Inset> doClone() const;
159 /** We store the Color::color value as an int to get Color.h out
160 * of the header file.
164 mutable pit_type old_pit;