#ifndef GUICITATION_H
#define GUICITATION_H
-#include "GuiDialog.h"
-#include "GuiSelectionManager.h"
+#include "DialogView.h"
#include "ui_CitationUi.h"
-#include "BiblioInfo.h"
+#include "FancyLineEdit.h"
#include "insets/InsetCommandParams.h"
+#include "Citation.h"
+
#include <QStringList>
#include <QStringListModel>
namespace lyx {
+
+class BiblioInfo;
+
namespace frontend {
-class GuiCitation : public GuiDialog, public Ui::CitationUi
+class GuiSelectionManager;
+
+class GuiCitation : public DialogView, public Ui::CitationUi
{
Q_OBJECT
public:
///
GuiCitation(GuiView & lv);
-
///
- void applyView();
-
-public Q_SLOTS:
- /// Update the display of the dialog whilst it is still visible.
- void updateView();
-
-private:
- ///
- void showEvent(QShowEvent * e);
- ///
- void closeEvent(QCloseEvent * e);
- /// prepares a call to GuiCitation::searchKeys when we
- /// are ready to search the BibTeX entries
- void findText(QString const & text, bool reset = false);
- /// check whether key is already selected
- bool isSelected(const QModelIndex &);
- /// update the display of BibTeX information
- void updateInfo(QModelIndex const &);
+ ~GuiCitation();
private Q_SLOTS:
- void cleanUp();
void on_okPB_clicked();
void on_cancelPB_clicked();
void on_restorePB_clicked();
void on_applyPB_clicked();
- void on_findLE_textChanged(const QString & text);
+ void filterPressed();
+ void filterChanged(const QString & text);
void on_fieldsCO_currentIndexChanged(int index);
void on_entriesCO_currentIndexChanged(int index);
void on_citationStyleCO_currentIndexChanged(int index);
- void on_caseCB_stateChanged(int);
- void on_regexCB_stateChanged(int);
+ void resetFilter();
+ void caseChanged();
+ void regexChanged();
+ void instantChanged(bool checked);
void changed();
- ///
+ /// set the citation keys, mark as changed
void setCitedKeys();
+ /// update the styles for the style combo, mark as changed
+ void updateStyles();
/// performs a limited update, suitable for internal call
- void updateDialog();
-
+ void updateControls();
+
+
private:
+ /// Dialog inherited methods
+ //@{
+ void applyView();
+ void updateView() {}
+ bool initialiseParams(std::string const & data);
+ void clearParams();
+ void dispatchParams();
+ bool isBufferDependent() const { return true; }
+ void saveSession() const;
+ void restoreSession();
+ /** Disconnect from the inset when the Apply button is pressed.
+ * Allows easy insertion of multiple citations.
+ */
+ bool disconnectOnApply() const { return true; }
+ //@}
+
+ ///
+ void showEvent(QShowEvent * e);
+ ///
+ void closeEvent(QCloseEvent * e);
+ /// prepares a call to GuiCitation::searchKeys when we
+ /// are ready to search the BibTeX entries
+ void findText(QString const & text, bool reset = false);
+ /// check whether key is already selected
+ bool isSelected(const QModelIndex &);
+ /// update the display of BibTeX information
+ void updateInfo(BiblioInfo const & bi, QModelIndex const &);
/// enable/disable buttons
void setButtons();
- /// fill the styles combo
- void fillStyles();
/// fill the fields combo
- void fillFields();
+ void fillFields(BiblioInfo const & bi);
/// fill the entries combo
- void fillEntries();
+ void fillEntries(BiblioInfo const & bi);
/// set the styles combo
- void updateStyle();
+ void updateStyles(BiblioInfo const & bi);
/// set the formatting widgets
- void updateFormatting(biblio::CiteStyle currentStyle);
- /// last used citation style
- int style_;
-
- GuiSelectionManager * selectionManager;
-
+ void updateFormatting(CitationStyle currentStyle);
+ ///
+ void updateControls(BiblioInfo const & bi);
+ /// Set the appropriate hinting text on the filter bar
+ void updateFilterHint();
///
void init();
- /// Available keys
- QStringListModel * available() { return &available_model_; }
- /// Selected keys
- QStringListModel * selected() { return &selected_model_; }
- /// Text before cite
- QString textBefore();
- /// Text after cite
- QString textAfter();
- /// Get key description
- QString getKeyInfo(QString const &);
/// Clear selected keys
void clearSelection();
- /// Return a list of available fields
- QStringList getFieldsAsQStringList();
- /// Return a list of available fields
- QStringList getEntriesAsQStringList();
-
+
/// Find keys containing a string.
void findKey(
+ BiblioInfo const & bi, //< optimize by passing this
QString const & str, //< string expression
bool only_keys, //< set to true if only keys shall be searched.
docstring field, //<field to search, empty for all fields
);
/// List of example cite strings
- QStringList citationStyles(int);
+ QStringList citationStyles(BiblioInfo const & bi, size_t max_size);
/// Set the Params variable for the Controller.
- void apply(int const choice, bool const full, bool const force,
+ void applyParams(int const choice, bool const full, bool const force,
QString before, QString after);
- ///
- bool initialiseParams(std::string const & data);
- /// clean-up on hide.
- void clearParams();
- /// clean-up on hide.
- void dispatchParams();
- ///
- bool isBufferDependent() const { return true; }
-private:
- /// available keys.
- QStringListModel available_model_;
- /// selected keys.
- QStringListModel selected_model_;
- /// All keys.
- QStringList all_keys_;
- /// Cited keys.
- QStringList cited_keys_;
///
- InsetCommandParams params_;
-
- /** Disconnect from the inset when the Apply button is pressed.
- * Allows easy insertion of multiple citations.
- */
- bool disconnectOnApply() const { return true; }
-
- /// \return the list of all available bibliography keys.
- std::vector<docstring> availableKeys() const;
- /// \return the list of all used BibTeX fields
- std::vector<docstring> availableFields() const;
- /// \return the list of all used BibTeX entry types
- std::vector<docstring> availableEntries() const;
- ///
- void filterByEntryType(
+ void filterByEntryType(BiblioInfo const & bi,
std::vector<docstring> & keyVector, docstring entryType);
- ///
- biblio::CiteEngine citeEngine() const;
-
- /// \return information for this key.
- docstring getInfo(docstring const & key) const;
/// Search a given string within the passed keys.
/// \return the vector of matched keys.
std::vector<docstring> searchKeys(
+ BiblioInfo const & bi, //< optimize by passing this
std::vector<docstring> const & keys_to_search, //< Keys to search.
bool only_keys, //< whether to search only the keys
docstring const & search_expression, //< Search expression (regex possible)
bool regex = false //< \set to true if \c search_expression is a regex
); //
-private:
/// The BibTeX information available to the dialog
- BiblioInfo bibkeysInfo_;
+ /// Calls to this method will lead to checks of modification times and
+ /// the like, so it should be avoided.
+ BiblioInfo const & bibInfo() const;
+
+ /// contains the search box
+ FancyLineEdit * filter_;
+
+ /// Regexp action
+ QAction * regexp_;
+ /// Case sensitive action
+ QAction * casesense_;
+ /// Search as you type action
+ QAction * instant_;
+
+ /// last used citation style
+ int style_;
+ ///
+ GuiSelectionManager * selectionManager;
+ /// available keys.
+ QStringListModel available_model_;
+ /// selected keys.
+ QStringListModel selected_model_;
+ /// All keys.
+ QStringList all_keys_;
+ /// Cited keys.
+ QStringList cited_keys_;
+ ///
+ InsetCommandParams params_;
};
} // namespace frontend