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