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 &, bool same_id = false);
  60         ///
  61         ~InsetMinipage();
  62         ///
  63         virtual dispatch_result localDispatch(FuncRequest const & cmd);
  64         ///
  65         void write(Buffer const * buf, std::ostream & os) const;
  66         ///
  67         void read(Buffer const * buf, LyXLex & lex);
  68         ///
  69         Inset * clone(Buffer const &, bool same_id = false) const;
  70         ///
  71         int ascent(BufferView *, LyXFont const &) const;
  72         ///
  73         int descent(BufferView *, LyXFont const &) const;
  74         ///
  75         Inset::Code lyxCode() const { return Inset::MINIPAGE_CODE; }
  76         ///
  77         int latex(Buffer const *, std::ostream &, bool fragile, bool fp) const;
  78         ///
  79         string const editMessage() const;
  80         ///
  81         bool insetAllowed(Inset::Code) const;
  82         ///
  83         int getMaxWidth(BufferView *, UpdatableInset const *) const;
  84         ///
  85         bool needFullRow() const { return false; }
  86         /** returns true if, when outputing LaTeX, font changes should
  87             be closed before generating this inset. This is needed for
  88             insets that may contain several paragraphs */
  89         bool noFontChange() const { return true; }
  90         ///
  91         bool showInsetDialog(BufferView *) const;
  92         ///
  93         int latexTextWidth(BufferView *) const;
  94         ///
  95         void params(Params const & p) { params_ = p; }
  96         ///
  97         Params const & params() const { return params_; }
  98 private:
  99         ///
 100         Params params_;
 101 };
 102
 103
 104 #include "mailinset.h"
 105
 106
 107 class InsetMinipageMailer : public MailInset {
 108 public:
 109         ///
 110         InsetMinipageMailer(InsetMinipage & inset);
 111         ///
 112         virtual InsetBase & inset() const { return inset_; }
 113         ///
 114         virtual string const & name() const { return name_; }
 115         ///
 116         virtual string const inset2string() const;
 117         ///
 118         static void string2params(string const &, InsetMinipage::Params &);
 119         ///
 120         static string const params2string(InsetMinipage::Params const &);
 121 private:
 122         ///
 123         static string const name_;
 124         ///
 125         InsetMinipage & inset_;
 126 };
 127
 128 #endif