lyx_mirror/src/insets/InsetNote.h
André Pönitz f9b81e51e9 remove remaining MailInsets.
please check your favourite insets, I am sure I broke _something_...



git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@24006 a592a061-630c-0410-9148-cb99ea01b6c8
2008-03-27 22:26:24 +00:00

113 lines
2.3 KiB
C++

// -*- C++ -*-
/**
* \file InsetNote.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Angus Leeming
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSET_NOTE_H
#define INSET_NOTE_H
#include "InsetCollapsable.h"
namespace lyx {
class InsetNoteParams
{
public:
enum Type {
Note,
Comment,
Greyedout
};
/// \c type defaults to Note
InsetNoteParams();
///
void write(std::ostream & os) const;
///
void read(Lexer & lex);
///
Type type;
};
/////////////////////////////////////////////////////////////////////////
//
// InsetNote
//
/////////////////////////////////////////////////////////////////////////
/// The PostIt note inset, and other annotations
class InsetNote : public InsetCollapsable
{
public:
///
InsetNote(Buffer const &, std::string const &);
///
~InsetNote();
///
static std::string params2string(InsetNoteParams const &);
///
static void string2params(std::string const &, InsetNoteParams &);
///
InsetNoteParams const & params() const { return params_; }
private:
///
docstring editMessage() const;
///
InsetCode lyxCode() const { return NOTE_CODE; }
///
docstring name() const;
///
DisplayType display() const;
///
bool noFontChange() const { return params_.type != InsetNoteParams::Note; }
///
void write(std::ostream &) const;
///
void read(Lexer & lex);
///
void setButtonLabel();
/// show the note dialog
bool showInsetDialog(BufferView * bv) const;
///
bool isMacroScope() const;
///
int latex(odocstream &, OutputParams const &) const;
///
int plaintext(odocstream &, OutputParams const &) const;
///
int docbook(odocstream &, OutputParams const &) const;
///
void validate(LaTeXFeatures &) const;
///
bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
// Update the counters of this inset and of its contents
void updateLabels(ParIterator const &);
///
void addToToc(ParConstIterator const &) const;
///
void doDispatch(Cursor & cur, FuncRequest & cmd);
///
Inset * clone() const { return new InsetNote(*this); }
/// used by the constructors
void init();
///
docstring contextMenu(BufferView const & bv, int x, int y) const;
///
friend class InsetNoteParams;
///
InsetNoteParams params_;
};
} // namespace lyx
#endif // INSET_NOTE_H