src/frontends/qt4/GuiCitation.h

   1 // -*- C++ -*-
   2 /**
   3  * \file GuiCitation.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Angus Leeming
   8  * \author Kalle Dalheimer
   9  * \author Abdelrazak Younes
  10  * \author Richard Heck
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #ifndef GUICITATION_H
  16 #define GUICITATION_H
  17
  18 #include "DialogView.h"
  19 #include "ui_CitationUi.h"
  20
  21 #include "insets/InsetCommandParams.h"
  22
  23 #include "Citation.h"
  24
  25 #include <QStringList>
  26 #include <QStringListModel>
  27
  28 namespace lyx {
  29
  30 class BiblioInfo;
  31
  32 namespace frontend {
  33
  34 class GuiSelectionManager;
  35
  36 class GuiCitation : public DialogView, public Ui::CitationUi
  37 {
  38         Q_OBJECT
  39
  40 public:
  41         ///
  42         GuiCitation(GuiView & lv);
  43         ///
  44         ~GuiCitation();
  45
  46 private Q_SLOTS:
  47         void cleanUp();
  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);
  60         void changed();
  61         ///
  62         void setCitedKeys();
  63         /// performs a limited update, suitable for internal call
  64         void updateControls();
  65
  66
  67 private:
  68         /// Dialog inherited methods
  69         //@{
  70         void applyView();
  71         void updateView() {}
  72         bool initialiseParams(std::string const & data);
  73         void clearParams();
  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.
  80          */
  81         bool disconnectOnApply() const { return true; }
  82         //@}
  83
  84         ///
  85         void showEvent(QShowEvent * e);
  86         ///
  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
  96         void setButtons();
  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
 104         void updateStyle();
 105         /// set the formatting widgets
 106         void updateFormatting(CiteStyle currentStyle);
 107         ///
 108         void updateControls(BiblioInfo const & bi);
 109         ///
 110         void init();
 111         /// Clear selected keys
 112         void clearSelection();
 113
 114         /// Find keys containing a string.
 115         void findKey(
 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
 124                 );
 125
 126         /// List of example cite strings
 127         QStringList citationStyles(BiblioInfo const & bi, int);
 128
 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);
 132
 133         ///
 134         void filterByEntryType(BiblioInfo const & bi,
 135                 std::vector<docstring> & keyVector, docstring entryType);
 136         ///
 137         CiteEngine citeEngine() const;
 138
 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
 149                 ); //
 150
 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;
 155
 156         /// last used citation style
 157         int style_;
 158         ///
 159         GuiSelectionManager * selectionManager;
 160         /// available keys.
 161         QStringListModel available_model_;
 162         /// selected keys.
 163         QStringListModel selected_model_;
 164         /// All keys.
 165         QStringList all_keys_;
 166         /// Cited keys.
 167         QStringList cited_keys_;
 168         ///
 169         InsetCommandParams params_;
 170 };
 171
 172 } // namespace frontend
 173 } // namespace lyx
 174
 175 #endif // GUICITATION_H