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