blob: 7218414bf4134182cca54f93c11f20c71ed65bb8 (
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
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
|
/* -*- 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 __com_sun_star_registry_XSimpleRegistry_idl__
#define __com_sun_star_registry_XSimpleRegistry_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/registry/InvalidRegistryException.idl>
#include <com/sun/star/registry/XRegistryKey.idl>
#include <com/sun/star/registry/MergeConflictException.idl>
//=============================================================================
module com { module sun { module star { module registry {
//=============================================================================
/** allows access to a registry (a persistent data source).
The data is stored in a hierarchical key structure beginning with a root key.
Each key can store a value and can have multiple subkeys.
@see XRegistryKey
*/
published interface XSimpleRegistry: com::sun::star::uno::XInterface
{
//---------------------------------------------------------------------
/** returns the URL of the current data source of the registry.
*/
string getURL();
//-------------------------------------------------------------------------
/** connects the registry to a persistent data source represented by
an URL.
<p>If a local registry is already open, this function
will close the currently open registry.
@param aURL
specifies the complete URL to access the data source.
@param bReadOnly
specifies if the data source should be opened for
read only.
@param bCreate
specifies if the data source should be created if it
does not already exist.
@throws InvalidRegistryException
if the registry does not exist.
*/
void open( [in] string rURL,
[in] boolean bReadOnly,
[in] boolean bCreate )
raises( com::sun::star::registry::InvalidRegistryException );
//-------------------------------------------------------------------------
/** checks if the registry points to a valid data-source.
*/
boolean isValid();
//-------------------------------------------------------------------------
/** disconnects the registry from the data-source.
@throws InvalidRegistryException
if the registry is not open.
*/
void close()
raises( com::sun::star::registry::InvalidRegistryException );
//-------------------------------------------------------------------------
/** destroys the registry and the data source.
@throws InvalidRegistryException
if the registry is not open.
*/
void destroy()
raises( com::sun::star::registry::InvalidRegistryException );
//-------------------------------------------------------------------------
/** @returns
the root key of the registry.
@throws InvalidRegistryException
if no registry is open
*/
com::sun::star::registry::XRegistryKey getRootKey()
raises( com::sun::star::registry::InvalidRegistryException );
//-------------------------------------------------------------------------
/** checks if the registry is readonly.
@throws InvalidRegistryException
if the registry is not open.
*/
boolean isReadOnly()
raises( com::sun::star::registry::InvalidRegistryException );
//-------------------------------------------------------------------------
/** DEPRECATED: this method lacks a registry key (better than a URL).
merges a registry under the specified key.
<p>If the key does not exist it will be created. Existing
keys will be overridden from keys of registry specified by
<var>aUrl</var>.
@throws InvalidRegistryException
if the registry is not open.
@throws MergeConflictException
if any differences occur during merging
*/
void mergeKey( [in] string aKeyName,
[in] string aUrl )
raises( com::sun::star::registry::InvalidRegistryException,
com::sun::star::registry::MergeConflictException );
};
//=============================================================================
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
