From 01d88b2886ada398c883a44410827b11b907e512 Mon Sep 17 00:00:00 2001
From: Michele Calgaro <michele.calgaro@yahoo.it>
Date: Thu, 27 Nov 2014 11:51:59 +0900
Subject: Added support for handbookDocPath(). This relates to bug 1850.

---
 tdeui/tdecmodule.cpp |  5 +++++
 tdeui/tdecmodule.h   | 10 ++++++++++
 2 files changed, 15 insertions(+)

(limited to 'tdeui')

diff --git a/tdeui/tdecmodule.cpp b/tdeui/tdecmodule.cpp
index 1c718273a..48a72b6b3 100644
--- a/tdeui/tdecmodule.cpp
+++ b/tdeui/tdecmodule.cpp
@@ -208,6 +208,11 @@ TQString TDECModule::quickHelp() const
     return d->_quickHelp;
 }
 
+TQString TDECModule::handbookDocPath() const
+{
+    return TQString::null;
+}
+
 TQString TDECModule::handbookSection() const
 {
     return TQString::null;
diff --git a/tdeui/tdecmodule.h b/tdeui/tdecmodule.h
index b4d7f6d88..186ee6656 100644
--- a/tdeui/tdecmodule.h
+++ b/tdeui/tdecmodule.h
@@ -177,6 +177,16 @@ public:
    */
   virtual TQString quickHelp() const;
 
+  /**
+   * If the handbook's docPath string of the currently displayed content
+   * (for example in tabbed control center modules) differs from the docPath string
+   * of the currently displaying container, this method returns the relevant docPath string
+   *
+   * @returns a TQString containing the relevant handbook's docPath string or TQString::null 
+   *          if no specific docPath string is required (i.e. the container docPath is sufficient)
+   */
+  virtual TQString handbookDocPath() 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
-- 
cgit v1.2.1