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

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file llviewerhelp.cpp
  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. #include "llviewerprecompiledheaders.h"
  34. #include "llcommandhandler.h"
  35. #include "llfloaterhelpbrowser.h"
  36. #include "llfloaterreg.h"
  37. #include "llfocusmgr.h"
  38. #include "llviewercontrol.h"
  39. #include "llappviewer.h"
  40. #include "lllogininstance.h"
  41. #include "llviewerhelputil.h"
  42. #include "llviewerhelp.h"
  43. // support for secondlife:///app/help/{TOPIC} SLapps
  44. class LLHelpHandler : public LLCommandHandler
  45. {
  46. public:
  47. // requests will be throttled from a non-trusted browser
  48. LLHelpHandler() : LLCommandHandler("help", UNTRUSTED_THROTTLE) {}
  49. bool handle(const LLSD& params, const LLSD& query_map, LLMediaCtrl* web)
  50. {
  51. LLViewerHelp* vhelp = LLViewerHelp::getInstance();
  52. if (! vhelp)
  53. {
  54. return false;
  55. }
  56. // get the requested help topic name, or use the fallback if none
  57. std::string help_topic = vhelp->defaultTopic();
  58. if (params.size() >= 1)
  59. {
  60. help_topic = params[0].asString();
  61. }
  62. vhelp->showTopic(help_topic);
  63. return true;
  64. }
  65. };
  66. LLHelpHandler gHelpHandler;
  67. //////////////////////////////
  68. // implement LLHelp interface
  69. void LLViewerHelp::showTopic(const std::string &topic)
  70. {
  71. // allow overriding the help server with a local help file
  72. if( gSavedSettings.getBOOL("HelpUseLocal") )
  73. {
  74. showHelp();
  75. LLFloaterHelpBrowser* helpbrowser = dynamic_cast<LLFloaterHelpBrowser*>(LLFloaterReg::getInstance("help_browser"));
  76. helpbrowser->navigateToLocalPage( "help-offline" , "index.html" );
  77. return;
  78. }
  79. // if the help topic is empty, use the default topic
  80. std::string help_topic = topic;
  81. if (help_topic.empty())
  82. {
  83. help_topic = defaultTopic();
  84. }
  85. // f1 help topic means: if the user is not logged in yet, show
  86. // the pre-login topic instead of the default fallback topic,
  87. // otherwise show help for the focused item
  88. if (help_topic == f1HelpTopic())
  89. {
  90. help_topic = getTopicFromFocus();
  91. if (help_topic == defaultTopic() && ! LLLoginInstance::getInstance()->authSuccess())
  92. {
  93. help_topic = preLoginTopic();
  94. }
  95. }
  96. // work out the URL for this topic and display it 
  97. showHelp();
  98. std::string helpURL = LLViewerHelpUtil::buildHelpURL( help_topic );
  99. setRawURL( helpURL );
  100. }
  101. std::string LLViewerHelp::defaultTopic()
  102. {
  103. // *hack: to be done properly
  104. return "this_is_fallbacktopic";
  105. }
  106. std::string LLViewerHelp::preLoginTopic()
  107. {
  108. // *hack: to be done properly
  109. return "pre_login_help";
  110. }
  111. std::string LLViewerHelp::f1HelpTopic()
  112. {
  113. // *hack: to be done properly
  114. return "f1_help";
  115. }
  116. //////////////////////////////
  117. // our own interfaces
  118. std::string LLViewerHelp::getTopicFromFocus()
  119. {
  120. // use UI element with viewer's keyboard focus as basis for searching
  121. LLUICtrl* focused = dynamic_cast<LLUICtrl*>(gFocusMgr.getKeyboardFocus());
  122. if (focused)
  123. {
  124. std::string topic;
  125. if (focused->findHelpTopic(topic))
  126. {
  127. return topic;
  128. }
  129. }
  130. // didn't find a help topic in the UI hierarchy for focused
  131. // element, return the fallback topic name instead.
  132. return defaultTopic();
  133. }
  134. // static 
  135. void LLViewerHelp::showHelp()
  136. {
  137. LLFloaterHelpBrowser* helpbrowser = dynamic_cast<LLFloaterHelpBrowser*>(LLFloaterReg::getInstance("help_browser"));
  138. if (helpbrowser)
  139. {
  140. BOOL visible = TRUE;
  141. BOOL take_focus = TRUE;
  142. helpbrowser->setVisible(visible);
  143. helpbrowser->setFrontmost(take_focus);
  144. }
  145. else
  146. {
  147. llwarns << "Eep, help_browser floater not found" << llendl;
  148. }
  149. }
  150. // static
  151. void LLViewerHelp::setRawURL(std::string url)
  152. {
  153. LLFloaterHelpBrowser* helpbrowser = dynamic_cast<LLFloaterHelpBrowser*>(LLFloaterReg::getInstance("help_browser"));
  154. if (helpbrowser)
  155. {
  156. helpbrowser->openMedia(url);
  157. }
  158. else
  159. {
  160. llwarns << "Eep, help_browser floater not found" << llendl;
  161. }
  162. }