X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2Finsetnote.h;h=034f81158b8766b6c1b86a4e5babe26a08d64e29;hb=e28331ed63062dea10d0a21b9ec12034b4b17b9a;hp=a23fbdb2191a29a2fc09719c23ae6cb9f4280b99;hpb=55bf6460f304a4632af2136a62c8a82fb86053f3;p=lyx.git diff --git a/src/insets/insetnote.h b/src/insets/insetnote.h index a23fbdb219..034f81158b 100644 --- a/src/insets/insetnote.h +++ b/src/insets/insetnote.h @@ -1,47 +1,115 @@ // -*- C++ -*- -/* This file is part of - * ====================================================== - * - * LyX, The Document Processor +/** + * \file insetnote.h + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. * - * Copyright 2001 The LyX Team. + * \author Angus Leeming * - *====================================================== + * Full author contact details are available in file CREDITS. */ #ifndef INSETNOTE_H #define INSETNOTE_H -#ifdef __GNUG__ -#pragma interface -#endif - #include "insetcollapsable.h" +#include "mailinset.h" + + +namespace lyx { + +class InsetNoteParams { +public: + enum Type { + Note, + Comment, + Greyedout, + Framed, + Shaded + }; + /// \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 -/** The PostIt note inset - */ class InsetNote : public InsetCollapsable { public: - /// - InsetNote(); - /// constructor with initial contents - InsetNote(Buffer const *, string const & contents, bool collapsed); /// - virtual Inset * clone(Buffer const &, bool) const; + InsetNote(BufferParams const &, std::string const &); + /// + ~InsetNote(); + /// + virtual docstring 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 &, odocstream &, OutputParams const &) const; + /// + int docbook(Buffer const &, odocstream &, OutputParams const &) const; /// - virtual string const editMessage() const; + int plaintext(Buffer const &, odocstream &, OutputParams const &) const; /// - virtual Inset::Code lyxCode() const { return Inset::IGNORE_CODE; } + void validate(LaTeXFeatures &) const; /// - virtual void write(Buffer const *, std::ostream &) const; + InsetNoteParams const & params() const { return params_; } /// - virtual int latex(Buffer const *, std::ostream &, bool, bool) const - { return 0; } + 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 doClone() const; + /// used by the constructors void init(); + /// + InsetNoteParams params_; +}; + +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_; }; + +} // namespace lyx + #endif