src/insets/insetbox.h

   1 // -*- C++ -*-
   2 /**
   3  * \file insetbox.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Angus Leeming
   8  * \author Martin Vermeer
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef INSETBOX_H
  14 #define INSETBOX_H
  15
  16
  17 #include "insetcollapsable.h"
  18 #include "lyxlength.h"
  19
  20
  21 class InsetBoxParams {
  22 public:
  23         ///
  24         InsetBoxParams(std::string const &);
  25         ///
  26         void write(std::ostream & os) const;
  27         ///
  28         void read(LyXLex & lex);
  29         ///
  30         std::string type;
  31         /// Use a parbox (true) or minipage (false)
  32         bool use_parbox;
  33         /// Do we have an inner parbox or minipage to format paragraphs to
  34         /// columnwidth?
  35         bool inner_box;
  36         ///
  37         LyXLength width;
  38         /// "special" widths, see usrguide.dvi §3.5
  39         std::string special;
  40         ///
  41         char pos;
  42         ///
  43         char hor_pos;
  44         ///
  45         char inner_pos;
  46         ///
  47         LyXLength height;
  48         ///
  49         std::string height_special;
  50 };
  51
  52
  53 /** The fbox/fancybox inset
  54
  55 */
  56 class InsetBox : public InsetCollapsable {
  57 public:
  58         ///
  59         InsetBox(BufferParams const &, std::string const &);
  60         ///
  61         ~InsetBox();
  62         ///
  63         std::string const editMessage() const;
  64         ///
  65         InsetBase::Code lyxCode() const { return InsetBase::BOX_CODE; }
  66         ///
  67         void write(Buffer const &, std::ostream &) const;
  68         ///
  69         void read(Buffer const & buf, LyXLex & lex);
  70         ///
  71         void setButtonLabel();
  72         ///
  73         void metrics(MetricsInfo &, Dimension &) const;
  74         /// show the Box dialog
  75         bool showInsetDialog(BufferView * bv) const;
  76         ///
  77         bool display() const { return false; }
  78         ///
  79         bool forceDefaultParagraphs(idx_type) const;
  80         ///
  81         bool neverIndent() const { return true; }
  82         ///
  83         int latex(Buffer const &, std::ostream &,
  84                         OutputParams const &) const;
  85         ///
  86         int linuxdoc(Buffer const &, std::ostream &,
  87                      OutputParams const &) const;
  88         ///
  89         int docbook(Buffer const &, std::ostream &,
  90                     OutputParams const &) const;
  91         ///
  92         int plaintext(Buffer const &, std::ostream &,
  93                   OutputParams const & runparams) const;
  94         ///
  95         void validate(LaTeXFeatures &) const;
  96         ///
  97         InsetBoxParams const & params() const { return params_; }
  98         ///
  99         bool getStatus(LCursor &, FuncRequest const &, FuncStatus &) const;
 100         ///
 101         enum BoxType {
 102                 Frameless,
 103                 Boxed,
 104                 ovalbox,
 105                 Ovalbox,
 106                 Shadowbox,
 107                 Doublebox
 108         };
 109 protected:
 110         InsetBox(InsetBox const &);
 111         virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
 112 private:
 113         friend class InsetBoxParams;
 114
 115         virtual std::auto_ptr<InsetBase> doClone() const;
 116
 117         /// used by the constructors
 118         void init();
 119         ///
 120         InsetBoxParams params_;
 121 };
 122
 123
 124 #include "mailinset.h"
 125
 126 class InsetBoxMailer : public MailInset {
 127 public:
 128         ///
 129         InsetBoxMailer(InsetBox & inset);
 130         ///
 131         virtual InsetBase & inset() const { return inset_; }
 132         ///
 133         virtual std::string const & name() const { return name_; }
 134         ///
 135         virtual std::string const inset2string(Buffer const &) const;
 136         ///
 137         static std::string const params2string(InsetBoxParams const &);
 138         ///
 139         static void string2params(std::string const &, InsetBoxParams &);
 140
 141 private:
 142         ///
 143         static std::string const name_;
 144         ///
 145         InsetBox & inset_;
 146 };
 147
 148 #endif // INSET_BOX_H