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 class LaTeXFeatures;
  19
  20 /** The url inset
  21  */
  22 class InsetUrl : public InsetCommand {
  23 public:
  24         ///
  25         explicit
  26         InsetUrl(InsetCommandParams const &);
  27         ///
  28         InsetBase::Code lyxCode() const { return InsetBase::URL_CODE; }
  29         ///
  30         void validate(LaTeXFeatures &) const;
  31         ///
  32         lyx::docstring const getScreenLabel(Buffer const &) const;
  33         ///
  34         EDITABLE editable() const { return IS_EDITABLE; }
  35         ///
  36         bool display() const { return false; }
  37         ///
  38         int latex(Buffer const &, lyx::odocstream &,
  39                   OutputParams const &) const;
  40         ///
  41         int plaintext(Buffer const &, lyx::odocstream &,
  42                   OutputParams const &) const;
  43         ///
  44         int docbook(Buffer const &, std::ostream &,
  45                     OutputParams const &) const;
  46         /// the string that is passed to the TOC
  47         virtual int textString(Buffer const &, lyx::odocstream &,
  48                 OutputParams const &) const;
  49 private:
  50         virtual std::auto_ptr<InsetBase> doClone() const {
  51                 return std::auto_ptr<InsetBase>(new InsetUrl(params()));
  52         }
  53 };
  54
  55 #endif