lyx_mirror/src/insets/InsetBox.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

145 lines
2.9 KiB
C++

// -*- C++ -*-
/**
* \file InsetBox.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Angus Leeming
* \author Martin Vermeer
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSETBOX_H
#define INSETBOX_H
#include "InsetCollapsable.h"
#include "Length.h"
namespace lyx {
class InsetBoxParams
{
public:
///
InsetBoxParams(std::string const &);
///
void write(std::ostream & os) const;
///
void read(Lexer & lex);
///
std::string type;
/// Is there a parbox?
bool use_parbox;
/// Is there a makebox?
bool use_makebox;
/// Do we have an inner parbox or minipage to format paragraphs to
/// columnwidth?
bool inner_box;
///
Length width;
/// "special" widths, see usrguide.dvi §3.5
std::string special;
///
char pos;
///
char hor_pos;
///
char inner_pos;
///
Length height;
///
std::string height_special;
};
///////////////////////////////////////////////////////////////////////
//
// The fbox/fancybox inset
//
///////////////////////////////////////////////////////////////////////
class InsetBox : public InsetCollapsable
{
public:
///
enum BoxType {
Frameless,
Boxed,
Framed,
ovalbox,
Ovalbox,
Shadowbox,
Shaded,
Doublebox
};
///
InsetBox(Buffer *, std::string const &);
///
static std::string params2string(InsetBoxParams const &);
///
static void string2params(std::string const &, InsetBoxParams &);
///
InsetBoxParams const & params() const { return params_; }
private:
///
friend class InsetBoxParams;
///
InsetCode lyxCode() const { return BOX_CODE; }
///
docstring layoutName() const;
///
void write(std::ostream &) const;
///
void read(Lexer & lex);
///
void setButtonLabel();
///
void metrics(MetricsInfo &, Dimension &) const;
///
DisplayType display() const { return Inline; }
///
bool allowParagraphCustomization(idx_type = 0) const { return !forcePlainLayout(); }
///
bool forcePlainLayout(idx_type = 0) const;
///
bool neverIndent() const { return true; }
/** returns false if, when outputing LaTeX, font changes should
be closed before generating this inset. This is needed for
insets that may contain several paragraphs */
bool inheritFont() const { return false; }
///
void latex(otexstream &, OutputParams const &) const;
///
int plaintext(odocstream &, OutputParams const &) const;
///
int docbook(odocstream &, OutputParams const &) const;
///
docstring xhtml(XHTMLStream &, OutputParams const &) const;
///
void validate(LaTeXFeatures &) const;
///
bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
///
void doDispatch(Cursor & cur, FuncRequest & cmd);
/// Is the width forced to some value?
bool hasFixedWidth() const;
///
Inset * clone() const { return new InsetBox(*this); }
/// used by the constructors
void init();
///
docstring contextMenuName() const;
///
InsetBoxParams params_;
};
} // namespace lyx
#endif // INSETBOX_H