1 /************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23 #ifndef INCLUDED_SVTOOLS_HELPOPT_HXX 24 #define INCLUDED_SVTOOLS_HELPOPT_HXX 25 26 #include "svtools/svtdllapi.h" 27 28 #ifndef INCLUDED_LIST 29 #include <list> 30 #define INCLUDED_LIST 31 #endif 32 #include <tools/string.hxx> 33 #include <unotools/options.hxx> 34 35 typedef std::list< sal_Int32 > IdList; 36 37 class SvtHelpOptions_Impl; 38 39 class SVT_DLLPUBLIC SvtHelpOptions: public utl::detail::Options 40 { 41 SvtHelpOptions_Impl* pImp; 42 43 public: 44 SvtHelpOptions(); 45 virtual ~SvtHelpOptions(); 46 47 void SetExtendedHelp( sal_Bool b ); 48 sal_Bool IsExtendedHelp() const; 49 void SetHelpTips( sal_Bool b ); 50 sal_Bool IsHelpTips() const; 51 52 void SetHelpAgentAutoStartMode( sal_Bool b ); 53 sal_Bool IsHelpAgentAutoStartMode() const; 54 void SetHelpAgentTimeoutPeriod( sal_Int32 _nSeconds ); 55 sal_Int32 GetHelpAgentTimeoutPeriod( ) const; 56 void SetHelpAgentRetryLimit( sal_Int32 _nTrials ); 57 sal_Int32 GetHelpAgentRetryLimit( ) const; 58 59 const String& GetHelpStyleSheet()const; 60 void SetHelpStyleSheet(const String& rStyleSheet); 61 62 /** retrieves the help agent's ignore counter for the given URL. 63 <p> If the counter returned 0, the agent should silently drop any requests for this URL.<br/> 64 If the counter is greater 0, the agent should display the URL and, if the user ignores it, 65 decrement the counter by 1. 66 </p> 67 */ 68 sal_Int32 getAgentIgnoreURLCounter( const ::rtl::OUString& _rURL ); 69 /** decrements the help agent's ignore counter for the given URL 70 @see getAgentIgnoreURLCounter 71 */ 72 void decAgentIgnoreURLCounter( const ::rtl::OUString& _rURL ); 73 /** resets the help agent's ignore counter for the given URL 74 */ 75 void resetAgentIgnoreURLCounter( const ::rtl::OUString& _rURL ); 76 /** resets the help agent's ignore counter for all URL's 77 */ 78 void resetAgentIgnoreURLCounter(); 79 80 void SetWelcomeScreen( sal_Bool b ); 81 sal_Bool IsWelcomeScreen() const; 82 83 IdList* GetPIStarterList(); 84 void AddToPIStarterList( sal_Int32 nId ); 85 void RemoveFromPIStarterList( sal_Int32 nId ); 86 87 String GetLocale() const; 88 String GetSystem() const; 89 }; 90 91 #endif 92 93