src/insets/insetminipage.h

   1 // -*- C++ -*-
   2 /**
   3  * \file insetminipage.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Jürgen Vigna
   8  * \author Lars Gullik Bjønnes
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef INSETMINIPAGE_H
  14 #define INSETMINIPAGE_H
  15
  16 #include "insetcollapsable.h"
  17 #include "lyxlength.h"
  18
  19 /** The minipage inset
  20
  21 */
  22 class InsetMinipage : public InsetCollapsable {
  23 public:
  24         ///
  25         enum Position {
  26                 top,
  27                 center,
  28                 bottom
  29         };
  30         ///
  31         enum InnerPosition {
  32                 inner_center,
  33                 inner_top,
  34                 inner_bottom,
  35                 inner_stretch
  36         };
  37
  38         ///
  39         struct Params {
  40                 ///
  41                 Params();
  42                 ///
  43                 Position pos;
  44                 ///
  45                 InnerPosition inner_pos;
  46                 ///
  47                 LyXLength height;
  48                 ///
  49                 LyXLength width;
  50                 ///
  51                 void write(std::ostream & os) const;
  52                 ///
  53                 void read(LyXLex & lex);
  54         };
  55
  56         ///
  57         InsetMinipage(BufferParams const &);
  58         ///
  59         InsetMinipage(InsetMinipage const &);
  60         ///
  61         ~InsetMinipage();
  62         ///
  63         void write(Buffer const & buf, std::ostream & os) const;
  64         ///
  65         void read(Buffer const & buf, LyXLex & lex);
  66         ///
  67         virtual std::auto_ptr<InsetBase> clone() const;
  68         ///
  69         void metrics(MetricsInfo &, Dimension &) const;
  70         ///
  71         InsetOld::Code lyxCode() const { return InsetOld::MINIPAGE_CODE; }
  72         ///
  73         int latex(Buffer const &, std::ostream &,
  74                   OutputParams const &) const;
  75         ///
  76         std::string const editMessage() const;
  77         ///
  78         bool insetAllowed(InsetOld::Code) const;
  79         /** returns true if, when outputing LaTeX, font changes should
  80             be closed before generating this inset. This is needed for
  81             insets that may contain several paragraphs */
  82         bool noFontChange() const { return true; }
  83         ///
  84         bool showInsetDialog(BufferView *) const;
  85         ///
  86         int latexTextWidth(BufferView *) const;
  87         ///
  88         void params(Params const & p) { params_ = p; }
  89         ///
  90         Params const & params() const { return params_; }
  91 protected:
  92         ///
  93         virtual
  94         DispatchResult
  95         priv_dispatch(FuncRequest const & cmd, idx_type &, pos_type &);
  96 private:
  97         ///
  98         Params params_;
  99 };
 100
 101
 102 #include "mailinset.h"
 103
 104
 105 class InsetMinipageMailer : public MailInset {
 106 public:
 107         ///
 108         InsetMinipageMailer(InsetMinipage & inset);
 109         ///
 110         virtual InsetBase & inset() const { return inset_; }
 111         ///
 112         virtual std::string const & name() const { return name_; }
 113         ///
 114         virtual std::string const inset2string(Buffer const &) const;
 115         ///
 116         static void string2params(std::string const &, InsetMinipage::Params &);
 117         ///
 118         static std::string const params2string(InsetMinipage::Params const &);
 119 private:
 120         ///
 121         static std::string const name_;
 122         ///
 123         InsetMinipage & inset_;
 124 };
 125
 126 #endif