1 /************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org 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 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27 #ifndef INCLUDED_SVTOOLS_HELPOPT_HXX 28 #define INCLUDED_SVTOOLS_HELPOPT_HXX 29 30 #include "svtools/svtdllapi.h" 31 32 #ifndef INCLUDED_LIST 33 #include <list> 34 #define INCLUDED_LIST 35 #endif 36 #include <tools/string.hxx> 37 #include <unotools/options.hxx> 38 39 typedef std::list< sal_Int32 > IdList; 40 41 class SvtHelpOptions_Impl; 42 43 class SVT_DLLPUBLIC SvtHelpOptions: public utl::detail::Options 44 { 45 SvtHelpOptions_Impl* pImp; 46 47 public: 48 SvtHelpOptions(); 49 virtual ~SvtHelpOptions(); 50 51 void SetExtendedHelp( sal_Bool b ); 52 sal_Bool IsExtendedHelp() const; 53 void SetHelpTips( sal_Bool b ); 54 sal_Bool IsHelpTips() const; 55 56 void SetHelpAgentAutoStartMode( sal_Bool b ); 57 sal_Bool IsHelpAgentAutoStartMode() const; 58 void SetHelpAgentTimeoutPeriod( sal_Int32 _nSeconds ); 59 sal_Int32 GetHelpAgentTimeoutPeriod( ) const; 60 void SetHelpAgentRetryLimit( sal_Int32 _nTrials ); 61 sal_Int32 GetHelpAgentRetryLimit( ) const; 62 63 const String& GetHelpStyleSheet()const; 64 void SetHelpStyleSheet(const String& rStyleSheet); 65 66 /** retrieves the help agent's ignore counter for the given URL. 67 <p> If the counter returned 0, the agent should silently drop any requests for this URL.<br/> 68 If the counter is greater 0, the agent should display the URL and, if the user ignores it, 69 decrement the counter by 1. 70 </p> 71 */ 72 sal_Int32 getAgentIgnoreURLCounter( const ::rtl::OUString& _rURL ); 73 /** decrements the help agent's ignore counter for the given URL 74 @see getAgentIgnoreURLCounter 75 */ 76 void decAgentIgnoreURLCounter( const ::rtl::OUString& _rURL ); 77 /** resets the help agent's ignore counter for the given URL 78 */ 79 void resetAgentIgnoreURLCounter( const ::rtl::OUString& _rURL ); 80 /** resets the help agent's ignore counter for all URL's 81 */ 82 void resetAgentIgnoreURLCounter(); 83 84 void SetWelcomeScreen( sal_Bool b ); 85 sal_Bool IsWelcomeScreen() const; 86 87 IdList* GetPIStarterList(); 88 void AddToPIStarterList( sal_Int32 nId ); 89 void RemoveFromPIStarterList( sal_Int32 nId ); 90 91 String GetLocale() const; 92 String GetSystem() const; 93 }; 94 95 #endif 96 97