Add new handbookSection() method to the TDECModule class

This relates to Bug 1850
pull/16/head
Timothy Pearson 10 years ago
parent cc5fd88be3
commit 319f69a280

@ -208,6 +208,10 @@ TQString TDECModule::quickHelp() const
return d->_quickHelp;
}
TQString TDECModule::handbookSection() const
{
return TQString::null;
}
const TQPtrList<TDEConfigDialogManager>& TDECModule::configs() const
{

@ -177,6 +177,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

Loading…
Cancel
Save