NCBI C++ ToolKit
help_service.hpp
Go to the documentation of this file.

Go to the SVN repository for this file.

1 #ifndef GUI_FRAMEWORK___HELP_SERVICE__HPP
2 #define GUI_FRAMEWORK___HELP_SERVICE__HPP
3 
4 /* $Id: help_service.hpp 18397 2008-11-28 19:45:17Z dicuccio $
5  * ===========================================================================
6  *
7  * PUBLIC DOMAIN NOTICE
8  * National Center for Biotechnology Information
9  *
10  * This software/database is a "United States Government Work" under the
11  * terms of the United States Copyright Act. It was written as part of
12  * the author's official duties as a United States Government employee and
13  * thus cannot be copyrighted. This software/database is freely available
14  * to the public for use. The National Library of Medicine and the U.S.
15  * Government have not placed any restriction on its use or reproduction.
16  *
17  * Although all reasonable efforts have been taken to ensure the accuracy
18  * and reliability of the software and data, the NLM and the U.S.
19  * Government do not and cannot warrant the performance or results that
20  * may be obtained by using this software or data. The NLM and the U.S.
21  * Government disclaim all warranties, express or implied, including
22  * warranties of performance, merchantability or fitness for any particular
23  * purpose.
24  *
25  * Please cite the author in any work or product based on this material.
26  *
27  * ===========================================================================
28  *
29  * Authors: Andrey Yazhuk
30  *
31  * File Description:
32  *
33  */
34 
35 /** @addtogroup GUI_FRAMEWORK
36 *
37 * @{
38 */
39 
40 #include <corelib/ncbistd.hpp>
41 
42 
44 
45 ///////////////////////////////////////////////////////////////////////////////
46 /// IHelpService
47 /// TODO - this is just a placeholder, the interface needs to be extended
48 /// - functions for registering additional help resources
49 /// - saving / loading settings
51 {
52 public:
53  virtual void ShowHelpIndex() = 0;
54  virtual void ShowHelpSearch(const string& text) = 0;
55  virtual void ShowContextHelp(const string& context_id) = 0;
56 
57  virtual ~IHelpService() {}
58 };
59 
61 
62 /* @} */
63 
64 #endif // GUI_FRAMEWORK___HELP_SERVICE__HPP
65 
IHelpService TODO - this is just a placeholder, the interface needs to be extended.
Include a standard set of the NCBI C++ Toolkit most basic headers.
virtual void ShowContextHelp(const string &context_id)=0
virtual void ShowHelpIndex()=0
virtual void ShowHelpSearch(const string &text)=0
virtual ~IHelpService()
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
static void text(MDB_val *v)
Definition: mdb_dump.c:62
Modified on Fri May 24 14:58:11 2024 by modify_doxy.py rev. 669887