src/frontends/xforms/combox.C

   1 /**
   2  * \file combox.C
   3  * Copyright 1996Alejandro Aguilar Sierra
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Alejandro Aguilar Sierra
   8  *
   9  * Full author contact details are available in file CREDITS
  10  */
  11
  12 /* A combination of two objects (a button and a browser) is encapsulated to
  13  * get a combobox-like object. All XForms functions are hidden.
  14  *
  15  */
  16
  17 /* Change log:
  18  *
  19  *  2/06/1996,   Alejandro Aguilar Sierra
  20  *    Created and tested.
  21  *
  22  *  4/06/1996,   Alejandro Aguilar Sierra
  23  *    Added droplist mode (a button with a black down arrow at right)
  24  *    and support for middle and right buttons, as XForms choice object.
  25  *
  26  *  6/06/1996,   Lars Gullik Bjønnes
  27  *    Added a combox with an input object. and a pre and a post handle.
  28  *
  29  *  22/07/96,    Alejandro Aguilar Sierra
  30  *    Assigned to the browser its own popup window. No more need of
  31  *    external pre and post handlers to simulate the wanted behaviour.
  32  *
  33  */
  34
  35 #include <config.h>
  36
  37 #ifdef __GNUG__
  38 #pragma implementation
  39 #endif
  40
  41 #include "combox.h"
  42 //#include <cstring>
  43
  44 #include "debug.h"
  45
  46 using std::endl;
  47
  48 // These are C wrappers around static members of Combox, used as
  49 // callbacks for xforms.
  50 extern "C" {
  51
  52         static
  53         void C_Combox_input_cb(FL_OBJECT * ob, long data)
  54         {
  55                 Combox::input_cb(ob, data);
  56         }
  57
  58         static
  59         void C_Combox_combo_cb(FL_OBJECT * ob, long data)
  60         {
  61                 Combox::combo_cb(ob, data);
  62         }
  63
  64         static
  65         int C_Combox_peek_event(FL_FORM * form, void *xev)
  66         {
  67                 return Combox::peek_event(form, xev);
  68         }
  69
  70 }
  71
  72
  73 Combox::Combox(combox_type t)
  74         : type(t)
  75 {
  76    browser = button = 0;
  77    callback = 0;
  78    label = 0;
  79    cb_arg = 0;
  80    _pre = 0;
  81    _post = 0;
  82    sel = 0;
  83    form = 0;
  84 }
  85
  86
  87 Combox::~Combox()
  88 {
  89         // This is now handled by the XFormsView destructor (Lgb)
  90         // remove();
  91 }
  92
  93
  94 void Combox::clear()
  95 {
  96         if (browser) fl_clear_browser(browser);
  97         sel = 0;
  98         if (type == FL_COMBOX_INPUT)
  99                 fl_set_input(label, "");
 100         else
 101                 fl_set_object_label(label, "");
 102         is_empty = true;
 103 }
 104
 105
 106 void Combox::remove()
 107 {
 108         lyxerr[Debug::GUI] << "Button: " << button << endl;
 109         if (button) {
 110                 fl_delete_object(button);
 111                 fl_free_object(button);
 112         }
 113
 114         lyxerr[Debug::GUI] << "Label: " << label << endl;
 115         if (label && label != button) {
 116                 fl_delete_object(label);
 117                 fl_free_object(label);
 118         }
 119
 120         lyxerr[Debug::GUI] << "Form: " << form << endl;
 121         lyxerr[Debug::GUI] << "Browser: " << browser << endl;
 122         if (form && browser) {
 123            fl_delete_object(browser);
 124            fl_free_object(browser);
 125            fl_free_form(form);
 126         }
 127         button = 0;
 128         browser = 0;
 129         label = 0;
 130         form = 0;
 131         sel = 0;
 132         is_empty = true;
 133 }
 134
 135
 136 void Combox::addline(string const & text)
 137 {
 138         if (!browser) return;
 139         fl_add_browser_line(browser, text.c_str());
 140
 141         // By default the first item is selected
 142         if (!sel) {
 143                 sel = 1;
 144                 if (type == FL_COMBOX_INPUT)
 145                         fl_set_input(label, text.c_str());
 146                 else
 147                         fl_set_object_label(label, text.c_str());
 148         }
 149         is_empty = false;
 150 }
 151
 152
 153 bool Combox::select(string const & t)
 154 {
 155         if (!browser || t.empty()) return false;
 156         int const maxline = fl_get_browser_maxline(browser);
 157
 158         for (int i = 1; i <= maxline; ++i) {
 159                 if (t == fl_get_browser_line(browser, i)) {
 160                         select(i);
 161                         return true;
 162                 }
 163         }
 164         return false;  // t does not exist in browser
 165 }
 166
 167
 168 void Combox::select(int i)
 169 {
 170         if (!browser || !button) return;
 171         if (i > 0 && i <= fl_get_browser_maxline(browser)) sel = i;
 172         fl_deactivate_object(button);
 173
 174         if (type == FL_COMBOX_INPUT)
 175                 fl_set_input(label, fl_get_browser_line(browser, sel));
 176         else
 177                 fl_set_object_label(label, fl_get_browser_line(browser, sel));
 178         fl_activate_object(button);
 179 }
 180
 181
 182 void Combox::add(int x, int y, int w, int hmin, int hmax)
 183 {
 184         FL_OBJECT * obj;
 185
 186         switch (type) {
 187         case FL_COMBOX_DROPLIST:
 188         {
 189                 button = obj = fl_add_button(FL_NORMAL_BUTTON,
 190                                              x+w-22, y, 22, hmin, "@2->");
 191                 fl_set_object_color(obj, FL_MCOL, FL_MCOL);
 192                 fl_set_object_dblbuffer(obj, 1);
 193                 fl_set_object_callback(obj, C_Combox_combo_cb, 0);
 194                 label = obj = fl_add_button(FL_NORMAL_TEXT, x, y, w-22, hmin, "");
 195                 fl_set_object_boxtype(obj, FL_DOWN_BOX);
 196                 fl_set_object_color(obj, FL_MCOL, FL_BLACK);
 197                 fl_set_object_lalign(obj, FL_ALIGN_CENTER|FL_ALIGN_INSIDE);
 198                 fl_set_object_dblbuffer(obj, 1);
 199                 fl_set_object_callback(obj, C_Combox_combo_cb, 0);
 200                 break;
 201         }
 202         case FL_COMBOX_NORMAL:
 203         {
 204                 button = obj = fl_add_button(FL_NORMAL_BUTTON, x, y, w, hmin, "");
 205                 fl_set_object_color(obj, FL_MCOL, FL_MCOL);
 206                 fl_set_object_boxtype(obj, FL_DOWN_BOX);
 207                 fl_set_object_callback(obj, C_Combox_combo_cb, 0);
 208                 fl_set_object_color(obj, FL_MCOL, FL_BLACK);
 209                 label = button;
 210                 break;
 211         }
 212         case FL_COMBOX_INPUT:
 213         {
 214                 button = obj = fl_add_button(FL_NORMAL_BUTTON,
 215                                              x+w-22, y, 22, hmin, "@2->");
 216                 fl_set_object_color(obj, FL_MCOL, FL_MCOL);
 217                 fl_set_object_callback(obj, C_Combox_combo_cb, 0);
 218                 label = obj = fl_add_input(FL_NORMAL_INPUT, x, y, w-22, hmin, "");
 219                 fl_set_object_boxtype(obj, FL_DOWN_BOX);
 220                 fl_set_object_return(obj, FL_RETURN_END_CHANGED);
 221                 fl_set_object_callback(obj, C_Combox_input_cb, 0);
 222                 //fl_set_object_color(obj, FL_MCOL, FL_BLACK);
 223                 //fl_set_object_lalign(obj,FL_ALIGN_CENTER|FL_ALIGN_INSIDE);
 224                 break;
 225         }
 226         } // end of switch
 227
 228         label->u_vdata = this;
 229         button->u_vdata = this;
 230
 231         // Hmm, it seems fl_create_browser is broken in xforms 0.86.
 232         // We have to work around that by creating the dropped browser form
 233         // at this point already. However, this means that we have
 234         // to do a little hacking: (Asger)
 235         FL_FORM * current_form = fl_current_form;
 236         fl_end_form();
 237
 238         bw = w + 20;
 239         bh = hmax - hmin - 12;
 240
 241         form = fl_bgn_form(FL_NO_BOX, bw, bh);
 242         browser = obj = fl_add_browser(FL_HOLD_BROWSER, 0, 0, bw, bh, "");
 243         fl_set_object_boxtype(obj, FL_UP_BOX);
 244         fl_set_object_color(obj, FL_MCOL, FL_YELLOW);
 245         fl_set_object_gravity(obj, NorthWestGravity, NorthWestGravity);
 246         fl_set_object_callback(obj, C_Combox_combo_cb, 2);
 247         fl_end_form();
 248         browser->u_vdata = this;
 249         form->u_vdata = browser;
 250         fl_register_raw_callback(form,
 251                                  ButtonPressMask|KeyPressMask,
 252                                  C_Combox_peek_event);
 253
 254         // And revert to adding to the old form (Asger)
 255         fl_addto_form(current_form);
 256 }
 257
 258
 259 namespace {
 260
 261 Window save_window;
 262
 263 } // namespace anon
 264
 265
 266 void Combox::redraw()
 267 {
 268         if (browser) fl_redraw_object(browser);
 269         if (button) fl_redraw_object(button);
 270         if (label) fl_redraw_object(label);
 271 }
 272
 273 void Combox::show()
 274 {
 275         if (_pre) _pre();
 276
 277         int tmp;
 278         XGetInputFocus(fl_get_display(), &save_window, &tmp); //BUG-Fix Dietmar
 279         XFlush(fl_get_display());
 280         if (button && type != FL_COMBOX_NORMAL) {
 281                 fl_set_object_label(button, "@2<-");
 282                 fl_redraw_object(button);
 283         }
 284
 285 #if FL_VERSION < 1
 286         // This fix ensures that, even if label lies on a tabfolder,
 287         // the x,y coords of the underlying form are up to date.
 288         // It should be rendered redundant by a similar fix in the
 289         // tabfolder prehandler, but apparently "enter" events are not always
 290         // caught...
 291         // Angus 4 Oct, 2002.
 292         if (label->form->window) {
 293                 FL_FORM * lf = label->form;
 294                 fl_get_winorigin(lf->window, &(lf->x), &(lf->y));
 295         }
 296 #endif
 297
 298         int const x = label->form->x + label->x;
 299         int const y = label->form->y + label->y + label->h;
 300
 301         fl_set_form_position(form, x, y);
 302         fl_show_form(form, FL_PLACE_POSITION, FL_NOBORDER, "");
 303         if (sel > 0) {
 304                 fl_set_browser_topline(browser, sel);
 305                 fl_select_browser_line(browser, sel);
 306         }
 307         XGrabPointer(fl_get_display(), form->window, false,
 308                      ButtonPressMask | ButtonReleaseMask | PointerMotionMask,
 309                      GrabModeAsync, GrabModeAsync,
 310                      0, 0, 0);
 311         XFlush(fl_get_display());
 312 }
 313
 314 void Combox::hide(int who)
 315 {
 316         if (!who && browser && label) {
 317                 sel = fl_get_browser(browser);
 318
 319                 if (type == FL_COMBOX_INPUT)
 320                         fl_set_input(label, fl_get_browser_line(browser, sel));
 321                 else
 322                         fl_set_object_label(label,
 323                                             fl_get_browser_line(browser, sel));
 324 //              if (callback) callback(sel, cb_arg);
 325         }
 326         XUngrabPointer(fl_get_display(), 0);
 327         XFlush(fl_get_display());
 328         if (form) {
 329                 fl_hide_form(form);
 330                 XSetInputFocus(fl_get_display(), save_window,
 331                                RevertToParent, CurrentTime); // BUG-FIX-Dietmar
 332                 XFlush(fl_get_display());
 333         }
 334         if (button) {
 335                 if (type != FL_COMBOX_NORMAL) {
 336                         fl_set_object_label(button, "@2->");
 337                         fl_redraw_object(button);
 338                 }
 339         }
 340         if (!who && browser && label && callback)
 341             callback(sel, cb_arg, this);
 342         if (_post) _post();
 343 }
 344
 345
 346 void Combox::activate()
 347 {
 348         if (browser)
 349                 fl_activate_object(browser);
 350         if (button) {
 351                 fl_activate_object(button);
 352                 fl_set_object_lcol(button, FL_BLACK);
 353         }
 354         if (label) {
 355                 fl_activate_object(label);
 356                 fl_set_object_lcol(label, FL_BLACK);
 357         }
 358 }
 359
 360
 361 void Combox::deactivate()
 362 {
 363         if (browser)
 364                 fl_deactivate_object(browser);
 365         if (button) {
 366                 fl_deactivate_object(button);
 367                 fl_set_object_lcol(button, FL_INACTIVE);
 368         }
 369         if (label) {
 370                 fl_deactivate_object(label);
 371                 fl_set_object_lcol(label, FL_INACTIVE);
 372         }
 373 }
 374
 375
 376 void Combox::input_cb(FL_OBJECT * ob, long)
 377 {
 378         Combox * combo = static_cast<Combox*>(ob->u_vdata);
 379
 380         char const * text = fl_get_input(ob);
 381
 382         combo->addto(text ? string(text) : string());
 383         combo->is_empty = false;
 384 }
 385
 386
 387 void Combox::combo_cb(FL_OBJECT * ob, long data)
 388 {
 389         Combox * combo = static_cast<Combox*>(ob->u_vdata);
 390         switch (data) {
 391         case 0:
 392         {
 393                 int const i = combo->get();
 394                 switch (fl_get_button_numb(ob)) {
 395                 case 2:
 396                 {
 397                         combo->select(i - 1);
 398                         if (combo->callback)
 399                                 combo->callback(combo->sel,
 400                                                 combo->cb_arg, combo);
 401                         break;
 402                 }
 403                 case 3:
 404                 {
 405                         combo->select(i + 1);
 406                         if (combo->callback)
 407                                 combo->callback(combo->sel,
 408                                                 combo->cb_arg, combo);
 409                         break;
 410                 }
 411                 default: combo->show(); break;
 412                 }
 413                 break;
 414         }
 415         case 2:
 416                 combo->hide();
 417                 break;
 418         }
 419 }
 420
 421
 422 int Combox::peek_event(FL_FORM * form, void * xev)
 423 {
 424         FL_OBJECT * ob = static_cast<FL_OBJECT *>(form->u_vdata);
 425         Combox * combo = static_cast<Combox*>(ob->u_vdata);
 426
 427         // below mouse does not work like we need it
 428         if (static_cast<XEvent *>(xev)->type == ButtonPress && (
 429                 static_cast<XEvent *>(xev)->xbutton.x - ob->x < 0 ||
 430                 static_cast<XEvent *>(xev)->xbutton.x - ob->x > ob->w ||
 431                 static_cast<XEvent *>(xev)->xbutton.y - ob->y < 0 ||
 432                 static_cast<XEvent *>(xev)->xbutton.y - ob->y > ob->h)) {
 433                 combo->hide(1);
 434                 return 1;
 435         }
 436
 437         if (static_cast<XEvent*>(xev)->type != KeyPress) return 0;
 438
 439         char s_r[10]; s_r[9] = '\0';
 440         KeySym keysym_return;
 441         XLookupString(&static_cast<XEvent*>(xev)->xkey, s_r, 10,
 442                               &keysym_return, 0);
 443         XFlush(fl_get_display());
 444         switch (keysym_return) {
 445         case XK_Down:
 446 #ifdef XK_KP_Down
 447         case XK_KP_Down:
 448 #endif
 449                 if (fl_get_browser(combo->browser) <
 450                     fl_get_browser_maxline(combo->browser))
 451                         fl_select_browser_line(combo->browser,
 452                                                fl_get_browser(combo->browser)+1);
 453                 if (fl_get_browser(combo->browser)>=
 454                     fl_get_browser_topline(combo->browser) +
 455                     fl_get_browser_screenlines(combo->browser))
 456                         fl_set_browser_topline(combo->browser,
 457                                                fl_get_browser(combo->browser)
 458                                                - fl_get_browser_screenlines(combo->browser)+1);
 459                 if (fl_get_browser(combo->browser)<
 460                     fl_get_browser_topline(combo->browser))
 461                         fl_set_browser_topline(combo->browser,
 462                                                fl_get_browser(combo->browser));
 463                 return 1;
 464         case XK_Up:
 465 #ifdef XK_KP_Up
 466         case XK_KP_Up:
 467 #endif
 468                 if (fl_get_browser(combo->browser) > 1)
 469                         fl_select_browser_line(combo->browser,
 470                                                fl_get_browser(combo->browser)-1);
 471                 if (fl_get_browser(combo->browser)>=
 472                     fl_get_browser_topline(combo->browser) +
 473                     fl_get_browser_screenlines(combo->browser))
 474                         fl_set_browser_topline(combo->browser,
 475                                                fl_get_browser(combo->browser)
 476                                                - fl_get_browser_screenlines(combo->browser)+1);
 477                 if (fl_get_browser(combo->browser) <
 478                     fl_get_browser_topline(combo->browser))
 479                         fl_set_browser_topline(combo->browser,
 480                                                fl_get_browser(combo->browser));
 481                 return 1;
 482         case XK_Return:
 483 #ifdef XK_KP_Enter
 484         case XK_KP_Enter:
 485 #endif
 486                 combo->hide();
 487                 return 1;
 488         case XK_Escape:
 489                 combo->hide(1);
 490                 return 1;
 491         }
 492         return 0;
 493 }
 494
 495
 496 #ifdef TESTCOMBO
 497 typedef struct {
 498         FL_FORM *test;
 499         FL_OBJECT *bar;
 500         void *vdata;
 501         long ldata;
 502 } FD_test;
 503
 504 //Combox combo(FL_COMBOX_DROPLIST);
 505 Combox combo(FL_COMBOX_INPUT);
 506
 507 FD_test *fd_test;
 508
 509 FD_test *create_form_test(void)
 510 {
 511    FL_OBJECT *obj;
 512    FD_test *fdui = (FD_test *) fl_calloc(1, sizeof(*fdui));
 513
 514    fdui->test = fl_bgn_form(FL_NO_BOX, 320, 190);
 515    obj = fl_add_box(FL_UP_BOX, 0, 0, 320, 190, "");
 516    obj = fl_add_box(FL_DOWN_BOX, 10, 50, 300, 110, "");
 517    obj = fl_add_button(FL_NORMAL_BUTTON, 250, 10, 50, 30, _("Done"));
 518    combo.add(10, 15, 120, 25, 135);
 519    fl_end_form();
 520
 521   return fdui;
 522 }
 523
 524 void combo_cb(int i)
 525 {
 526    fprintf(stderr, "selected %d:%s\n", i, combo.getline());
 527 }
 528
 529 int main(int argc, char *argv[])
 530 {
 531         //int n1;
 532
 533    // Same defaults as in lyx
 534    FL_IOPT cntl;
 535    cntl.buttonFontSize = FL_NORMAL_SIZE;
 536    cntl.browserFontSize = FL_NORMAL_SIZE;
 537    cntl.labelFontSize = FL_NORMAL_SIZE;
 538    cntl.choiceFontSize = FL_NORMAL_SIZE;
 539    cntl.inputFontSize = FL_NORMAL_SIZE;
 540    cntl.borderWidth = -2;
 541    fl_set_defaults(FL_PDButtonFontSize, &cntl);
 542    fl_set_defaults(FL_PDBrowserFontSize, &cntl);
 543    fl_set_defaults(FL_PDLabelFontSize, &cntl);
 544    fl_set_defaults(FL_PDChoiceFontSize, &cntl);
 545    fl_set_defaults(FL_PDInputFontSize, &cntl);
 546    fl_set_defaults(FL_PDBorderWidth, &cntl);
 547    fl_initialize(&argc, argv, 0, 0, 0);
 548
 549    fd_test = create_form_test();
 550
 551    /* fill-in form initialization code */
 552    combo.addline("Title");
 553    combo.addline("Author");
 554    combo.addline("Date");
 555    combo.addline("Abstract");
 556    combo.addline("Chapter");
 557    combo.addline("Section");
 558    combo.addline("Subsection");
 559    combo.addline("List");
 560    combo.addline("Description");
 561    combo.addline("Verse");
 562    combo.addline("Verbatim");
 563    combo.setcallback(combo_cb);
 564 //   combo.select(4);
 565
 566    /* show the first form */
 567    fl_show_form(fd_test->test, FL_PLACE_CENTER, FL_FULLBORDER, "test");
 568    fl_do_forms();
 569    return 0;
 570 }
 571
 572 #endif