]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetRef.h
Fix trailing whitespace in cpp files.
[lyx.git] / src / insets / InsetRef.h
index 9bc8d44641021766304b899386dd8b0327b2e1a9..066a596630b15f55399e015f96bdafd364780a7d 100644 (file)
@@ -4,7 +4,7 @@
  * 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.
  */
@@ -17,7 +17,6 @@
 
 namespace lyx {
 
-
 /// The reference inset
 class InsetRef : public InsetCommand {
 public:
@@ -29,53 +28,99 @@ public:
                ///
                std::string short_gui_name;
        };
-       static type_info types[];
+       static const type_info types[];
        ///
        static int getType(std::string const & name);
        ///
        static std::string const & getName(int type);
 
+       ///
+       InsetRef(Buffer * buffer, InsetCommandParams const &);
 
-       InsetRef(InsetCommandParams const &, Buffer const &);
-
+       /// \name Public functions inherited from Inset class
+       //@{
        ///
-       docstring screenLabel() const;
+       bool isLabeled() const { return true; }
        ///
-       EDITABLE editable() const { return IS_EDITABLE; }
+       docstring toolTip(BufferView const &, int, int) const
+               { return tooltip_; }
+       ///
+  docstring getTOCString() const;
+       ///
+       bool hasSettings() const { return true; }
        ///
        InsetCode lyxCode() const { return REF_CODE; }
        ///
        DisplayType display() const { return Inline; }
        ///
-       int latex(odocstream &, OutputParams const &) const;
+       void latex(otexstream &, OutputParams const &) const;
        ///
-       int plaintext(odocstream &, OutputParams const &) const;
+       int plaintext(odocstringstream & ods, OutputParams const & op,
+                     size_t max_length = INT_MAX) const;
        ///
        int docbook(odocstream &, OutputParams const &) const;
-       /// the string that is passed to the TOC
-       void textString(odocstream &) const;
+       ///
+       docstring xhtml(XHTMLStream &, OutputParams const &) const;
+       ///
+       void toString(odocstream &) const;
+       ///
+       void forOutliner(docstring &, size_t const, bool const) const;
        ///
        void validate(LaTeXFeatures & features) const;
        ///
+       void updateBuffer(ParIterator const & it, UpdateType);
+       ///
+       void addToToc(DocIterator const & di, bool output_active,
+                                 UpdateType utype, TocBackend & backend) 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);
-       ///
-       void addToToc(ParConstIterator const &) const;
+       //@}
+
 protected:
        ///
        InsetRef(InsetRef const &);
-       ///
-       void doDispatch(Cursor & cur, FuncRequest & cmd);
+
 private:
+       /// \name Private functions inherited from Inset class
+       //@{
        ///
        Inset * clone() const { return new InsetRef(*this); }
+       //@}
+
+       /// \name Private functions inherited from InsetCommand class
+       //@{
+       ///
+       docstring screenLabel() const;
+       //@}
+
+       /// \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 we're cross-referencing
+       /// \param argument for reference command
+       /// \param prefix of the label (before :)
+       docstring getFormattedCmd(docstring const & ref, docstring & label,
+                       docstring & prefix, docstring const & caps) const;
+
        ///
-       bool isLatex;
+       mutable docstring screen_label_;
+       ///
+       mutable bool broken_;
+       ///
+       mutable docstring tooltip_;
 };
 
+
 } // namespace lyx
 
-#endif
+#endif // INSET_REF_H