1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef _UCBHELPER_REGISTERUCB_HXX_ 25*b1cdbd2cSJim Jagielski #define _UCBHELPER_REGISTERUCB_HXX_ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include <com/sun/star/uno/RuntimeException.hpp> 28*b1cdbd2cSJim Jagielski #include <com/sun/star/uno/Reference.h> 29*b1cdbd2cSJim Jagielski #include <com/sun/star/ucb/XContentProvider.hpp> 30*b1cdbd2cSJim Jagielski #include <com/sun/star/ucb/XContentProviderManager.hpp> 31*b1cdbd2cSJim Jagielski #include <vector> 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski #include "ucbhelper/ucbhelperdllapi.h" 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski namespace com { namespace sun { namespace star { 36*b1cdbd2cSJim Jagielski namespace lang { class XMultiServiceFactory; } 37*b1cdbd2cSJim Jagielski } } } 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski namespace rtl { class OUString; } 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski namespace ucbhelper { 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski //============================================================================ 44*b1cdbd2cSJim Jagielski /** Information about a registered content provider. 45*b1cdbd2cSJim Jagielski */ 46*b1cdbd2cSJim Jagielski struct ContentProviderRegistrationInfo 47*b1cdbd2cSJim Jagielski { 48*b1cdbd2cSJim Jagielski /** The registered content provider (or null if registration failed). 49*b1cdbd2cSJim Jagielski */ 50*b1cdbd2cSJim Jagielski com::sun::star::uno::Reference< com::sun::star::ucb::XContentProvider > 51*b1cdbd2cSJim Jagielski m_xProvider; 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski /** The arguments the content provider was instantiated with. 54*b1cdbd2cSJim Jagielski */ 55*b1cdbd2cSJim Jagielski rtl::OUString m_aArguments; 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski /** The URL template the content provider is registered on. 58*b1cdbd2cSJim Jagielski */ 59*b1cdbd2cSJim Jagielski rtl::OUString m_aTemplate; 60*b1cdbd2cSJim Jagielski }; 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski typedef std::vector< ContentProviderRegistrationInfo > 63*b1cdbd2cSJim Jagielski ContentProviderRegistrationInfoList; 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski //============================================================================ 66*b1cdbd2cSJim Jagielski /** Information about a content provider, passed to 67*b1cdbd2cSJim Jagielski <method>configureUcb</method>. 68*b1cdbd2cSJim Jagielski */ 69*b1cdbd2cSJim Jagielski struct ContentProviderData 70*b1cdbd2cSJim Jagielski { 71*b1cdbd2cSJim Jagielski /** The UNO service name to use to instanciate the content provider. 72*b1cdbd2cSJim Jagielski */ 73*b1cdbd2cSJim Jagielski rtl::OUString ServiceName; 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski /** The URL template to use to instanciate the content provider. 76*b1cdbd2cSJim Jagielski */ 77*b1cdbd2cSJim Jagielski rtl::OUString URLTemplate; 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski /** The arguments to use to instanciate the content provider. 80*b1cdbd2cSJim Jagielski */ 81*b1cdbd2cSJim Jagielski rtl::OUString Arguments; 82*b1cdbd2cSJim Jagielski ContentProviderDataucbhelper::ContentProviderData83*b1cdbd2cSJim Jagielski ContentProviderData() {}; ContentProviderDataucbhelper::ContentProviderData84*b1cdbd2cSJim Jagielski ContentProviderData( const rtl::OUString & rService, 85*b1cdbd2cSJim Jagielski const rtl::OUString & rTemplate, 86*b1cdbd2cSJim Jagielski const rtl::OUString & rArgs ) 87*b1cdbd2cSJim Jagielski : ServiceName( rService ), URLTemplate( rTemplate ), Arguments( rArgs ) {} 88*b1cdbd2cSJim Jagielski }; 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski typedef std::vector< ContentProviderData > ContentProviderDataList; 91*b1cdbd2cSJim Jagielski //============================================================================ 92*b1cdbd2cSJim Jagielski /** Register a content provider at a Universal Content Broker. 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski @param rManager A content provider manager (normally, this would be a 95*b1cdbd2cSJim Jagielski UCB). May be null, which is only useful if the content provider is an 96*b1cdbd2cSJim Jagielski <type>XParamterizedContentProvider</type>s. 97*b1cdbd2cSJim Jagielski 98*b1cdbd2cSJim Jagielski @param rServiceFactory A factory through which to obtain the required 99*b1cdbd2cSJim Jagielski services. 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski @param rName The service name of the content provider. 102*b1cdbd2cSJim Jagielski 103*b1cdbd2cSJim Jagielski @param rArguments Any arguments to instantiate the content provider with. 104*b1cdbd2cSJim Jagielski 105*b1cdbd2cSJim Jagielski @param rTemplate The URL template to register the content provider on. 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski @param pInfo If not null, this output parameter is filled with 108*b1cdbd2cSJim Jagielski information about the (atemptively) registered provider. 109*b1cdbd2cSJim Jagielski */ 110*b1cdbd2cSJim Jagielski 111*b1cdbd2cSJim Jagielski UCBHELPER_DLLPUBLIC bool registerAtUcb( 112*b1cdbd2cSJim Jagielski com::sun::star::uno::Reference< 113*b1cdbd2cSJim Jagielski com::sun::star::ucb::XContentProviderManager > const & 114*b1cdbd2cSJim Jagielski rManager, 115*b1cdbd2cSJim Jagielski com::sun::star::uno::Reference< 116*b1cdbd2cSJim Jagielski com::sun::star::lang::XMultiServiceFactory > const & 117*b1cdbd2cSJim Jagielski rServiceFactory, 118*b1cdbd2cSJim Jagielski rtl::OUString const & rName, 119*b1cdbd2cSJim Jagielski rtl::OUString const & rArguments, 120*b1cdbd2cSJim Jagielski rtl::OUString const & rTemplate, 121*b1cdbd2cSJim Jagielski ContentProviderRegistrationInfo * pInfo) 122*b1cdbd2cSJim Jagielski throw (com::sun::star::uno::RuntimeException); 123*b1cdbd2cSJim Jagielski 124*b1cdbd2cSJim Jagielski } 125*b1cdbd2cSJim Jagielski #endif // _UCBHELPER_REGISTERUCB_HXX_ 126