summaryrefslogtreecommitdiffstats
path: root/tdeui/tdecmodule.h
diff options
context:
space:
mode:
authorMichele Calgaro <[email protected]>2014-11-27 11:51:59 +0900
committerMichele Calgaro <[email protected]>2014-11-27 11:51:59 +0900
commit01d88b2886ada398c883a44410827b11b907e512 (patch)
treea293fc2e5c18385408a922ea6544052b9b9bb103 /tdeui/tdecmodule.h
parentd4b2ca0550eeacd278c638664b43464239342244 (diff)
downloadtdelibs-01d88b2886ada398c883a44410827b11b907e512.tar.gz
tdelibs-01d88b2886ada398c883a44410827b11b907e512.zip
Added support for handbookDocPath(). This relates to bug 1850.
Diffstat (limited to 'tdeui/tdecmodule.h')
-rw-r--r--tdeui/tdecmodule.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/tdeui/tdecmodule.h b/tdeui/tdecmodule.h
index b4d7f6d88..186ee6656 100644
--- a/tdeui/tdecmodule.h
+++ b/tdeui/tdecmodule.h
@@ -178,6 +178,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
*