WhatsThisGenerator.cc 2.59 KB
Newer Older
Matthias Möller's avatar
Matthias Möller committed
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)
Matthias Möller's avatar
Matthias Möller committed
6
 */
7
WhatsThisGenerator::WhatsThisGenerator(const QString &_plugin_name) :
Matthias Möller's avatar
Matthias Möller committed
8
plugin_name_(_plugin_name)
Matthias Möller's avatar
Matthias Möller committed
9 10 11 12
{
}


13
/**	\brief generates a clickable link to the documentation for whatsThis Messages
Matthias Möller's avatar
Matthias Möller committed
14
 * @param _ref gives the section in the documentation for the action. The help-browser will jump into the section.
Matthias Möller's avatar
Matthias Möller committed
15
 *                      An example: _jump = "cube" in PrimitiveGenerator refs to the section "cube" in the Documentation and the help Browser.
Matthias Möller's avatar
Matthias Möller committed
16 17
 *
 * @param _site gives the documentation site (html-site) which you want to open.
Matthias Möller's avatar
Matthias Möller committed
18 19
 *                      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.
Matthias Möller's avatar
Matthias Möller committed
20
 */
21
QString WhatsThisGenerator::generateLink(const QString &_ref /*= ""*/, const QString &_site /*= "index.html"*/) const
Matthias Möller's avatar
Matthias Möller committed
22
{
Matthias Möller's avatar
Matthias Möller committed
23 24 25 26 27
  const QString baseHelpURL = QString(" <a href='qthelp://org.openflipper.plugin-")
                                         + plugin_name_.toLower()
                                         + QString("/Plugin-")
                                         + plugin_name_+QString("/")
                                         + _site+QString("#")+_ref + QString("'>");
Matthias Möller's avatar
Matthias Möller committed
28

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

33
/**	\brief sets a whatsThis Message plus link to the doc for the given QAction
Matthias Möller's avatar
Matthias Möller committed
34 35 36 37
 * @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.
Matthias Möller's avatar
Matthias Möller committed
38
 * 	                    An example: _jump = "cube" in PrimitiveGenerator refs to the section "cube" in the Documentation and the help Browser.
Matthias Möller's avatar
Matthias Möller committed
39 40
 *
 * @param _site gives the documentation site (html-site) which you want to open.
Matthias Möller's avatar
Matthias Möller committed
41 42
 * 	                    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.
Matthias Möller's avatar
Matthias Möller committed
43 44 45
 */
void WhatsThisGenerator::setWhatsThis(QAction* _action, const QString &_msg, const QString &_ref /*= ""*/,const QString &_site /*= "index.html"*/) const
{
46
  _action->setWhatsThis(_msg + generateLink(_ref, _site));
Matthias Möller's avatar
Matthias Möller committed
47
}