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 virtual ~InsetText() { destroyed(); }
48 /// empty inset to empty par
51 void read(Buffer const & buf, Lexer & lex);
53 void write(Buffer const & buf, std::ostream & os) const;
55 bool metrics(MetricsInfo & mi, Dimension & dim) const;
57 void draw(PainterInfo & pi, int x, int y) const;
58 /// draw inset selection
59 void drawSelection(PainterInfo & pi, int x, int y) const;
60 /// are we inside the area covered by the inset?
61 virtual bool covers(BufferView const & bv, int x, int y) const;
63 virtual docstring const editMessage() const;
65 EDITABLE editable() const { return HIGHLY_EDITABLE; }
67 bool canTrackChanges() const { return true; }
69 InsetText * asTextInset() { return this; }
71 InsetText const * asTextInset() const { return this; }
73 int latex(Buffer const &, odocstream &, OutputParams const &) const;
75 int plaintext(Buffer const &, odocstream &, OutputParams const &) const;
77 int docbook(Buffer const &, odocstream &, OutputParams const &) const;
79 void validate(LaTeXFeatures & features) const;
81 /// return x,y of given position relative to the inset's baseline
82 void cursorPos(BufferView const & bv, CursorSlice const & sl,
83 bool boundary, int & x, int & y) const;
85 Code lyxCode() const { return TEXT_CODE; }
87 void setText(docstring const &, Font const &, bool trackChanges);
89 void setAutoBreakRows(bool);
91 bool getAutoBreakRows() const { return text_.autoBreakRows_; }
93 void setDrawFrame(bool);
95 Color_color frameColor() const;
97 void setFrameColor(Color_color);
99 bool showInsetDialog(BufferView *) const;
101 Text * getText(int i) const {
102 return (i == 0) ? const_cast<Text*>(&text_) : 0;
105 virtual bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
107 /// set the change for the entire inset
108 void setChange(Change const & change);
109 /// accept the changes within the inset
110 void acceptChanges(BufferParams const & bparams);
111 /// reject the changes within the inset
112 void rejectChanges(BufferParams const & bparams);
114 /// append text onto the existing text
115 void appendParagraphs(Buffer * bp, ParagraphList &);
118 void addPreview(graphics::PreviewLoader &) const;
121 void edit(Cursor & cur, bool left);
123 Inset * editXY(Cursor & cur, int x, int y);
125 /// number of cells in this inset
126 size_t nargs() const { return 1; }
128 ParagraphList & paragraphs();
130 ParagraphList const & paragraphs() const;
132 bool insetAllowed(Code) const { return true; }
134 bool allowSpellCheck() const { return true; }
135 /// should paragraph indendation be ommitted in any case?
136 bool neverIndent(Buffer const &) const;
138 InsetText(InsetText const &);
140 virtual bool wide() const { return wide_inset_; }
142 void setWide(bool wide_inset) { wide_inset_ = wide_inset; }
144 boost::signal<void()> * destroyedSignal() { return &destroyed; }
148 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
152 virtual std::auto_ptr<Inset> doClone() const;
158 /** We store the Color::color value as an int to get Color.h out
159 * of the header file.
163 mutable pit_type old_pit;
166 /// This signal is emitted when the inset is destroyed.
167 boost::signal<void()> destroyed;