lyx_mirror/src/insets/InsetFloat.h
Lars Gullik Bjønnes 897436efbb Whitespace cleanup
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@18550 a592a061-630c-0410-9148-cb99ea01b6c8
2007-05-28 22:27:45 +00:00

129 lines
2.7 KiB
C++

// -*- C++ -*-
/**
* \file InsetFloat.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Jürgen Vigna
* \author Lars Gullik Bjønnes
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSETFLOAT_H
#define INSETFLOAT_H
#include "InsetCollapsable.h"
#include "MailInset.h"
namespace lyx {
class InsetFloatParams {
public:
///
InsetFloatParams() : wide(false), sideways(false) {}
///
void write(std::ostream & os) const;
///
void read(Lexer & lex);
///
std::string type;
///
std::string placement;
///
bool wide;
///
bool sideways;
};
/** The float inset
*/
class InsetFloat : public InsetCollapsable {
public:
///
InsetFloat(BufferParams const &, std::string const &);
///
~InsetFloat();
///
docstring name() const { return name_; }
///
void write(Buffer const & buf, std::ostream & os) const;
///
void read(Buffer const & buf, Lexer & lex);
///
void validate(LaTeXFeatures & features) const;
///
Inset::Code lyxCode() const { return Inset::FLOAT_CODE; }
///
virtual bool wide() const { return false; }
///
int latex(Buffer const &, odocstream &,
OutputParams const &) const;
///
int plaintext(Buffer const &, odocstream &,
OutputParams const &) const;
///
int docbook(Buffer const &, odocstream &,
OutputParams const &) const;
///
virtual docstring const editMessage() const;
///
bool insetAllowed(Inset::Code) const;
/** returns true if, when outputing LaTeX, font changes should
be closed before generating this inset. This is needed for
insets that may contain several paragraphs */
bool noFontChange() const { return true; }
///
void wide(bool w, BufferParams const &);
///
void sideways(bool s, BufferParams const &);
///
void addToToc(TocList &, Buffer const &) const;
///
bool showInsetDialog(BufferView *) const;
///
InsetFloatParams const & params() const { return params_; }
///
bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
protected:
virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
private:
///
virtual std::auto_ptr<Inset> doClone() const;
///
InsetFloatParams params_;
///
docstring name_;
};
class InsetFloatMailer : public MailInset {
public:
///
InsetFloatMailer(InsetFloat & inset);
///
virtual Inset & inset() const { return inset_; }
///
virtual std::string const & name() const { return name_; }
///
virtual std::string const inset2string(Buffer const &) const;
///
static void string2params(std::string const &, InsetFloatParams &);
///
static std::string const params2string(InsetFloatParams const &);
private:
///
static std::string const name_;
///
InsetFloat & inset_;
};
} // namespace lyx
#endif