s/updateLabels/updateBuffer/g, per a suggestion of Abdel's.

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

diff --git a/src/insets/Inset.h b/src/insets/Inset.h
index 8b56f802cd4a59870d4af15e553682d3d9652b57..01907cb330ec9ab2eb51eab064eb0104cef28458 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
 
@@ -113,7 +115,7 @@ public:
        /**
          * 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 +190,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.
@@ -291,6 +293,9 @@ public:
        /// request "external features"
        virtual void validate(LaTeXFeatures &) const {}
 
+       /// Validate LFUN_INSET_MODIFY argument.
+       virtual bool validateModifyArgument(docstring const &) const { return true; }
+
        /// describe content if cursor inside
        virtual void infoize(odocstream &) const {}
        /// describe content if cursor behind
@@ -473,7 +478,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;
@@ -488,6 +493,8 @@ public:
        virtual mode_type currentMode() const { return UNDECIDED_MODE; }
        /// returns whether changing mode during latex export is forbidden
        virtual bool lockedMode() const { return false; }
+       /// returns whether only ascii chars are allowed during latex export
+       virtual bool asciiOnly() const { return false; }
        /// returns whether this inset is allowed in other insets of given mode
        virtual bool allowedIn(mode_type) const { return true; }
        /**