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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
/*************************************************************************
*
* $RCSfile: regoptions.hxx,v $
*
* $Revision: 1.1 $
*
* last change: $Author: fs $ $Date: 2001-12-20 13:06:15 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc..
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef SVTOOLS_REGOPTIONS_HXX
#define SVTOOLS_REGOPTIONS_HXX
#ifndef _STRING_HXX
#include <tools/string.hxx>
#endif
//........................................................................
namespace svt
{
//........................................................................
//====================================================================
//= RegOptions
//====================================================================
class RegOptionsImpl;
/** encapsulates access to the configuration settings for registering the product
*/
class RegOptions
{
private:
RegOptionsImpl* m_pImpl;
// the impl class is constructed upon need only (as this is expensive)
void ensureImpl( );
public:
RegOptions( );
~RegOptions( );
// retrieves the URL which should be used for online registration
String getRegistrationURL( ) const;
// checks if the menu item which can be used to trigger the online registration should be available
sal_Bool allowMenu( ) const;
enum DialogPermission
{ // the registration dialog shall be executed ....
dpDisabled, // ... never - it has been disabled
dpNotThisSession, // ... later - no statement when, but _not now_
dpRemindLater, // ... later at a reminder date
dpThisSession // ... during this session
};
/** checks if the registration dialog is allowed
<p>A return value of <TRUE/> does not mean that during this session, the dialog is allowed to
be executed. It simply means executing it is allowed <em>in general</em></p>
*/
DialogPermission getDialogPermission( ) const;
/** claims that the current session is done with respect to the registration dialog.
<p>This is not to be called if <method>getDialogPermission</method> returned dpDisabled previously<p>
<p>The behaviour changes as follows:
<ul>
<li>any subsequent calls to <method>getDialogPermission</method> will return dpNotThisSession, given
that it previously returned dpNotThisSession</li>
<li>any subsequent calls to <method>getDialogPermission</method> will return dpDisabled, given
that it previously returned dpThisSession</li>
<li>an internal (persistent) session counter is updated, so that during the next session,
<method>getDialogPermission</method> <em>may</em> return dpThisSession</li>
</ul></p>
*/
void markSessionDone( );
/** activates the reminder
<p>If this method is called, the reminder for the dialog will be activated. This meas that during the
next <arg>_nDaysFromNow</arg>-1 days, <method>getDialogPermission</method> will return dpRemindLater</p>,
at the <arg>_nDaysFromNow</arg>th day from today onwards it will return dpThisSession.</p>
<p>It is not allowed to call this method if the dialog is currently disabled.</p>
<p>If the current session has not been marked as done already (i.e., <method>markSessionDone</method> has
not been called, yet), this is done implicitly when you call <method>activateReminder</method>.</p>
*/
void activateReminder( sal_Int32 _nDaysFromNow );
};
//........................................................................
} // namespace svt
//........................................................................
#endif // SVTOOLS_REGOPTIONS_HXX
/*************************************************************************
* history:
* $Log: not supported by cvs2svn $
*
* Revision 1.0 19.12.01 13:41:17 fs
************************************************************************/
|
