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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
/*************************************************************************
*
* 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: MediaDescriptorHelper.hxx,v $
* $Revision: 1.4.44.1 $
*
* 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 _MEDIADESCRIPTORHELPER_HXX
#define _MEDIADESCRIPTORHELPER_HXX
#include <com/sun/star/uno/Sequence.hxx>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/util/URL.hpp>
#include <com/sun/star/awt/Rectangle.hpp>
#include <com/sun/star/io/XStream.hpp>
#include <com/sun/star/io/XInputStream.hpp>
#include <com/sun/star/io/XOutputStream.hpp>
#include <com/sun/star/embed/XStorage.hpp>
#include "charttoolsdllapi.hxx"
/*
* This class helps to read and write the properties mentioned in the service description
* com.sun.star.document.MediaDescriptor from and to a sequence of PropertyValues.
* Properties that are not mentioned in the service description
* are stored in the member AdditionalProperties.
*
* As an additional feature this helper class can generate a reduced sequence of PropertyValues
* that does not contain properties which are known to be only view relevant. This
* reduced sequence than might be attached to a model directly.
*/
namespace apphelper
{
class OOO_DLLPUBLIC_CHARTTOOLS MediaDescriptorHelper
{
private:
//MediaDescriptorHelper(){};
public:
MediaDescriptorHelper( const ::com::sun::star::uno::Sequence<
::com::sun::star::beans::PropertyValue > & rMediaDescriptor );
virtual ~MediaDescriptorHelper();
::com::sun::star::uno::Sequence<
::com::sun::star::beans::PropertyValue > getReducedForModel();
public:
//---------------------
//all properties given in the constructor are stored in the following three sequences
::com::sun::star::uno::Sequence<
::com::sun::star::beans::PropertyValue >
m_aRegularProperties; //these are the properties which are described in service com.sun.star.document.MediaDescriptor and not marked as deprecated
::com::sun::star::uno::Sequence<
::com::sun::star::beans::PropertyValue >
m_aDeprecatedProperties; //these are properties which are described in service com.sun.star.document.MediaDescriptor but are marked as deprecated
::com::sun::star::uno::Sequence<
::com::sun::star::beans::PropertyValue >
m_aAdditionalProperties; //these are properties which are not described in service com.sun.star.document.MediaDescriptor
//----------------------
//properties which should be given to a model are additionally stored in this sequence (not documented properties and deprecated properties are not included!)
::com::sun::star::uno::Sequence<
::com::sun::star::beans::PropertyValue >
m_aModelProperties; //these are properties which are not described in service com.sun.star.document.MediaDescriptor
//@todo define this for debug only, except URL
sal_Bool AsTemplate; //document is a template.
sal_Bool ISSET_AsTemplate;
::rtl::OUString Author; //
sal_Bool ISSET_Author;
::rtl::OUString CharacterSet; //identifier of used character set.
sal_Bool ISSET_CharacterSet;
::rtl::OUString Comment;//
sal_Bool ISSET_Comment;
::com::sun::star::uno::Any
ComponentData;//
sal_Bool ISSET_ComponentData;
::rtl::OUString FileName; //deprecated, same as url
sal_Bool ISSET_FileName;
::com::sun::star::uno::Any
FilterData;//
sal_Bool ISSET_FilterData;
::rtl::OUString FilterName; //internal filter name.
sal_Bool ISSET_FilterName;
::rtl::OUString FilterFlags;//deprecated,
sal_Bool ISSET_FilterFlags;
::rtl::OUString FilterOptions;//
sal_Bool ISSET_FilterOptions;
//not documented ... @todo remove?
::rtl::OUString FrameName; //name of target frame.
sal_Bool ISSET_FrameName;
sal_Bool Hidden; //load document, invisible.
sal_Bool ISSET_Hidden;
::rtl::OUString HierarchicalDocumentName;
sal_Bool ISSET_HierarchicalDocumentName;
::com::sun::star::uno::Reference< ::com::sun::star::io::XOutputStream >
OutputStream; //a stream to receive the document data for saving
sal_Bool ISSET_OutputStream;
::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >
InputStream; //content of document.
sal_Bool ISSET_InputStream;
::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >
InteractionHandler; // //::com::sun::star::task::XInteractionHandler
sal_Bool ISSET_InteractionHandler;
::rtl::OUString JumpMark; //specifies the name of a mark within the document where the first view is to position itself.
sal_Bool ISSET_JumpMark;
::rtl::OUString MediaType; //mime type.
sal_Bool ISSET_MediaType;
::rtl::OUString OpenFlags; //deprecated
sal_Bool ISSET_OpenFlags;
sal_Bool OpenNewView; //opens a new view for an already loaded document.
sal_Bool ISSET_OpenNewView;
sal_Bool Overwrite; //opens a new view for an already loaded document.
sal_Bool ISSET_Overwrite;
::rtl::OUString Password; //
sal_Bool ISSET_Password;
//not documented ... @todo remove?
::com::sun::star::awt::Rectangle
PosSize; //position and size of document window.
sal_Bool ISSET_PosSize;
::com::sun::star::uno::Sequence< sal_Int8 >
PostData; //contains the data for HTTP post method as a sequence of bytes.
sal_Bool ISSET_PostData;
::rtl::OUString PostString; //deprecated, contains the data for HTTP post method as a sequence of bytes.
sal_Bool ISSET_PostString;
sal_Bool Preview; //show preview.
sal_Bool ISSET_Preview;
sal_Bool ReadOnly; //open document readonly.
sal_Bool ISSET_ReadOnly;
::rtl::OUString Referer; //name of document referrer.
sal_Bool ISSET_Referer;
::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >
StatusIndicator; // //::com::sun::star::task::XStatusIndicator
sal_Bool ISSET_StatusIndicator;
//not documented ... @todo remove?
sal_Bool Silent; //prevents dialogs to query for more information.
sal_Bool ISSET_Silent;
::rtl::OUString TemplateName; //deprecated, name of the template instead of the URL.
sal_Bool ISSET_TemplateName;
::rtl::OUString TemplateRegionName; //deprecated, name of the region of the template.
sal_Bool ISSET_TemplateRegionName;
sal_Bool Unpacked;
sal_Bool ISSET_Unpacked;
::rtl::OUString URL;// FileName, URL of the document.
sal_Bool ISSET_URL;
sal_Int16 Version; //storage version.
sal_Bool ISSET_Version;
::com::sun::star::uno::Any
ViewData;//
sal_Bool ISSET_ViewData;
sal_Int16 ViewId; //id of the initial view.
sal_Bool ISSET_ViewId;
// new framework objects
::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >
Storage;
sal_Bool ISSET_Storage;
::com::sun::star::uno::Reference< ::com::sun::star::io::XStream >
Stream;
sal_Bool ISSET_Stream;
// undocumented SFX Properties
::com::sun::star::uno::Sequence< sal_Int32 >
WinExtent;
sal_Bool ISSET_WinExtent;
sal_Bool SetEmbedded;
sal_Bool ISSET_SetEmbedded;
protected:
SAL_DLLPRIVATE void impl_init();
};
}
#endif
|
