2010-11-21 17:00:12 +00:00
|
|
|
// -*- C++ -*-
|
|
|
|
|
/**
|
|
|
|
|
* \file InsetScript.h
|
|
|
|
|
* This file is part of LyX, the document processor.
|
|
|
|
|
* Licence details can be found in the file COPYING.
|
|
|
|
|
*
|
|
|
|
|
* \author Georg Baum
|
|
|
|
|
*
|
|
|
|
|
* Full author contact details are available in file CREDITS.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef INSET_SCRIPT_H
|
|
|
|
|
#define INSET_SCRIPT_H
|
|
|
|
|
|
|
|
|
|
#include "InsetText.h"
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
namespace lyx {
|
|
|
|
|
|
|
|
|
|
class InsetScriptParams
|
|
|
|
|
{
|
|
|
|
|
public:
|
|
|
|
|
enum Type {
|
|
|
|
|
Subscript,
|
|
|
|
|
Superscript
|
|
|
|
|
};
|
|
|
|
|
/// \c type defaults to Subscript
|
|
|
|
|
InsetScriptParams();
|
|
|
|
|
///
|
|
|
|
|
void write(std::ostream & os) const;
|
|
|
|
|
///
|
|
|
|
|
void read(Lexer & lex);
|
|
|
|
|
///
|
|
|
|
|
int shift(FontInfo const & font) const;
|
|
|
|
|
///
|
|
|
|
|
Type type;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/////////////////////////////////////////////////////////////////////////
|
|
|
|
|
//
|
|
|
|
|
// InsetScript
|
|
|
|
|
//
|
|
|
|
|
/////////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
|
|
|
|
/// The subscript and superscript inset
|
|
|
|
|
class InsetScript : public InsetText
|
|
|
|
|
{
|
|
|
|
|
public:
|
|
|
|
|
///
|
|
|
|
|
InsetScript(Buffer *, InsetScriptParams const & = InsetScriptParams());
|
|
|
|
|
///
|
|
|
|
|
InsetScript(Buffer *, std::string const &);
|
|
|
|
|
///
|
|
|
|
|
~InsetScript();
|
|
|
|
|
///
|
|
|
|
|
static std::string params2string(InsetScriptParams const &);
|
|
|
|
|
///
|
|
|
|
|
static void string2params(std::string const &, InsetScriptParams &);
|
|
|
|
|
///
|
|
|
|
|
InsetScriptParams const & params() const { return params_; }
|
2010-11-25 13:00:31 +00:00
|
|
|
|
|
|
|
|
/// \name Public functions inherited from Inset class
|
|
|
|
|
//@{
|
2010-11-21 17:00:12 +00:00
|
|
|
///
|
|
|
|
|
InsetCode lyxCode() const { return SCRIPT_CODE; }
|
|
|
|
|
///
|
|
|
|
|
docstring name() const;
|
|
|
|
|
///
|
|
|
|
|
DisplayType display() const;
|
|
|
|
|
///
|
|
|
|
|
void metrics(MetricsInfo &, Dimension &) const;
|
|
|
|
|
///
|
|
|
|
|
void draw(PainterInfo & pi, int x, int y) const;
|
|
|
|
|
///
|
2010-11-25 13:00:31 +00:00
|
|
|
void cursorPos(BufferView const & bv,
|
2010-11-21 17:00:12 +00:00
|
|
|
CursorSlice const & sl, bool boundary, int & x, int & y) const;
|
|
|
|
|
///
|
|
|
|
|
void write(std::ostream &) const;
|
|
|
|
|
///
|
|
|
|
|
void read(Lexer & lex);
|
|
|
|
|
///
|
|
|
|
|
bool neverIndent() const { return true; }
|
|
|
|
|
///
|
2010-11-25 13:00:31 +00:00
|
|
|
bool forcePlainLayout(idx_type = 0) const { return true; }
|
2010-11-21 17:00:12 +00:00
|
|
|
///
|
2010-11-25 13:00:31 +00:00
|
|
|
bool allowParagraphCustomization(idx_type = 0) const { return false; }
|
2010-11-21 17:00:12 +00:00
|
|
|
///
|
|
|
|
|
virtual void validate(LaTeXFeatures &) const;
|
|
|
|
|
///
|
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;
|
2010-11-21 17:00:12 +00:00
|
|
|
///
|
|
|
|
|
int plaintext(odocstream &, OutputParams const &) const;
|
|
|
|
|
///
|
|
|
|
|
int docbook(odocstream &, OutputParams const &) const;
|
|
|
|
|
///
|
|
|
|
|
docstring xhtml(XHTMLStream &, OutputParams const &) const;
|
|
|
|
|
///
|
|
|
|
|
void edit(Cursor & cur, bool front,
|
|
|
|
|
EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
|
|
|
|
|
///
|
|
|
|
|
Inset * editXY(Cursor & cur, int x, int y);
|
|
|
|
|
///
|
2010-11-25 13:00:31 +00:00
|
|
|
bool insetAllowed(InsetCode code) const;
|
2010-11-21 17:00:12 +00:00
|
|
|
///
|
|
|
|
|
bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
|
|
|
|
|
///
|
|
|
|
|
docstring toolTip(BufferView const & bv, int x, int y) const;
|
|
|
|
|
///
|
|
|
|
|
Inset * clone() const { return new InsetScript(*this); }
|
|
|
|
|
///
|
2010-11-29 21:27:25 +00:00
|
|
|
docstring contextMenuName() const;
|
2010-11-25 13:00:31 +00:00
|
|
|
//@}
|
|
|
|
|
|
|
|
|
|
/// \name Public functions inherited from InsetText class
|
|
|
|
|
//@{
|
2010-11-21 17:00:12 +00:00
|
|
|
///
|
2010-11-25 13:00:31 +00:00
|
|
|
bool allowMultiPar() const { return false; }
|
|
|
|
|
//@}
|
2010-11-21 17:00:12 +00:00
|
|
|
|
2010-11-25 13:00:31 +00:00
|
|
|
protected:
|
|
|
|
|
/// \name Protected functions inherited from Inset class
|
|
|
|
|
//@{
|
|
|
|
|
///
|
|
|
|
|
void doDispatch(Cursor & cur, FuncRequest & cmd);
|
|
|
|
|
//@}
|
|
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
/// used by the constructors
|
|
|
|
|
void init();
|
|
|
|
|
///
|
|
|
|
|
friend class InsetScriptParams;
|
2010-11-21 17:00:12 +00:00
|
|
|
///
|
|
|
|
|
InsetScriptParams params_;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
} // namespace lyx
|
|
|
|
|
|
|
|
|
|
#endif
|
