2 * \file xforms/FormRef.C
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Angus Leeming
8 * Full author contact details are available in file CREDITS
15 #pragma implementation
19 #include "ControlRef.h"
22 #include "forms/form_ref.h"
23 #include "xforms_helpers.h"
24 #include "insets/insetref.h"
25 #include "helper_funcs.h" // getStringFromVector
26 #include "support/lstrings.h" // frontStrip, strip
27 #include FORMS_H_LOCATION
34 typedef FormCB<ControlRef, FormDB<FD_ref> > base_class;
37 : base_class(_("Reference")),
44 dialog_.reset(build_ref(this));
46 for (int i = 0; !InsetRef::types[i].latex_name.empty(); ++i)
47 fl_addto_choice(dialog_->choice_format,
48 _(InsetRef::types[i].gui_name.c_str()));
50 // Force the user to use the browser to change refs.
51 fl_deactivate_object(dialog_->input_ref);
53 fl_set_input_return(dialog_->input_name, FL_RETURN_CHANGED);
54 fl_set_input_return(dialog_->input_ref, FL_RETURN_CHANGED);
56 setPrehandler(dialog_->input_name);
57 setPrehandler(dialog_->input_ref);
59 // Manage the ok and cancel/close buttons
60 bc().setOK(dialog_->button_ok);
61 bc().setApply(dialog_->button_apply);
62 bc().setCancel(dialog_->button_close);
63 bc().setRestore(dialog_->button_restore);
65 bc().addReadOnly(dialog_->button_update);
66 bc().addReadOnly(dialog_->input_name);
67 bc().addReadOnly(dialog_->input_ref);
69 // set up the tooltips
70 string str = _("Select a document for references.");
71 tooltips().init(dialog_->choice_document, str);
72 str = _("Sort the references alphabetically.");
73 tooltips().init(dialog_->check_sort, str);
74 str = _("Go to selected reference.");
75 tooltips().init(dialog_->button_go, str);
76 str = _("Update the list of references.");
77 tooltips().init(dialog_->button_update, str);
78 str = _("Select format style of the reference.");
79 tooltips().init(dialog_->choice_format, str);
83 void FormRef::update()
85 fl_set_input(dialog_->input_ref,
86 controller().params().getContents().c_str());
87 fl_set_input(dialog_->input_name,
88 controller().params().getOptions().c_str());
89 fl_set_choice(dialog_->choice_format,
90 InsetRef::getType(controller().params().getCmdName()) + 1);
95 // Name is irrelevant to LaTeX/Literate documents
96 if (controller().docType() == ControlRef::LATEX ||
97 controller().docType() == ControlRef::LITERATE) {
98 setEnabled(dialog_->input_name, false);
100 setEnabled(dialog_->input_name, true);
103 // type is irrelevant to LinuxDoc/DocBook.
104 if (controller().docType() == ControlRef::LINUXDOC ||
105 controller().docType() == ControlRef::DOCBOOK) {
106 fl_set_choice(dialog_->choice_format, 1);
107 setEnabled(dialog_->choice_format, false);
109 setEnabled(dialog_->choice_format, true);
112 // Get the available buffers
113 vector<string> const buffers = controller().getBufferList();
114 vector<string> const choice_documents =
115 getVector(dialog_->choice_document);
117 // If different from the current contents of the choice, then update it
118 if (buffers != choice_documents) {
119 // create a string of entries " entry1 | entry2 | entry3 "
120 // with which to initialise the xforms choice object.
121 string const choice =
122 " " + getStringFromVector(buffers, " | ") + " ";
124 fl_clear_choice(dialog_->choice_document);
125 fl_addto_choice(dialog_->choice_document, choice.c_str());
128 fl_set_choice(dialog_->choice_document,
129 controller().getBufferNum() + 1);
131 string const name = controller().
132 getBufferName(fl_get_choice(dialog_->choice_document) - 1);
133 refs_ = controller().getLabelList(name);
135 updateBrowser(refs_);
141 void updateHighlight(FL_OBJECT * browser,
142 vector<string> const & keys,
145 vector<string>::const_iterator cit = (ref.empty())
147 : find(keys.begin(), keys.end(), ref);
149 if (cit == keys.end()) {
150 fl_deselect_browser(browser);
152 int const i = static_cast<int>(cit - keys.begin());
153 fl_set_browser_topline(browser, max(i-5, 1));
154 fl_select_browser_line(browser, i+1);
161 void FormRef::updateBrowser(vector<string> const & akeys) const
163 vector<string> keys(akeys);
164 if (fl_get_button(dialog_->check_sort))
165 sort(keys.begin(), keys.end());
167 vector<string> browser_keys = getVector(dialog_->browser_refs);
169 if (browser_keys == keys) {
170 updateHighlight(dialog_->browser_refs, keys,
171 getString(dialog_->input_ref));
175 fl_clear_browser(dialog_->browser_refs);
176 for (vector<string>::const_iterator it = keys.begin();
177 it != keys.end(); ++it)
178 fl_add_browser_line(dialog_->browser_refs, it->c_str());
181 fl_add_browser_line(dialog_->browser_refs,
182 _("*** No labels found in document ***"));
184 setEnabled(dialog_->browser_refs, false);
185 setEnabled(dialog_->check_sort, false);
187 fl_set_input(dialog_->input_ref, "");
189 setEnabled(dialog_->browser_refs, true);
190 setEnabled(dialog_->check_sort, true);
192 updateHighlight(dialog_->browser_refs, keys,
193 getString(dialog_->input_ref));
198 void FormRef::apply()
200 int const type = fl_get_choice(dialog_->choice_format) - 1;
201 controller().params().setCmdName(InsetRef::getName(type));
203 controller().params().setOptions(getString(dialog_->input_name));
204 controller().params().setContents(getString(dialog_->input_ref));
208 ButtonPolicy::SMInput FormRef::input(FL_OBJECT * ob, long)
210 ButtonPolicy::SMInput activate(ButtonPolicy::SMI_VALID);
212 if (ob == dialog_->button_go) {
213 // goto reference / go back
216 activate = ButtonPolicy::SMI_NOOP;
220 controller().gotoRef(getString(dialog_->input_ref));
222 controller().gotoBookmark();
226 } else if (ob == dialog_->browser_refs) {
228 unsigned int sel = fl_get_browser(dialog_->browser_refs);
229 if (sel < 1 || sel > refs_.size())
230 return ButtonPolicy::SMI_NOOP;
232 if (!controller().bufferIsReadonly()) {
233 string s = fl_get_browser_line(dialog_->browser_refs, sel);
234 fl_set_input(dialog_->input_ref, s.c_str());
238 controller().gotoBookmark();
242 setEnabled(dialog_->choice_format, true);
243 setEnabled(dialog_->button_go, true);
244 fl_set_object_lcol(dialog_->input_ref, FL_BLACK);
246 } else if (ob == dialog_->button_update ||
247 ob == dialog_->check_sort ||
248 ob == dialog_->choice_document) {
250 if (ob == dialog_->button_update ||
251 ob == dialog_->choice_document) {
253 controller().getBufferName(fl_get_choice(dialog_->choice_document) - 1);
254 refs_ = controller().getLabelList(name);
257 fl_freeze_form(form());
258 updateBrowser(refs_);
259 fl_unfreeze_form(form());
261 } else if (ob == dialog_->choice_format) {
263 int const type = fl_get_choice(dialog_->choice_format) - 1;
264 if (controller().params().getCmdName() ==
265 InsetRef::getName(type)) {
266 activate = ButtonPolicy::SMI_NOOP;
274 void FormRef::switch_go_button()
277 fl_set_object_label(dialog_->button_go, _("Go back"));
278 tooltips().init(dialog_->button_go, _("Go back to original place."));
280 fl_set_object_label(dialog_->button_go, _("Go to"));
281 tooltips().init(dialog_->button_go, _("Go to selected reference."));
283 fl_set_button_shortcut(dialog_->button_go, "#G", 1);
284 fl_show_object(dialog_->button_go);