lyx_mirror/src/insets/InsetWrap.h
Guillaume Munch 9b7ccbfc80 New class InsetCaptionable
This generalises the new use of TocBuilder (97e8101) to listings and wraps and
removes some duplicate code.

Make sure that we will never write an empty float type again in the future
(#9760)
2015-09-15 15:25:33 +01:00

100 lines
1.9 KiB
C++

// -*- C++ -*-
/**
* \file InsetWrap.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Dekel Tsur
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSETWRAP_H
#define INSETWRAP_H
#include "InsetCaptionable.h"
#include "Length.h"
namespace lyx {
class InsetWrapParams {
public:
///
void write(std::ostream &) const;
///
void read(Lexer &);
///
std::string type;
///
int lines;
///
std::string placement;
///
Length overhang;
///
Length width;
};
/** The wrap inset
*/
class InsetWrap : public InsetCaptionable {
public:
///
InsetWrap(Buffer *, std::string const &);
///
~InsetWrap();
///
InsetWrapParams const & params() const { return params_; }
///
static void string2params(std::string const &, InsetWrapParams &);
///
static std::string params2string(InsetWrapParams const &);
private:
///
void setCaptionType(std::string const & type);
///
void write(std::ostream & os) const;
///
void read(Lexer & lex);
///
void validate(LaTeXFeatures & features) const;
///
InsetCode lyxCode() const { return WRAP_CODE; }
///
docstring toolTip(BufferView const & bv, int x, int y) const;
///
void latex(otexstream &, OutputParams const &) const;
///
int plaintext(odocstringstream & ods, OutputParams const & op,
size_t max_length = INT_MAX) const;
///
int docbook(odocstream &, OutputParams const &) const;
///
docstring xhtml(XHTMLStream &, OutputParams const &) const;
///
bool insetAllowed(InsetCode) const;
///
bool showInsetDialog(BufferView *) const;
///
bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
/// Update the label
void updateBuffer(ParIterator const &, UpdateType);
///
void doDispatch(Cursor & cur, FuncRequest & cmd);
///
docstring layoutName() const;
///
Inset * clone() const { return new InsetWrap(*this); }
///
InsetWrapParams params_;
};
} // namespace lyx
#endif