src/insets/insetminipage.C

   1 /* This file is part of
   2  * ======================================================
   3  *
   4  *           LyX, The Document Processor
   5  *
   6  *          Copyright 1998 The LyX Team.
   7  *
   8  *======================================================*/
   9
  10 #include <config.h>
  11
  12 #ifdef __GNUG__
  13 #pragma implementation
  14 #endif
  15
  16 #include "insetminipage.h"
  17 #include "gettext.h"
  18 #include "lyxfont.h"
  19 #include "BufferView.h"
  20 #include "LyXView.h"
  21 #include "frontends/Dialogs.h"
  22 #include "lyxtext.h"
  23 #include "insets/insettext.h"
  24 #include "support/LOstream.h"
  25 #include "support/lstrings.h"
  26 #include "debug.h"
  27
  28 using std::ostream;
  29 using std::endl;
  30
  31
  32 // Some information about Minipages in LaTeX:
  33 // A minipage is a complete miniversion of a page and can contain
  34 // its own footnotes, paragraphs, and array, tabular, and multicols
  35 // environments. However it cannot contain floats or \marginpar's,
  36 // but it can appear inside floats.
  37 //
  38 // The minipage environment is defined like this:
  39 //
  40 // \begin{minipage}[pos][height][inner-pos]{width} <text> \end{minipage}
  41 //
  42 // Where:
  43 //     pos [opt] = is the vertical placement of the box with respect
  44 //                 to the text baseline, [c], [t] and [b].
  45 //     height [opt] = the height of the box
  46 //     inner-pos [opt] = the position of the text within the box.
  47 //                 It can be t, c, b or s, if unspecified the value
  48 //                 of pos is used.
  49 //     width = the width of the box
  50 //
  51 // In LyX we should try to support all these parameters, settable in a
  52 // pop-up dialog.
  53 // In this pop-up diallog it should also be possible to set all margin
  54 // values that is usable in the minipage.
  55 // With regard to different formats (like DocBook) I guess a minipage
  56 // can be used there also. Perhaps not in the latex way, but we do not
  57 // have to output "" for minipages.
  58 // (Lgb)
  59
  60 InsetMinipage::InsetMinipage()
  61         : InsetCollapsable(), pos_(center),
  62           inner_pos_(inner_center)
  63 {
  64         setLabel(_("minipage"));
  65         LyXFont font(LyXFont::ALL_SANE);
  66         font.decSize();
  67         font.decSize();
  68         font.setColor(LColor::footnote);
  69         setLabelFont(font);
  70         setAutoCollapse(false);
  71         setInsetName("Minipage");
  72         collapsed = false;
  73 }
  74
  75
  76 InsetMinipage::~InsetMinipage()
  77 {
  78         hideDialog();
  79 }
  80
  81
  82 void InsetMinipage::Write(Buffer const * buf, ostream & os) const
  83 {
  84         os << getInsetName() << "\n";
  85         InsetCollapsable::Write(buf, os);
  86 }
  87
  88
  89 Inset * InsetMinipage::Clone(Buffer const &) const
  90 {
  91         InsetMinipage * result = new InsetMinipage;
  92         result->inset->init(inset);
  93
  94         result->collapsed = collapsed;
  95         return result;
  96 }
  97
  98
  99 string const InsetMinipage::EditMessage() const
 100 {
 101         return _("Opened Minipage Inset");
 102 }
 103
 104
 105 int InsetMinipage::Latex(Buffer const * buf,
 106                          ostream & os, bool fragile, bool fp) const
 107 {
 108         os << "\\begin{minipage}{\\columnwidth}%\n";
 109
 110         int i = inset->Latex(buf, os, fragile, fp);
 111         os << "\\end{minipage}%\n";
 112
 113         return i + 2;
 114 }
 115
 116
 117 bool InsetMinipage::InsertInsetAllowed(Inset * in) const
 118 {
 119         if ((in->LyxCode() == Inset::FLOAT_CODE) ||
 120             (in->LyxCode() == Inset::MARGIN_CODE)) {
 121                 return false;
 122         }
 123         return true;
 124 }
 125
 126
 127 InsetMinipage::Position InsetMinipage::pos() const
 128 {
 129         return pos_;
 130 }
 131
 132
 133 void InsetMinipage::pos(InsetMinipage::Position p)
 134 {
 135         pos_ = p;
 136 }
 137
 138
 139 InsetMinipage::InnerPosition InsetMinipage::innerPos() const
 140 {
 141         return inner_pos_;
 142 }
 143
 144
 145 void InsetMinipage::innerPos(InsetMinipage::InnerPosition ip)
 146 {
 147         inner_pos_ = ip;
 148 }
 149
 150
 151 LyXLength const & InsetMinipage::height() const
 152 {
 153         return height_;
 154 }
 155
 156
 157 void InsetMinipage::height(LyXLength const & ll)
 158 {
 159         height_ = ll;
 160 }
 161
 162
 163 string const & InsetMinipage::width() const
 164 {
 165         return width_;
 166 }
 167
 168
 169 void InsetMinipage::width(string const & ll)
 170 {
 171         width_ = ll;
 172 }
 173
 174 int InsetMinipage::widthp() const
 175 {
 176         return widthp_;
 177 }
 178
 179
 180 void InsetMinipage::widthp(int ll)
 181 {
 182         widthp_ = ll;
 183 }
 184
 185
 186 void InsetMinipage::widthp(string const & ll)
 187 {
 188         widthp_ = strToInt(ll);
 189 }
 190
 191
 192 void InsetMinipage::InsetButtonRelease(BufferView * bv, int x, int y,
 193                                        int button)
 194 {
 195     if (button == 3) {
 196 #if 0
 197 // we have to check first if we have a locking inset and if this locking inset
 198 // has a popup menu with the 3rd button
 199         if (the_locking_inset) {
 200             UpdatableInset * i;
 201             if ((i=the_locking_inset->GetFirstLockingInsetOfType(TABULAR_CODE))) {
 202                 i->InsetButtonRelease(bv, x, y, button);
 203                 return;
 204             }
 205         }
 206 #endif
 207         bv->owner()->getDialogs()->showMinipage(this);
 208         return;
 209     }
 210     InsetCollapsable::InsetButtonRelease(bv, x, y, button);
 211 }