lyx_mirror/src/insets/insetnote.h
Georg Baum 323cafa18c implement missing getStatus methods
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@9853 a592a061-630c-0410-9148-cb99ea01b6c8
2005-04-22 08:57:22 +00:00

116 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 INSETNOTE_H
#define INSETNOTE_H
#include "insetcollapsable.h"
class InsetNoteParams {
public:
enum Type {
Note,
Comment,
Greyedout
};
/// \c type defaults to Note
InsetNoteParams();
///
void write(std::ostream & os) const;
///
void read(LyXLex & lex);
///
Type type;
};
/** The PostIt note inset, and other annotations
*/
class InsetNote : public InsetCollapsable {
public:
///
InsetNote(BufferParams const &, std::string const &);
///
~InsetNote();
///
std::string const editMessage() const;
///
InsetBase::Code lyxCode() const { return InsetBase::NOTE_CODE; }
///
void write(Buffer const &, std::ostream &) const;
///
void read(Buffer const & buf, LyXLex & lex);
///
void setButtonLabel();
/// show the note dialog
bool showInsetDialog(BufferView * bv) const;
///
int latex(Buffer const &, std::ostream &,
OutputParams const &) const;
///
int linuxdoc(Buffer const &, std::ostream &,
OutputParams const &) const;
///
int docbook(Buffer const &, std::ostream &,
OutputParams const &) const;
///
int plaintext(Buffer const &, std::ostream &,
OutputParams const &) const;
///
void validate(LaTeXFeatures &) const;
///
InsetNoteParams const & params() const { return params_; }
///
bool getStatus(LCursor &, FuncRequest const &, FuncStatus &) const;
protected:
InsetNote(InsetNote const &);
///
virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
private:
friend class InsetNoteParams;
virtual std::auto_ptr<InsetBase> doClone() const;
/// used by the constructors
void init();
///
InsetNoteParams params_;
};
#include "mailinset.h"
class InsetNoteMailer : public MailInset {
public:
///
InsetNoteMailer(InsetNote & inset);
///
virtual InsetBase & inset() const { return inset_; }
///
virtual std::string const & name() const { return name_; }
///
virtual std::string const inset2string(Buffer const &) const;
///
static std::string const params2string(InsetNoteParams const &);
///
static void string2params(std::string const &, InsetNoteParams &);
private:
///
static std::string const name_;
///
InsetNote & inset_;
};
#endif