xref: /AOO41X/main/xmlhelp/source/cxxhelp/provider/contentcaps.cxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir // MARKER(update_precomp.py): autogen include statement, do not remove
29*cdf0e10cSrcweir #include "precompiled_xmlhelp.hxx"
30*cdf0e10cSrcweir #include <com/sun/star/beans/Property.hpp>
31*cdf0e10cSrcweir #include <com/sun/star/beans/PropertyAttribute.hpp>
32*cdf0e10cSrcweir #include <com/sun/star/beans/PropertyValue.hpp>
33*cdf0e10cSrcweir #include <com/sun/star/ucb/CommandInfo.hpp>
34*cdf0e10cSrcweir #include <com/sun/star/ucb/OpenCommandArgument2.hpp>
35*cdf0e10cSrcweir #include <com/sun/star/uno/Sequence.hxx>
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir #include "content.hxx"
38*cdf0e10cSrcweir 
39*cdf0e10cSrcweir using namespace com::sun;
40*cdf0e10cSrcweir using namespace com::sun::star;
41*cdf0e10cSrcweir 
42*cdf0e10cSrcweir using namespace chelp;
43*cdf0e10cSrcweir 
44*cdf0e10cSrcweir // virtual
45*cdf0e10cSrcweir uno::Sequence< beans::Property > Content::getProperties(
46*cdf0e10cSrcweir     const uno::Reference< star::ucb::XCommandEnvironment > & /*xEnv*/ )
47*cdf0e10cSrcweir {
48*cdf0e10cSrcweir 	bool withMediaType = m_aURLParameter.isFile() || m_aURLParameter.isRoot();
49*cdf0e10cSrcweir 	bool isModule = m_aURLParameter.isModule();
50*cdf0e10cSrcweir 	bool isFile = m_aURLParameter.isFile();
51*cdf0e10cSrcweir 
52*cdf0e10cSrcweir 	sal_Int32 num = withMediaType ? 7 : 6;
53*cdf0e10cSrcweir 	if( isModule ) num+=6;
54*cdf0e10cSrcweir 	if( isFile )   num++;
55*cdf0e10cSrcweir 
56*cdf0e10cSrcweir 	uno::Sequence< beans::Property > props(num);
57*cdf0e10cSrcweir 
58*cdf0e10cSrcweir 	sal_Int32 idx = 0;
59*cdf0e10cSrcweir 	props[idx++] =
60*cdf0e10cSrcweir 		beans::Property(
61*cdf0e10cSrcweir 			rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "ContentType" ) ),
62*cdf0e10cSrcweir 			-1,
63*cdf0e10cSrcweir 			getCppuType( static_cast< const rtl::OUString * >( 0 ) ),
64*cdf0e10cSrcweir 			beans::PropertyAttribute::BOUND
65*cdf0e10cSrcweir             | beans::PropertyAttribute::READONLY );
66*cdf0e10cSrcweir 
67*cdf0e10cSrcweir 	props[idx++] =
68*cdf0e10cSrcweir 		beans::Property(
69*cdf0e10cSrcweir 			rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "IsReadOnly" ) ),
70*cdf0e10cSrcweir 			-1,
71*cdf0e10cSrcweir 			getCppuBooleanType(),
72*cdf0e10cSrcweir 			beans::PropertyAttribute::BOUND
73*cdf0e10cSrcweir             | beans::PropertyAttribute::READONLY );
74*cdf0e10cSrcweir 
75*cdf0e10cSrcweir 	props[idx++] =
76*cdf0e10cSrcweir 		beans::Property(
77*cdf0e10cSrcweir 			rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "IsErrorDocument" ) ),
78*cdf0e10cSrcweir 			-1,
79*cdf0e10cSrcweir 			getCppuBooleanType(),
80*cdf0e10cSrcweir 			beans::PropertyAttribute::BOUND
81*cdf0e10cSrcweir             | beans::PropertyAttribute::READONLY );
82*cdf0e10cSrcweir 
83*cdf0e10cSrcweir 	props[idx++] =
84*cdf0e10cSrcweir 		beans::Property(
85*cdf0e10cSrcweir 			rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "IsDocument" ) ),
86*cdf0e10cSrcweir 			-1,
87*cdf0e10cSrcweir 			getCppuBooleanType(),
88*cdf0e10cSrcweir 			beans::PropertyAttribute::BOUND
89*cdf0e10cSrcweir             | beans::PropertyAttribute::READONLY );
90*cdf0e10cSrcweir 
91*cdf0e10cSrcweir 	props[idx++] =
92*cdf0e10cSrcweir 		beans::Property(
93*cdf0e10cSrcweir 			rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "IsFolder" ) ),
94*cdf0e10cSrcweir 			-1,
95*cdf0e10cSrcweir 			getCppuBooleanType(),
96*cdf0e10cSrcweir 			beans::PropertyAttribute::BOUND
97*cdf0e10cSrcweir             | beans::PropertyAttribute::READONLY );
98*cdf0e10cSrcweir 
99*cdf0e10cSrcweir 	props[idx++] =
100*cdf0e10cSrcweir 		beans::Property(
101*cdf0e10cSrcweir 			rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Title" ) ),
102*cdf0e10cSrcweir 			-1,
103*cdf0e10cSrcweir 			getCppuType( static_cast< const rtl::OUString * >( 0 ) ),
104*cdf0e10cSrcweir 			beans::PropertyAttribute::BOUND
105*cdf0e10cSrcweir             | beans::PropertyAttribute::READONLY );
106*cdf0e10cSrcweir 
107*cdf0e10cSrcweir 	if( withMediaType )
108*cdf0e10cSrcweir 		props[idx++] =
109*cdf0e10cSrcweir 			beans::Property(
110*cdf0e10cSrcweir                 rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "MediaType" ) ),
111*cdf0e10cSrcweir                 -1,
112*cdf0e10cSrcweir                 getCppuType( static_cast< const rtl::OUString * >( 0 ) ),
113*cdf0e10cSrcweir                 beans::PropertyAttribute::BOUND
114*cdf0e10cSrcweir                 | beans::PropertyAttribute::READONLY );
115*cdf0e10cSrcweir 
116*cdf0e10cSrcweir 	if( isModule )
117*cdf0e10cSrcweir 	{
118*cdf0e10cSrcweir 		props[idx++] =
119*cdf0e10cSrcweir 			beans::Property(
120*cdf0e10cSrcweir                 rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Order" ) ),
121*cdf0e10cSrcweir                 -1,
122*cdf0e10cSrcweir                 getCppuType( static_cast< sal_Int32* >( 0 ) ),
123*cdf0e10cSrcweir                 beans::PropertyAttribute::BOUND
124*cdf0e10cSrcweir                 | beans::PropertyAttribute::READONLY );
125*cdf0e10cSrcweir 
126*cdf0e10cSrcweir 		props[idx++] =
127*cdf0e10cSrcweir 			beans::Property(
128*cdf0e10cSrcweir                 rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "KeywordList" ) ),
129*cdf0e10cSrcweir                 -1,
130*cdf0e10cSrcweir                 getCppuType(
131*cdf0e10cSrcweir                     static_cast< const uno::Sequence< rtl::OUString >* >(
132*cdf0e10cSrcweir                         0 ) ),
133*cdf0e10cSrcweir                 beans::PropertyAttribute::BOUND
134*cdf0e10cSrcweir                 | beans::PropertyAttribute::READONLY );
135*cdf0e10cSrcweir 
136*cdf0e10cSrcweir 		props[idx++] =
137*cdf0e10cSrcweir 			beans::Property(
138*cdf0e10cSrcweir                 rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "KeywordRef" ) ),
139*cdf0e10cSrcweir                 -1,
140*cdf0e10cSrcweir                 getCppuType(
141*cdf0e10cSrcweir                     static_cast< const uno::Sequence< uno::Sequence< rtl::OUString > >* >( 0 ) ),
142*cdf0e10cSrcweir                 beans::PropertyAttribute::BOUND
143*cdf0e10cSrcweir                 | beans::PropertyAttribute::READONLY );
144*cdf0e10cSrcweir 
145*cdf0e10cSrcweir 		props[idx++] =
146*cdf0e10cSrcweir 			beans::Property(
147*cdf0e10cSrcweir                 rtl::OUString(
148*cdf0e10cSrcweir                     RTL_CONSTASCII_USTRINGPARAM( "KeywordTitleForRef" ) ),
149*cdf0e10cSrcweir                 -1,
150*cdf0e10cSrcweir                 getCppuType(
151*cdf0e10cSrcweir                     static_cast< const uno::Sequence< uno::Sequence< rtl::OUString > >* >( 0 ) ),
152*cdf0e10cSrcweir                 beans::PropertyAttribute::BOUND
153*cdf0e10cSrcweir                 | beans::PropertyAttribute::READONLY );
154*cdf0e10cSrcweir 
155*cdf0e10cSrcweir 		props[idx++] =
156*cdf0e10cSrcweir 			beans::Property(
157*cdf0e10cSrcweir                 rtl::OUString(
158*cdf0e10cSrcweir                     RTL_CONSTASCII_USTRINGPARAM( "KeywordAnchorForRef" ) ),
159*cdf0e10cSrcweir                 -1,
160*cdf0e10cSrcweir                 getCppuType(
161*cdf0e10cSrcweir                     static_cast< const uno::Sequence< uno::Sequence< rtl::OUString > >* >( 0 ) ),
162*cdf0e10cSrcweir                 beans::PropertyAttribute::BOUND
163*cdf0e10cSrcweir                 | beans::PropertyAttribute::READONLY );
164*cdf0e10cSrcweir 
165*cdf0e10cSrcweir 		props[idx++] =
166*cdf0e10cSrcweir 			beans::Property(
167*cdf0e10cSrcweir                 rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "SearchScopes" ) ),
168*cdf0e10cSrcweir                 -1,
169*cdf0e10cSrcweir                 getCppuType(
170*cdf0e10cSrcweir                     static_cast< const uno::Sequence< rtl::OUString >* >( 0 ) ),
171*cdf0e10cSrcweir                 beans::PropertyAttribute::BOUND
172*cdf0e10cSrcweir                 | beans::PropertyAttribute::READONLY );
173*cdf0e10cSrcweir 	}
174*cdf0e10cSrcweir 
175*cdf0e10cSrcweir 	if( isFile )
176*cdf0e10cSrcweir 	{
177*cdf0e10cSrcweir 		props[idx++] =
178*cdf0e10cSrcweir 			beans::Property(
179*cdf0e10cSrcweir                 rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "AnchorName" ) ),
180*cdf0e10cSrcweir                 -1,
181*cdf0e10cSrcweir                 getCppuType( static_cast< const rtl::OUString * >( 0 ) ),
182*cdf0e10cSrcweir                 beans::PropertyAttribute::BOUND
183*cdf0e10cSrcweir                 | beans::PropertyAttribute::READONLY );
184*cdf0e10cSrcweir 	}
185*cdf0e10cSrcweir 
186*cdf0e10cSrcweir 	return props;
187*cdf0e10cSrcweir }
188*cdf0e10cSrcweir 
189*cdf0e10cSrcweir 
190*cdf0e10cSrcweir 
191*cdf0e10cSrcweir //=========================================================================
192*cdf0e10cSrcweir // virtual
193*cdf0e10cSrcweir uno::Sequence< star::ucb::CommandInfo > Content::getCommands(
194*cdf0e10cSrcweir     const uno::Reference< star::ucb::XCommandEnvironment > & /*xEnv*/ )
195*cdf0e10cSrcweir {
196*cdf0e10cSrcweir //	osl::MutexGuard aGuard( m_aMutex );
197*cdf0e10cSrcweir 
198*cdf0e10cSrcweir 	//=================================================================
199*cdf0e10cSrcweir 	//
200*cdf0e10cSrcweir 	// Supported commands
201*cdf0e10cSrcweir 	//
202*cdf0e10cSrcweir 	//=================================================================
203*cdf0e10cSrcweir 
204*cdf0e10cSrcweir #define COMMAND_COUNT 5
205*cdf0e10cSrcweir 
206*cdf0e10cSrcweir 	static const star::ucb::CommandInfo aCommandInfoTable[] =
207*cdf0e10cSrcweir 	{
208*cdf0e10cSrcweir 		///////////////////////////////////////////////////////////////
209*cdf0e10cSrcweir 		// Required commands
210*cdf0e10cSrcweir 		///////////////////////////////////////////////////////////////
211*cdf0e10cSrcweir 		star::ucb::CommandInfo(
212*cdf0e10cSrcweir 			rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "getCommandInfo" ) ),
213*cdf0e10cSrcweir 			-1,
214*cdf0e10cSrcweir 			getCppuVoidType()
215*cdf0e10cSrcweir 		),
216*cdf0e10cSrcweir 		star::ucb::CommandInfo(
217*cdf0e10cSrcweir 			rtl::OUString(
218*cdf0e10cSrcweir                 RTL_CONSTASCII_USTRINGPARAM( "getPropertySetInfo" ) ),
219*cdf0e10cSrcweir 			-1,
220*cdf0e10cSrcweir 			getCppuVoidType()
221*cdf0e10cSrcweir 		),
222*cdf0e10cSrcweir 		star::ucb::CommandInfo(
223*cdf0e10cSrcweir 			rtl::OUString(
224*cdf0e10cSrcweir                 RTL_CONSTASCII_USTRINGPARAM( "getPropertyValues" ) ),
225*cdf0e10cSrcweir 			-1,
226*cdf0e10cSrcweir 			getCppuType(
227*cdf0e10cSrcweir                 static_cast< uno::Sequence< beans::Property > * >( 0 ) )
228*cdf0e10cSrcweir 		),
229*cdf0e10cSrcweir 		star::ucb::CommandInfo(
230*cdf0e10cSrcweir 			rtl::OUString(
231*cdf0e10cSrcweir                 RTL_CONSTASCII_USTRINGPARAM( "setPropertyValues" ) ),
232*cdf0e10cSrcweir 			-1,
233*cdf0e10cSrcweir 			getCppuType(
234*cdf0e10cSrcweir                 static_cast< uno::Sequence< beans::PropertyValue > * >( 0 ) )
235*cdf0e10cSrcweir 		),
236*cdf0e10cSrcweir 		star::ucb::CommandInfo(
237*cdf0e10cSrcweir 			rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "open" ) ),
238*cdf0e10cSrcweir 			-1,
239*cdf0e10cSrcweir 			getCppuType(
240*cdf0e10cSrcweir                 static_cast< star::ucb::OpenCommandArgument2 * >( 0 ) )
241*cdf0e10cSrcweir 		)
242*cdf0e10cSrcweir 	};
243*cdf0e10cSrcweir 
244*cdf0e10cSrcweir 	return uno::Sequence< star::ucb::CommandInfo >(
245*cdf0e10cSrcweir         aCommandInfoTable, COMMAND_COUNT );
246*cdf0e10cSrcweir }
247*cdf0e10cSrcweir 
248