// -*- C++ -*-
-/* This file is part of*
- * ======================================================
+/**
+ * \file insetoptarg.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * LyX, The Document Processor
+ * \author Martin Vermeer
*
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2001 The LyX Team
- *
- * ====================================================== */
+ * Full author contact details are available in file CREDITS
+ */
#ifndef INSETOPTARG_H
#define INSETOPTARG_H
-#ifdef __GNUG__
-#pragma interface
-#endif
#include "insettext.h"
#include "insetcollapsable.h"
+
+/**
+ * InsetOptArg. Used to insert a short version of sectioning header etc.
+ * automatically, or other optional LaTeX arguments
+ */
class InsetOptArg : public InsetCollapsable {
public:
InsetOptArg(BufferParams const &);
- ///
- InsetOptArg(InsetOptArg const &, bool same_id = false);
- Inset * clone(Buffer const &, bool same_id = false) const;
- ///
+ InsetOptArg(InsetOptArg const &);
+ /// make a duplicate of this inset
+ virtual std::auto_ptr<InsetBase> clone() const;
+ /// this inset is editable
EDITABLE editable() const { return IS_EDITABLE; }
- ///
- Inset::Code lyxCode() const { return Inset::OPTARG_CODE; }
- ///
+ /// code of the inset
+ InsetOld::Code lyxCode() const { return InsetOld::OPTARG_CODE; }
+ /// return an message upon editing
string const editMessage() const;
+
/// Standard LaTeX output -- short-circuited
- int latex(Buffer const *, std::ostream &,
- bool fragile, bool fp) const;
+ int latex(Buffer const *, std::ostream &,
+ LatexRunParams const &) const;
/// Outputting the optional parameter of a LaTeX command
- int latexOptional(Buffer const *, std::ostream &,
- bool fragile, bool fp) const;
- ///
- void write(Buffer const * buf, ostream & os) const;
+ int latexOptional(Buffer const *, std::ostream &,
+ LatexRunParams const &) const;
+ /// Write out tothe .lyx file
+ void write(Buffer const * buf, std::ostream & os) const;
};
-#endif
+#endif // INSETOPTARG_H