File indexing completed on 2025-02-23 04:34:16

0001 /**
0002  * \file contexthelp.h
0003  * Context sensitive help.
0004  *
0005  * \b Project: Kid3
0006  * \author Urs Fleisch
0007  * \date 09 Jul 2011
0008  *
0009  * Copyright (C) 2011-2018  Urs Fleisch
0010  *
0011  * This file is part of Kid3.
0012  *
0013  * Kid3 is free software; you can redistribute it and/or modify
0014  * it under the terms of the GNU General Public License as published by
0015  * the Free Software Foundation; either version 2 of the License, or
0016  * (at your option) any later version.
0017  *
0018  * Kid3 is distributed in the hope that it will be useful,
0019  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0020  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0021  * GNU General Public License for more details.
0022  *
0023  * You should have received a copy of the GNU General Public License
0024  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
0025  */
0026 
0027 #pragma once
0028 
0029 #include <QString>
0030 #include "kid3api.h"
0031 
0032 class IPlatformTools;
0033 
0034 /**
0035  * Context sensitive help.
0036  */
0037 class KID3_GUI_EXPORT ContextHelp {
0038 public:
0039   /**
0040    * Initialize context help.
0041    *
0042    * @param platformTools platform tools to use
0043    */
0044   static void init(IPlatformTools* platformTools);
0045 
0046   /**
0047    * Display help for a topic.
0048    *
0049    * @param anchor anchor in help document
0050    */
0051   static void displayHelp(const QString& anchor = QString());
0052 
0053 private:
0054   static IPlatformTools* s_platformTools;
0055 };