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                                 dim.wid += textdim_.wid;
 144                                 dim.des = max(dim.des - textdim_.asc + dim.asc, textdim_.des);
 145                                 dim.asc = textdim_.asc;
 146                         } else {
 147                                 dim.des += textdim_.height() + TEXT_TO_BOTTOM_OFFSET;
 148                                 dim.wid = max(dim.wid, textdim_.wid);
 149                         }
 150                 }
 151         }
 152         dim.asc += TEXT_TO_INSET_OFFSET;
 153         dim.des += TEXT_TO_INSET_OFFSET;
 154         dim.wid += 2 * TEXT_TO_INSET_OFFSET;
 155         mi.base.textwidth += 2 * TEXT_TO_INSET_OFFSET;
 156         dim_ = dim;
 157 }
 158
 159
 160 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
 161 {
 162         const int xx = x + TEXT_TO_INSET_OFFSET;
 163         if (status() == Inlined) {
 164                 InsetText::draw(pi, xx, y);
 165         } else {
 166                 Dimension dimc = dimensionCollapsed();
 167                 int const top  = y - ascent() + TEXT_TO_INSET_OFFSET;
 168                 button_dim.x1 = xx + 0;
 169                 button_dim.x2 = xx + dimc.width();
 170                 button_dim.y1 = top;
 171                 button_dim.y2 = top + dimc.height();
 172
 173                 pi.pain.buttonText(xx, top + dimc.asc, label, labelfont_);
 174
 175                 if (status() == Open) {
 176                         int textx, texty;
 177                         if (openinlined_) {
 178                                 textx = xx + dimc.width();
 179                                 texty = top + textdim_.asc;
 180                         } else {
 181                                 textx = xx;
 182                                 texty = top + dimc.height() + textdim_.asc;
 183                         }
 184                         InsetText::draw(pi, textx, texty);
 185                 }
 186         }
 187         setPosCache(pi, x, y);
 188 }
 189
 190
 191 void InsetCollapsable::drawSelection(PainterInfo & pi, int x, int y) const
 192 {
 193         x += TEXT_TO_INSET_OFFSET;
 194         if (status() == Open) {
 195                 if (openinlined_)
 196                         x += dimensionCollapsed().wid;
 197                 else
 198                         y += dimensionCollapsed().des + textdim_.asc;
 199         }
 200         if (status() != Collapsed)
 201                 InsetText::drawSelection(pi, x, y);
 202 }
 203
 204
 205 void InsetCollapsable::cursorPos
 206         (CursorSlice const & sl, bool boundary, int & x, int & y) const
 207 {
 208         BOOST_ASSERT(status() != Collapsed);
 209
 210         InsetText::cursorPos(sl, boundary, x, y);
 211
 212         if (status() == Open) {
 213                 if (openinlined_)
 214                         x += dimensionCollapsed().wid;
 215                 else
 216                         y += dimensionCollapsed().height() - ascent()
 217                                 + TEXT_TO_INSET_OFFSET + textdim_.asc;
 218         }
 219         x += TEXT_TO_INSET_OFFSET;
 220 }
 221
 222
 223 InsetBase::EDITABLE InsetCollapsable::editable() const
 224 {
 225         return status() != Collapsed ? HIGHLY_EDITABLE : IS_EDITABLE;
 226 }
 227
 228
 229 bool InsetCollapsable::descendable() const
 230 {
 231         return status() != Collapsed;
 232 }
 233
 234
 235 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
 236 {
 237         return button_dim.contains(cmd.x, cmd.y);
 238 }
 239
 240
 241 string const InsetCollapsable::getNewLabel(string const & l) const
 242 {
 243         string label;
 244         pos_type const max_length = 15;
 245         pos_type const p_siz = paragraphs().begin()->size();
 246         pos_type const n = min(max_length, p_siz);
 247         pos_type i = 0;
 248         pos_type j = 0;
 249         for (; i < n && j < p_siz; ++j) {
 250                 if (paragraphs().begin()->isInset(j))
 251                         continue;
 252                 label += paragraphs().begin()->getChar(j);
 253                 ++i;
 254         }
 255         if (paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
 256                 label += "...";
 257         }
 258         return label.empty() ? l : label;
 259 }
 260
 261
 262 void InsetCollapsable::edit(LCursor & cur, bool left)
 263 {
 264         //lyxerr << "InsetCollapsable: edit left/right" << endl;
 265         cur.push(*this);
 266         InsetText::edit(cur, left);
 267 }
 268
 269
 270 InsetBase * InsetCollapsable::editXY(LCursor & cur, int x, int y)
 271 {
 272         //lyxerr << "InsetCollapsable: edit xy" << endl;
 273         if (status() == Collapsed)
 274                 return this;
 275         cur.push(*this);
 276         return InsetText::editXY(cur, x, y);
 277 }
 278
 279
 280 void InsetCollapsable::doDispatch(LCursor & cur, FuncRequest & cmd)
 281 {
 282         //lyxerr << "InsetCollapsable::doDispatch (begin): cmd: " << cmd
 283         //      << " cur: " << cur << " bvcur: " << cur.bv().cursor() << endl;
 284
 285         switch (cmd.action) {
 286         case LFUN_MOUSE_PRESS:
 287                 if (status() == Inlined)
 288                         InsetText::doDispatch(cur, cmd);
 289                 else if (status() == Open && !hitButton(cmd))
 290                         InsetText::doDispatch(cur, cmd);
 291                 else
 292                         cur.noUpdate();
 293                 break;
 294
 295         case LFUN_MOUSE_MOTION:
 296         case LFUN_MOUSE_DOUBLE:
 297         case LFUN_MOUSE_TRIPLE:
 298                 if (status_ == Inlined)
 299                         InsetText::doDispatch(cur, cmd);
 300                 else if (status() && !hitButton(cmd))
 301                         InsetText::doDispatch(cur, cmd);
 302                 else
 303                         cur.undispatched();
 304                 break;
 305
 306         case LFUN_MOUSE_RELEASE:
 307                 if (cmd.button() == mouse_button::button3) {
 308                         showInsetDialog(&cur.bv());
 309                         break;
 310                 }
 311
 312                 switch (status()) {
 313
 314                 case Collapsed:
 315                         //lyxerr << "InsetCollapsable::lfunMouseRelease 1" << endl;
 316                         setStatus(cur, Open);
 317                         edit(cur, true);
 318                         cur.bv().cursor() = cur;
 319                         break;
 320
 321                 case Open: {
 322                         if (hitButton(cmd)) {
 323                                 //lyxerr << "InsetCollapsable::lfunMouseRelease 2" << endl;
 324                                 setStatus(cur, Collapsed);
 325                                 cur.bv().cursor() = cur;
 326                         } else {
 327                                 //lyxerr << "InsetCollapsable::lfunMouseRelease 3" << endl;
 328                                 InsetText::doDispatch(cur, cmd);
 329                         }
 330                         break;
 331                 }
 332
 333                 case Inlined:
 334                         //lyxerr << "InsetCollapsable::lfunMouseRelease 4" << endl;
 335                         InsetText::doDispatch(cur, cmd);
 336                         break;
 337                 }
 338                 break;
 339
 340         case LFUN_INSET_TOGGLE:
 341                 if (cmd.argument == "open")
 342                         setStatus(cur, Open);
 343                 else if (cmd.argument == "close")
 344                         setStatus(cur, Collapsed);
 345                 else if (cmd.argument == "toggle" || cmd.argument.empty())
 346                         if (isOpen()) {
 347                                 setStatus(cur, Collapsed);
 348                                 cur.forwardPosNoDescend();
 349                         }
 350                         else
 351                                 setStatus(cur, Open);
 352                 else // if assign or anything else
 353                         cur.undispatched();
 354                 cur.dispatched();
 355                 break;
 356
 357         default:
 358                 InsetText::doDispatch(cur, cmd);
 359                 break;
 360         }
 361 }
 362
 363
 364 bool InsetCollapsable::getStatus(LCursor & cur, FuncRequest const & cmd,
 365                 FuncStatus & flag) const
 366 {
 367         switch (cmd.action) {
 368
 369         case LFUN_INSET_TOGGLE:
 370                 if (cmd.argument == "open" || cmd.argument == "close" ||
 371                     cmd.argument == "toggle")
 372                         flag.enabled(true);
 373                 else
 374                         flag.enabled(false);
 375                 return true;
 376
 377         default:
 378                 return InsetText::getStatus(cur, cmd, flag);
 379         }
 380 }
 381
 382
 383 void InsetCollapsable::setLabel(string const & l)
 384 {
 385         label = l;
 386 }
 387
 388
 389 void InsetCollapsable::setStatus(LCursor & cur, CollapseStatus status)
 390 {
 391         status_ = status;
 392         setButtonLabel();
 393         if (status_ == Collapsed)
 394                 cur.leaveInset(*this);
 395 }
 396
 397
 398 void InsetCollapsable::setLabelFont(LyXFont & font)
 399 {
 400         labelfont_ = font;
 401 }
 402