1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef COMMANDDESCRIPTIONPROVIDER_HXX
25 #define COMMANDDESCRIPTIONPROVIDER_HXX
26 
27 /** === begin UNO includes === **/
28 #include <com/sun/star/frame/XModel.hpp>
29 /** === end UNO includes === **/
30 
31 #include <comphelper/componentcontext.hxx>
32 
33 #include <boost/shared_ptr.hpp>
34 
35 //........................................................................
36 namespace frm
37 {
38 //........................................................................
39 
40 	//====================================================================
41 	//= ICommandDescriptionProvider
42 	//====================================================================
43 	class SAL_NO_VTABLE ICommandDescriptionProvider
44 	{
45     public:
46         virtual ::rtl::OUString getCommandDescription( const ::rtl::OUString& _rCommandURL ) const = 0;
47 
~ICommandDescriptionProvider()48         virtual ~ICommandDescriptionProvider() { }
49 	};
50 
51     typedef ::boost::shared_ptr< const ICommandDescriptionProvider >  PCommandDescriptionProvider;
52 
53     //=====================================================================
54     //= factory
55     //=====================================================================
56     PCommandDescriptionProvider
57         createDocumentCommandDescriptionProvider(
58             const ::comphelper::ComponentContext& _rContext,
59             const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& _rxDocument
60         );
61 
62 //........................................................................
63 } // namespace frm
64 //........................................................................
65 
66 #endif // COMMANDDESCRIPTIONPROVIDER_HXX
67