* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author José Matos
+ * \author José Matos
*
* Full author contact details are available in file CREDITS.
*/
namespace lyx {
-
/// The reference inset
class InsetRef : public InsetCommand {
public:
///
static std::string const & getName(int type);
+ ///
+ InsetRef(Buffer * buffer, InsetCommandParams const &);
- InsetRef(InsetCommandParams const &, Buffer const &);
-
+ /// \name Public functions inherited from Inset class
+ //@{
+ ///
+ bool isLabeled() const { return true; }
///
- docstring const getScreenLabel(Buffer const &) const;
+ docstring toolTip(BufferView const &, int, int) const
+ { return tooltip_; }
///
- EDITABLE editable() const { return IS_EDITABLE; }
+ bool hasSettings() const { return true; }
///
InsetCode lyxCode() const { return REF_CODE; }
///
DisplayType display() const { return Inline; }
///
- int latex(Buffer const &, odocstream &, OutputParams const &) const;
+ int latex(odocstream &, OutputParams const &) const;
///
- int plaintext(Buffer const &, odocstream &, OutputParams const &) const;
+ int plaintext(odocstream &, OutputParams const &) const;
///
- int docbook(Buffer const &, odocstream &, OutputParams const &) const;
+ int docbook(odocstream &, OutputParams const &) const;
+ ///
+ docstring xhtml(XHTMLStream &, OutputParams const &) const;
/// the string that is passed to the TOC
- void textString(Buffer const &, odocstream &) const;
+ void tocString(odocstream &) const;
///
void validate(LaTeXFeatures & features) const;
///
- static CommandInfo const * findInfo(std::string const &);
+ void updateBuffer(ParIterator const & it, UpdateType);
+ ///
+ void addToToc(DocIterator const &);
+ ///
+ bool forceLTR() const { return true; }
+ //@}
+
+ /// \name Static public methods obligated for InsetCommand derived classes
+ //@{
+ ///
+ static ParamInfo const & findInfo(std::string const &);
///
- static std::string defaultCommand() { return "ref"; };
+ static std::string defaultCommand() { return "ref"; }
///
static bool isCompatibleCommand(std::string const & s);
+ //@}
+
+ //FIXME: private
+ /// \name Private functions inherited from InsetCommand class
+ //@{
+ ///
+ docstring screenLabel() const { return screen_label_; }
+ //@}
+
protected:
///
InsetRef(InsetRef const &);
- ///
- virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
private:
+ /// \name Private functions inherited from Inset class
+ //@{
///
Inset * clone() const { return new InsetRef(*this); }
+ //@}
+
+ /// \return the label with things that need to be escaped escaped
+ docstring getEscapedLabel(OutputParams const &) const;
+ /// \return the command for a formatted reference to ref
+ /// \param label gets what follows the prefix, for refstyle
+ docstring getFormattedCmd(docstring const & ref, docstring & label) const;
+
///
- bool isLatex;
+ mutable docstring screen_label_;
+ ///
+ mutable docstring tooltip_;
};
+
} // namespace lyx
-#endif
+#endif // INSET_REF_H