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