Re #11508 Help string interface on component

(not yet tested)
mantidproject · Apr 20, 2015 · 671ca69 · 671ca69
1 parent b1d9aef
commit 671ca69
Show file tree

Hide file tree

Showing 2 changed files with 624 additions and 534 deletions.
diff --git a/Code/Mantid/Framework/Geometry/inc/MantidGeometry/Instrument/Component.h b/Code/Mantid/Framework/Geometry/inc/MantidGeometry/Instrument/Component.h
@@ -222,7 +222,20 @@ class MANTID_GEOMETRY_DLL Component : public virtual IComponent {
     else
       return std::string("");
   }
-
+  /** Get a parameter's description   */
+  std::string getParDescription(const std::string &pname,
+                               bool recursive = true) const;
+
+  /** Get this parameter's description -- no recursive search within children*/
+  std::string getParDescription() const;
+
+  /** Get a parameter's tooltip (short description) */
+  std::string getParTooltip(const std::string &pname,
+                               bool recursive = true) const;
+  /** Get a parameter's tooltip (short description) -- no recursive search within children*/
+  std::string getParTooltip() const;
+  /**Set components description. Works for parameterized components only */
+  void setDescription(const std::string &descr);
   /**
   * Get a parameter defined as a bool
   * @param pname :: The name of the parameter