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"
34 A text inset is like a TeX box to write full text
35 (including styles and other insets) in a given space.
37 class InsetText : public InsetOld {
40 explicit InsetText(BufferParams const &);
43 /// empty inset to empty par
46 void read(Buffer const & buf, LyXLex & lex);
48 void write(Buffer const & buf, std::ostream & os) const;
50 void metrics(MetricsInfo & mi, Dimension & dim) const;
52 void draw(PainterInfo & pi, int x, int y) const;
53 /// draw inset selection
54 void drawSelection(PainterInfo & pi, int x, int y) const;
56 std::string const editMessage() const;
58 EDITABLE editable() const { return HIGHLY_EDITABLE; }
60 bool isTextInset() const { return true; }
62 int latex(Buffer const &, std::ostream &,
63 OutputParams const &) const;
65 int plaintext(Buffer const &, std::ostream &,
66 OutputParams const &) const;
68 int linuxdoc(Buffer const &, std::ostream &,
69 OutputParams const &) const;
71 int docbook(Buffer const &, std::ostream &,
72 OutputParams const &) const;
74 void validate(LaTeXFeatures & features) const;
76 /// return x,y of given position relative to the inset's baseline
77 void cursorPos(CursorSlice const & sl, bool boundary, int & x, int & y) const;
79 Code lyxCode() const { return TEXT_CODE; }
81 void setFont(BufferView *, LyXFont const &,
82 bool toggleall = false,
83 bool selectall = false);
85 void setText(std::string const &, LyXFont const &);
87 void setAutoBreakRows(bool);
89 bool getAutoBreakRows() const { return text_.autoBreakRows_; }
91 void setDrawFrame(bool);
93 LColor_color frameColor() const;
95 void setFrameColor(LColor_color);
97 void setViewCache(BufferView const * bv) const;
99 bool showInsetDialog(BufferView *) const;
100 /// Appends \c list with all labels found within this inset.
101 void getLabelList(Buffer const &, std::vector<std::string> & list) const;
103 LyXText * getText(int i) const {
104 return (i == 0) ? const_cast<LyXText*>(&text_) : 0;
107 bool getStatus(LCursor & cur, FuncRequest const & cmd, FuncStatus &) const;
109 /// mark as erased for change tracking
110 void markErased(bool erased);
113 * Mark as new. Used when pasting in tabular, and adding rows
114 * or columns. Note that pasting will ensure that tracking already
115 * happens, and this just resets the changes for the copied text,
116 * whereas for row/col add, we need to start tracking changes
117 * for the (empty) paragraph contained.
119 void markNew(bool track_changes = false);
121 /// append text onto the existing text
122 void appendParagraphs(Buffer * bp, ParagraphList &);
125 void addPreview(lyx::graphics::PreviewLoader &) const;
128 void edit(LCursor & cur, bool left);
130 InsetBase * editXY(LCursor & cur, int x, int y);
132 /// number of cells in this inset
133 size_t nargs() const { return 1; }
135 ParagraphList & paragraphs();
137 ParagraphList const & paragraphs() const;
139 bool insetAllowed(Code) const { return true; }
141 bool allowSpellCheck() const { return true; }
142 /// should paragraph indendation be ommitted in any case?
143 bool neverIndent() const;
145 InsetText(InsetText const &);
149 virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
153 virtual std::auto_ptr<InsetBase> doClone() const;
159 /** We store the LColor::color value as an int to get LColor.h out
160 * of the header file.
164 mutable lyx::pit_type old_pit;
169 mutable LyXText text_;
171 mutable LyXFont font_;