diff options
| author | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2014-10-03 18:45:41 -0500 |
|---|---|---|
| committer | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2014-10-03 18:45:41 -0500 |
| commit | 319f69a280df213c70a2bf18d999d29641d45fc7 (patch) | |
| tree | 5dc34f527722d76a6df0452f5b7dabb017abbe25 /tdeui/tdecmodule.h | |
| parent | cc5fd88be313142d3996c81f8bdfc1290485858c (diff) | |
| download | tdelibs-319f69a280df213c70a2bf18d999d29641d45fc7.tar.gz tdelibs-319f69a280df213c70a2bf18d999d29641d45fc7.zip | |
Add new handbookSection() method to the TDECModule class
This relates to Bug 1850
Diffstat (limited to 'tdeui/tdecmodule.h')
| -rw-r--r-- | tdeui/tdecmodule.h | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/tdeui/tdecmodule.h b/tdeui/tdecmodule.h index ccaaa8fd5..b4d7f6d88 100644 --- a/tdeui/tdecmodule.h +++ b/tdeui/tdecmodule.h @@ -178,6 +178,15 @@ public: 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 @@ public: * @returns the TDEAboutData for this module */ virtual const TDEAboutData *aboutData() const; - + /** * This sets the TDEAboutData returned by aboutData() * @since 3.3 |