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 "DialogView.h"
19 #include "ui_CitationUi.h"
21 #include "insets/InsetCommandParams.h"
25 #include <QStringList>
26 #include <QStringListModel>
34 class GuiSelectionManager;
36 class GuiCitation : public DialogView, public Ui::CitationUi
42 GuiCitation(GuiView & lv);
47 void on_okPB_clicked();
48 void on_cancelPB_clicked();
49 void on_restorePB_clicked();
50 void on_applyPB_clicked();
51 void on_searchPB_clicked();
52 void on_findLE_textChanged(const QString & text);
53 void on_fieldsCO_currentIndexChanged(int index);
54 void on_entriesCO_currentIndexChanged(int index);
55 void on_citationStyleCO_currentIndexChanged(int index);
56 void on_caseCB_stateChanged(int);
57 void on_regexCB_stateChanged(int);
58 void on_asTypeCB_stateChanged(int);
62 /// performs a limited update, suitable for internal call
63 void updateControls();
67 /// Dialog inherited methods
71 bool initialiseParams(std::string const & data);
73 void dispatchParams();
74 bool isBufferDependent() const { return true; }
75 void saveSession() const;
76 void restoreSession();
77 /** Disconnect from the inset when the Apply button is pressed.
78 * Allows easy insertion of multiple citations.
80 bool disconnectOnApply() const { return true; }
84 void showEvent(QShowEvent * e);
86 void closeEvent(QCloseEvent * e);
87 /// prepares a call to GuiCitation::searchKeys when we
88 /// are ready to search the BibTeX entries
89 void findText(QString const & text, bool reset = false);
90 /// check whether key is already selected
91 bool isSelected(const QModelIndex &);
92 /// update the display of BibTeX information
93 void updateInfo(BiblioInfo const & bi, QModelIndex const &);
94 /// enable/disable buttons
96 /// fill the styles combo
97 void fillStyles(BiblioInfo const & bi);
98 /// fill the fields combo
99 void fillFields(BiblioInfo const & bi);
100 /// fill the entries combo
101 void fillEntries(BiblioInfo const & bi);
102 /// set the styles combo
104 /// set the formatting widgets
105 void updateFormatting(CiteStyle currentStyle);
107 void updateControls(BiblioInfo const & bi);
110 /// Clear selected keys
111 void clearSelection();
113 /// Find keys containing a string.
115 BiblioInfo const & bi, //< optimize by passing this
116 QString const & str, //< string expression
117 bool only_keys, //< set to true if only keys shall be searched.
118 docstring field, //<field to search, empty for all fields
119 docstring entryType, //<entry type to display, empty for all
120 bool case_sensitive, //< set to true for case sensitive search.
121 bool reg_exp, //< set to true if \c str is a regular expression.
122 bool reset = false //< whether to reset and search all keys
125 /// List of example cite strings
126 QStringList citationStyles(BiblioInfo const & bi, int);
128 /// Set the Params variable for the Controller.
129 void apply(int const choice, bool const full, bool const force,
130 QString before, QString after);
133 void filterByEntryType(BiblioInfo const & bi,
134 std::vector<docstring> & keyVector, docstring entryType);
136 CiteEngine citeEngine() const;
138 /// Search a given string within the passed keys.
139 /// \return the vector of matched keys.
140 std::vector<docstring> searchKeys(
141 BiblioInfo const & bi, //< optimize by passing this
142 std::vector<docstring> const & keys_to_search, //< Keys to search.
143 bool only_keys, //< whether to search only the keys
144 docstring const & search_expression, //< Search expression (regex possible)
145 docstring field, //< field to search, empty for all fields
146 bool case_sensitive = false, //< set to true is the search should be case sensitive
147 bool regex = false //< \set to true if \c search_expression is a regex
150 /// The BibTeX information available to the dialog
151 /// Calls to this method will lead to checks of modification times and
152 /// the like, so it should be avoided.
153 BiblioInfo const & bibInfo() const;
155 /// last used citation style
158 GuiSelectionManager * selectionManager;
160 QStringListModel available_model_;
162 QStringListModel selected_model_;
164 QStringList all_keys_;
166 QStringList cited_keys_;
168 InsetCommandParams params_;
171 } // namespace frontend
174 #endif // GUICITATION_H