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