lyx_mirror/src/insets/InsetHyperlink.h
Vincent van Ravesteijn c75d667e78 Organize header files in src\insets.
- Functions that inherit from the same baseclass are grouped together with a command;
- Functions that inherit should not have a doxy entry;
- Other functions are also grouped together as much as possible;
- Some function don't need to be implemented if they return the same as the baseclass;
- and more.

git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@35873 a592a061-630c-0410-9148-cb99ea01b6c8
2010-10-27 21:35:13 +00:00

93 lines
2.0 KiB
C++

// -*- C++ -*-
/**
* \file InsetHyperlink.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author José Matos
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSET_HYPERLINK_H
#define INSET_HYPERLINK_H
#include "InsetCommand.h"
namespace lyx {
/** The hyperlink inset
*/
class InsetHyperlink : public InsetCommand
{
public:
///
InsetHyperlink(Buffer * buf, InsetCommandParams const &);
/// \name Public functions inherited from Inset class
//@{
///
InsetCode lyxCode() const { return HYPERLINK_CODE; }
///
bool hasSettings() const { return true; }
///
bool forceLTR() const { return true; }
///
bool isInToc() const { return true; }
///
void tocString(odocstream &) const;
///
docstring toolTip(BufferView const & bv, int x, int y) const;
///
docstring contextMenu(BufferView const &, int, int) const;
///
void validate(LaTeXFeatures &) const;
///
int latex(odocstream &, OutputParams const &) const;
///
int plaintext(odocstream &, OutputParams const &) const;
///
int docbook(odocstream &, OutputParams const &) const;
///
docstring xhtml(XHTMLStream &, OutputParams const &) const;
//@}
/// \name Static public methods obligated for InsetCommand derived classes
//@{
///
static bool isCompatibleCommand(std::string const & s)
{ return s == "href"; }
///
static std::string defaultCommand() { return "href"; }
///
static ParamInfo const & findInfo(std::string const &);
//@}
private:
/// \name Private functions inherited from Inset class
//@{
///
void doDispatch(Cursor & cur, FuncRequest & cmd);
///
bool getStatus(Cursor & cur, FuncRequest const & cmd,
FuncStatus & flag) const;
///
Inset * clone() const { return new InsetHyperlink(*this); }
//@}
/// \name Private functions inherited from InsetCommand class
//@{
///
docstring screenLabel() const;
//@}
///
void viewTarget() const;
};
} // namespace lyx
#endif // INSET_HYPERLINK_H