src/frontends/xforms/FormRef.C

   1 /**
   2  * \file xforms/FormRef.C
   3  * Copyright 2000-2001 The LyX Team.
   4  * See the file COPYING.
   5  *
   6  * \author Angus Leeming, a.leeming@ic.ac.uk
   7  */
   8
   9 #include <config.h>
  10 #include <algorithm>
  11
  12 #ifdef __GNUG__
  13 #pragma implementation
  14 #endif
  15
  16 #include "xformsBC.h"
  17 #include "ControlRef.h"
  18 #include "FormRef.h"
  19 #include "form_ref.h"
  20 #include "xforms_helpers.h"
  21 #include "insets/insetref.h"
  22 #include "helper_funcs.h" // getStringFromVector
  23 #include "support/lstrings.h" // frontStrip, strip
  24
  25 using std::find;
  26 using std::max;
  27 using std::sort;
  28 using std::vector;
  29
  30 typedef FormCB<ControlRef, FormDB<FD_form_ref> > base_class;
  31
  32 FormRef::FormRef(ControlRef & c)
  33         : base_class(c, _("Reference")),
  34           at_ref_(false)
  35 {}
  36
  37
  38 void FormRef::build()
  39 {
  40         dialog_.reset(build_ref());
  41
  42         for (int i = 0; !InsetRef::types[i].latex_name.empty(); ++i)
  43                 fl_addto_choice(dialog_->choice_type,
  44                                 _(InsetRef::types[i].gui_name.c_str()));
  45
  46         // Force the user to use the browser to change refs.
  47         fl_deactivate_object(dialog_->input_ref);
  48
  49         fl_set_input_return(dialog_->input_name, FL_RETURN_CHANGED);
  50         fl_set_input_return(dialog_->input_ref,  FL_RETURN_CHANGED);
  51
  52         setPrehandler(dialog_->input_name);
  53         setPrehandler(dialog_->input_ref);
  54
  55         // Manage the ok and cancel/close buttons
  56         bc().setOK(dialog_->button_ok);
  57         bc().setApply(dialog_->button_apply);
  58         bc().setCancel(dialog_->button_cancel);
  59         bc().setRestore(dialog_->button_restore);
  60
  61         bc().addReadOnly(dialog_->button_update);
  62         bc().addReadOnly(dialog_->input_name);
  63         bc().addReadOnly(dialog_->input_ref);
  64 }
  65
  66
  67 void FormRef::update()
  68 {
  69         fl_set_input(dialog_->input_ref,
  70                      controller().params().getContents().c_str());
  71         fl_set_input(dialog_->input_name,
  72                      controller().params().getOptions().c_str());
  73         fl_set_choice(dialog_->choice_type,
  74                       InsetRef::getType(controller().params().getCmdName()) + 1);
  75
  76         at_ref_ = false;
  77         fl_set_object_label(dialog_->button_go, _("Go to reference"));
  78
  79         // Name is irrelevant to LaTeX/Literate documents
  80         if (controller().docType() == ControlRef::LATEX ||
  81             controller().docType() == ControlRef::LITERATE) {
  82                 setEnabled(dialog_->input_name, false);
  83         } else {
  84                 setEnabled(dialog_->input_name, true);
  85         }
  86
  87         // type is irrelevant to LinuxDoc/DocBook.
  88         if (controller().docType() == ControlRef::LINUXDOC ||
  89             controller().docType() == ControlRef::DOCBOOK) {
  90                 fl_set_choice(dialog_->choice_type, 1);
  91                 setEnabled(dialog_->choice_type, false);
  92         } else {
  93                 setEnabled(dialog_->choice_type, true);
  94         }
  95
  96         // Get the available buffers
  97         vector<string> const buffers = controller().getBufferList();
  98         vector<string> const choice_buffers =
  99                 getVectorFromChoice(dialog_->choice_buffer);
 100
 101         // If different from the current contents of the choice, then update it
 102         if (buffers != choice_buffers) {
 103                 // create a string of entries " entry1 | entry2 | entry3 "
 104                 // with which to initialise the xforms choice object.
 105                 string const choice =
 106                         " " + getStringFromVector(buffers, " | ") + " ";
 107
 108                 fl_clear_choice(dialog_->choice_buffer);
 109                 fl_addto_choice(dialog_->choice_buffer, choice.c_str());
 110
 111                 fl_set_choice(dialog_->choice_buffer,
 112                               controller().getBufferNum() + 1);
 113         }
 114
 115         refs_ = controller().getLabelList(string());
 116         updateBrowser(refs_);
 117 }
 118
 119
 120 void FormRef::updateBrowser(vector<string> const & akeys) const
 121 {
 122         vector<string> keys(akeys);
 123         if (fl_get_button(dialog_->check_sort))
 124                 sort(keys.begin(), keys.end());
 125
 126         vector<string> browser_keys =
 127                 getVectorFromBrowser(dialog_->browser_refs);
 128
 129         if (browser_keys == keys)
 130                 return;
 131
 132         fl_clear_browser(dialog_->browser_refs);
 133         for (vector<string>::const_iterator it = keys.begin();
 134              it != keys.end(); ++it)
 135                 fl_add_browser_line(dialog_->browser_refs, it->c_str());
 136
 137         if (keys.empty()) {
 138                 fl_add_browser_line(dialog_->browser_refs,
 139                                     _("*** No labels found in document ***"));
 140
 141                 setEnabled(dialog_->browser_refs, false);
 142                 setEnabled(dialog_->check_sort,   false);
 143
 144                 fl_set_input(dialog_->input_ref, "");
 145         } else {
 146                 setEnabled(dialog_->browser_refs, true);
 147                 setEnabled(dialog_->check_sort,   true);
 148
 149                 string ref = fl_get_input(dialog_->input_ref);
 150                 vector<string>::const_iterator cit = (ref.empty())
 151                         ? keys.begin()
 152                         : find(keys.begin(), keys.end(), ref);
 153                 if (cit == keys.end()) {
 154                         fl_deselect_browser(dialog_->browser_refs);
 155                 } else {
 156                         if (ref.empty())
 157                                 fl_set_input(dialog_->input_ref, cit->c_str());
 158
 159                         int const i = static_cast<int>(cit - keys.begin());
 160                         fl_set_browser_topline(dialog_->browser_refs, max(i-5, 1));
 161                         fl_select_browser_line(dialog_->browser_refs, i+1);
 162                 }
 163         }
 164 }
 165
 166
 167 void FormRef::apply()
 168 {
 169         int const type = fl_get_choice(dialog_->choice_type) - 1;
 170         controller().params().setCmdName(InsetRef::getName(type));
 171
 172         controller().params().setOptions(fl_get_input(dialog_->input_name));
 173         controller().params().setContents(fl_get_input(dialog_->input_ref));
 174 }
 175
 176
 177 ButtonPolicy::SMInput FormRef::input(FL_OBJECT * ob, long)
 178 {
 179         ButtonPolicy::SMInput activate(ButtonPolicy::SMI_VALID);
 180
 181         if (ob == dialog_->button_go) {
 182                 // goto reference / go back
 183
 184                 // No change to data
 185                 activate = ButtonPolicy::SMI_NOOP;
 186
 187                 at_ref_ = !at_ref_;
 188                 if (at_ref_) {
 189                         controller().gotoRef(fl_get_input(dialog_->input_ref));
 190                         fl_set_object_label(dialog_->button_go, _("Go back"));
 191                 } else {
 192                         controller().gotoBookmark();
 193                         fl_set_object_label(dialog_->button_go,
 194                                             _("Go to reference"));
 195                 }
 196
 197         } else if (ob == dialog_->browser_refs) {
 198
 199                 unsigned int sel = fl_get_browser(dialog_->browser_refs);
 200                 if (sel < 1 || sel > refs_.size())
 201                         return ButtonPolicy::SMI_NOOP;
 202
 203                 if (!controller().isReadonly()) {
 204                         string s = fl_get_browser_line(dialog_->browser_refs, sel);
 205                         fl_set_input(dialog_->input_ref, s.c_str());
 206                 }
 207
 208                 if (at_ref_)
 209                         controller().gotoBookmark();
 210                 at_ref_ = false;
 211                 fl_set_object_label(dialog_->button_go, _("Go to reference"));
 212
 213                 setEnabled(dialog_->choice_type,      true);
 214                 setEnabled(dialog_->button_go, true);
 215                 fl_set_object_lcol(dialog_->input_ref, FL_BLACK);
 216
 217         } else if (ob == dialog_->button_update ||
 218                    ob == dialog_->check_sort ||
 219                    ob == dialog_->choice_buffer) {
 220
 221                 if (ob == dialog_->button_update ||
 222                     ob == dialog_->choice_buffer) {
 223                         string const name =
 224                                 controller().getBufferName(fl_get_choice(dialog_->choice_buffer) - 1);
 225                         refs_ = controller().getLabelList(name);
 226                 }
 227
 228                 fl_freeze_form(form());
 229                 updateBrowser(refs_);
 230                 fl_unfreeze_form(form());
 231
 232         } else if (ob == dialog_->choice_type) {
 233
 234                 int const type = fl_get_choice(dialog_->choice_type) - 1;
 235                 if (controller().params().getCmdName() ==
 236                     InsetRef::getName(type)) {
 237                         activate = ButtonPolicy::SMI_NOOP;
 238                 }
 239         }
 240
 241         return activate;
 242 }