src/insets/InsetHyperlink.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetHyperlink.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_HYPERLINK_H
  13 #define INSET_HYPERLINK_H
  14
  15
  16 #include "InsetCommand.h"
  17
  18
  19 namespace lyx {
  20
  21 class LaTeXFeatures;
  22
  23 /** The hyperlink inset
  24  */
  25 class InsetHyperlink : public InsetCommand {
  26 public:
  27         ///
  28         explicit
  29         InsetHyperlink(InsetCommandParams const &);
  30         ///
  31         InsetCode lyxCode() const { return HYPERLINK_CODE; }
  32         ///
  33         void validate(LaTeXFeatures &) const;
  34         ///
  35         docstring screenLabel() const;
  36         ///
  37         EDITABLE editable() const { return IS_EDITABLE; }
  38         ///
  39         DisplayType display() const { return Inline; }
  40         ///
  41         int latex(odocstream &, OutputParams const &) const;
  42         ///
  43         int plaintext(odocstream &, OutputParams const &) const;
  44         ///
  45         int docbook(odocstream &, OutputParams const &) const;
  46         /// the string that is passed to the TOC
  47         void textString(odocstream &) const;
  48         ///
  49         static ParamInfo const & findInfo(std::string const &);
  50         ///
  51         static std::string defaultCommand() { return "href"; };
  52         ///
  53         static bool isCompatibleCommand(std::string const & s)
  54                 { return s == "href"; }
  55         /// Force inset into LTR environment if surroundings are RTL?
  56         bool forceLTR() const { return true; }
  57 private:
  58         Inset * clone() const { return new InsetHyperlink(params()); }
  59 };
  60
  61
  62 } // namespace lyx
  63
  64 #endif