WhatsThisGenerator.cc 6.48 KB
Newer Older
Jan Möbius's avatar
Jan Möbius committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
*                                                                            *
\*===========================================================================*/

/*===========================================================================*\
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
\*===========================================================================*/

Matthias Möller's avatar
Matthias Möller committed
50 51
#include "WhatsThisGenerator.hh"

52 53
/** Constructor for the whatsThisGenerator initializing the plugin name.
 *
54 55
 * @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).
 *  If you want to reference in the core user plugin, then _plugin = "user"
Matthias Möller's avatar
Matthias Möller committed
56
 */
57
WhatsThisGenerator::WhatsThisGenerator(const QString &_plugin_name) :
58
plugin_name_((_plugin_name != "user") ? QString("Plugin-")+_plugin_name : _plugin_name)
Matthias Möller's avatar
Matthias Möller committed
59 60 61 62
{
}


63
/**	\brief generates a clickable link to the documentation for whatsThis Messages
Matthias Möller's avatar
Matthias Möller committed
64
 * @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
65 66
 *                      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
Matthias Möller's avatar
Matthias Möller committed
67 68
 *
 * @param _site gives the documentation site (html-site) which you want to open.
Matthias Möller's avatar
Matthias Möller committed
69 70
 *                      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
71
 */
72
QString WhatsThisGenerator::generateLink(const QString &_ref /*= ""*/, const QString &_site /*= "index.html"*/) const
Matthias Möller's avatar
Matthias Möller committed
73
{
74
  const QString baseHelpURL = QString(" <a href='qthelp://org.openflipper.")
Matthias Möller's avatar
Matthias Möller committed
75
                                         + plugin_name_.toLower()
76
                                         + QString("/")
Matthias Möller's avatar
Matthias Möller committed
77 78
                                         + plugin_name_+QString("/")
                                         + _site+QString("#")+_ref + QString("'>");
Matthias Möller's avatar
Matthias Möller committed
79

Matthias Möller's avatar
Matthias Möller committed
80 81
  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
82 83
}

84
/**	\brief sets a whatsThis Message plus link to the doc for the given QAction
Matthias Möller's avatar
Matthias Möller committed
85 86 87 88
 * @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
89 90
 *                      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
Matthias Möller's avatar
Matthias Möller committed
91 92
 *
 * @param _site gives the documentation site (html-site) which you want to open.
Matthias Möller's avatar
Matthias Möller committed
93 94
 * 	                    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
95 96 97
 */
void WhatsThisGenerator::setWhatsThis(QAction* _action, const QString &_msg, const QString &_ref /*= ""*/,const QString &_site /*= "index.html"*/) const
{
98
  _action->setWhatsThis(_msg + generateLink(_ref, _site));
Matthias Möller's avatar
Matthias Möller committed
99
}