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 "InsetCollapsible.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 InsetCollapsible
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 draw(PainterInfo & pi, int x, int y) const;
67 void write(std::ostream &) const;
69 void read(Lexer & lex);
71 void setButtonLabel();
72 /// show the phantom dialog
73 bool showInsetDialog(BufferView * bv) const;
75 bool neverIndent() const { return true; }
77 void latex(otexstream &, OutputParams const &) const;
79 int plaintext(odocstringstream & ods, OutputParams const & op,
80 size_t max_length = INT_MAX) const;
82 int docbook(odocstream &, OutputParams const &) const;
83 /// Makes no sense fof XHTML.
84 docstring xhtml(XHTMLStream &, OutputParams const &) const;
86 bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
88 void doDispatch(Cursor & cur, FuncRequest & cmd);
90 docstring toolTip(BufferView const & bv, int x, int y) const;
92 Inset * clone() const { return new InsetPhantom(*this); }
93 /// used by the constructors
96 std::string contextMenuName() const;
98 friend class InsetPhantomParams;
101 InsetPhantomParams params_;
107 #endif // INSET_PHANTOM_H