src/insets/inseturl.h

   1 // -*- C++ -*-
   2 /**
   3  * \file inseturl.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author José Matos
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef INSET_URL_H
  13 #define INSET_URL_H
  14
  15
  16 #include "insetcommand.h"
  17
  18
  19 namespace lyx {
  20
  21 class LaTeXFeatures;
  22
  23 /** The url inset
  24  */
  25 class InsetUrl : public InsetCommand {
  26 public:
  27         ///
  28         explicit
  29         InsetUrl(InsetCommandParams const &);
  30         ///
  31         InsetBase::Code lyxCode() const { return InsetBase::URL_CODE; }
  32         ///
  33         void validate(LaTeXFeatures &) const;
  34         ///
  35         docstring const getScreenLabel(Buffer const &) const;
  36         ///
  37         EDITABLE editable() const { return IS_EDITABLE; }
  38         ///
  39         bool display() const { return false; }
  40         ///
  41         int latex(Buffer const &, odocstream &,
  42                   OutputParams const &) const;
  43         ///
  44         int plaintext(Buffer const &, odocstream &,
  45                   OutputParams const &) const;
  46         ///
  47         int docbook(Buffer const &, odocstream &,
  48                     OutputParams const &) const;
  49         /// the string that is passed to the TOC
  50         virtual int textString(Buffer const &, odocstream &,
  51                 OutputParams const &) const;
  52 private:
  53         virtual std::auto_ptr<InsetBase> doClone() const {
  54                 return std::auto_ptr<InsetBase>(new InsetUrl(params()));
  55         }
  56 };
  57
  58
  59 } // namespace lyx
  60
  61 #endif