X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2Finsetnote.h;h=034f81158b8766b6c1b86a4e5babe26a08d64e29;hb=e28331ed63062dea10d0a21b9ec12034b4b17b9a;hp=ca75cade0151be97542fb5bec84f241f77df09cc;hpb=f1c24d100985c6df2eb5ec390017b69c78fe49c7;p=lyx.git diff --git a/src/insets/insetnote.h b/src/insets/insetnote.h index ca75cade01..034f81158b 100644 --- a/src/insets/insetnote.h +++ b/src/insets/insetnote.h @@ -1,60 +1,115 @@ // -*- C++ -*- -/* This file is part of - * ====================================================== +/** + * \file insetnote.h + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. * - * LyX, The Document Processor + * \author Angus Leeming * - * Copyright 2001 The LyX Team. - * - *====================================================== + * 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" -/** The PostIt note inset + +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 */ class InsetNote : public InsetCollapsable { public: /// - InsetNote(BufferParams const &); + InsetNote(BufferParams const &, std::string const &); + /// + ~InsetNote(); /// - InsetNote(InsetNote const &, bool same_id = false); + virtual docstring const editMessage() const; /// - Inset * clone(Buffer const &, bool same_id = false) const; - /// constructor with initial contents - InsetNote(Buffer const *, string const & contents, bool collapsed); + InsetBase::Code lyxCode() const { return InsetBase::NOTE_CODE; } /// - string const editMessage() const; + void write(Buffer const &, std::ostream &) const; /// - Inset::Code lyxCode() const { return Inset::IGNORE_CODE; } + void read(Buffer const & buf, LyXLex & lex); /// - void write(Buffer const *, std::ostream &) const; + void setButtonLabel(); + /// show the note dialog + bool showInsetDialog(BufferView * bv) const; /// - int latex(Buffer const *, std::ostream &, bool, bool) const - { return 0; } + int latex(Buffer const &, odocstream &, OutputParams const &) const; /// - int linuxdoc(Buffer const *, std::ostream &) const - { return 0; } + int docbook(Buffer const &, odocstream &, OutputParams const &) const; /// - int docbook(Buffer const *, std::ostream &, bool) const - { return 0; } + int plaintext(Buffer const &, odocstream &, OutputParams const &) const; /// - int ascii(Buffer const *, std::ostream &, int) const - { return 0; } + void validate(LaTeXFeatures &) 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 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