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 + pi.base.bv->top_y();
 174                 button_dim.y2 = y - aa + pi.base.bv->top_y() + 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 void InsetCollapsable::drawSelection(PainterInfo & pi, int x, int y) const
 187 {
 188         inset.drawSelection(pi, x, y);
 189 }
 190
 191
 192 InsetOld::EDITABLE InsetCollapsable::editable() const
 193 {
 194         return status_ != Collapsed ? HIGHLY_EDITABLE : IS_EDITABLE;
 195 }
 196
 197
 198 bool InsetCollapsable::descendable() const
 199 {
 200         return status_ != Collapsed;
 201 }
 202
 203
 204 DispatchResult
 205 InsetCollapsable::lfunMouseRelease(LCursor & cur, FuncRequest const & cmd)
 206 {
 207         if (cmd.button() == mouse_button::button3) {
 208                 showInsetDialog(&cur.bv());
 209         }
 210
 211         switch (status_) {
 212         case Collapsed:
 213                 lyxerr << "InsetCollapsable::lfunMouseRelease 1" << endl;
 214                 setStatus(Open);
 215                 edit(cur, true);
 216                 return DispatchResult(true, true);
 217
 218         case Open: {
 219                 FuncRequest cmd1 = cmd;
 220 //              cmd1.y -= cur.bv().top_y();
 221                 if (hitButton(cmd1)) {
 222                         lyxerr << "InsetCollapsable::lfunMouseRelease 2" << endl;
 223                         setStatus(Collapsed);
 224                         return DispatchResult(false, FINISHED_RIGHT);
 225                 }
 226                 lyxerr << "InsetCollapsable::lfunMouseRelease 3" << endl;
 227                 return inset.dispatch(cur, cmd);
 228         }
 229         case Inlined:
 230                 return inset.dispatch(cur, cmd);
 231         }
 232         BOOST_ASSERT(false);
 233         // shut up compiler
 234         return DispatchResult(true, true);
 235 }
 236
 237
 238 int InsetCollapsable::latex(Buffer const & buf, ostream & os,
 239                             OutputParams const & runparams) const
 240 {
 241         return inset.latex(buf, os, runparams);
 242 }
 243
 244
 245 int InsetCollapsable::plaintext(Buffer const & buf, ostream & os,
 246                             OutputParams const & runparams) const
 247 {
 248         return inset.plaintext(buf, os, runparams);
 249 }
 250
 251
 252 int InsetCollapsable::linuxdoc(Buffer const & buf, ostream & os,
 253                                OutputParams const & runparams) const
 254 {
 255         return inset.linuxdoc(buf, os, runparams);
 256 }
 257
 258
 259 int InsetCollapsable::docbook(Buffer const & buf, ostream & os,
 260                               OutputParams const & runparams) const
 261 {
 262         return inset.docbook(buf, os, runparams);
 263 }
 264
 265
 266 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
 267 {
 268         return button_dim.contains(cmd.x, cmd.y);
 269 }
 270
 271
 272 string const InsetCollapsable::getNewLabel(string const & l) const
 273 {
 274         string la;
 275         pos_type const max_length = 15;
 276         pos_type const p_siz = inset.paragraphs().begin()->size();
 277         pos_type const n = min(max_length, p_siz);
 278         pos_type i = 0;
 279         pos_type j = 0;
 280         for( ; i < n && j < p_siz; ++j) {
 281                 if (inset.paragraphs().begin()->isInset(j))
 282                         continue;
 283                 la += inset.paragraphs().begin()->getChar(j);
 284                 ++i;
 285         }
 286         if (inset.paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
 287                 la += "...";
 288         }
 289         return la.empty() ? l : la;
 290 }
 291
 292
 293 void InsetCollapsable::edit(LCursor & cur, bool left)
 294 {
 295         //lyxerr << "InsetCollapsable: edit left/right" << endl;
 296         cur.push(this);
 297         inset.edit(cur, left);
 298         open();
 299 }
 300
 301
 302 void InsetCollapsable::edit(LCursor & cur, int x, int y)
 303 {
 304         cur.push(this);
 305         //lyxerr << "InsetCollapsable: edit xy" << endl;
 306         if (status_ == Collapsed) {
 307                 setStatus(Open);
 308                 inset.edit(cur, true);
 309 #warning look here
 310 //we are not calling edit(x,y) because there are no coordinates in the
 311 //inset yet. I personally think it's ok. (ab)
 312         } else {
 313 //              if (y <= yo() + inset.ascent() + button_dim.y2)
 314 //                      y = yo();
 315 //              else
 316 //                      y += inset.ascent() - height_collapsed();
 317
 318                 inset.edit(cur, x, y);
 319         }
 320 }
 321
 322
 323 DispatchResult
 324 InsetCollapsable::priv_dispatch(LCursor & cur, FuncRequest const & cmd)
 325 {
 326         //lyxerr << "\nInsetCollapsable::priv_dispatch (begin): cmd: " << cmd
 327         //      << "  button y: " << button_dim.y2 << endl;
 328         switch (cmd.action) {
 329                 case LFUN_MOUSE_PRESS:
 330                         if (status_ == Inlined)
 331                                 inset.dispatch(cur, cmd);
 332                         else if (status_ == Open && cmd.y > button_dim.y2)
 333                                 inset.dispatch(cur, cmd);
 334                         return DispatchResult(true, true);
 335
 336                 case LFUN_MOUSE_MOTION:
 337                         if (status_ == Inlined)
 338                                 inset.dispatch(cur, cmd);
 339                         else if (status_ == Open && cmd.y > button_dim.y2)
 340                                 inset.dispatch(cur, cmd);
 341                         return DispatchResult(true, true);
 342
 343                 case LFUN_MOUSE_RELEASE:
 344                         return lfunMouseRelease(cur, cmd);
 345
 346                 case LFUN_INSET_TOGGLE:
 347                         if (inset.text_.toggleInset(cur))
 348                                 return DispatchResult(true, true);
 349                         if (status_ == Open) {
 350                                 setStatus(Inlined);
 351                                 return DispatchResult(true, true);
 352                         }
 353                         setStatus(Collapsed);
 354                         return DispatchResult(false, FINISHED_RIGHT);
 355
 356                 default:
 357                         return inset.dispatch(cur, cmd);
 358         }
 359 }
 360
 361
 362 void InsetCollapsable::validate(LaTeXFeatures & features) const
 363 {
 364         inset.validate(features);
 365 }
 366
 367
 368 void InsetCollapsable::getCursorPos(CursorSlice const & cur,
 369         int & x, int & y) const
 370 {
 371         inset.getCursorPos(cur, x, y);
 372 }
 373
 374
 375 void InsetCollapsable::getLabelList(Buffer const & buffer,
 376                                     std::vector<string> & list) const
 377 {
 378         inset.getLabelList(buffer, list);
 379 }
 380
 381
 382 int InsetCollapsable::scroll(bool recursive) const
 383 {
 384         int sx = UpdatableInset::scroll(false);
 385
 386         if (recursive)
 387                 sx += inset.scroll(false);
 388
 389         return sx;
 390 }
 391
 392
 393 int InsetCollapsable::numParagraphs() const
 394 {
 395         return inset.numParagraphs();
 396 }
 397
 398
 399 LyXText * InsetCollapsable::getText(int i) const
 400 {
 401         return inset.getText(i);
 402 }
 403
 404
 405 void InsetCollapsable::open()
 406 {
 407         if (status_ == Collapsed)   // ...but not inlined
 408                 setStatus(Open);
 409 }
 410
 411
 412 void InsetCollapsable::close()
 413 {
 414         setStatus(Collapsed);
 415 }
 416
 417
 418 void InsetCollapsable::setLabel(string const & l)
 419 {
 420         label = l;
 421 }
 422
 423
 424 void InsetCollapsable::setStatus(CollapseStatus st)
 425 {
 426         status_ = st;
 427         setButtonLabel();
 428 }
 429
 430
 431 void InsetCollapsable::markErased()
 432 {
 433         inset.markErased();
 434 }
 435
 436
 437 void InsetCollapsable::addPreview(PreviewLoader & loader) const
 438 {
 439         inset.addPreview(loader);
 440 }
 441
 442
 443 bool InsetCollapsable::insetAllowed(InsetOld::Code code) const
 444 {
 445         return inset.insetAllowed(code);
 446 }
 447
 448
 449 void InsetCollapsable::setLabelFont(LyXFont & font)
 450 {
 451         labelfont_ = font;
 452 }
 453
 454
 455 void InsetCollapsable::scroll(BufferView & bv, float sx) const
 456 {
 457         UpdatableInset::scroll(bv, sx);
 458 }
 459
 460
 461 void InsetCollapsable::scroll(BufferView & bv, int offset) const
 462 {
 463         UpdatableInset::scroll(bv, offset);
 464 }
 465
 466
 467 Box const & InsetCollapsable::buttonDim() const
 468 {
 469         return button_dim;
 470 }
 471
 472
 473 void InsetCollapsable::setBackgroundColor(LColor_color color)
 474 {
 475         InsetOld::setBackgroundColor(color);
 476         inset.setBackgroundColor(color);
 477 }