blob: 78738baad49424d1075ee10d6abdf11a9671c4a4 (
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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: xml_cdff.hxx,v $
* $Revision: 1.3 $
*
* 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 UDKSERVICE_XML_CDFF_HXX
#define UDKSERVICE_XML_CDFF_HXX
#include <tools/string.hxx>
#include "xml_cd.hxx"
class ComponentDescriptionImpl;
/** @descr
Is able to parse an XML file with Component descriptions. Gives access
to the parsed data.
Use:
CompDescrsFromAnXmlFile aCds;
UniString aFilepath(...);
if (! aCds.Parse(aFilepath) )
{
// react on:
aCds.Status();
}
With operator[] you get access to ComponentDescriptions
on indices 0 to NrOfDescriptions()-1 .
For further handling see class ComponentDescription
in xml_cd.hxx .
It is possible to parse more than one time. Then the old data
are discarded.
**/
class CompDescrsFromAnXmlFile
{
public:
enum E_Status
{
ok = 0,
not_yet_parsed,
cant_read_file,
inconsistent_file,
no_tag_found_in_file
};
// LIFECYCLE
CompDescrsFromAnXmlFile();
~CompDescrsFromAnXmlFile();
// OPERATIONS
BOOL Parse(
const UniString & i_sXmlFilePath );
// INQUIRY
INT32 NrOfDescriptions() const;
const ComponentDescription &
operator[]( /// @return an empty description, if index does not exist.
INT32 i_nIndex ) const;
CompDescrsFromAnXmlFile::E_Status
Status() const;
private:
// PRIVATE SERVICES
void Empty();
// DATA
std::vector< ComponentDescriptionImpl* > *
dpDescriptions;
E_Status eStatus;
};
#endif
|