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 COMMANDIMAGEPROVIDER_HXX
28 #define COMMANDIMAGEPROVIDER_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 #include <vcl/image.hxx>
36 
37 #include <boost/shared_ptr.hpp>
38 
39 //........................................................................
40 namespace frm
41 {
42 //........................................................................
43 
44     //=====================================================================
45     //= ICommandImageProvider
46     //=====================================================================
47     typedef ::rtl::OUString                                 CommandURL;
48     typedef ::com::sun::star::uno::Sequence< CommandURL >   CommandURLs;
49     typedef ::std::vector< Image >                          CommandImages;
50 
51     class SAL_NO_VTABLE ICommandImageProvider
52     {
53     public:
54         virtual CommandImages   getCommandImages(
55                                     const CommandURLs& _rCommandURLs,
56                                     const bool _bLarge,
57                                     const bool _bHiContrast
58                                 ) const = 0;
59 
60         virtual ~ICommandImageProvider() { }
61     };
62 
63     typedef ::boost::shared_ptr< const ICommandImageProvider >  PCommandImageProvider;
64 
65     //=====================================================================
66     //= factory
67     //=====================================================================
68     PCommandImageProvider
69         createDocumentCommandImageProvider(
70             const ::comphelper::ComponentContext& _rContext,
71             const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& _rxDocument
72         );
73 
74 //........................................................................
75 } // namespace frm
76 //........................................................................
77 
78 #endif // COMMANDIMAGEPROVIDER_HXX
79