2001-07-20 09:57:23 +00:00
|
|
|
// -*- C++ -*-
|
2002-09-25 14:26:13 +00:00
|
|
|
/**
|
2007-04-25 01:24:38 +00:00
|
|
|
* \file InsetNote.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-03-21 17:09:55 +00:00
|
|
|
*
|
2002-09-25 14:26:13 +00:00
|
|
|
* \author Angus Leeming
|
2001-07-20 09:57:23 +00:00
|
|
|
*
|
2003-08-23 00:17:00 +00:00
|
|
|
* Full author contact details are available in file CREDITS.
|
2001-07-20 09:57:23 +00:00
|
|
|
*/
|
|
|
|
|
|
2008-03-27 22:26:24 +00:00
|
|
|
#ifndef INSET_NOTE_H
|
|
|
|
|
#define INSET_NOTE_H
|
2001-07-20 09:57:23 +00:00
|
|
|
|
2007-04-25 01:24:38 +00:00
|
|
|
#include "InsetCollapsable.h"
|
2006-10-21 00:16:43 +00:00
|
|
|
|
2001-07-20 09:57:23 +00:00
|
|
|
|
2006-10-21 00:16:43 +00:00
|
|
|
namespace lyx {
|
2003-07-25 17:11:25 +00:00
|
|
|
|
2008-03-27 22:26:24 +00:00
|
|
|
class InsetNoteParams
|
|
|
|
|
{
|
2005-01-19 15:03:31 +00:00
|
|
|
public:
|
2003-12-10 17:28:14 +00:00
|
|
|
enum Type {
|
|
|
|
|
Note,
|
|
|
|
|
Comment,
|
2007-12-04 09:25:50 +00:00
|
|
|
Greyedout
|
2003-12-10 17:28:14 +00:00
|
|
|
};
|
|
|
|
|
/// \c type defaults to Note
|
|
|
|
|
InsetNoteParams();
|
2003-07-25 17:11:25 +00:00
|
|
|
///
|
|
|
|
|
void write(std::ostream & os) const;
|
|
|
|
|
///
|
2007-04-26 11:30:54 +00:00
|
|
|
void read(Lexer & lex);
|
2003-07-25 17:11:25 +00:00
|
|
|
///
|
2003-12-10 17:28:14 +00:00
|
|
|
Type type;
|
2003-07-08 14:19:25 +00:00
|
|
|
};
|
2003-07-25 17:11:25 +00:00
|
|
|
|
|
|
|
|
|
2008-03-27 22:26:24 +00:00
|
|
|
/////////////////////////////////////////////////////////////////////////
|
|
|
|
|
//
|
|
|
|
|
// InsetNote
|
|
|
|
|
//
|
|
|
|
|
/////////////////////////////////////////////////////////////////////////
|
2002-03-21 17:09:55 +00:00
|
|
|
|
2008-03-27 22:26:24 +00:00
|
|
|
/// The PostIt note inset, and other annotations
|
|
|
|
|
class InsetNote : public InsetCollapsable
|
|
|
|
|
{
|
2001-07-20 09:57:23 +00:00
|
|
|
public:
|
2002-03-21 17:09:55 +00:00
|
|
|
///
|
2009-11-08 15:53:21 +00:00
|
|
|
InsetNote(Buffer *, std::string const &);
|
2001-07-27 12:03:36 +00:00
|
|
|
///
|
2003-07-08 14:19:25 +00:00
|
|
|
~InsetNote();
|
2008-03-05 00:21:05 +00:00
|
|
|
///
|
2008-03-27 22:26:24 +00:00
|
|
|
static std::string params2string(InsetNoteParams const &);
|
|
|
|
|
///
|
|
|
|
|
static void string2params(std::string const &, InsetNoteParams &);
|
|
|
|
|
///
|
2008-03-05 00:21:05 +00:00
|
|
|
InsetNoteParams const & params() const { return params_; }
|
|
|
|
|
private:
|
2001-07-20 09:57:23 +00:00
|
|
|
///
|
2007-10-13 09:04:52 +00:00
|
|
|
InsetCode lyxCode() const { return NOTE_CODE; }
|
2001-07-20 09:57:23 +00:00
|
|
|
///
|
2007-08-13 12:13:17 +00:00
|
|
|
docstring name() const;
|
2007-12-04 09:25:50 +00:00
|
|
|
///
|
2008-03-27 22:26:24 +00:00
|
|
|
DisplayType display() const;
|
2007-04-29 12:32:14 +00:00
|
|
|
///
|
2008-03-09 17:43:16 +00:00
|
|
|
bool noFontChange() const { return params_.type != InsetNoteParams::Note; }
|
2010-12-20 22:33:12 +00:00
|
|
|
/// Is the content of this inset part of the output document?
|
|
|
|
|
bool producesOutput() const
|
|
|
|
|
{ return params_.type == InsetNoteParams::Greyedout; }
|
2008-03-09 17:43:16 +00:00
|
|
|
///
|
2010-02-13 16:22:39 +00:00
|
|
|
bool allowSpellCheck() const;
|
|
|
|
|
///
|
2008-02-27 20:43:16 +00:00
|
|
|
void write(std::ostream &) const;
|
2001-07-20 09:57:23 +00:00
|
|
|
///
|
2008-02-27 20:43:16 +00:00
|
|
|
void read(Lexer & lex);
|
2003-07-15 23:52:05 +00:00
|
|
|
/// show the note dialog
|
|
|
|
|
bool showInsetDialog(BufferView * bv) const;
|
2003-07-08 14:19:25 +00:00
|
|
|
///
|
2008-02-27 20:43:16 +00:00
|
|
|
bool isMacroScope() const;
|
2007-12-21 20:42:46 +00:00
|
|
|
///
|
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;
|
2001-08-18 15:01:09 +00:00
|
|
|
///
|
2008-02-27 20:43:16 +00:00
|
|
|
int plaintext(odocstream &, OutputParams const &) const;
|
2007-02-15 22:59:06 +00:00
|
|
|
///
|
2008-02-27 20:43:16 +00:00
|
|
|
int docbook(odocstream &, OutputParams const &) const;
|
2002-04-16 16:43:19 +00:00
|
|
|
///
|
2009-11-25 21:58:18 +00:00
|
|
|
docstring xhtml(XHTMLStream &, OutputParams const &) const;
|
2009-06-05 19:58:23 +00:00
|
|
|
///
|
2003-07-08 14:19:25 +00:00
|
|
|
void validate(LaTeXFeatures &) const;
|
|
|
|
|
///
|
2007-04-26 14:56:30 +00:00
|
|
|
bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
|
2008-02-11 13:06:01 +00:00
|
|
|
///
|
2011-01-12 22:23:27 +00:00
|
|
|
void addToToc(DocIterator const &) const;
|
2003-10-17 18:01:15 +00:00
|
|
|
///
|
2008-03-05 00:21:05 +00:00
|
|
|
void doDispatch(Cursor & cur, FuncRequest & cmd);
|
2008-02-27 20:43:16 +00:00
|
|
|
///
|
2008-03-05 00:21:05 +00:00
|
|
|
Inset * clone() const { return new InsetNote(*this); }
|
2001-07-23 09:11:14 +00:00
|
|
|
/// used by the constructors
|
|
|
|
|
void init();
|
2008-03-05 00:21:05 +00:00
|
|
|
///
|
2010-11-29 21:27:25 +00:00
|
|
|
docstring contextMenuName() const;
|
2008-03-24 13:33:48 +00:00
|
|
|
///
|
2008-03-05 00:21:05 +00:00
|
|
|
friend class InsetNoteParams;
|
|
|
|
|
|
2003-07-08 14:19:25 +00:00
|
|
|
///
|
|
|
|
|
InsetNoteParams params_;
|
|
|
|
|
};
|
|
|
|
|
|
2006-10-21 00:16:43 +00:00
|
|
|
} // namespace lyx
|
|
|
|
|
|
2008-03-27 22:26:24 +00:00
|
|
|
#endif // INSET_NOTE_H
|
