WhatsThisGenerator.cc 2.79 KB
Newer Older
1 2
#include "WhatsThisGenerator.hh"

3 4 5
/** Constructor for the whatsThisGenerator initializing the plugin name.
 *
 * @param _plugin_name the name of the plugin which is used \note use only the name and NOT the prefix Plugin- (e.g. SkeletonEditing for Plugin-SkeletonEditing)
6
 */
7
WhatsThisGenerator::WhatsThisGenerator(const QString &_plugin_name) :
Matthias Möller's avatar
Matthias Möller committed
8
plugin_name_(_plugin_name)
9 10 11 12
{
}


13
/**	\brief generates a clickable link to the documentation for whatsThis Messages
14
 * @param _ref gives the section in the documentation for the action. The help-browser will jump into the section.
15 16
 *                      An example: _jump = "Cube" in PrimitiveGenerator refs to the section "Cube" in the Documentation and the help Browser.
 *                      \note use the doxygen reference name (always one word), not the section name
17 18
 *
 * @param _site gives the documentation site (html-site) which you want to open.
Matthias Möller's avatar
Matthias Möller committed
19 20
 *                      Default is the site "index.html".
 *                      You need this parameter if you have more than one site in your plugin documentation and want to refer on one of this.
21
 */
22
QString WhatsThisGenerator::generateLink(const QString &_ref /*= ""*/, const QString &_site /*= "index.html"*/) const
23
{
Matthias Möller's avatar
Matthias Möller committed
24 25 26 27 28
  const QString baseHelpURL = QString(" <a href='qthelp://org.openflipper.plugin-")
                                         + plugin_name_.toLower()
                                         + QString("/Plugin-")
                                         + plugin_name_+QString("/")
                                         + _site+QString("#")+_ref + QString("'>");
29

Matthias Möller's avatar
Matthias Möller committed
30 31
  const QString clickText = QString(QObject::tr("Click for more information"))+QObject::tr("</a>");
  return (baseHelpURL + clickText);
32 33
}

34
/**	\brief sets a whatsThis Message plus link to the doc for the given QAction
35 36 37 38
 * @param _action action where the message should appear.
 * @param _msg help message for the user. This is the default Whatsthis Text which you set with QAction::setWhatsThis
 *
 * @param _ref gives the section in the documentation for the action. The help-browser will jump into the section.
39 40
 *                      An example: _jump = "Cube" in PrimitiveGenerator refs to the section "Cube" in the Documentation and the help Browser.
 *                      \note use the doxygen reference name (always one word), not the section name
41 42
 *
 * @param _site gives the documentation site (html-site) which you want to open.
Matthias Möller's avatar
Matthias Möller committed
43 44
 * 	                    Default is the site "index.html".
 * 	                    You need this parameter if you have more than one site in your plugin documentation and want to refer on one of this.
45 46 47
 */
void WhatsThisGenerator::setWhatsThis(QAction* _action, const QString &_msg, const QString &_ref /*= ""*/,const QString &_site /*= "index.html"*/) const
{
48
  _action->setWhatsThis(_msg + generateLink(_ref, _site));
49
}