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
|
/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: defaultprovider.hxx,v $
*
* $Revision: 1.6 $
*
* last change: $Author: rt $ $Date: 2005-09-08 03:47:05 $
*
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1.
*
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2005 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
*
************************************************************************/
#ifndef CONFIGMGR_DEFAULTPROVIDER_HXX
#define CONFIGMGR_DEFAULTPROVIDER_HXX
#ifndef _CONFIGMGR_TREE_VALUENODE_HXX
#include "valuenode.hxx"
#endif
#ifndef CONFIGMGR_UTILITY_HXX_
#include "utility.hxx"
#endif
#ifndef _COM_SUN_STAR_UNO_EXCEPTION_HPP_
#include <com/sun/star/uno/Exception.hpp>
#endif
#ifndef _COM_SUN_STAR_UNO_RUNTIMEEXCEPTION_HPP_
#include <com/sun/star/uno/RuntimeException.hpp>
#endif
#ifndef INCLUDED_MEMORY
#include <memory>
#define INCLUDED_MEMORY
#endif
namespace configmgr
{
namespace uno = com::sun::star::uno;
using ::rtl::OUString;
////////////////////////////////////////////////////////////////////////////////
namespace configuration
{
class AbsolutePath;
}
//-------------------------
namespace memory
{
class Segment;
}
//-------------------------
class ISubtree;
class RequestOptions;
//==========================================================================
//= IDefaultProvider
//==========================================================================
/* is an interface that can be implemented by an <type>ITreeProvider</type>
or <type>ITreeManager</type>.
<p>Supports functionality to fetch only the default data corresponding to a tree</p>
*/
class SAL_NO_VTABLE IDefaultProvider
{
public:
/** load the default version of the tree named by a path
using certain options and requiring a specific loading depth
@returns
the default data tree, yielding ownership of it
<NULL/>if no default data is available for the tree
*/
virtual std::auto_ptr<ISubtree> requestDefaultData( configuration::AbsolutePath const& aSubtreePath,
const RequestOptions& _aOptions
) CFG_UNO_THROW_ALL( ) = 0;
};
//==========================================================================
/// a refcounted <type>IDefaultProvider</type>.
class SAL_NO_VTABLE IConfigDefaultProvider : public Refcounted
, public IDefaultProvider
{
};
//==========================================================================
//= IDefaultableTreeManager
//==========================================================================
/* is a supplementary interface for a <type>ITreeManager</type>.
<p>Supports functionality to load default data into the managed tree</p>
*/
class SAL_NO_VTABLE IDefaultableTreeManager
{
public:
/// get a data segment to host the given location - also available in ITreeManager
virtual memory::Segment* getDataSegment(configuration::AbsolutePath const& _rAccessor,
const RequestOptions& _aOptions) = 0;
/** attempt to load default data into the tree named by a path using certain options
and requiring a specific loading depth.
@returns
<TRUE/>, if some default data is available within the tree
<FALSE/>, if no default data is available for the tree
*/
virtual sal_Bool fetchDefaultData( memory::UpdateAccessor& _aAccessToken,
configuration::AbsolutePath const& aSubtreePath,
const RequestOptions& _xOptions
) CFG_UNO_THROW_ALL( ) = 0;
};
////////////////////////////////////////////////////////////////////////////////
} // namespace configmgr
#endif
|
