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 #include "support/translator.h"
  20
  21
  22 struct InsetBoxParams {
  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         /// Copy constructor
  61         InsetBox(InsetBox const &);
  62         ///
  63         ~InsetBox();
  64         ///
  65         virtual std::auto_ptr<InsetBase> clone() const;
  66         ///
  67         std::string const editMessage() const;
  68         ///
  69         InsetOld::Code lyxCode() const { return InsetOld::BOX_CODE; }
  70         ///
  71         void write(Buffer const &, std::ostream &) const;
  72         ///
  73         void read(Buffer const & buf, LyXLex & lex);
  74         ///
  75         void setButtonLabel();
  76         ///
  77         void metrics(MetricsInfo &, Dimension &) const;
  78         /// show the Box dialog
  79         bool showInsetDialog(BufferView * bv) const;
  80         ///
  81         bool display() const { return false; }
  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         enum BoxType {
 100                 Frameless,
 101                 Boxed,
 102                 ovalbox,
 103                 Ovalbox,
 104                 Shadowbox,
 105                 Doublebox
 106         };
 107 protected:
 108         ///
 109         virtual
 110         DispatchResult
 111         priv_dispatch(FuncRequest const &, idx_type &, pos_type &);
 112 private:
 113         friend class InsetBoxParams;
 114
 115         /// used by the constructors
 116         void init();
 117         ///
 118         InsetBoxParams params_;
 119 };
 120
 121
 122 namespace {
 123
 124 typedef Translator<std::string, InsetBox::BoxType> BoxTranslator;
 125 BoxTranslator const & boxtranslator();
 126 BoxTranslator const & boxtranslator_loc();
 127
 128 } // anon
 129
 130
 131 #include "mailinset.h"
 132
 133 class InsetBoxMailer : public MailInset {
 134 public:
 135         ///
 136         InsetBoxMailer(InsetBox & inset);
 137         ///
 138         virtual InsetBase & inset() const { return inset_; }
 139         ///
 140         virtual std::string const & name() const { return name_; }
 141         ///
 142         virtual std::string const inset2string(Buffer const &) const;
 143         ///
 144         static std::string const params2string(InsetBoxParams const &);
 145         ///
 146         static void string2params(std::string const &, InsetBoxParams &);
 147
 148 private:
 149         ///
 150         static std::string const name_;
 151         ///
 152         InsetBox & inset_;
 153 };
 154
 155 #endif // INSET_BOX_H