src/gromacs/onlinehelp/helpmanager.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \libinternal \file
  32  * \brief
  33  * Declares gmx::HelpManager.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \inlibraryapi
  37  * \ingroup module_onlinehelp
  38  */
  39 #ifndef GMX_ONLINEHELP_HELPMANAGER_H
  40 #define GMX_ONLINEHELP_HELPMANAGER_H
  41
  42 #include "../utility/common.h"
  43
  44 namespace gmx
  45 {
  46
  47 class File;
  48 class HelpTopicInterface;
  49
  50 /*! \libinternal \brief
  51  * Helper for providing interactive online help.
  52  *
  53  * \inlibraryapi
  54  * \ingroup module_onlinehelp
  55  */
  56 class HelpManager
  57 {
  58     public:
  59         /*! \brief
  60          * Creates a manager that uses a given root topic.
  61          *
  62          * \param[in] rootTopic  Help topic that can be accessed through this
  63          *      manager.
  64          * \throws    std::bad_alloc if out of memory.
  65          *
  66          * The provided topic must remain valid for the lifetime of this
  67          * manager object.
  68          */
  69         explicit HelpManager(const HelpTopicInterface &rootTopic);
  70         ~HelpManager();
  71
  72         /*! \brief
  73          * Enters a subtopic with the given name under the active topic.
  74          *
  75          * \param[in] name  Subtopic name to enter.
  76          * \throws    std::bad_allod if out of memory.
  77          * \throws    InvalidInputError if topic with \p name is not found.
  78          */
  79         void enterTopic(const char *name);
  80
  81         /*! \brief
  82          * Writes out the help for the currently active topic.
  83          *
  84          * \param   file  File to write the help text to.
  85          * \throws  std::bad_alloc if out of memory.
  86          * \throws  FileIOError on any I/O error.
  87          */
  88         void writeCurrentTopic(File *file) const;
  89
  90     private:
  91         class Impl;
  92
  93         PrivateImplPointer<Impl> impl_;
  94 };
  95
  96 } // namespace gmx
  97
  98 #endif