src/insets/insetwrap.h

   1 /**
   2  * \file insetwrap.h
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Dekel Tsur
   7  *
   8  * Full author contact details are available in file CREDITS
   9  */
  10
  11 #ifndef InsetWrap_H
  12 #define InsetWrap_H
  13
  14
  15 #include "insetcollapsable.h"
  16 #include "toc.h"
  17 #include "lyxlength.h"
  18
  19
  20 struct InsetWrapParams {
  21         ///
  22         void write(std::ostream &) const;
  23         ///
  24         void read(LyXLex &);
  25
  26         ///
  27         string type;
  28         ///
  29         string placement;
  30         ///
  31         LyXLength width;
  32 };
  33
  34
  35 /** The wrap inset
  36  */
  37 class InsetWrap : public InsetCollapsable {
  38 public:
  39         ///
  40         InsetWrap(BufferParams const &, string const &);
  41         ///
  42         InsetWrap(InsetWrap const &);
  43         ///
  44         //InsetWrap(InsetWrap const &, bool same_id);
  45         ///
  46         ~InsetWrap();
  47         ///
  48         virtual dispatch_result localDispatch(FuncRequest const & cmd);
  49         ///
  50         void write(Buffer const * buf, std::ostream & os) const;
  51         ///
  52         void read(Buffer const * buf, LyXLex & lex);
  53         ///
  54         void validate(LaTeXFeatures & features) const;
  55         ///
  56         Inset * clone(Buffer const &) const;
  57         ///
  58         //Inset * clone(Buffer const &, bool same_id) const;
  59         ///
  60         Inset::Code lyxCode() const { return Inset::WRAP_CODE; }
  61         ///
  62         int latex(Buffer const *, std::ostream &,
  63                   LatexRunParams const &) const;
  64         ///
  65         int docbook(Buffer const *, std::ostream &, bool mixcont) const;
  66         ///
  67         string const editMessage() const;
  68         ///
  69         bool insetAllowed(Inset::Code) const;
  70         ///
  71         int getMaxWidth(BufferView *, UpdatableInset const *) const;
  72         ///
  73         void addToToc(toc::TocList &, Buffer const *) const;
  74         ///
  75         bool  showInsetDialog(BufferView *) const;
  76         ///
  77         int latexTextWidth(BufferView *) const;
  78         ///
  79         InsetWrapParams const & params() const { return params_; }
  80 private:
  81         ///
  82         InsetWrapParams params_;
  83 };
  84
  85
  86
  87 #include "mailinset.h"
  88
  89
  90 class InsetWrapMailer : public MailInset {
  91 public:
  92         ///
  93         InsetWrapMailer(InsetWrap & inset);
  94         ///
  95         virtual InsetBase & inset() const { return inset_; }
  96         ///
  97         virtual string const & name() const { return name_; }
  98         ///
  99         virtual string const inset2string() const;
 100         ///
 101         static void string2params(string const &, InsetWrapParams &);
 102         ///
 103         static string const params2string(InsetWrapParams const &);
 104 private:
 105         ///
 106         static string const name_;
 107         ///
 108         InsetWrap & inset_;
 109 };
 110
 111 #endif