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 "LColor.h"
  23 #include "lyxlex.h"
  24 #include "funcrequest.h"
  25 #include "metricsinfo.h"
  26 #include "paragraph.h"
  27
  28 #include "frontends/font_metrics.h"
  29 #include "frontends/Painter.h"
  30 #include "frontends/LyXView.h"
  31
  32
  33 using lyx::graphics::PreviewLoader;
  34
  35 using std::endl;
  36 using std::string;
  37 using std::max;
  38 using std::min;
  39 using std::ostream;
  40
  41
  42 InsetCollapsable::InsetCollapsable(BufferParams const & bp,
  43         CollapseStatus status)
  44         : inset(bp), label("Label"), status_(status)
  45 {
  46         inset.setOwner(this);
  47         inset.setAutoBreakRows(true);
  48         inset.setDrawFrame(InsetText::ALWAYS);
  49         inset.setFrameColor(LColor::collapsableframe);
  50         setInsetName("Collapsable");
  51         setButtonLabel();
  52 }
  53
  54
  55 InsetCollapsable::InsetCollapsable(InsetCollapsable const & in)
  56         : UpdatableInset(in), inset(in.inset),
  57           labelfont_(in.labelfont_), label(in.label), status_(in.status_)
  58 {
  59         inset.setOwner(this);
  60         setButtonLabel();
  61 }
  62
  63
  64 void InsetCollapsable::write(Buffer const & buf, ostream & os) const
  65 {
  66         os << "status ";
  67         switch (status_) {
  68         case Open:
  69                 os << "open";
  70                 break;
  71         case Collapsed:
  72                 os << "collapsed";
  73                 break;
  74         case Inlined:
  75                 os << "inlined";
  76                 break;
  77         }
  78         os << "\n";
  79         inset.text_.write(buf, os);
  80 }
  81
  82
  83 void InsetCollapsable::read(Buffer const & buf, LyXLex & lex)
  84 {
  85         bool token_found = false;
  86         if (lex.isOK()) {
  87                 lex.next();
  88                 string const token = lex.getString();
  89                 if (token == "status") {
  90                         lex.next();
  91                         string const tmp_token = lex.getString();
  92
  93                         if (tmp_token == "inlined") {
  94                                 status_ = Inlined;
  95                                 token_found = true;
  96                         } else if (tmp_token == "collapsed") {
  97                                 status_ = Collapsed;
  98                                 token_found = true;
  99                         } else if (tmp_token == "open") {
 100                                 status_ = Open;
 101                                 token_found = true;
 102                         } else {
 103                                 lyxerr << "InsetCollapsable::read: Missing status!"
 104                                        << endl;
 105                                 // Take countermeasures
 106                                 lex.pushToken(token);
 107                         }
 108                 } else {
 109                         lyxerr << "InsetCollapsable::Read: Missing 'status'-tag!"
 110                                    << endl;
 111                         // take countermeasures
 112                         lex.pushToken(token);
 113                 }
 114         }
 115         inset.read(buf, lex);
 116
 117         if (!token_found)
 118                 status_ = isOpen() ? Open : Collapsed;
 119
 120         setButtonLabel();
 121 }
 122
 123
 124 void InsetCollapsable::dimension_collapsed(Dimension & dim) const
 125 {
 126         font_metrics::buttonText(label, labelfont_, dim.wid, dim.asc, dim.des);
 127 }
 128
 129
 130 int InsetCollapsable::height_collapsed() const
 131 {
 132         Dimension dim;
 133         font_metrics::buttonText(label, labelfont_, dim.wid, dim.asc, dim.des);
 134         return dim.asc + dim.des;
 135 }
 136
 137
 138 void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
 139 {
 140         if (status_ == Inlined) {
 141                 inset.metrics(mi, dim);
 142         } else {
 143                 dimension_collapsed(dim);
 144                 if (status_ == Open) {
 145                         Dimension insetdim;
 146                         inset.metrics(mi, insetdim);
 147                         dim.des += insetdim.height() + TEXT_TO_BOTTOM_OFFSET;
 148                         dim.wid = max(dim.wid, insetdim.wid);
 149                 }
 150         }
 151         dim_ = dim;
 152 }
 153
 154
 155 void InsetCollapsable::draw_collapsed(PainterInfo & pi, int x, int y) const
 156 {
 157         pi.pain.buttonText(x, y, label, labelfont_);
 158 }
 159
 160
 161 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
 162 {
 163         setPosCache(pi, x, y);
 164
 165         if (status_ == Inlined) {
 166                 inset.draw(pi, x, y);
 167         } else {
 168                 Dimension dimc;
 169                 dimension_collapsed(dimc);
 170                 int const aa  = ascent();
 171                 button_dim.x1 = x + 0;
 172                 button_dim.x2 = x + dimc.width();
 173                 button_dim.y1 = y - aa;
 174                 button_dim.y2 = y - aa + dimc.height();
 175
 176                 draw_collapsed(pi, x, y);
 177                 if (status_ == Open) {
 178                         if (!owner())
 179                                 x += scroll();
 180                         inset.draw(pi, x, y - aa + dimc.height() + inset.ascent());
 181                 }
 182         }
 183 }
 184
 185
 186 InsetOld::EDITABLE InsetCollapsable::editable() const
 187 {
 188         return status_ != Collapsed ? HIGHLY_EDITABLE : IS_EDITABLE;
 189 }
 190
 191
 192 bool InsetCollapsable::descendable() const
 193 {
 194         return status_ != Collapsed;
 195 }
 196
 197
 198 DispatchResult
 199 InsetCollapsable::lfunMouseRelease(LCursor & cur, FuncRequest const & cmd)
 200 {
 201         if (cmd.button() == mouse_button::button3) {
 202                 lyxerr << "InsetCollapsable::lfunMouseRelease 0" << endl;
 203                 showInsetDialog(&cur.bv());
 204                 return DispatchResult(true, true);
 205         }
 206
 207         switch (status_) {
 208         case Collapsed:
 209                 lyxerr << "InsetCollapsable::lfunMouseRelease 1" << endl;
 210                 setStatus(Open);
 211                 edit(cur, true);
 212                 return DispatchResult(true, true);
 213
 214         case Open:
 215                 if (hitButton(cmd)) {
 216                         lyxerr << "InsetCollapsable::lfunMouseRelease 2" << endl;
 217                         setStatus(Collapsed);
 218                         return DispatchResult(false, FINISHED_RIGHT);
 219                 }
 220                 lyxerr << "InsetCollapsable::lfunMouseRelease 3" << endl;
 221                 return inset.dispatch(cur, cmd);
 222
 223         case Inlined:
 224                 return inset.dispatch(cur, cmd);
 225         }
 226         BOOST_ASSERT(false);
 227         // shut up compiler
 228         return DispatchResult(true, true);
 229 }
 230
 231
 232 int InsetCollapsable::latex(Buffer const & buf, ostream & os,
 233                             OutputParams const & runparams) const
 234 {
 235         return inset.latex(buf, os, runparams);
 236 }
 237
 238
 239 int InsetCollapsable::plaintext(Buffer const & buf, ostream & os,
 240                             OutputParams const & runparams) const
 241 {
 242         return inset.plaintext(buf, os, runparams);
 243 }
 244
 245
 246 int InsetCollapsable::linuxdoc(Buffer const & buf, ostream & os,
 247                                OutputParams const & runparams) const
 248 {
 249         return inset.linuxdoc(buf, os, runparams);
 250 }
 251
 252
 253 int InsetCollapsable::docbook(Buffer const & buf, ostream & os,
 254                               OutputParams const & runparams) const
 255 {
 256         return inset.docbook(buf, os, runparams);
 257 }
 258
 259
 260 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
 261 {
 262         return button_dim.contains(cmd.x, cmd.y);
 263 }
 264
 265
 266 string const InsetCollapsable::getNewLabel(string const & l) const
 267 {
 268         string la;
 269         pos_type const max_length = 15;
 270         pos_type const p_siz = inset.paragraphs().begin()->size();
 271         pos_type const n = min(max_length, p_siz);
 272         pos_type i = 0;
 273         pos_type j = 0;
 274         for( ; i < n && j < p_siz; ++j) {
 275                 if (inset.paragraphs().begin()->isInset(j))
 276                         continue;
 277                 la += inset.paragraphs().begin()->getChar(j);
 278                 ++i;
 279         }
 280         if (inset.paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
 281                 la += "...";
 282         }
 283         return la.empty() ? l : la;
 284 }
 285
 286
 287 void InsetCollapsable::edit(LCursor & cur, bool left)
 288 {
 289         //lyxerr << "InsetCollapsable: edit left/right" << endl;
 290         cur.push(this);
 291         inset.edit(cur, left);
 292         open();
 293 }
 294
 295
 296 void InsetCollapsable::edit(LCursor & cur, int x, int y)
 297 {
 298         cur.push(this);
 299         //lyxerr << "InsetCollapsable: edit xy" << endl;
 300         if (status_ == Collapsed) {
 301                 setStatus(Open);
 302         } else {
 303                 if (y <= button_dim.y2)
 304                         y = 0;
 305                 else
 306                         y += inset.ascent() - height_collapsed();
 307         }
 308         inset.edit(cur, x, y);
 309 }
 310
 311
 312 DispatchResult
 313 InsetCollapsable::priv_dispatch(LCursor & cur, FuncRequest const & cmd)
 314 {
 315         lyxerr << "\nInsetCollapsable::priv_dispatch (begin): cmd: " << cmd
 316                 << "  button y: " << button_dim.y2 << endl;
 317         switch (cmd.action) {
 318                 case LFUN_MOUSE_PRESS:
 319                         if (status_ == Inlined)
 320                                 inset.dispatch(cur, cmd);
 321                         else if (status_ == Open && cmd.y > button_dim.y2)
 322                                 inset.dispatch(cur, cmd);
 323                         return DispatchResult(true, true);
 324
 325                 case LFUN_MOUSE_MOTION:
 326                         if (status_ == Inlined)
 327                                 inset.dispatch(cur, cmd);
 328                         else if (status_ == Open && cmd.y > button_dim.y2)
 329                                 inset.dispatch(cur, cmd);
 330                         return DispatchResult(true, true);
 331
 332                 case LFUN_MOUSE_RELEASE:
 333                         return lfunMouseRelease(cur, cmd);
 334
 335                 case LFUN_INSET_TOGGLE:
 336                         if (inset.text_.toggleInset())
 337                                 return DispatchResult(true, true);
 338                         if (status_ == Open) {
 339                                 setStatus(Inlined);
 340                                 return DispatchResult(true, true);
 341                         } else {
 342                                 setStatus(Collapsed);
 343                                 return DispatchResult(false, FINISHED_RIGHT);
 344                         }
 345
 346                 default:
 347                         return inset.dispatch(cur, cmd);
 348         }
 349 }
 350
 351
 352 void InsetCollapsable::validate(LaTeXFeatures & features) const
 353 {
 354         inset.validate(features);
 355 }
 356
 357
 358 void InsetCollapsable::getCursorPos(CursorSlice const & cur,
 359         int & x, int & y) const
 360 {
 361         inset.getCursorPos(cur, x, y);
 362 }
 363
 364
 365 void InsetCollapsable::getLabelList(Buffer const & buffer,
 366                                     std::vector<string> & list) const
 367 {
 368         inset.getLabelList(buffer, list);
 369 }
 370
 371
 372 int InsetCollapsable::scroll(bool recursive) const
 373 {
 374         int sx = UpdatableInset::scroll(false);
 375
 376         if (recursive)
 377                 sx += inset.scroll(false);
 378
 379         return sx;
 380 }
 381
 382
 383 int InsetCollapsable::numParagraphs() const
 384 {
 385         return inset.numParagraphs();
 386 }
 387
 388
 389 LyXText * InsetCollapsable::getText(int i) const
 390 {
 391         return inset.getText(i);
 392 }
 393
 394
 395 void InsetCollapsable::open()
 396 {
 397         if (status_ == Collapsed)   // ...but not inlined
 398                 setStatus(Open);
 399 }
 400
 401
 402 void InsetCollapsable::close()
 403 {
 404         setStatus(Collapsed);
 405 }
 406
 407
 408 void InsetCollapsable::setLabel(string const & l)
 409 {
 410         label = l;
 411 }
 412
 413
 414 void InsetCollapsable::setStatus(CollapseStatus st)
 415 {
 416         status_ = st;
 417         setButtonLabel();
 418 }
 419
 420
 421 void InsetCollapsable::markErased()
 422 {
 423         inset.markErased();
 424 }
 425
 426
 427 void InsetCollapsable::addPreview(PreviewLoader & loader) const
 428 {
 429         inset.addPreview(loader);
 430 }
 431
 432
 433 bool InsetCollapsable::insetAllowed(InsetOld::Code code) const
 434 {
 435         return inset.insetAllowed(code);
 436 }
 437
 438
 439 void InsetCollapsable::setLabelFont(LyXFont & font)
 440 {
 441         labelfont_ = font;
 442 }
 443
 444
 445 void InsetCollapsable::scroll(BufferView & bv, float sx) const
 446 {
 447         UpdatableInset::scroll(bv, sx);
 448 }
 449
 450
 451 void InsetCollapsable::scroll(BufferView & bv, int offset) const
 452 {
 453         UpdatableInset::scroll(bv, offset);
 454 }
 455
 456
 457 Box const & InsetCollapsable::buttonDim() const
 458 {
 459         return button_dim;
 460 }
 461
 462
 463 void InsetCollapsable::setBackgroundColor(LColor_color color)
 464 {
 465         InsetOld::setBackgroundColor(color);
 466         inset.setBackgroundColor(color);
 467 }