src/insets/insetcite.h

   1 // -*- C++ -*-
   2 /**
   3  * \file insetcite.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 Herbert Voß
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef INSET_CITE_H
  14 #define INSET_CITE_H
  15
  16
  17 #include "insetcommand.h"
  18
  19 /** Used to insert citations
  20  */
  21 class InsetCitation : public InsetCommand {
  22 public:
  23         ///
  24         InsetCitation(InsetCommandParams const &);
  25         ///
  26         ~InsetCitation();
  27         ///
  28         std::auto_ptr<InsetBase> clone() const {
  29                 return std::auto_ptr<InsetBase>(new InsetCitation(params()));
  30         }
  31         ///
  32         std::string const getScreenLabel(Buffer const &) const;
  33         ///
  34         EDITABLE editable() const { return IS_EDITABLE; }
  35         ///
  36         InsetOld::Code lyxCode() const { return InsetOld::CITE_CODE; }
  37         ///
  38         int ascii(Buffer const &, std::ostream &, int linelen) const;
  39         ///
  40         int latex(Buffer const &, std::ostream &,
  41                   LatexRunParams const &) const;
  42         ///
  43         dispatch_result localDispatch(FuncRequest const & cmd);
  44         ///
  45         void validate(LaTeXFeatures &) const;
  46         /** Invoked by BufferView::Pimpl::dispatch when a new citation key
  47             is inserted. Tells us that the buffer is no longer being loaded
  48             and that the cache of BibTeX keys should be reloaded in the future.
  49         */
  50         void setLoadingBuffer(Buffer const & buffer, bool state) const;
  51 protected:
  52         ///
  53         virtual
  54         dispatch_result
  55         priv_dispatch(FuncRequest const & cmd, idx_type &, pos_type &);
  56 private:
  57         struct Cache {
  58                 ///
  59                 enum Style {
  60                         ///
  61                         BASIC,
  62                         ///
  63                         NATBIB_AY,
  64                         ///
  65                         NATBIB_NUM
  66                 };
  67                 ///
  68                 Cache() : style(BASIC) {}
  69                 ///
  70                 Style style;
  71                 ///
  72                 InsetCommandParams params;
  73                 ///
  74                 std::string generated_label;
  75                 ///
  76                 std::string screen_label;
  77         };
  78
  79         /// This function does the donkey work of creating the pretty label
  80         std::string const generateLabel(Buffer const &) const;
  81         ///
  82         Cache::Style getStyle(Buffer const & buffer) const;
  83
  84         ///
  85         mutable Cache cache;
  86 };
  87
  88 #endif // INSET_CITE_H