PageRenderTime 44ms CodeModel.GetById 36ms app.highlight 4ms RepoModel.GetById 1ms app.codeStats 0ms

/indra/llui/llhelp.h

https://bitbucket.org/lindenlab/viewer-beta/
C++ Header | 44 lines | 12 code | 3 blank | 29 comment | 0 complexity | 4dc3deaef7ff540b35865c21ef5fea28 MD5 | raw file
 1/** 
 2 * @file llhelp.h
 3 * @brief Abstract interface to the Help system
 4 * @author Tofu Linden
 5 *
 6 * $LicenseInfo:firstyear=2009&license=viewerlgpl$
 7 * Second Life Viewer Source Code
 8 * Copyright (C) 2010, Linden Research, Inc.
 9 * 
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation;
13 * version 2.1 of the License only.
14 * 
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18 * Lesser General Public License for more details.
19 * 
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with this library; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
23 * 
24 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
25 * $/LicenseInfo$
26 */
27
28#ifndef LL_LLHELP_H
29#define LL_LLHELP_H
30
31class LLHelp
32{
33 public:
34	virtual void showTopic(const std::string &topic) = 0;
35	virtual std::string getURL(const std::string &topic) = 0;
36	// return default (fallback) topic name suitable for showTopic()
37	virtual std::string defaultTopic() = 0;
38	// return topic to use before the user logs in
39	virtual std::string preLoginTopic() = 0;
40	// return topic to use for the top-level help, invoked by F1
41	virtual std::string f1HelpTopic() = 0;
42};
43
44#endif // headerguard