1 /*************************************************************************
2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3  *
4  * Copyright 2000, 2010 Oracle and/or its affiliates.
5  *
6  * OpenOffice.org - a multi-platform office productivity suite
7  *
8  * This file is part of OpenOffice.org.
9  *
10  * OpenOffice.org is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU Lesser General Public License version 3
12  * only, as published by the Free Software Foundation.
13  *
14  * OpenOffice.org is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU Lesser General Public License version 3 for more details
18  * (a copy is included in the LICENSE file that accompanied this code).
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * version 3 along with OpenOffice.org.  If not, see
22  * <http://www.openoffice.org/license.html>
23  * for a copy of the LGPLv3 License.
24  *
25 ************************************************************************/
26 
27 #ifndef COMMANDDESCRIPTIONPROVIDER_HXX
28 #define COMMANDDESCRIPTIONPROVIDER_HXX
29 
30 /** === begin UNO includes === **/
31 #include <com/sun/star/frame/XModel.hpp>
32 /** === end UNO includes === **/
33 
34 #include <comphelper/componentcontext.hxx>
35 
36 #include <boost/shared_ptr.hpp>
37 
38 //........................................................................
39 namespace frm
40 {
41 //........................................................................
42 
43 	//====================================================================
44 	//= ICommandDescriptionProvider
45 	//====================================================================
46 	class SAL_NO_VTABLE ICommandDescriptionProvider
47 	{
48     public:
49         virtual ::rtl::OUString getCommandDescription( const ::rtl::OUString& _rCommandURL ) const = 0;
50 
51         virtual ~ICommandDescriptionProvider() { }
52 	};
53 
54     typedef ::boost::shared_ptr< const ICommandDescriptionProvider >  PCommandDescriptionProvider;
55 
56     //=====================================================================
57     //= factory
58     //=====================================================================
59     PCommandDescriptionProvider
60         createDocumentCommandDescriptionProvider(
61             const ::comphelper::ComponentContext& _rContext,
62             const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& _rxDocument
63         );
64 
65 //........................................................................
66 } // namespace frm
67 //........................................................................
68 
69 #endif // COMMANDDESCRIPTIONPROVIDER_HXX
70