src/frontends/xforms/FormBase.C

   1 /**
   2  * \file FormBase.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Angus Leeming
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "FormBase.h"
  14
  15 #include "Tooltips.h"
  16 #include "xforms_helpers.h" // formatted
  17 #include "xforms_resize.h"
  18 #include "xformsBC.h"
  19
  20 #include "controllers/ButtonController.h"
  21 #include "controllers/ControlButtons.h"
  22
  23 #include "support/filetools.h" //  LibFileSearch
  24 #include "support/lstrings.h"
  25
  26 #include "lyx_forms.h"
  27
  28 using lyx::support::bformat;
  29 using lyx::support::LibFileSearch;
  30
  31
  32 extern "C" {
  33
  34 #if FL_VERSION == 0 || (FL_REVISION == 0 && FL_FIXLEVEL == 0)
  35 // These should be in forms.h but aren't
  36 void fl_show_tooltip(const char *, int, int);
  37 void fl_hide_tooltip();
  38 #endif
  39
  40 // Callback function invoked by xforms when the dialog is closed by the
  41 // window manager.
  42 static int C_WMHideCB(FL_FORM * form, void *);
  43
  44 // Callback function invoked by the xforms pre-handler routine.
  45 static int C_PrehandlerCB(FL_OBJECT *, int, FL_Coord, FL_Coord, int, void *);
  46
  47 } // extern "C"
  48
  49
  50 FormBase::FormBase(string const & t, bool allowResize)
  51         : ViewBase(t),
  52           warning_posted_(false), message_widget_(0),
  53           minw_(0), minh_(0), allow_resize_(allowResize),
  54           icon_pixmap_(0), icon_mask_(0),
  55           tooltips_(new Tooltips)
  56 {}
  57
  58
  59 FormBase::~FormBase()
  60 {
  61         if (icon_pixmap_)
  62                 XFreePixmap(fl_get_display(), icon_pixmap_);
  63
  64         delete tooltips_;
  65 }
  66
  67
  68 bool FormBase::isVisible() const
  69 {
  70         return form() && form()->visible;
  71 }
  72
  73
  74 Tooltips & FormBase::tooltips()
  75 {
  76         return *tooltips_;
  77 }
  78
  79
  80 void FormBase::redraw()
  81 {
  82         if (form() && form()->visible)
  83                 fl_redraw_form(form());
  84 }
  85
  86
  87 xformsBC & FormBase::bcview()
  88 {
  89         return static_cast<xformsBC &>(bc().view());
  90 }
  91
  92
  93 void FormBase::prepare_to_show()
  94 {
  95         double const scale = get_scale_to_fit(form());
  96         if (scale > 1.001)
  97                 scale_form_horizontally(form(), scale);
  98
  99         // work around dumb xforms sizing bug
 100         minw_ = form()->w;
 101         minh_ = form()->h;
 102
 103         fl_set_form_atclose(form(), C_WMHideCB, 0);
 104
 105         // set the title for the minimized form
 106         if (!getController().IconifyWithMain())
 107                 fl_winicontitle(form()->window, getTitle().c_str());
 108
 109         //  assign an icon to the form
 110         string const iconname = LibFileSearch("images", "lyx", "xpm");
 111         if (!iconname.empty()) {
 112                 unsigned int w, h;
 113                 icon_pixmap_ = fl_read_pixmapfile(fl_root,
 114                                                   iconname.c_str(),
 115                                                   &w,
 116                                                   &h,
 117                                                   &icon_mask_,
 118                                                   0, 0, 0);
 119                 fl_set_form_icon(form(), icon_pixmap_, icon_mask_);
 120         }
 121 }
 122
 123
 124 void FormBase::show()
 125 {
 126         // build() is/should be called from the controller, so form() should
 127         // always exist.
 128         BOOST_ASSERT(form());
 129
 130         // we use minw_ to flag whether the dialog has ever been shown.
 131         // In turn, prepare_to_show() initialises various bits 'n' pieces
 132         // (including minw_).
 133         if (minw_ == 0) {
 134                 prepare_to_show();
 135         }
 136
 137         // make sure the form is up to date.
 138         fl_freeze_form(form());
 139         update();
 140         fl_unfreeze_form(form());
 141
 142         if (form()->visible) {
 143                 fl_raise_form(form());
 144                 /* This XMapWindow() will hopefully ensure that
 145                  * iconified dialogs are de-iconified. Mad props
 146                  * out to those crazy Xlib guys for forgetting a
 147                  * XDeiconifyWindow(). At least WindowMaker, when
 148                  * being notified of the redirected MapRequest will
 149                  * specifically de-iconify. From source, fvwm2 seems
 150                  * to do the same.
 151                  */
 152                 XMapWindow(fl_get_display(), form()->window);
 153         } else {
 154                 // calls to fl_set_form_minsize/maxsize apply only to the next
 155                 // fl_show_form(), so this comes first.
 156                 fl_set_form_minsize(form(), minw_, minh_);
 157                 if (!allow_resize_)
 158                         fl_set_form_maxsize(form(), minw_, minh_);
 159
 160                 string const maximize_title = "LyX: " + getTitle();
 161                 int const iconify_policy =
 162                         getController().IconifyWithMain() ? FL_TRANSIENT : 0;
 163
 164                 fl_show_form(form(),
 165                              FL_PLACE_MOUSE | FL_FREE_SIZE,
 166                              iconify_policy,
 167                              maximize_title.c_str());
 168         }
 169 }
 170
 171
 172 void FormBase::hide()
 173 {
 174         // xforms sometimes tries to process a hint-type MotionNotify, and
 175         // use XQueryPointer, without verifying if the window still exists.
 176         // So we try to clear out motion events in the queue before the
 177         // DestroyNotify
 178         XSync(fl_get_display(), false);
 179
 180         if (form() && form()->visible)
 181                 fl_hide_form(form());
 182 }
 183
 184
 185 void FormBase::setPrehandler(FL_OBJECT * ob)
 186 {
 187         BOOST_ASSERT(ob);
 188         fl_set_object_prehandler(ob, C_PrehandlerCB);
 189 }
 190
 191
 192 void FormBase::setMessageWidget(FL_OBJECT * ob)
 193 {
 194         BOOST_ASSERT(ob && ob->objclass == FL_TEXT);
 195         message_widget_ = ob;
 196         fl_set_object_lsize(message_widget_, FL_NORMAL_SIZE);
 197 }
 198
 199
 200 void FormBase::InputCB(FL_OBJECT * ob, long data)
 201 {
 202         // It is possible to set the choice to 0 when using the
 203         // keyboard shortcuts. This work-around deals with the problem.
 204         if (ob && ob->objclass == FL_CHOICE && fl_get_choice(ob) < 1) {
 205                 fl_set_choice(ob, 1);
 206         }
 207
 208         bc().input(input(ob, data));
 209 }
 210
 211
 212 ButtonPolicy::SMInput FormBase::input(FL_OBJECT *, long)
 213 {
 214         return ButtonPolicy::SMI_VALID;
 215 }
 216
 217
 218 // preemptive handler for feedback messages
 219 void FormBase::MessageCB(FL_OBJECT * ob, int event)
 220 {
 221         BOOST_ASSERT(ob);
 222
 223         switch (event) {
 224         case FL_ENTER:
 225         {
 226                 string const feedback = getFeedback(ob);
 227                 if (feedback.empty() && warning_posted_)
 228                         break;
 229
 230                 warning_posted_ = false;
 231                 postMessage(getFeedback(ob));
 232                 break;
 233         }
 234
 235         case FL_LEAVE:
 236                 if (!warning_posted_)
 237                         clearMessage();
 238                 break;
 239
 240         default:
 241                 break;
 242         }
 243 }
 244
 245
 246 void FormBase::PrehandlerCB(FL_OBJECT * ob, int event, int key)
 247 {
 248         BOOST_ASSERT(ob);
 249
 250         if (ob->objclass == FL_INPUT && event == FL_PUSH && key == 2) {
 251                 // Trigger an input event when pasting in an xforms input object
 252                 // using the middle mouse button.
 253                 InputCB(ob, 0);
 254                 return;
 255         }
 256
 257         if (message_widget_) {
 258                 switch (event) {
 259                 case FL_ENTER:
 260                 case FL_LEAVE:
 261                         // Post feedback as the mouse enters the object,
 262                         // remove it as the mouse leaves.
 263                         MessageCB(ob, event);
 264                         break;
 265                 }
 266         }
 267
 268 #if FL_VERSION == 0 || (FL_REVISION == 0 && FL_FIXLEVEL == 0)
 269         // Tooltips are not displayed on browser widgets due to an xforms' bug.
 270         // This is a work-around:
 271         if (ob->objclass == FL_BROWSER) {
 272                 switch (event) {
 273                 case FL_ENTER:
 274                         if (ob->tooltip && *(ob->tooltip)) {
 275                                 int const x = ob->form->x + ob->x;
 276                                 int const y = ob->form->y + ob->y + ob->h + 1;
 277                                 fl_show_tooltip(ob->tooltip, x, y);
 278                         }
 279                         break;
 280                 case FL_LEAVE:
 281                 case FL_PUSH:
 282                 case FL_KEYPRESS:
 283                         fl_hide_tooltip();
 284                         break;
 285                 }
 286         }
 287 #endif
 288 }
 289
 290
 291 void FormBase::postWarning(string const & warning)
 292 {
 293         warning_posted_ = true;
 294         postMessage(warning);
 295 }
 296
 297
 298 void FormBase::clearMessage()
 299 {
 300         BOOST_ASSERT(message_widget_);
 301
 302         warning_posted_ = false;
 303
 304         string const existing = message_widget_->label
 305                 ? message_widget_->label : string();
 306         if (existing.empty())
 307                 return;
 308
 309         // This trick is needed to get xforms to clear the label...
 310         fl_set_object_label(message_widget_, "");
 311         fl_hide_object(message_widget_);
 312 }
 313
 314
 315 void FormBase::postMessage(string const & message)
 316 {
 317         BOOST_ASSERT(message_widget_);
 318
 319         int const width = message_widget_->w - 10;
 320         string const tmp = warning_posted_ ?
 321                 bformat(_("WARNING! %1$s"), message) :
 322                 message;
 323
 324         string const str = formatted(tmp, width, FL_NORMAL_SIZE);
 325
 326         fl_set_object_label(message_widget_, str.c_str());
 327         FL_COLOR const label_color = warning_posted_ ? FL_RED : FL_LCOL;
 328         fl_set_object_lcol(message_widget_, label_color);
 329
 330         if (!message_widget_->visible)
 331                 fl_show_object(message_widget_);
 332 }
 333
 334
 335 namespace {
 336
 337 FormBase * GetForm(FL_OBJECT * ob)
 338 {
 339         BOOST_ASSERT(ob && ob->form && ob->form->u_vdata);
 340         FormBase * ptr = static_cast<FormBase *>(ob->form->u_vdata);
 341         return ptr;
 342 }
 343
 344 } // namespace anon
 345
 346
 347 extern "C" {
 348
 349 void C_FormBaseApplyCB(FL_OBJECT * ob, long)
 350 {
 351         GetForm(ob)->getController().ApplyButton();
 352 }
 353
 354
 355 void C_FormBaseOKCB(FL_OBJECT * ob, long)
 356 {
 357         GetForm(ob)->getController().OKButton();
 358 }
 359
 360
 361 void C_FormBaseCancelCB(FL_OBJECT * ob, long)
 362 {
 363         FormBase * form = GetForm(ob);
 364         form->getController().CancelButton();
 365 }
 366
 367
 368 void C_FormBaseRestoreCB(FL_OBJECT * ob, long)
 369 {
 370         GetForm(ob)->getController().RestoreButton();
 371 }
 372
 373
 374 void C_FormBaseInputCB(FL_OBJECT * ob, long d)
 375 {
 376         GetForm(ob)->InputCB(ob, d);
 377 }
 378
 379
 380 static int C_WMHideCB(FL_FORM * form, void *)
 381 {
 382         // Close the dialog cleanly, even if the WM is used to do so.
 383         BOOST_ASSERT(form && form->u_vdata);
 384         FormBase * ptr = static_cast<FormBase *>(form->u_vdata);
 385         ptr->getController().CancelButton();
 386         return FL_CANCEL;
 387 }
 388
 389 static int C_PrehandlerCB(FL_OBJECT * ob, int event,
 390                           FL_Coord, FL_Coord, int key, void *)
 391 {
 392         // Note that the return value is important in the pre-emptive handler.
 393         // Don't return anything other than 0.
 394         BOOST_ASSERT(ob);
 395
 396         // Don't Assert this one, as it can happen quite naturally when things
 397         // are being deleted in the d-tor.
 398         //BOOST_ASSERT(ob->form);
 399         if (!ob->form) return 0;
 400
 401         FormBase * ptr = static_cast<FormBase *>(ob->form->u_vdata);
 402
 403         if (ptr)
 404                 ptr->PrehandlerCB(ob, event, key);
 405
 406         return 0;
 407 }
 408
 409 } // extern "C"