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