office-gobmx/forms/source/inc/commanddescriptionprovider.hxx
2010-10-28 15:48:02 +01:00

72 lines
2.8 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef COMMANDDESCRIPTIONPROVIDER_HXX
#define COMMANDDESCRIPTIONPROVIDER_HXX
/** === begin UNO includes === **/
#include <com/sun/star/frame/XModel.hpp>
/** === end UNO includes === **/
#include <comphelper/componentcontext.hxx>
#include <boost/shared_ptr.hpp>
//........................................................................
namespace frm
{
//........................................................................
//====================================================================
//= ICommandDescriptionProvider
//====================================================================
class SAL_NO_VTABLE ICommandDescriptionProvider
{
public:
virtual ::rtl::OUString getCommandDescription( const ::rtl::OUString& _rCommandURL ) const = 0;
virtual ~ICommandDescriptionProvider() { }
};
typedef ::boost::shared_ptr< const ICommandDescriptionProvider > PCommandDescriptionProvider;
//=====================================================================
//= factory
//=====================================================================
PCommandDescriptionProvider
createDocumentCommandDescriptionProvider(
const ::comphelper::ComponentContext& _rContext,
const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& _rxDocument
);
//........................................................................
} // namespace frm
//........................................................................
#endif // COMMANDDESCRIPTIONPROVIDER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */