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.
14 #include "ControlRef.h"
15 #include "forms/form_ref.h"
18 #include "xforms_helpers.h"
21 #include "insets/insetref.h"
23 #include "support/lstrings.h" // trim
25 #include "lyx_forms.h"
27 using namespace lyx::support;
35 typedef FormController<ControlRef, FormView<FD_ref> > base_class;
37 FormRef::FormRef(Dialog & parent)
38 : base_class(parent, _("Cross-reference")),
45 dialog_.reset(build_ref(this));
47 for (int i = 0; !InsetRef::types[i].latex_name.empty(); ++i)
48 fl_addto_choice(dialog_->choice_format,
49 _(InsetRef::types[i].gui_name).c_str());
51 // Force the user to use the browser to change refs.
52 fl_deactivate_object(dialog_->input_ref);
54 fl_set_input_return(dialog_->input_name, FL_RETURN_CHANGED);
55 fl_set_input_return(dialog_->input_ref, FL_RETURN_CHANGED);
57 setPrehandler(dialog_->input_name);
58 setPrehandler(dialog_->input_ref);
60 // Manage the ok and cancel/close buttons
61 bcview().setOK(dialog_->button_ok);
62 bcview().setApply(dialog_->button_apply);
63 bcview().setCancel(dialog_->button_close);
64 bcview().setRestore(dialog_->button_restore);
66 bcview().addReadOnly(dialog_->button_update);
67 bcview().addReadOnly(dialog_->input_name);
68 bcview().addReadOnly(dialog_->input_ref);
70 // set up the tooltips
71 string str = _("Select a document for references.");
72 tooltips().init(dialog_->choice_document, str);
73 str = _("Sort the references alphabetically.");
74 tooltips().init(dialog_->check_sort, str);
75 str = _("Go to selected reference.");
76 tooltips().init(dialog_->button_go, str);
77 str = _("Update the list of references.");
78 tooltips().init(dialog_->button_update, str);
79 str = _("Select format style of the reference.");
80 tooltips().init(dialog_->choice_format, str);
84 void FormRef::update()
86 fl_set_input(dialog_->input_ref,
87 controller().params().getContents().c_str());
88 fl_set_input(dialog_->input_name,
89 controller().params().getOptions().c_str());
90 fl_set_choice(dialog_->choice_format,
91 InsetRef::getType(controller().params().getCmdName()) + 1);
96 // Name is irrelevant to LaTeX/Literate documents
97 Kernel::DocTypes doctype = kernel().docType();
98 if (doctype == Kernel::LATEX || doctype == Kernel::LITERATE) {
99 setEnabled(dialog_->input_name, false);
101 setEnabled(dialog_->input_name, true);
104 // type is irrelevant to LinuxDoc/DocBook.
105 if (doctype == Kernel::LINUXDOC || doctype == Kernel::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 ***").c_str());
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 (!kernel().isBufferReadonly()) {
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) {
251 activate = ButtonPolicy::SMI_NOOP;
253 if (ob == dialog_->button_update ||
254 ob == dialog_->choice_document) {
256 controller().getBufferName(fl_get_choice(dialog_->choice_document) - 1);
257 refs_ = controller().getLabelList(name);
260 fl_freeze_form(form());
261 updateBrowser(refs_);
262 fl_unfreeze_form(form());
264 } else if (ob == dialog_->choice_format) {
266 int const type = fl_get_choice(dialog_->choice_format) - 1;
267 if (controller().params().getCmdName() ==
268 InsetRef::getName(type)) {
269 activate = ButtonPolicy::SMI_NOOP;
277 void FormRef::switch_go_button()
280 fl_set_object_label(dialog_->button_go, _("Go back").c_str());
281 tooltips().init(dialog_->button_go, _("Go back to original place.").c_str());
283 fl_set_object_label(dialog_->button_go, _("Go to").c_str());
284 tooltips().init(dialog_->button_go, _("Go to selected reference.").c_str());
286 fl_set_button_shortcut(dialog_->button_go, "#G", 1);
287 fl_show_object(dialog_->button_go);