lyx_mirror/src/insets/InsetFloat.h
Richard Heck 996505c2ae This patch introduces an optional argument to Buffer::updateLabels(), so
as to allow us to call the routine when we are preparing for output and
so to do certain things we might not want to do every time. 

This is an abuse of updateLabels(), in a way, but updateLabels() long
ago became the general recurse-through-the-Buffer routine, and to
implement the sort of thing I want to do here in validate(), say, much
of the code in updateLabels()---in particular, the counter-update
code---would have to be duplicated. So I believe this is the best, and
easiest, way to go.

Actual use of the new argument will follow.


git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@32318 a592a061-630c-0410-9148-cb99ea01b6c8
2009-12-04 03:03:38 +00:00

121 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 INSET_FLOAT_H
#define INSET_FLOAT_H
#include "InsetCollapsable.h"
namespace lyx {
class InsetFloatParams {
public:
///
InsetFloatParams() : wide(false), sideways(false), subfloat(false) {}
///
void write(std::ostream & os) const;
///
void read(Lexer & lex);
///
std::string type;
///
std::string placement;
/// span columns
bool wide;
///
bool sideways;
///
bool subfloat;
};
/////////////////////////////////////////////////////////////////////////
//
// InsetFloat
//
/////////////////////////////////////////////////////////////////////////
/// Used for "floating" objects like tables, figures etc.
class InsetFloat : public InsetCollapsable
{
public:
///
InsetFloat(Buffer *, std::string const &);
///
~InsetFloat();
///
static void string2params(std::string const &, InsetFloatParams &);
///
static std::string params2string(InsetFloatParams const &);
///
void setWide(bool w, bool update_label = true);
///
void setSideways(bool s, bool update_label = true);
///
void setSubfloat(bool s, bool update_label = true);
///
void setNewLabel();
///
InsetFloatParams const & params() const { return params_; }
private:
///
docstring name() const;
///
docstring toolTip(BufferView const & bv, int x, int y) const;
///
void write(std::ostream & os) const;
///
void read(Lexer & lex);
///
void validate(LaTeXFeatures & features) const;
///
InsetCode lyxCode() const { return FLOAT_CODE; }
///
int latex(odocstream &, OutputParams const &) const;
///
int plaintext(odocstream &, OutputParams const &) const;
///
int docbook(odocstream &, OutputParams const &) const;
///
docstring xhtml(XHTMLStream &, OutputParams const &) const;
///
bool insetAllowed(InsetCode) 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; }
///
bool showInsetDialog(BufferView *) const;
///
bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
// Update the counters of this inset and of its contents
void updateLabels(ParIterator const &, bool);
///
void doDispatch(Cursor & cur, FuncRequest & cmd);
///
Inset * clone() const { return new InsetFloat(*this); }
///
docstring getCaption(OutputParams const &) const;
///
InsetFloatParams params_;
///
docstring name_;
};
} // namespace lyx
#endif // INSET_FLOAT_H