lyx_mirror/src/insets/InsetOptArg.h
Richard Heck 2807761e65 Fix a bug that allowed setting of layouts inside optional arguments.
There is more that could be done here.


git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@26303 a592a061-630c-0410-9148-cb99ea01b6c8
2008-09-04 21:50:14 +00:00

65 lines
1.5 KiB
C++

// -*- C++ -*-
/**
* \file InsetOptArg.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Martin Vermeer
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSETOPTARG_H
#define INSETOPTARG_H
#include "InsetCollapsable.h"
namespace lyx {
/**
* InsetOptArg. Used to insert a short version of sectioning header etc.
* automatically, or other optional LaTeX arguments
*/
class InsetOptArg : public InsetCollapsable
{
public:
///
InsetOptArg(Buffer const &);
/// Outputting the optional parameter of a LaTeX command
int latexOptional(odocstream &, OutputParams const &) const;
private:
/// code of the inset
InsetCode lyxCode() const { return OPTARG_CODE; }
///
docstring name() const { return from_ascii("OptArg"); }
/// return an message upon editing
docstring editMessage() const;
/// Standard LaTeX output -- short-circuited
int latex(odocstream &, OutputParams const &) const;
/// Standard plain text output -- short-circuited
int plaintext(odocstream &, OutputParams const &) const;
/// Standard DocBook output -- short-circuited
int docbook(odocstream &, OutputParams const &) const;
///
virtual bool forcePlainLayout(idx_type = 0) const { return true; }
/// Write out to the .lyx file
void write(std::ostream & os) const;
/// should paragraph indendation be ommitted in any case?
bool neverIndent() const { return true; }
///
Inset * clone() const { return new InsetOptArg(*this); }
};
} // namespace lyx
#endif // INSETOPTARG_H