4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Angus Leeming
8 * \author Kalle Dalheimer
9 * \author Abdelrazak Younes
10 * \author Richard Heck
12 * Full author contact details are available in file CREDITS.
18 #include "GuiDialog.h"
19 #include "GuiSelectionManager.h"
20 #include "ui_CitationUi.h"
21 #include "support/docstring.h"
22 #include "BiblioInfo.h"
25 #include <QStringList>
26 #include <QStringListModel>
31 class GuiCitation : public GuiCommand, public Ui::CitationUi
37 GuiCitation(LyXView & lv);
41 /// Hide the dialog from sight
43 /// Create the dialog if necessary, update it and display it.
45 /// \return true if the dialog is visible.
46 bool isVisibleView() const;
49 /// Update the display of the dialog whilst it is still visible.
54 void closeEvent(QCloseEvent * e);
55 /// prepares a call to GuiCitation::searchKeys when we
56 /// are ready to search the BibTeX entries
57 void findText(QString const & text, bool reset = false);
58 /// check whether key is already selected
59 bool isSelected(const QModelIndex &);
60 /// update the display of BibTeX information
61 void updateInfo(QModelIndex const &);
65 void on_okPB_clicked();
66 void on_cancelPB_clicked();
67 void on_restorePB_clicked();
68 void on_applyPB_clicked();
69 void on_findLE_textChanged(const QString & text);
70 void on_fieldsCO_currentIndexChanged(int index);
71 void on_entriesCO_currentIndexChanged(int index);
72 void on_caseCB_stateChanged(int);
73 void on_regexCB_stateChanged(int);
77 /// performs a limited update, suitable for internal call
81 /// enable/disable buttons
83 /// fill the styles combo
85 /// fill the fields combo
87 /// fill the entries combo
89 /// set the styles combo
91 /// last used citation style
94 GuiSelectionManager * selectionManager;
99 QStringListModel * available() { return &available_model_; }
101 QStringListModel * selected() { return &selected_model_; }
103 QString textBefore();
106 /// Get key description
107 QString getKeyInfo(QString const &);
108 /// Clear selected keys
109 void clearSelection();
110 /// Return a list of available fields
111 QStringList getFieldsAsQStringList();
112 /// Return a list of available fields
113 QStringList getEntriesAsQStringList();
115 /// Find keys containing a string.
117 QString const & str, //< string expression
118 bool only_keys, //< set to true if only keys shall be searched.
119 docstring field, //<field to search, empty for all fields
120 docstring entryType, //<entry type to display, empty for all
121 bool case_sensitive, //< set to true for case sensitive search.
122 bool reg_exp, //< set to true if \c str is a regular expression.
123 bool reset = false //< whether to reset and search all keys
126 /// List of example cite strings
127 QStringList citationStyles(int);
129 /// Set the Params variable for the Controller.
130 void apply(int const choice, bool const full, bool const force,
131 QString before, QString after);
135 QStringListModel available_model_;
137 QStringListModel selected_model_;
139 QStringList all_keys_;
141 QStringList cited_keys_;
144 bool initialiseParams(std::string const & data);
146 /// clean-up on hide.
149 /** Disconnect from the inset when the Apply button is pressed.
150 * Allows easy insertion of multiple citations.
152 bool disconnectOnApply() const { return true; }
154 /// \return the list of all available bibliography keys.
155 std::vector<docstring> const availableKeys() const;
156 /// \return the list of all used BibTeX fields
157 std::vector<docstring> const availableFields() const;
158 /// \return the list of all used BibTeX entry types
159 std::vector<docstring> const availableEntries() const;
161 void filterByEntryType(
162 std::vector<docstring> & keyVector, docstring entryType);
164 biblio::CiteEngine getEngine() const;
166 /// \return information for this key.
167 docstring getInfo(docstring const & key) const;
169 /// Search a given string within the passed keys.
170 /// \return the vector of matched keys.
171 std::vector<docstring> searchKeys(
172 std::vector<docstring> const & keys_to_search, //< Keys to search.
173 bool only_keys, //< whether to search only the keys
174 docstring const & search_expression, //< Search expression (regex possible)
175 docstring field, //< field to search, empty for all fields
176 bool case_sensitive = false, //< set to true is the search should be case sensitive
177 bool regex = false //< \set to true if \c search_expression is a regex
181 /// The BibTeX information available to the dialog
182 BiblioInfo bibkeysInfo_;
185 } // namespace frontend
188 #endif // GUICITATION_H