lyx_mirror/src/insets/InsetPhantom.h
Richard Heck 3f27f951cb This is intended to be a pure renaming of the Inset::name() routine,
preparatory to fixing #7080. Note that mathed uses the same routine, but
for a completely different purpose, so I did not rename it there. I have
seen no difference in behavior after testing, e.g., opening and
exporting Math.lyx, and also re-saving it and looking at the diff.


git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@38109 a592a061-630c-0410-9148-cb99ea01b6c8
2011-03-28 22:33:04 +00:00

109 lines
2.2 KiB
C++

// -*- C++ -*-
/**
* \file InsetPhantom.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Uwe Stöhr
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSET_PHANTOM_H
#define INSET_PHANTOM_H
#include "InsetCollapsable.h"
namespace lyx {
class InsetPhantomParams
{
public:
enum Type {
Phantom,
HPhantom,
VPhantom
};
/// \c type defaults to Phantom
InsetPhantomParams();
///
void write(std::ostream & os) const;
///
void read(Lexer & lex);
///
Type type;
};
/////////////////////////////////////////////////////////////////////////
//
// InsetPhantom
//
/////////////////////////////////////////////////////////////////////////
/// The phantom inset
class InsetPhantom : public InsetCollapsable
{
public:
///
InsetPhantom(Buffer *, std::string const &);
///
~InsetPhantom();
///
static std::string params2string(InsetPhantomParams const &);
///
static void string2params(std::string const &, InsetPhantomParams &);
///
InsetPhantomParams const & params() const { return params_; }
private:
///
InsetCode lyxCode() const { return PHANTOM_CODE; }
///
docstring layoutName() const;
///
void metrics(MetricsInfo &, Dimension &) const;
///
void draw(PainterInfo & pi, int x, int y) const;
///
void write(std::ostream &) const;
///
void read(Lexer & lex);
///
void setButtonLabel();
/// show the phantom dialog
bool showInsetDialog(BufferView * bv) const;
///
bool neverIndent() const { return true; }
///
void latex(otexstream &, OutputParams const &) const;
///
int plaintext(odocstream &, OutputParams const &) const;
///
int docbook(odocstream &, OutputParams const &) const;
/// Makes no sense fof XHTML.
docstring xhtml(XHTMLStream &, OutputParams const &) const;
///
bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
///
void doDispatch(Cursor & cur, FuncRequest & cmd);
///
docstring toolTip(BufferView const & bv, int x, int y) const;
///
Inset * clone() const { return new InsetPhantom(*this); }
/// used by the constructors
void init();
///
docstring contextMenuName() const;
///
friend class InsetPhantomParams;
///
InsetPhantomParams params_;
};
} // namespace lyx
#endif // INSET_PHANTOM_H