llviewerhelp.h
上传用户:king477883
上传日期:2021-03-01
资源大小:9553k
文件大小:2k
源码类别:

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file llviewerhelp.h
  3.  * @brief Utility functions for the Help system
  4.  * @author Tofu Linden
  5.  *
  6.  * $LicenseInfo:firstyear=2009&license=viewergpl$
  7.  * 
  8.  * Copyright (c) 2009-2010, Linden Research, Inc.
  9.  * 
  10.  * Second Life Viewer Source Code
  11.  * The source code in this file ("Source Code") is provided by Linden Lab
  12.  * to you under the terms of the GNU General Public License, version 2.0
  13.  * ("GPL"), unless you have obtained a separate licensing agreement
  14.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  15.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  16.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  17.  * 
  18.  * There are special exceptions to the terms and conditions of the GPL as
  19.  * it is applied to this Source Code. View the full text of the exception
  20.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  21.  * online at
  22.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  23.  * 
  24.  * By copying, modifying or distributing this software, you acknowledge
  25.  * that you have read and understood your obligations described above,
  26.  * and agree to abide by those obligations.
  27.  * 
  28.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  29.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  30.  * COMPLETENESS OR PERFORMANCE.
  31.  * $/LicenseInfo$
  32.  */
  33. #ifndef LL_LLVIEWERHELP_H
  34. #define LL_LLVIEWERHELP_H
  35. // The Help UI lives in llfloaterhelpbrowser, llviewerhelp provides a
  36. // layer of abstraction that protects help-system-using code from the details of
  37. // the Help UI floater and how help topics are converted into URLs.
  38. #include "llhelp.h" // our abstract base
  39. #include "llsingleton.h"
  40. class LLUICtrl;
  41. class LLViewerHelp : public LLHelp, public LLSingleton<LLViewerHelp>
  42. {
  43. friend class LLSingleton<LLViewerHelp>;
  44.  public:
  45. /// display the specified help topic in the help viewer
  46. /*virtual*/ void showTopic(const std::string &topic);
  47. // return topic derived from viewer UI focus, else default topic
  48. std::string getTopicFromFocus();
  49. /// return default (fallback) topic name suitable for showTopic()
  50. /*virtual*/ std::string defaultTopic();
  51. // return topic to use before the user logs in
  52. /*virtual*/ std::string preLoginTopic();
  53. // return topic to use for the top-level help, invoked by F1
  54. /*virtual*/ std::string f1HelpTopic();
  55.  private:
  56. static void showHelp(); // make sure help UI is visible & raised
  57. static void setRawURL(std::string url); // send URL to help UI
  58. };
  59. #endif // header guard