forms/source/inc/commanddescriptionprovider.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 COMMANDDESCRIPTIONPROVIDER_HXX
  21 #define COMMANDDESCRIPTIONPROVIDER_HXX
  22
  23 #include <com/sun/star/frame/XModel.hpp>
  24 #include <com/sun/star/uno/XComponentContext.hpp>
  25
  26 #include <boost/shared_ptr.hpp>
  27
  28 //........................................................................
  29 namespace frm
  30 {
  31 //........................................................................
  32
  33     //====================================================================
  34     //= ICommandDescriptionProvider
  35     //====================================================================
  36     class SAL_NO_VTABLE ICommandDescriptionProvider
  37     {
  38     public:
  39         virtual OUString getCommandDescription( const OUString& _rCommandURL ) const = 0;
  40
  41         virtual ~ICommandDescriptionProvider() { }
  42     };
  43
  44     typedef ::boost::shared_ptr< const ICommandDescriptionProvider >  PCommandDescriptionProvider;
  45
  46     //=====================================================================
  47     //= factory
  48     //=====================================================================
  49     PCommandDescriptionProvider
  50         createDocumentCommandDescriptionProvider(
  51             const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext,
  52             const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& _rxDocument
  53         );
  54
  55 //........................................................................
  56 } // namespace frm
  57 //........................................................................
  58
  59 #endif // COMMANDDESCRIPTIONPROVIDER_HXX
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */