Branch: master

319f69a2 2014-10-03 18:45:41 Timothy Pearson
Add new handbookSection() method to the TDECModule class
This relates to Bug 1850
M tdeui/tdecmodule.cpp
M tdeui/tdecmodule.h
diff --git a/tdeui/tdecmodule.cpp b/tdeui/tdecmodule.cpp
index c6b7d37..1c71827 100644
--- a/tdeui/tdecmodule.cpp
+++ b/tdeui/tdecmodule.cpp
@@ -208,6 +208,10 @@
     return d->_quickHelp;
 }
 
+TQString TDECModule::handbookSection() const
+{
+    return TQString::null;
+}
 
 const TQPtrList<TDEConfigDialogManager>& TDECModule::configs() const
 {
diff --git a/tdeui/tdecmodule.h b/tdeui/tdecmodule.h
index ccaaa8f..b4d7f6d 100644
--- a/tdeui/tdecmodule.h
+++ b/tdeui/tdecmodule.h
@@ -178,6 +178,15 @@
   virtual TQString quickHelp() const;
 
   /**
+   * If a specific handbook section is relevant to the currently displayed content
+   * (for example tabbed control center modules) this method returns the relevant section name
+   *
+   * @note this string must match the handbook HTML section name exactly
+   * @returns a TQString containing the relevant handbook section name or TQString::null if no specific section is relevant
+   */
+  virtual TQString handbookSection() const;
+
+  /**
    * This is generally only called for the KBugReport.
    * If you override you should  have it return a pointer to a constant.
    *
@@ -185,7 +194,7 @@
    * @returns the TDEAboutData for this module
    */
   virtual const TDEAboutData *aboutData() const;
-  
+
   /**
    * This sets the TDEAboutData returned by aboutData()
    * @since 3.3