src/combox.C

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