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.
12 #ifndef INSET_PHANTOM_H
13 #define INSET_PHANTOM_H
15 #include "InsetCollapsable.h"
20 class InsetPhantomParams
28 /// \c type defaults to Phantom
31 void write(std::ostream & os) const;
33 void read(Lexer & lex);
39 /////////////////////////////////////////////////////////////////////////
43 /////////////////////////////////////////////////////////////////////////
46 class InsetPhantom : public InsetCollapsable
50 InsetPhantom(Buffer *, std::string const &);
54 static std::string params2string(InsetPhantomParams const &);
56 static void string2params(std::string const &, InsetPhantomParams &);
58 InsetPhantomParams const & params() const { return params_; }
61 InsetCode lyxCode() const { return PHANTOM_CODE; }
63 docstring layoutName() const;
65 void metrics(MetricsInfo &, Dimension &) const;
67 void draw(PainterInfo & pi, int x, int y) const;
69 void write(std::ostream &) const;
71 void read(Lexer & lex);
73 void setButtonLabel();
74 /// show the phantom dialog
75 bool showInsetDialog(BufferView * bv) const;
77 bool neverIndent() const { return true; }
79 void latex(otexstream &, OutputParams const &) const;
81 int plaintext(odocstringstream & ods, OutputParams const & op,
82 size_t max_length = INT_MAX) const;
84 int docbook(odocstream &, OutputParams const &) const;
85 /// Makes no sense fof XHTML.
86 docstring xhtml(XHTMLStream &, OutputParams const &) const;
88 bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
90 void doDispatch(Cursor & cur, FuncRequest & cmd);
92 docstring toolTip(BufferView const & bv, int x, int y) const;
94 Inset * clone() const { return new InsetPhantom(*this); }
95 /// used by the constructors
98 std::string contextMenuName() const;
100 friend class InsetPhantomParams;
103 InsetPhantomParams params_;
109 #endif // INSET_PHANTOM_H