Pure HTML output for math macros.

[lyx.git] / src / insets / Inset.h

diff --git a/src/insets/Inset.h b/src/insets/Inset.h
index eb547f6c958f4a4eb2fe22fe32aef312f5e7f9ff..22604a73de1e2e783b50d8ae30b60ad837707df1 100644 (file)
--- a/src/insets/Inset.h
+++ b/src/insets/Inset.h
@@ -60,13 +60,15 @@ class XHTMLStream;
 namespace graphics { class PreviewLoader; }
 
 
-/** returns the InsetCode corresponding to the \c name.
-*   Eg, insetCode("branch") == BRANCH_CODE
-*   Implemented in 'Inset.cpp'.
-*/
+/// returns the InsetCode corresponding to the \c name.
+/// Eg, insetCode("branch") == BRANCH_CODE
 InsetCode insetCode(std::string const & name);
-/// the other way
+/// returns the Inset name corresponding to the \c InsetCode.
+/// Eg, insetName(BRANCH_CODE) == "branch"
 std::string insetName(InsetCode);
+/// returns the Inset name corresponding to the \c InsetCode.
+/// Eg, insetDisplayName(BRANCH_CODE) == _("Branch")
+docstring insetDisplayName(InsetCode);
 
 /// Common base class to all insets
 
@@ -105,15 +107,19 @@ public:
        /// retrieve associated Buffer
        virtual Buffer & buffer();
        virtual Buffer const & buffer() const;
-       /// This checks whether the Buffer * actually points to an open 
-       /// Buffer. It might not if that Buffer has been closed.
+       /// Returns true if buffer_ actually points to a Buffer that has
+       /// been loaded into LyX and is still open. Note that this will
+       /// always return false for cloned Buffers. If you want to allow
+       /// for the case of cloned Buffers, use isBufferValid().
+       bool isBufferLoaded() const;
+       /// Returns true if this is a loaded buffer or a cloned buffer.
        bool isBufferValid() const;
 
        /// initialize view for this inset.
        /**
          * This is typically used after this inset is created interactively.
          * Intented purpose is to sanitize internal state with regard to current
-         * Buffer. The default implementation calls buffer().updateLabels() if
+         * Buffer. The default implementation calls buffer().updateBuffer() if
          * the inset is labeled.
          *
          * \sa isLabeled()
@@ -188,7 +194,7 @@ public:
        ///
        virtual bool editing(BufferView const * bv) const;
        ///
-       virtual bool showInsetDialog(BufferView *) const { return false; }
+       virtual bool showInsetDialog(BufferView *) const;
 
        /// draw inset decoration if necessary.
        /// This can use \c drawMarkers() for example.
@@ -476,7 +482,7 @@ public:
        /// Update the counters of this inset and of its contents.
        /// The boolean indicates whether we are preparing for output, e.g.,
        /// of XHTML.
-       virtual void updateLabels(ParIterator const &, UpdateType) {}
+       virtual void updateBuffer(ParIterator const &, UpdateType) {}
 
        /// Updates the inset's dialog
        virtual Buffer const * updateFrontend() const;