src/frontends/xforms/Toolbar_pimpl.C

   1 /* This file is part of
   2  * ======================================================
   3  *
   4  *           LyX, The Document Processor
   5  *
   6  *           Copyright 1995 Matthias Ettrich
   7  *           Copyright 1995-2001 The LyX Team.
   8  *
   9  *           This file is Copyright 1996-1998
  10  *           Lars Gullik Bjønnes
  11  *
  12  * ====================================================== */
  13
  14 //  Added pseudo-action handling, asierra 180296
  15
  16 #include <config.h>
  17
  18 #ifdef __GNUG__
  19 #pragma implementation
  20 #endif
  21
  22 #include "Toolbar_pimpl.h"
  23 #include "debug.h"
  24 #include "LyXView.h"
  25 #include "lyxfunc.h"
  26 #include "BufferView.h"
  27 #include "buffer.h"
  28 #include "LyXAction.h"
  29 #include "MathsSymbols.h"
  30 #include "support/filetools.h"
  31 #include "support/lstrings.h"
  32 #include "gettext.h"
  33
  34 using std::endl;
  35
  36 extern LyXAction lyxaction;
  37
  38 // some constants
  39 const int standardspacing = 2; // the usual space between items
  40 const int sepspace = 6; // extra space
  41 const int buttonwidth = 30; // the standard button width
  42 const int height = 30; // the height of all items in the toolbar
  43
  44 Toolbar::Pimpl::toolbarItem::toolbarItem() {
  45         action = LFUN_NOACTION;
  46         icon = 0;
  47 }
  48
  49
  50 Toolbar::Pimpl::toolbarItem::~toolbarItem() {
  51         clean();
  52 }
  53
  54
  55 void Toolbar::Pimpl::toolbarItem::clean() {
  56         if (icon) {
  57                 fl_delete_object(icon);
  58                 fl_free_object(icon);
  59                 icon = 0;
  60         }
  61 }
  62
  63
  64 Toolbar::Pimpl::toolbarItem &
  65 Toolbar::Pimpl::toolbarItem::operator=(toolbarItem const & ti) {
  66         // Are we assigning the object onto itself?
  67         if (this == &ti)
  68                 return *this;
  69
  70         // If we already have an icon, release it.
  71         clean();
  72
  73         // do we have to check icon too?
  74         action = ti.action;
  75         icon = 0; // locally we need to get the icon anew
  76
  77         return *this;
  78 }
  79
  80
  81
  82 Toolbar::Pimpl::Pimpl(LyXView * o, int x, int y)
  83         : owner(o), sxpos(x), sypos(y)
  84 {
  85         combox = 0;
  86 #if FL_REVISION < 89
  87         bubble_timer = 0;
  88 #endif
  89 }
  90
  91
  92 namespace {
  93
  94 #if FL_REVISION < 89
  95 // timer-cb for bubble-help (Matthias)
  96 void BubbleTimerCB(FL_OBJECT *, long data)
  97 {
  98         FL_OBJECT * ob = reinterpret_cast<FL_OBJECT*>(data);
  99         // The trick we use to get the help text is to read the
 100         // argument of the callback that has been registered for
 101         // ToolBarCB.  (JMarc)
 102         string help = _(lyxaction.helpText(ob->argument));
 103         fl_show_oneliner(help.c_str(), ob->form->x + ob->x,
 104                          ob->form->y + ob->y + ob->h);
 105 }
 106
 107
 108 extern "C" void C_Toolbar_BubbleTimerCB(FL_OBJECT * ob, long data)
 109 {
 110         BubbleTimerCB(ob, data);
 111 }
 112
 113
 114 // post_handler for bubble-help (Matthias)
 115 int BubblePost(FL_OBJECT *ob, int event,
 116                         FL_Coord /*mx*/, FL_Coord /*my*/,
 117                         int /*key*/, void * /*xev*/)
 118 {
 119         FL_OBJECT * bubble_timer = reinterpret_cast<FL_OBJECT *>(ob->u_cdata);
 120
 121         // We do not test for empty help here, since this can never happen
 122         if (event == FL_ENTER){
 123                 fl_set_object_callback(bubble_timer,
 124                                        C_Toolbar_BubbleTimerCB,
 125                                        reinterpret_cast<long>(ob));
 126                 fl_set_timer(bubble_timer, 1);
 127         }
 128         else if (event != FL_MOTION){
 129                 fl_set_timer(bubble_timer, 0);
 130                 fl_hide_oneliner();
 131         }
 132         return 0;
 133 }
 134
 135
 136 extern "C" int C_Toolbar_BubblePost(FL_OBJECT * ob, int event,
 137                                     FL_Coord /*mx*/, FL_Coord /*my*/,
 138                                     int key, void * xev)
 139 {
 140         return BubblePost(ob, event, 0, 0, key, xev);
 141 }
 142 #endif
 143
 144 } // namespace anon
 145
 146
 147 // this one is not "C" because combox callbacks are really C++ %-|
 148 void Toolbar::Pimpl::layoutSelectedCB(int sel, void * arg, Combox *)
 149 {
 150         Toolbar::Pimpl * tb = reinterpret_cast<Toolbar::Pimpl *>(arg);
 151
 152         tb->layoutSelected(sel);
 153 }
 154
 155
 156 void Toolbar::Pimpl::layoutSelected(int sel)
 157 {
 158         string const tmp = tostr(sel);
 159         owner->getLyXFunc()->Dispatch(LFUN_LAYOUTNO, tmp);
 160 }
 161
 162
 163 void Toolbar::Pimpl::activate()
 164 {
 165         ToolbarList::const_iterator p = toollist.begin();
 166         ToolbarList::const_iterator end = toollist.end();
 167         for (; p != end; ++p) {
 168                 if (p->icon) {
 169                         fl_activate_object(p->icon);
 170                 }
 171         }
 172 }
 173
 174
 175 void Toolbar::Pimpl::deactivate()
 176 {
 177         ToolbarList::const_iterator p = toollist.begin();
 178         ToolbarList::const_iterator end = toollist.end();
 179         for (; p != end; ++p) {
 180                 if (p->icon) {
 181                         fl_deactivate_object(p->icon);
 182                 }
 183         }
 184 }
 185
 186 void Toolbar::Pimpl::update()
 187 {
 188         ToolbarList::const_iterator p = toollist.begin();
 189         ToolbarList::const_iterator end = toollist.end();
 190         for (; p != end; ++p) {
 191                 if (p->icon) {
 192                         int status = owner->getLyXFunc()->getStatus(p->action);
 193                         if (status & LyXFunc::ToggleOn) {
 194                                 // I'd like to use a different color
 195                                 // here, but then the problem is to
 196                                 // know how to use transparency with
 197                                 // Xpm library. It seems pretty
 198                                 // complicated to me (JMarc)
 199                                 fl_set_object_color(p->icon, FL_LEFT_BCOL, FL_BLUE);
 200                                 fl_set_object_boxtype(p->icon, FL_DOWN_BOX);
 201                         } else {
 202                                 fl_set_object_color(p->icon, FL_MCOL, FL_BLUE);
 203                                 fl_set_object_boxtype(p->icon, FL_UP_BOX);
 204                         }
 205
 206                         if (status & LyXFunc::Disabled) {
 207                                 // Is there a way here to specify a
 208                                 // mask in order to show that the
 209                                 // button is disabled? (JMarc)
 210                                 fl_deactivate_object(p->icon);
 211                         }
 212                         else
 213                                 fl_activate_object(p->icon);
 214                 }
 215         }
 216 }
 217
 218
 219 void Toolbar::Pimpl::setLayout(int layout) {
 220         if (combox)
 221                 combox->select(layout+1);
 222 }
 223
 224
 225 void Toolbar::Pimpl::updateLayoutList(bool force)
 226 {
 227         // Update the layout display
 228         if (!combox) return;
 229
 230         // If textclass is different, we need to update the list
 231         if (combox->empty() || force) {
 232                 combox->clear();
 233                 LyXTextClass const & tc =
 234                         textclasslist.TextClass(owner->buffer()->
 235                                                 params.textclass);
 236                 LyXTextClass::const_iterator end = tc.end();
 237                 for (LyXTextClass::const_iterator cit = tc.begin();
 238                      cit != end; ++cit) {
 239                         if ((*cit).obsoleted_by().empty())
 240                                 combox->addline(_((*cit).name()));
 241                         else
 242                                 combox->addline("@N" + _((*cit).name()));
 243                 }
 244         }
 245         // we need to do this.
 246         combox->Redraw();
 247 }
 248
 249
 250 void Toolbar::Pimpl::clearLayoutList()
 251 {
 252         if (combox) {
 253                 combox->clear();
 254                 combox->Redraw();
 255         }
 256 }
 257
 258
 259 void Toolbar::Pimpl::openLayoutList()
 260 {
 261         if (combox)
 262                 combox->Show();
 263 }
 264
 265
 266 namespace {
 267
 268 void ToolbarCB(FL_OBJECT * ob, long ac)
 269 {
 270         LyXView * owner = static_cast<LyXView *>(ob->u_vdata);
 271
 272         string res = owner->getLyXFunc()->Dispatch(int(ac));
 273         if (!res.empty())
 274                 lyxerr[Debug::GUI] << "ToolbarCB: Function returned: "
 275                                    << res << endl;
 276 }
 277
 278 } // namespace anon
 279
 280
 281 extern "C" void C_Toolbar_ToolbarCB(FL_OBJECT * ob, long data)
 282 {
 283         ToolbarCB(ob, data);
 284 }
 285
 286
 287 #if 0
 288 // What are we supposed to do with that??
 289 int Toolbar::get_toolbar_func(string const & func)
 290 {
 291         int action = lyxaction.LookupFunc(func);
 292         if (action == -1) {
 293                 if (func == "separator"){
 294                         action = TOOL_SEPARATOR;
 295                 } else if (func == "layouts"){
 296                         action = TOOL_LAYOUTS;
 297                 } else action = 0;
 298         }
 299         return action;
 300 }
 301 #endif
 302
 303
 304 namespace {
 305
 306 void setPixmap(FL_OBJECT * obj, int action, int buttonwidth, int height) {
 307         string name, arg, xpm_name;
 308         kb_action act;
 309
 310         if (lyxaction.isPseudoAction(action)) {
 311                 act = lyxaction.retrieveActionArg(action, arg);
 312                 name = lyxaction.getActionName(act);
 313                 xpm_name = subst(name + ' ' + arg, ' ','_');
 314         } else {
 315                 act = (kb_action)action;
 316                 name = lyxaction.getActionName(action);
 317                 xpm_name = name;
 318         }
 319
 320         string fullname = LibFileSearch("images", xpm_name, "xpm");
 321
 322         if (!fullname.empty()) {
 323                 lyxerr[Debug::GUI] << "Full icon name is `"
 324                                        << fullname << "'" << endl;
 325                 fl_set_pixmapbutton_file(obj, fullname.c_str());
 326                 return;
 327         }
 328
 329         if (act == LFUN_INSERT_MATH && !arg.empty()) {
 330                 char const ** pixmap = get_pixmap_from_symbol(arg.c_str(),
 331                                                         buttonwidth,
 332                                                         height);
 333                 if (pixmap) {
 334                         lyxerr[Debug::GUI] << "Using mathed-provided icon"
 335                                            << endl;
 336                         fl_set_pixmapbutton_data(obj,
 337                                                  const_cast<char **>(pixmap));
 338                         return;
 339                 }
 340         }
 341
 342         lyxerr << "Unable to find icon `" << xpm_name << "'" << endl;
 343         fullname = LibFileSearch("images", "unknown", "xpm");
 344         if (!fullname.empty()) {
 345                 lyxerr[Debug::GUI] << "Using default `unknown' icon"
 346                                        << endl;
 347                 fl_set_pixmapbutton_file(obj, fullname.c_str());
 348         }
 349 }
 350
 351 } // namespace anon
 352
 353
 354 void Toolbar::Pimpl::set(bool doingmain)
 355 {
 356         // we shouldn't set if we have not cleaned
 357         if (!cleaned) return;
 358
 359         FL_OBJECT * obj;
 360
 361         if (!doingmain) {
 362                 fl_freeze_form(owner->getForm());
 363                 fl_addto_form(owner->getForm());
 364         }
 365
 366 #if FL_REVISION < 89
 367         // add the time if it don't exist
 368         if (bubble_timer == 0)
 369                 bubble_timer = fl_add_timer(FL_HIDDEN_TIMER,
 370                                             xpos, ypos, 0, 0, "Timer");
 371 #endif
 372
 373         ToolbarList::iterator item = toollist.begin();
 374         ToolbarList::iterator end = toollist.end();
 375         for (; item != end; ++item) {
 376                 switch (item->action){
 377                 case ToolbarDefaults::SEPARATOR:
 378                         xpos += sepspace;
 379                         break;
 380                 case ToolbarDefaults::NEWLINE:
 381                         // Not supported yet.
 382                         break;
 383                 case ToolbarDefaults::LAYOUTS:
 384                         xpos += standardspacing;
 385                         if (!combox)
 386                                 combox = new Combox(FL_COMBOX_DROPLIST);
 387                         combox->add(xpos, ypos, 135, height, 400);
 388                         combox->setcallback(layoutSelectedCB, this);
 389                         combox->resize(FL_RESIZE_ALL);
 390                         combox->gravity(NorthWestGravity, NorthWestGravity);
 391                         xpos += 135;
 392                         break;
 393                 default:
 394                         xpos += standardspacing;
 395                         item->icon = obj =
 396                                 fl_add_pixmapbutton(FL_NORMAL_BUTTON,
 397                                                     xpos, ypos,
 398                                                     buttonwidth,
 399                                                     height, "");
 400                         fl_set_object_resize(obj, FL_RESIZE_ALL);
 401                         fl_set_object_gravity(obj,
 402                                               NorthWestGravity,
 403                                               NorthWestGravity);
 404                         fl_set_object_callback(obj, C_Toolbar_ToolbarCB,
 405                                                static_cast<long>(item->action));
 406                         // Remove the blue feedback rectangle
 407                         fl_set_pixmapbutton_focus_outline(obj, 0);
 408
 409                         // Set the tooltip
 410 #if FL_REVISION >= 89
 411                         string help = _(lyxaction.helpText(item->action));
 412                         fl_set_object_helper(obj, help.c_str());
 413 #else
 414                         fl_set_object_posthandler(obj, C_Toolbar_BubblePost);
 415                         obj->u_cdata = reinterpret_cast<char *>(bubble_timer);
 416 #endif
 417
 418                         // The view that this object belongs to.
 419                         obj->u_vdata = owner;
 420
 421                         setPixmap(obj, item->action, buttonwidth, height);
 422                         // we must remember to update the positions
 423                         xpos += buttonwidth;
 424                         // ypos is constant
 425                         /* Here will come a check to see if the new
 426                          * pos is within the bounds of the main frame,
 427                          * and perhaps wrap the toolbar if not.
 428                          */
 429                         break;
 430                 }
 431         }
 432
 433         if (!doingmain) {
 434                 fl_end_form();
 435                 fl_unfreeze_form(owner->getForm());
 436                 // Should be safe to do this here.
 437                 owner->updateLayoutChoice();
 438         }
 439
 440         // set the state of the icons
 441         //update();
 442
 443         cleaned = false;
 444 }
 445
 446
 447 void Toolbar::Pimpl::add(int action, bool doclean)
 448 {
 449         if (doclean && !cleaned) clean();
 450
 451         // this is what we do if we want to add to an existing
 452         // toolbar.
 453         if (!doclean && owner) {
 454                 // first "hide" the toolbar buttons. This is not a real hide
 455                 // actually it deletes and frees the button altogether.
 456                 lyxerr << "Toolbar::add: \"hide\" the toolbar buttons."
 457                        << endl;
 458
 459                 lightReset();
 460
 461                 fl_freeze_form(owner->getForm());
 462
 463                 ToolbarList::iterator p = toollist.begin();
 464                 ToolbarList::iterator end = toollist.end();
 465                 for (; p != end; ++p) {
 466                         p->clean();
 467                 }
 468
 469                 if (combox) {
 470                         delete combox;
 471                         combox = 0;
 472                 }
 473                 fl_unfreeze_form(owner->getForm());
 474                 cleaned = true; // this is not completely true, but OK anyway
 475         }
 476
 477         // there exist some special actions not part of
 478         // kb_action: SEPARATOR, LAYOUTS
 479
 480         toolbarItem newItem;
 481         newItem.action = action;
 482         toollist.push_back(newItem);
 483 }
 484
 485
 486 void Toolbar::Pimpl::clean()
 487 {
 488         //reset(); // I do not understand what this reset() is, anyway
 489
 490         //now delete all the objects..
 491         if (owner)
 492                 fl_freeze_form(owner->getForm());
 493
 494         // G++ vector does not have clear defined
 495         //toollist.clear();
 496         toollist.erase(toollist.begin(), toollist.end());
 497
 498         lyxerr[Debug::GUI] << "Combox: " << combox << endl;
 499         if (combox) {
 500                 delete combox;
 501                 combox = 0;
 502         }
 503
 504         if (owner)
 505                 fl_unfreeze_form(owner->getForm());
 506         lyxerr[Debug::GUI] << "toolbar cleaned" << endl;
 507         cleaned = true;
 508 }
 509
 510
 511 void Toolbar::Pimpl::push(int nth)
 512 {
 513         lyxerr[Debug::GUI] << "Toolbar::push: trying to trigger no `"
 514                                << nth << '\'' << endl;
 515
 516         if (nth <= 0 || nth >= int(toollist.size())) {
 517                 // item nth not found...
 518                 return;
 519         }
 520
 521         fl_trigger_object(toollist[nth - 1].icon);
 522 }
 523
 524
 525 void Toolbar::Pimpl::reset()
 526 {
 527         //toollist = 0; // what is this supposed to do?
 528         cleaned = false;
 529         lightReset();
 530 }
 531
 532 void Toolbar::Pimpl::lightReset() {
 533         xpos = sxpos - standardspacing;
 534         ypos = sypos;
 535 }