forms/source/inc/commandimageprovider.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef COMMANDIMAGEPROVIDER_HXX
  21 #define COMMANDIMAGEPROVIDER_HXX
  22
  23 #include <com/sun/star/frame/XModel.hpp>
  24
  25 #include <comphelper/componentcontext.hxx>
  26 #include <vcl/image.hxx>
  27
  28 #include <boost/shared_ptr.hpp>
  29
  30 //........................................................................
  31 namespace frm
  32 {
  33 //........................................................................
  34
  35     //=====================================================================
  36     //= ICommandImageProvider
  37     //=====================================================================
  38     typedef OUString                                 CommandURL;
  39     typedef ::com::sun::star::uno::Sequence< CommandURL >   CommandURLs;
  40     typedef ::std::vector< Image >                          CommandImages;
  41
  42     class SAL_NO_VTABLE ICommandImageProvider
  43     {
  44     public:
  45         virtual CommandImages   getCommandImages(
  46                                     const CommandURLs& _rCommandURLs,
  47                                     const bool _bLarge
  48                                 ) const = 0;
  49
  50         virtual ~ICommandImageProvider() { }
  51     };
  52
  53     typedef ::boost::shared_ptr< const ICommandImageProvider >  PCommandImageProvider;
  54
  55     //=====================================================================
  56     //= factory
  57     //=====================================================================
  58     PCommandImageProvider
  59         createDocumentCommandImageProvider(
  60             const ::comphelper::ComponentContext& _rContext,
  61             const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& _rxDocument
  62         );
  63
  64 //........................................................................
  65 } // namespace frm
  66 //........................................................................
  67
  68 #endif // COMMANDIMAGEPROVIDER_HXX
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */