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 <string>
  43
  44 #include "../utility/common.h"
  45
  46 namespace gmx
  47 {
  48
  49 class HelpTopicInterface;
  50 class HelpWriterContext;
  51
  52 /*! \libinternal \brief
  53  * Helper for providing interactive online help.
  54  *
  55  * \inlibraryapi
  56  * \ingroup module_onlinehelp
  57  */
  58 class HelpManager
  59 {
  60     public:
  61         /*! \brief
  62          * Creates a manager that uses a given root topic.
  63          *
  64          * \param[in] rootTopic  Help topic that can be accessed through this
  65          *      manager.
  66          * \param[in] context    Context object for writing the help.
  67          * \throws    std::bad_alloc if out of memory.
  68          *
  69          * The provided topic and context objects must remain valid for the
  70          * lifetime of this manager object.
  71          */
  72         HelpManager(const HelpTopicInterface &rootTopic,
  73                     const HelpWriterContext &context);
  74         ~HelpManager();
  75
  76         /*! \brief
  77          * Enters a subtopic with the given name under the active topic.
  78          *
  79          * \param[in] name  Subtopic name to enter.
  80          * \throws    std::bad_allod if out of memory.
  81          * \throws    InvalidInputError if topic with \p name is not found.
  82          */
  83         void enterTopic(const char *name);
  84         //! \copydoc enterTopic(const char *)
  85         void enterTopic(const std::string &name);
  86
  87         /*! \brief
  88          * Writes out the help for the currently active topic.
  89          *
  90          * \throws  std::bad_alloc if out of memory.
  91          * \throws  FileIOError on any I/O error.
  92          */
  93         void writeCurrentTopic() const;
  94
  95     private:
  96         class Impl;
  97
  98         PrivateImplPointer<Impl> impl_;
  99 };
 100
 101 } // namespace gmx
 102
 103 #endif