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);
60 /// set the citation keys, mark as changed
62 /// update the styles for the style combo, mark as changed
64 /// performs a limited update, suitable for internal call
65 void updateControls();
69 /// Dialog inherited methods
73 bool initialiseParams(std::string const & data);
75 void dispatchParams();
76 bool isBufferDependent() const { return true; }
77 void saveSession() const;
78 void restoreSession();
79 /** Disconnect from the inset when the Apply button is pressed.
80 * Allows easy insertion of multiple citations.
82 bool disconnectOnApply() const { return true; }
86 void showEvent(QShowEvent * e);
88 void closeEvent(QCloseEvent * e);
89 /// prepares a call to GuiCitation::searchKeys when we
90 /// are ready to search the BibTeX entries
91 void findText(QString const & text, bool reset = false);
92 /// check whether key is already selected
93 bool isSelected(const QModelIndex &);
94 /// update the display of BibTeX information
95 void updateInfo(BiblioInfo const & bi, QModelIndex const &);
96 /// enable/disable buttons
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
103 void updateStyles(BiblioInfo const & bi);
104 /// set the formatting widgets
105 void updateFormatting(CitationStyle 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);
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 /// Search a given string within the passed keys.
137 /// \return the vector of matched keys.
138 std::vector<docstring> searchKeys(
139 BiblioInfo const & bi, //< optimize by passing this
140 std::vector<docstring> const & keys_to_search, //< Keys to search.
141 bool only_keys, //< whether to search only the keys
142 docstring const & search_expression, //< Search expression (regex possible)
143 docstring field, //< field to search, empty for all fields
144 bool case_sensitive = false, //< set to true is the search should be case sensitive
145 bool regex = false //< \set to true if \c search_expression is a regex
148 /// The BibTeX information available to the dialog
149 /// Calls to this method will lead to checks of modification times and
150 /// the like, so it should be avoided.
151 BiblioInfo const & bibInfo() const;
153 /// last used citation style
156 GuiSelectionManager * selectionManager;
158 QStringListModel available_model_;
160 QStringListModel selected_model_;
162 QStringList all_keys_;
164 QStringList cited_keys_;
166 InsetCommandParams params_;
169 } // namespace frontend
172 #endif // GUICITATION_H