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);
48 void on_okPB_clicked();
49 void on_cancelPB_clicked();
50 void on_restorePB_clicked();
51 void on_applyPB_clicked();
52 void on_searchPB_clicked();
53 void on_findLE_textChanged(const QString & text);
54 void on_fieldsCO_currentIndexChanged(int index);
55 void on_entriesCO_currentIndexChanged(int index);
56 void on_citationStyleCO_currentIndexChanged(int index);
57 void on_caseCB_stateChanged(int);
58 void on_regexCB_stateChanged(int);
59 void on_asTypeCB_stateChanged(int);
63 /// performs a limited update, suitable for internal call
64 void updateControls();
68 /// Dialog inherited methods
72 bool initialiseParams(std::string const & data);
74 void dispatchParams();
75 bool isBufferDependent() const { return true; }
76 void saveSession() const;
77 void restoreSession();
78 /** Disconnect from the inset when the Apply button is pressed.
79 * Allows easy insertion of multiple citations.
81 bool disconnectOnApply() const { return true; }
85 void showEvent(QShowEvent * e);
87 void closeEvent(QCloseEvent * e);
88 /// prepares a call to GuiCitation::searchKeys when we
89 /// are ready to search the BibTeX entries
90 void findText(QString const & text, bool reset = false);
91 /// check whether key is already selected
92 bool isSelected(const QModelIndex &);
93 /// update the display of BibTeX information
94 void updateInfo(BiblioInfo const & bi, QModelIndex const &);
95 /// enable/disable buttons
97 /// fill the styles combo
98 void fillStyles(BiblioInfo const & bi);
99 /// fill the fields combo
100 void fillFields(BiblioInfo const & bi);
101 /// fill the entries combo
102 void fillEntries(BiblioInfo const & bi);
103 /// set the styles combo
105 /// set the formatting widgets
106 void updateFormatting(CiteStyle currentStyle);
108 void updateControls(BiblioInfo const & bi);
111 /// Clear selected keys
112 void clearSelection();
114 /// Find keys containing a string.
116 BiblioInfo const & bi, //< optimize by passing this
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(BiblioInfo const & bi, 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);
134 void filterByEntryType(BiblioInfo const & bi,
135 std::vector<docstring> & keyVector, docstring entryType);
137 CiteEngine citeEngine() const;
139 /// Search a given string within the passed keys.
140 /// \return the vector of matched keys.
141 std::vector<docstring> searchKeys(
142 BiblioInfo const & bi, //< optimize by passing this
143 std::vector<docstring> const & keys_to_search, //< Keys to search.
144 bool only_keys, //< whether to search only the keys
145 docstring const & search_expression, //< Search expression (regex possible)
146 docstring field, //< field to search, empty for all fields
147 bool case_sensitive = false, //< set to true is the search should be case sensitive
148 bool regex = false //< \set to true if \c search_expression is a regex
151 /// The BibTeX information available to the dialog
152 /// Calls to this method will lead to checks of modification times and
153 /// the like, so it should be avoided.
154 BiblioInfo const & bibInfo() const;
156 /// last used citation style
159 GuiSelectionManager * selectionManager;
161 QStringListModel available_model_;
163 QStringListModel selected_model_;
165 QStringList all_keys_;
167 QStringList cited_keys_;
169 InsetCommandParams params_;
172 } // namespace frontend
175 #endif // GUICITATION_H