2002-08-23 09:05:32 +00:00
|
|
|
// -*- C++ -*-
|
2002-08-24 20:25:17 +00:00
|
|
|
/**
|
2010-06-04 22:44:58 +00:00
|
|
|
* \file InsetArgument.h
|
2002-09-25 14:26:13 +00:00
|
|
|
* This file is part of LyX, the document processor.
|
|
|
|
|
* Licence details can be found in the file COPYING.
|
2002-08-23 09:05:32 +00:00
|
|
|
*
|
2002-12-01 22:59:25 +00:00
|
|
|
* \author Martin Vermeer
|
2002-09-25 14:26:13 +00:00
|
|
|
*
|
2003-08-23 00:17:00 +00:00
|
|
|
* Full author contact details are available in file CREDITS.
|
2002-08-24 20:25:17 +00:00
|
|
|
*/
|
2002-08-23 09:05:32 +00:00
|
|
|
|
|
|
|
|
#ifndef INSETOPTARG_H
|
|
|
|
|
#define INSETOPTARG_H
|
|
|
|
|
|
|
|
|
|
|
2007-04-25 01:24:38 +00:00
|
|
|
#include "InsetCollapsable.h"
|
2002-08-23 09:05:32 +00:00
|
|
|
|
2002-08-26 11:27:37 +00:00
|
|
|
|
2006-10-21 00:16:43 +00:00
|
|
|
namespace lyx {
|
|
|
|
|
|
|
|
|
|
|
2002-08-24 20:25:17 +00:00
|
|
|
/**
|
2010-06-04 22:44:58 +00:00
|
|
|
* InsetArgument. Used to insert a short version of sectioning header etc.
|
2002-08-24 20:25:17 +00:00
|
|
|
* automatically, or other optional LaTeX arguments
|
|
|
|
|
*/
|
2010-06-04 22:44:58 +00:00
|
|
|
class InsetArgument : public InsetCollapsable
|
2008-03-05 00:21:05 +00:00
|
|
|
{
|
2002-08-23 09:05:32 +00:00
|
|
|
public:
|
2008-03-05 00:21:05 +00:00
|
|
|
///
|
2010-06-04 22:44:58 +00:00
|
|
|
InsetArgument(Buffer *);
|
2002-08-24 20:25:17 +00:00
|
|
|
|
2010-06-04 21:50:08 +00:00
|
|
|
/// Outputting the parameter of a LaTeX command
|
Introduce a wrapper class for odocstream to help ensuring that no
blank lines may be inadvertently output. This is achieved by using two
special iomanip-like variables (breakln and safebreakln) in the lyx::
namespace. When they are inserted in the stream, a newline is output
only if not already at the beginning of a line. The difference between
breakln and safebreakln is that, if needed, the former outputs '\n'
and the latter "%\n".
In future, the new class will also be used for counting the number of
newlines issued. Even if the infractrure for doing that is already in
place, the counting is essentially still done the old way.
There are still places in the code where the functionality of the
class could be used, most probably. ATM, it is used for InsetTabular,
InsetListings, InsetFloat, and InsetText.
The Comment and GreyedOut insets required a special treatment and a
new InsetLayout parameter (Display) has been introduced. The default
for Display is "true", meaning that the corresponding latex
environment is of "display" type, i.e., it stands on its own, whereas
"false" means that the contents appear inline with the text. The
latter is the case for both Comment and GreyedOut insets.
Mostly, the only visible effects on latex exports should be the
disappearing of some redundant % chars and the appearing/disappearing
of null {} latex groups after a comment or lyxgreyedout environments
(they are related to the presence or absence of a space immediately
after those environments), as well as the fact that math environments
are now started on their own lines.
As a last thing, only the latex code between \begin{document} and
\end{document} goes through the new class, the preamble being directly
output through odocstream, as usual.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@37360 a592a061-630c-0410-9148-cb99ea01b6c8
2011-01-29 02:41:13 +00:00
|
|
|
int latexArgument(otexstream &, OutputParams const &,
|
2010-06-04 21:50:08 +00:00
|
|
|
bool optional) const;
|
2009-04-22 20:55:13 +00:00
|
|
|
///
|
|
|
|
|
bool hasSettings() const { return false; }
|
2008-03-05 00:21:05 +00:00
|
|
|
|
|
|
|
|
private:
|
2002-08-24 20:25:17 +00:00
|
|
|
/// code of the inset
|
2010-06-04 22:44:58 +00:00
|
|
|
InsetCode lyxCode() const { return ARG_CODE; }
|
2007-11-15 15:40:01 +00:00
|
|
|
///
|
2010-06-07 21:58:27 +00:00
|
|
|
docstring name() const { return from_ascii("Argument"); }
|
2002-08-23 09:05:32 +00:00
|
|
|
/// Standard LaTeX output -- short-circuited
|
Introduce a wrapper class for odocstream to help ensuring that no
blank lines may be inadvertently output. This is achieved by using two
special iomanip-like variables (breakln and safebreakln) in the lyx::
namespace. When they are inserted in the stream, a newline is output
only if not already at the beginning of a line. The difference between
breakln and safebreakln is that, if needed, the former outputs '\n'
and the latter "%\n".
In future, the new class will also be used for counting the number of
newlines issued. Even if the infractrure for doing that is already in
place, the counting is essentially still done the old way.
There are still places in the code where the functionality of the
class could be used, most probably. ATM, it is used for InsetTabular,
InsetListings, InsetFloat, and InsetText.
The Comment and GreyedOut insets required a special treatment and a
new InsetLayout parameter (Display) has been introduced. The default
for Display is "true", meaning that the corresponding latex
environment is of "display" type, i.e., it stands on its own, whereas
"false" means that the contents appear inline with the text. The
latter is the case for both Comment and GreyedOut insets.
Mostly, the only visible effects on latex exports should be the
disappearing of some redundant % chars and the appearing/disappearing
of null {} latex groups after a comment or lyxgreyedout environments
(they are related to the presence or absence of a space immediately
after those environments), as well as the fact that math environments
are now started on their own lines.
As a last thing, only the latex code between \begin{document} and
\end{document} goes through the new class, the preamble being directly
output through odocstream, as usual.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@37360 a592a061-630c-0410-9148-cb99ea01b6c8
2011-01-29 02:41:13 +00:00
|
|
|
int latex(otexstream &, OutputParams const &) const;
|
2005-05-11 09:47:54 +00:00
|
|
|
/// Standard plain text output -- short-circuited
|
2008-02-27 20:43:16 +00:00
|
|
|
int plaintext(odocstream &, OutputParams const &) const;
|
2007-02-15 23:44:33 +00:00
|
|
|
/// Standard DocBook output -- short-circuited
|
2008-02-27 20:43:16 +00:00
|
|
|
int docbook(odocstream &, OutputParams const &) const;
|
2009-06-06 04:20:57 +00:00
|
|
|
/// Standard XHTML output -- short-circuited
|
2009-11-21 23:31:13 +00:00
|
|
|
docstring xhtml(XHTMLStream &, OutputParams const &) const;
|
2006-12-28 12:05:40 +00:00
|
|
|
/// Write out to the .lyx file
|
2008-02-27 20:43:16 +00:00
|
|
|
void write(std::ostream & os) const;
|
2005-09-10 06:51:58 +00:00
|
|
|
/// should paragraph indendation be ommitted in any case?
|
2008-02-27 20:43:16 +00:00
|
|
|
bool neverIndent() const { return true; }
|
2008-03-05 00:21:05 +00:00
|
|
|
///
|
2010-06-04 22:44:58 +00:00
|
|
|
Inset * clone() const { return new InsetArgument(*this); }
|
2002-08-23 09:05:32 +00:00
|
|
|
};
|
|
|
|
|
|
2006-10-21 00:16:43 +00:00
|
|
|
|
|
|
|
|
} // namespace lyx
|
|
|
|
|
|
2002-08-24 20:25:17 +00:00
|
|
|
#endif // INSETOPTARG_H
|
