src/insets/insetcollapsable.C

   1 /**
   2  * \file insetcollapsable.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Alejandro Aguilar Sierra
   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 #include <config.h>
  14
  15 #include "insetcollapsable.h"
  16
  17 #include "buffer.h"
  18 #include "BufferView.h"
  19 #include "cursor.h"
  20 #include "debug.h"
  21 #include "dispatchresult.h"
  22 #include "FuncStatus.h"
  23 #include "LColor.h"
  24 #include "lyxlex.h"
  25 #include "funcrequest.h"
  26 #include "metricsinfo.h"
  27 #include "paragraph.h"
  28
  29 #include "frontends/font_metrics.h"
  30 #include "frontends/Painter.h"
  31 #include "frontends/LyXView.h"
  32
  33
  34 using lyx::graphics::PreviewLoader;
  35
  36 using std::endl;
  37 using std::string;
  38 using std::max;
  39 using std::min;
  40 using std::ostream;
  41
  42
  43 InsetCollapsable::CollapseStatus InsetCollapsable::status() const
  44 {
  45         return (autoOpen_ && status_ != Inlined) ? Open : status_;
  46 }
  47
  48
  49 InsetCollapsable::InsetCollapsable
  50                 (BufferParams const & bp, CollapseStatus status)
  51         : InsetText(bp), label("Label"), status_(status),
  52           openinlined_(false), autoOpen_(false)
  53 {
  54         setAutoBreakRows(true);
  55         setDrawFrame(true);
  56         setFrameColor(LColor::collapsableframe);
  57         setInsetName("Collapsable");
  58         setButtonLabel();
  59 }
  60
  61
  62 void InsetCollapsable::write(Buffer const & buf, ostream & os) const
  63 {
  64         os << "status ";
  65         switch (status_) {
  66         case Open:
  67                 os << "open";
  68                 break;
  69         case Collapsed:
  70                 os << "collapsed";
  71                 break;
  72         case Inlined:
  73                 os << "inlined";
  74                 break;
  75         }
  76         os << "\n";
  77         text_.write(buf, os);
  78 }
  79
  80
  81 void InsetCollapsable::read(Buffer const & buf, LyXLex & lex)
  82 {
  83         bool token_found = false;
  84         if (lex.isOK()) {
  85                 lex.next();
  86                 string const token = lex.getString();
  87                 if (token == "status") {
  88                         lex.next();
  89                         string const tmp_token = lex.getString();
  90
  91                         if (tmp_token == "inlined") {
  92                                 status_ = Inlined;
  93                                 token_found = true;
  94                         } else if (tmp_token == "collapsed") {
  95                                 status_ = Collapsed;
  96                                 token_found = true;
  97                         } else if (tmp_token == "open") {
  98                                 status_ = Open;
  99                                 token_found = true;
 100                         } else {
 101                                 lyxerr << "InsetCollapsable::read: Missing status!"
 102                                        << endl;
 103                                 // Take countermeasures
 104                                 lex.pushToken(token);
 105                         }
 106                 } else {
 107                         lyxerr << "InsetCollapsable::read: Missing 'status'-tag!"
 108                                    << endl;
 109                         // take countermeasures
 110                         lex.pushToken(token);
 111                 }
 112         }
 113         InsetText::read(buf, lex);
 114
 115         if (!token_found)
 116                 status_ = isOpen() ? Open : Collapsed;
 117
 118         setButtonLabel();
 119 }
 120
 121
 122 Dimension InsetCollapsable::dimensionCollapsed() const
 123 {
 124         Dimension dim;
 125         font_metrics::buttonText(label, labelfont_, dim.wid, dim.asc, dim.des);
 126         return dim;
 127 }
 128
 129
 130 void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
 131 {
 132         autoOpen_ = mi.base.bv->cursor().isInside(this);
 133         mi.base.textwidth -= 2 * TEXT_TO_INSET_OFFSET;
 134
 135         if (status() == Inlined) {
 136                 InsetText::metrics(mi, dim);
 137         } else {
 138                 dim = dimensionCollapsed();
 139                 if (status() == Open) {
 140                         InsetText::metrics(mi, textdim_);
 141                         openinlined_ = textdim_.wid + 2 * dim.wid <= mi.base.textwidth;
 142                         if (openinlined_) {
 143                                 // Correct for button width, and re-fit
 144                                 mi.base.textwidth -= dim.wid;
 145                                 InsetText::metrics(mi, textdim_);
 146                                 dim.wid += textdim_.wid;
 147                                 dim.des = max(dim.des - textdim_.asc + dim.asc, textdim_.des);
 148                                 dim.asc = textdim_.asc;
 149                         } else {
 150                                 dim.des += textdim_.height() + TEXT_TO_BOTTOM_OFFSET;
 151                                 dim.wid = max(dim.wid, textdim_.wid);
 152                         }
 153                 }
 154         }
 155         dim.asc += TEXT_TO_INSET_OFFSET;
 156         dim.des += TEXT_TO_INSET_OFFSET;
 157         dim.wid += 2 * TEXT_TO_INSET_OFFSET;
 158         mi.base.textwidth += 2 * TEXT_TO_INSET_OFFSET;
 159         dim_ = dim;
 160 }
 161
 162
 163 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
 164 {
 165         const int xx = x + TEXT_TO_INSET_OFFSET;
 166         if (status() == Inlined) {
 167                 InsetText::draw(pi, xx, y);
 168         } else {
 169                 Dimension dimc = dimensionCollapsed();
 170                 int const top  = y - ascent() + TEXT_TO_INSET_OFFSET;
 171                 button_dim.x1 = xx + 0;
 172                 button_dim.x2 = xx + dimc.width();
 173                 button_dim.y1 = top;
 174                 button_dim.y2 = top + dimc.height();
 175
 176                 pi.pain.buttonText(xx, top + dimc.asc, label, labelfont_);
 177
 178                 if (status() == Open) {
 179                         int textx, texty;
 180                         if (openinlined_) {
 181                                 textx = xx + dimc.width();
 182                                 texty = top + textdim_.asc;
 183                         } else {
 184                                 textx = xx;
 185                                 texty = top + dimc.height() + textdim_.asc;
 186                         }
 187                         InsetText::draw(pi, textx, texty);
 188                 }
 189         }
 190         setPosCache(pi, x, y);
 191 }
 192
 193
 194 void InsetCollapsable::drawSelection(PainterInfo & pi, int x, int y) const
 195 {
 196         x += TEXT_TO_INSET_OFFSET;
 197         if (status() == Open) {
 198                 if (openinlined_)
 199                         x += dimensionCollapsed().wid;
 200                 else
 201                         y += dimensionCollapsed().des + textdim_.asc;
 202         }
 203         if (status() != Collapsed)
 204                 InsetText::drawSelection(pi, x, y);
 205 }
 206
 207
 208 void InsetCollapsable::cursorPos
 209         (CursorSlice const & sl, bool boundary, int & x, int & y) const
 210 {
 211         BOOST_ASSERT(status() != Collapsed);
 212
 213         InsetText::cursorPos(sl, boundary, x, y);
 214
 215         if (status() == Open) {
 216                 if (openinlined_)
 217                         x += dimensionCollapsed().wid;
 218                 else
 219                         y += dimensionCollapsed().height() - ascent()
 220                                 + TEXT_TO_INSET_OFFSET + textdim_.asc;
 221         }
 222         x += TEXT_TO_INSET_OFFSET;
 223 }
 224
 225
 226 InsetBase::EDITABLE InsetCollapsable::editable() const
 227 {
 228         return status() != Collapsed ? HIGHLY_EDITABLE : IS_EDITABLE;
 229 }
 230
 231
 232 bool InsetCollapsable::descendable() const
 233 {
 234         return status() != Collapsed;
 235 }
 236
 237
 238 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
 239 {
 240         return button_dim.contains(cmd.x, cmd.y);
 241 }
 242
 243
 244 string const InsetCollapsable::getNewLabel(string const & l) const
 245 {
 246         string label;
 247         pos_type const max_length = 15;
 248         pos_type const p_siz = paragraphs().begin()->size();
 249         pos_type const n = min(max_length, p_siz);
 250         pos_type i = 0;
 251         pos_type j = 0;
 252         for (; i < n && j < p_siz; ++j) {
 253                 if (paragraphs().begin()->isInset(j))
 254                         continue;
 255                 label += paragraphs().begin()->getChar(j);
 256                 ++i;
 257         }
 258         if (paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
 259                 label += "...";
 260         }
 261         return label.empty() ? l : label;
 262 }
 263
 264
 265 void InsetCollapsable::edit(LCursor & cur, bool left)
 266 {
 267         //lyxerr << "InsetCollapsable: edit left/right" << endl;
 268         cur.push(*this);
 269         InsetText::edit(cur, left);
 270 }
 271
 272
 273 InsetBase * InsetCollapsable::editXY(LCursor & cur, int x, int y)
 274 {
 275         //lyxerr << "InsetCollapsable: edit xy" << endl;
 276         if (status() == Collapsed)
 277                 return this;
 278         cur.push(*this);
 279         return InsetText::editXY(cur, x, y);
 280 }
 281
 282
 283 void InsetCollapsable::doDispatch(LCursor & cur, FuncRequest & cmd)
 284 {
 285         //lyxerr << "InsetCollapsable::doDispatch (begin): cmd: " << cmd
 286         //      << " cur: " << cur << " bvcur: " << cur.bv().cursor() << endl;
 287
 288         switch (cmd.action) {
 289         case LFUN_MOUSE_PRESS:
 290                 if (status() == Inlined)
 291                         InsetText::doDispatch(cur, cmd);
 292                 else if (status() == Open && !hitButton(cmd))
 293                         InsetText::doDispatch(cur, cmd);
 294                 else
 295                         cur.undispatched();
 296                 break;
 297
 298         case LFUN_MOUSE_MOTION:
 299         case LFUN_MOUSE_DOUBLE:
 300         case LFUN_MOUSE_TRIPLE:
 301                 if (status_ == Inlined)
 302                         InsetText::doDispatch(cur, cmd);
 303                 else if (status() && !hitButton(cmd))
 304                         InsetText::doDispatch(cur, cmd);
 305                 else
 306                         cur.undispatched();
 307                 break;
 308
 309         case LFUN_MOUSE_RELEASE:
 310                 if (cmd.button() == mouse_button::button3) {
 311                         showInsetDialog(&cur.bv());
 312                         break;
 313                 }
 314
 315                 switch (status()) {
 316
 317                 case Collapsed:
 318                         //lyxerr << "InsetCollapsable::lfunMouseRelease 1" << endl;
 319                         setStatus(cur, Open);
 320                         edit(cur, true);
 321                         cur.bv().cursor() = cur;
 322                         break;
 323
 324                 case Open: {
 325                         if (hitButton(cmd)) {
 326                                 //lyxerr << "InsetCollapsable::lfunMouseRelease 2" << endl;
 327                                 setStatus(cur, Collapsed);
 328                                 cur.bv().cursor() = cur;
 329                         } else {
 330                                 //lyxerr << "InsetCollapsable::lfunMouseRelease 3" << endl;
 331                                 InsetText::doDispatch(cur, cmd);
 332                         }
 333                         break;
 334                 }
 335
 336                 case Inlined:
 337                         //lyxerr << "InsetCollapsable::lfunMouseRelease 4" << endl;
 338                         InsetText::doDispatch(cur, cmd);
 339                         break;
 340                 }
 341                 break;
 342
 343         case LFUN_INSET_TOGGLE:
 344                 if (cmd.argument == "open")
 345                         setStatus(cur, Open);
 346                 else if (cmd.argument == "close")
 347                         setStatus(cur, Collapsed);
 348                 else if (cmd.argument == "toggle" || cmd.argument.empty())
 349                         if (isOpen()) {
 350                                 setStatus(cur, Collapsed);
 351                                 cur.forwardPosNoDescend();
 352                         }
 353                         else
 354                                 setStatus(cur, Open);
 355                 else // if assign or anything else
 356                         cur.undispatched();
 357                 cur.dispatched();
 358                 break;
 359
 360         default:
 361                 InsetText::doDispatch(cur, cmd);
 362                 break;
 363         }
 364 }
 365
 366
 367 bool InsetCollapsable::getStatus(LCursor & cur, FuncRequest const & cmd,
 368                 FuncStatus & flag) const
 369 {
 370         switch (cmd.action) {
 371
 372         case LFUN_INSET_TOGGLE:
 373                 if (cmd.argument == "open" || cmd.argument == "close" ||
 374                     cmd.argument == "toggle")
 375                         flag.enabled(true);
 376                 else
 377                         flag.enabled(false);
 378                 return true;
 379
 380         default:
 381                 return InsetText::getStatus(cur, cmd, flag);
 382         }
 383 }
 384
 385
 386 void InsetCollapsable::setLabel(string const & l)
 387 {
 388         label = l;
 389 }
 390
 391
 392 void InsetCollapsable::setStatus(LCursor & cur, CollapseStatus status)
 393 {
 394         status_ = status;
 395         setButtonLabel();
 396         if (status_ == Collapsed)
 397                 cur.leaveInset(*this);
 398 }
 399
 400
 401 void InsetCollapsable::setLabelFont(LyXFont & font)
 402 {
 403         labelfont_ = font;
 404 }