mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-09-23 00:11:49 +00:00
db8c16d554
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23289 a592a061-630c-0410-9148-cb99ea01b6c8
61 lines
1.5 KiB
C++
61 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(BufferParams const &);
|
|
|
|
/// 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;
|
|
|
|
/// Outputting the optional parameter of a LaTeX command
|
|
int latexOptional(odocstream &, OutputParams const &) const;
|
|
/// 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; }
|
|
protected:
|
|
InsetOptArg(InsetOptArg const &);
|
|
private:
|
|
Inset * clone() const;
|
|
};
|
|
|
|
|
|
} // namespace lyx
|
|
|
|
#endif // INSETOPTARG_H
|