]> git.lyx.org Git - lyx.git/blobdiff - src/frontends/xforms/FormRef.C
Introduce LFUN_PRINT.
[lyx.git] / src / frontends / xforms / FormRef.C
index 685f8207ec8549781ecd3ea981017b2f6ce3da56..0fe2db21726f9dfe1561e9710d7335090b200906 100644 (file)
-// -*- C++ -*-
-/* This file is part of
- * ====================================================== 
+/**
+ * \file FormRef.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *           LyX, The Document Processor
+ * \author Angus Leeming
  *
- *           Copyright 2000 The LyX Team.
- *
- * ======================================================
+ * Full author contact details are available in file CREDITS.
  */
 
 #include <config.h>
 
-#include FORMS_H_LOCATION
-
-#ifdef __GNUG__
-#pragma implementation
-#endif
+#include "FormRef.h"
+#include "ControlRef.h"
+#include "forms/form_ref.h"
 
+#include "Tooltips.h"
+#include "xforms_helpers.h"
+#include "xformsBC.h"
 
-#include "Dialogs.h"
-#include "FormRef.h"
-#include "LyXView.h"
-#include "buffer.h"
-#include "form_ref.h"
-#include "lyxfunc.h"
 #include "insets/insetref.h"
 
-#include <algorithm>
+#include "support/lstrings.h" // trim
+
+#include "lyx_forms.h"
+
+using lyx::support::getStringFromVector;
 
 using std::find;
 using std::max;
 using std::sort;
+using std::string;
 using std::vector;
 
-FormRef::FormRef(LyXView * lv, Dialogs * d)
-       : FormCommand(lv, d, _("Reference"), new NoRepeatedApplyPolicy),
-         toggle(GOBACK), dialog_(0)
-{
-       // let the dialog be shown
-       // These are permanent connections so we won't bother
-       // storing a copy because we won't be disconnecting.
-       d->showRef.connect(slot(this, &FormRef::showInset));
-       d->createRef.connect(slot(this, &FormRef::createInset));
-}
-
-
-FormRef::~FormRef()
-{
-       delete dialog_;
-}
 
+typedef FormController<ControlRef, FormView<FD_ref> > base_class;
 
-FL_FORM * FormRef::form() const
-{
-       if (dialog_) return dialog_->form;
-       return 0;
-}
-
-
-void FormRef::disconnect()
-{
-       refs.clear();
-       FormCommand::disconnect();
-}
+FormRef::FormRef(Dialog & parent)
+       : base_class(parent, _("Cross-reference")),
+         at_ref_(false)
+{}
 
 
 void FormRef::build()
 {
-       dialog_ = build_ref();
+       dialog_.reset(build_ref(this));
 
        for (int i = 0; !InsetRef::types[i].latex_name.empty(); ++i)
-               fl_addto_choice(dialog_->type,
-                               _(InsetRef::types[i].gui_name.c_str()));
-
-       // Workaround dumb xforms sizing bug
-       minw_ = form()->w;
-       minh_ = form()->h;
+               fl_addto_choice(dialog_->choice_format,
+                               _(InsetRef::types[i].gui_name).c_str());
 
        // Force the user to use the browser to change refs.
-       fl_deactivate_object(dialog_->ref);
-
-        // Manage the ok and cancel/close buttons
-       bc_.setOK(dialog_->button_ok);
-       bc_.setApply(dialog_->button_apply);
-       bc_.setCancel(dialog_->button_cancel);
-       bc_.setUndoAll(dialog_->button_restore);
-       bc_.refresh();
-
-#warning I had to uncomment this so the buttons could be disabled in update() (dekel)
-       //bc_.addReadOnly(dialog_->type);
-       //bc_.addReadOnly(dialog_->name);
+       fl_deactivate_object(dialog_->input_ref);
+
+       fl_set_input_return(dialog_->input_name, FL_RETURN_CHANGED);
+       fl_set_input_return(dialog_->input_ref,  FL_RETURN_CHANGED);
+
+       setPrehandler(dialog_->input_name);
+       setPrehandler(dialog_->input_ref);
+
+       // Manage the ok and cancel/close buttons
+       bcview().setOK(dialog_->button_ok);
+       bcview().setApply(dialog_->button_apply);
+       bcview().setCancel(dialog_->button_close);
+       bcview().setRestore(dialog_->button_restore);
+
+       bcview().addReadOnly(dialog_->button_update);
+       bcview().addReadOnly(dialog_->input_name);
+       bcview().addReadOnly(dialog_->input_ref);
+
+       // set up the tooltips
+       string str = _("Select a document for references.");
+       tooltips().init(dialog_->choice_document, str);
+       str = _("Sort the references alphabetically.");
+       tooltips().init(dialog_->check_sort, str);
+       str = _("Go to selected reference.");
+       tooltips().init(dialog_->button_go, str);
+       str = _("Update the list of references.");
+       tooltips().init(dialog_->button_update, str);
+       str = _("Select format style of the reference.");
+       tooltips().init(dialog_->choice_format, str);
 }
 
 
 void FormRef::update()
 {
-       if (inset_) {
-               fl_set_input(dialog_->ref,  params.getContents().c_str());
-               fl_set_input(dialog_->name, params.getOptions().c_str());
-               fl_set_choice(dialog_->type, getType()+1);
+       fl_set_input(dialog_->input_ref,
+                    controller().params().getContents().c_str());
+       fl_set_input(dialog_->input_name,
+                    controller().params().getOptions().c_str());
+       fl_set_choice(dialog_->choice_format,
+                     InsetRef::getType(controller().params().getCmdName()) + 1);
+
+       at_ref_ = false;
+       switch_go_button();
+
+       // Name is irrelevant to LaTeX/Literate documents
+       Kernel::DocTypes doctype = kernel().docType();
+       if (doctype == Kernel::LATEX || doctype == Kernel::LITERATE) {
+               setEnabled(dialog_->input_name, false);
+       } else {
+               setEnabled(dialog_->input_name, true);
        }
 
-       toggle = GOBACK;
-       fl_set_object_label(dialog_->button_go, _("Goto reference"));
-
-       // Name is irrelevant to LaTeX/Literate documents, while
        // type is irrelevant to LinuxDoc/DocBook.
-       if (lv_->buffer()->isLatex() || lv_->buffer()->isLatex()) {
-               fl_deactivate_object(dialog_->name);
-               fl_set_object_lcol(dialog_->name, FL_INACTIVE);
-               fl_activate_object(dialog_->type);
-               fl_set_object_lcol(dialog_->type, FL_BLACK);
+       if (doctype == Kernel::LINUXDOC || doctype == Kernel::DOCBOOK) {
+               fl_set_choice(dialog_->choice_format, 1);
+               setEnabled(dialog_->choice_format, false);
        } else {
-               fl_set_choice(dialog_->type, 1);
+               setEnabled(dialog_->choice_format, true);
+       }
+
+       // Get the available buffers
+       vector<string> const buffers = controller().getBufferList();
+       vector<string> const choice_documents =
+               getVector(dialog_->choice_document);
 
-               fl_activate_object(dialog_->name);
-               fl_set_object_lcol(dialog_->name, FL_BLACK);
-               fl_deactivate_object(dialog_->type);
-               fl_set_object_lcol(dialog_->type, FL_INACTIVE);
+       // If different from the current contents of the choice, then update it
+       if (buffers != choice_documents) {
+               // create a string of entries " entry1 | entry2 | entry3 "
+               // with which to initialise the xforms choice object.
+               string const choice =
+                       ' ' + getStringFromVector(buffers, " | ") + ' ';
+
+               fl_clear_choice(dialog_->choice_document);
+               fl_addto_choice(dialog_->choice_document, choice.c_str());
        }
 
-       refs = lv_->buffer()->getLabelList();
-       updateBrowser(refs);
+       fl_set_choice(dialog_->choice_document,
+                     controller().getBufferNum() + 1);
+
+       string const name = controller().
+               getBufferName(fl_get_choice(dialog_->choice_document) - 1);
+       refs_ = controller().getLabelList(name);
 
-       bc_.readOnly(lv_->buffer()->isReadonly());
+       updateBrowser(refs_);
 }
 
 
+namespace {
+
+void updateHighlight(FL_OBJECT * browser,
+                    vector<string> const & keys,
+                    string const & ref)
+{
+       vector<string>::const_iterator cit = (ref.empty())
+               ? keys.end()
+               : find(keys.begin(), keys.end(), ref);
+
+       if (cit == keys.end()) {
+               fl_deselect_browser(browser);
+       } else {
+               int const i = static_cast<int>(cit - keys.begin());
+               fl_set_browser_topline(browser, max(i-5, 1));
+               fl_select_browser_line(browser, i+1);
+       }
+}
+
+} // namespace anon
+
+
 void FormRef::updateBrowser(vector<string> const & akeys) const
 {
        vector<string> keys(akeys);
-       if (fl_get_button(dialog_->sort))
+       if (fl_get_button(dialog_->check_sort))
                sort(keys.begin(), keys.end());
 
-       fl_clear_browser(dialog_->browser);
+       vector<string> browser_keys = getVector(dialog_->browser_refs);
+
+       if (browser_keys == keys) {
+               updateHighlight(dialog_->browser_refs, keys,
+                               getString(dialog_->input_ref));
+               return;
+       }
+
+       fl_clear_browser(dialog_->browser_refs);
        for (vector<string>::const_iterator it = keys.begin();
             it != keys.end(); ++it)
-               fl_add_browser_line(dialog_->browser, (*it).c_str());
+               fl_add_browser_line(dialog_->browser_refs, it->c_str());
 
        if (keys.empty()) {
-               fl_add_browser_line(dialog_->browser,
-                                   _("*** No labels found in document ***"));
-
-               fl_deactivate_object(dialog_->browser);
-               fl_deactivate_object(dialog_->sort);
-               fl_set_object_lcol(dialog_->browser, FL_INACTIVE);
-               fl_set_object_lcol(dialog_->sort, FL_INACTIVE);
-               fl_set_input(dialog_->ref, "");
+               fl_add_browser_line(dialog_->browser_refs,
+                                   _("*** No labels found in document ***").c_str());
+
+               setEnabled(dialog_->browser_refs, false);
+               setEnabled(dialog_->check_sort,   false);
+
+               fl_set_input(dialog_->input_ref, "");
        } else {
-               fl_activate_object(dialog_->browser);
-               fl_set_object_lcol(dialog_->browser, FL_BLACK);
-               fl_activate_object(dialog_->sort);
-               fl_set_object_lcol(dialog_->sort, FL_BLACK);
-
-               string ref = fl_get_input(dialog_->ref);
-               vector<string>::const_iterator cit =
-                       find(keys.begin(), keys.end(), ref);
-               if (cit == keys.end())
-                       cit = keys.begin();
-               if (ref.empty())
-                       fl_set_input(dialog_->ref, (*cit).c_str());
+               setEnabled(dialog_->browser_refs, true);
+               setEnabled(dialog_->check_sort,   true);
 
-               int const i = static_cast<int>(cit - keys.begin());
-               fl_set_browser_topline(dialog_->browser, max(i-5, 1));
-               fl_select_browser_line(dialog_->browser, i+1);
+               updateHighlight(dialog_->browser_refs, keys,
+                               getString(dialog_->input_ref));
        }
 }
 
 
 void FormRef::apply()
 {
-       if (!lv_->view()->available())
-               return;
-
-       int const type = fl_get_choice(dialog_->type) - 1;
-       params.setCmdName(getName(type));
+       int const type = fl_get_choice(dialog_->choice_format) - 1;
+       controller().params().setCmdName(InsetRef::getName(type));
 
-       params.setOptions(fl_get_input(dialog_->name));
-       params.setContents(fl_get_input(dialog_->ref));
-
-       if (inset_ != 0) {
-               // Only update if contents have changed
-               if (params != inset_->params()) {
-                       inset_->setParams(params);
-                       lv_->view()->updateInset(inset_, true);
-               }
-       } else {
-               lv_->getLyXFunc()->Dispatch(LFUN_REF_INSERT,
-                                           params.getAsString());
-       }
+       controller().params().setOptions(getString(dialog_->input_name));
+       controller().params().setContents(getString(dialog_->input_ref));
 }
 
 
-bool FormRef::input(FL_OBJECT *, long data)
+ButtonPolicy::SMInput FormRef::input(FL_OBJECT * ob, long)
 {
-       bool activate(true);
-       switch (data) {
-       // goto reference / go back
-       case 1:
-       {
+       ButtonPolicy::SMInput activate(ButtonPolicy::SMI_VALID);
+
+       if (ob == dialog_->button_go) {
+               // goto reference / go back
+
                // No change to data
-               activate = false;
-               
-               toggle = static_cast<Goto>(toggle + 1);
-               if (toggle == GOFIRST ) toggle = GOREF;
-       
-               switch (toggle) {
-               case GOREF:
-               {
-                       lv_->getLyXFunc()->
-                               Dispatch(LFUN_REF_GOTO,
-                                        fl_get_input(dialog_->ref));
-                       fl_set_object_label(dialog_->button_go, _("Go back"));
-               }
-               break;
+               activate = ButtonPolicy::SMI_NOOP;
 
-               case GOBACK:
-               {
-                       lv_->getLyXFunc()->Dispatch(LFUN_REF_BACK);
-                       fl_set_object_label(dialog_->button_go,
-                                           _("Goto reference"));
+               at_ref_ = !at_ref_;
+               if (at_ref_) {
+                       controller().gotoRef(getString(dialog_->input_ref));
+               } else {
+                       controller().gotoBookmark();
                }
-               break;
+               switch_go_button();
 
-               default:
-                       break;
-               }
-       }
-       break;
+       } else if (ob == dialog_->browser_refs) {
 
-       // choose browser key
-       case 2:
-       {
-               unsigned int sel = fl_get_browser(dialog_->browser);
-               if (sel < 1 || sel > refs.size()) break;
+               unsigned int sel = fl_get_browser(dialog_->browser_refs);
+               if (sel < 1 || sel > refs_.size())
+                       return ButtonPolicy::SMI_NOOP;
 
-               if (!lv_->buffer()->isReadonly()) {
-                       string s = fl_get_browser_line(dialog_->browser, sel);
-                       fl_set_input(dialog_->ref, s.c_str());
+               if (!kernel().isBufferReadonly()) {
+                       string s = fl_get_browser_line(dialog_->browser_refs, sel);
+                       fl_set_input(dialog_->input_ref, s.c_str());
                }
 
-               toggle = GOBACK;
-               lv_->getLyXFunc()->Dispatch(LFUN_REF_BACK);
-               fl_set_object_label(dialog_->button_go, _("Goto reference"));
+               if (at_ref_)
+                       controller().gotoBookmark();
+               at_ref_ = false;
+               switch_go_button();
 
-               fl_activate_object(dialog_->type);
-               fl_set_object_lcol(dialog_->type, FL_BLACK);
-               fl_activate_object(dialog_->button_go);
-               fl_set_object_lcol(dialog_->button_go, FL_BLACK);
-               fl_set_object_lcol(dialog_->ref, FL_BLACK);
-       }
-       break;
+               setEnabled(dialog_->choice_format, true);
+               setEnabled(dialog_->button_go, true);
+               fl_set_object_lcol(dialog_->input_ref, FL_BLACK);
 
-       // update or sort
-       case 3:
-               refs = lv_->buffer()->getLabelList();
+       } else if (ob == dialog_->button_update ||
+                  ob == dialog_->check_sort ||
+                  ob == dialog_->choice_document) {
+
+               // No change to data
+               activate = ButtonPolicy::SMI_NOOP;
+
+               if (ob == dialog_->button_update ||
+                   ob == dialog_->choice_document) {
+                       string const name =
+                               controller().getBufferName(fl_get_choice(dialog_->choice_document) - 1);
+                       refs_ = controller().getLabelList(name);
+               }
 
-               // fall through to...
-       case 4:
                fl_freeze_form(form());
-               updateBrowser(refs);
+               updateBrowser(refs_);
                fl_unfreeze_form(form());
-               break;
-
-       // changed reference type
-       case 5:
-       {
-               int const type = fl_get_choice(dialog_->type) - 1;
-               if (params.getCmdName() == getName(type) && inset_) {
-                       activate = false;
-               }
-       }
-       break;
 
-       default:
-               break;
+       } else if (ob == dialog_->choice_format) {
+
+               int const type = fl_get_choice(dialog_->choice_format) - 1;
+               if (controller().params().getCmdName() ==
+                   InsetRef::getName(type)) {
+                       activate = ButtonPolicy::SMI_NOOP;
+               }
        }
 
        return activate;
 }
 
 
-int FormRef::getType() const
-{
-       string const & command = params.getCmdName();
-       for (int i = 0; !InsetRef::types[i].latex_name.empty(); ++i)
-               if (command == InsetRef::types[i].latex_name)
-                       return i;
-       return 0;
-}
-
-
-string const FormRef::getName(int type) const
+void FormRef::switch_go_button()
 {
-       return InsetRef::types[type].latex_name;
+       if (at_ref_) {
+               fl_set_object_label(dialog_->button_go, _("Go back").c_str());
+               tooltips().init(dialog_->button_go, _("Go back to original place.").c_str());
+       } else {
+               fl_set_object_label(dialog_->button_go, _("Go to").c_str());
+               tooltips().init(dialog_->button_go, _("Go to selected reference.").c_str());
+       }
+       fl_set_button_shortcut(dialog_->button_go, "#G", 1);
+       fl_show_object(dialog_->button_go);
 }