src/frontends/xforms/FormDialogView.C

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