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::cursorPos
 196         (CursorSlice const & sl, bool boundary, int & x, int & y) const
 197 {
 198         if (status_ == Collapsed) {
 199                 x = xo();
 200                 y = yo();
 201         } else {
 202                 InsetText::cursorPos(sl, boundary, x, y);
 203                 if (status_ == Open) {
 204                         if (openinlined_)
 205                                 x += dimensionCollapsed().wid;
 206                         else
 207                                 y += dimensionCollapsed().height() - ascent()
 208                                         + TEXT_TO_INSET_OFFSET + textdim_.asc;
 209                 }
 210                 x += TEXT_TO_INSET_OFFSET;
 211         }
 212 }
 213
 214
 215 InsetBase::EDITABLE InsetCollapsable::editable() const
 216 {
 217         return status_ != Collapsed ? HIGHLY_EDITABLE : IS_EDITABLE;
 218 }
 219
 220
 221 bool InsetCollapsable::descendable() const
 222 {
 223         return status_ != Collapsed;
 224 }
 225
 226
 227 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
 228 {
 229         return button_dim.contains(cmd.x, cmd.y);
 230 }
 231
 232
 233 string const InsetCollapsable::getNewLabel(string const & l) const
 234 {
 235         string label;
 236         pos_type const max_length = 15;
 237         pos_type const p_siz = paragraphs().begin()->size();
 238         pos_type const n = min(max_length, p_siz);
 239         pos_type i = 0;
 240         pos_type j = 0;
 241         for (; i < n && j < p_siz; ++j) {
 242                 if (paragraphs().begin()->isInset(j))
 243                         continue;
 244                 label += paragraphs().begin()->getChar(j);
 245                 ++i;
 246         }
 247         if (paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
 248                 label += "...";
 249         }
 250         return label.empty() ? l : label;
 251 }
 252
 253
 254 void InsetCollapsable::edit(LCursor & cur, bool left)
 255 {
 256         //lyxerr << "InsetCollapsable: edit left/right" << endl;
 257         cur.push(*this);
 258         InsetText::edit(cur, left);
 259 }
 260
 261
 262 InsetBase * InsetCollapsable::editXY(LCursor & cur, int x, int y)
 263 {
 264         //lyxerr << "InsetCollapsable: edit xy" << endl;
 265         if (status_ == Collapsed)
 266                 return this;
 267         cur.push(*this);
 268         return InsetText::editXY(cur, x, y);
 269 }
 270
 271
 272 void InsetCollapsable::doDispatch(LCursor & cur, FuncRequest & cmd)
 273 {
 274         //lyxerr << "InsetCollapsable::doDispatch (begin): cmd: " << cmd
 275         //      << " cur: " << cur << " bvcur: " << cur.bv().cursor() << endl;
 276
 277         switch (cmd.action) {
 278         case LFUN_MOUSE_PRESS:
 279                 if (status_ == Inlined)
 280                         InsetText::doDispatch(cur, cmd);
 281                 else if (status_ == Open && !hitButton(cmd))
 282                         InsetText::doDispatch(cur, cmd);
 283                 else
 284                         cur.noUpdate();
 285                 break;
 286
 287         case LFUN_MOUSE_MOTION:
 288         case LFUN_MOUSE_DOUBLE:
 289         case LFUN_MOUSE_TRIPLE:
 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_RELEASE:
 299                 if (cmd.button() == mouse_button::button3) {
 300                         showInsetDialog(&cur.bv());
 301                         break;
 302                 }
 303
 304                 switch (status_) {
 305
 306                 case Collapsed:
 307                         //lyxerr << "InsetCollapsable::lfunMouseRelease 1" << endl;
 308                         setStatus(cur, Open);
 309                         edit(cur, true);
 310                         cur.bv().cursor() = cur;
 311                         break;
 312
 313                 case Open: {
 314                         if (hitButton(cmd)) {
 315                                 //lyxerr << "InsetCollapsable::lfunMouseRelease 2" << endl;
 316                                 setStatus(cur, Collapsed);
 317                                 cur.bv().cursor() = cur;
 318                         } else {
 319                                 //lyxerr << "InsetCollapsable::lfunMouseRelease 3" << endl;
 320                                 InsetText::doDispatch(cur, cmd);
 321                         }
 322                         break;
 323                 }
 324
 325                 case Inlined:
 326                         //lyxerr << "InsetCollapsable::lfunMouseRelease 4" << endl;
 327                         InsetText::doDispatch(cur, cmd);
 328                         break;
 329                 }
 330                 break;
 331
 332         case LFUN_INSET_TOGGLE:
 333                 if (cmd.argument == "open")
 334                         setStatus(cur, Open);
 335                 else if (cmd.argument == "close")
 336                         setStatus(cur, Collapsed);
 337                 else if (cmd.argument == "toggle" || cmd.argument.empty())
 338                         setStatus(cur, isOpen() ? Collapsed : Open);
 339                 else // if assign or anything else
 340                         cur.undispatched();
 341                 cur.dispatched();
 342                 break;
 343
 344         default:
 345                 InsetText::doDispatch(cur, cmd);
 346                 break;
 347         }
 348 }
 349
 350
 351 bool InsetCollapsable::getStatus(LCursor & cur, FuncRequest const & cmd,
 352                 FuncStatus & flag) const
 353 {
 354         switch (cmd.action) {
 355
 356         case LFUN_INSET_TOGGLE:
 357                 if (cmd.argument == "open" || cmd.argument == "close" ||
 358                     cmd.argument == "toggle")
 359                         flag.enabled(true);
 360                 else
 361                         flag.enabled(false);
 362                 return true;
 363
 364         default:
 365                 return InsetText::getStatus(cur, cmd, flag);
 366         }
 367 }
 368
 369
 370 void InsetCollapsable::setLabel(string const & l)
 371 {
 372         label = l;
 373 }
 374
 375
 376 void InsetCollapsable::setStatus(LCursor & cur, CollapseStatus status)
 377 {
 378         status_ = status;
 379         setButtonLabel();
 380         if (status_ == Collapsed)
 381                 cur.leaveInset(*this);
 382 }
 383
 384
 385 void InsetCollapsable::setLabelFont(LyXFont & font)
 386 {
 387         labelfont_ = font;
 388 }
 389