Files
libreoffice/chart2/source/inc/ControllerLockGuard.hxx
Michael Meeks b9042fad7c re-base on ALv2 code.
Change-Id: I6c145e984c885c7e06caa1c27bfb354ea49ad9ce
2012-06-21 15:00:05 +01:00

88 lines
2.8 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef CHART2_CONTROLLERLOCKGUARD_HXX
#define CHART2_CONTROLLERLOCKGUARD_HXX
#include <com/sun/star/frame/XModel.hpp>
#include "charttoolsdllapi.hxx"
namespace chart
{
/** This guard calls lockControllers at the given Model in the CTOR and
unlockControllers in the DTOR. Using this ensures that controllers do not
remain locked when leaving a function even in case an exception is thrown.
*/
class OOO_DLLPUBLIC_CHARTTOOLS ControllerLockGuard
{
public:
explicit ControllerLockGuard(
const ::com::sun::star::uno::Reference<
::com::sun::star::frame::XModel > & xModel );
~ControllerLockGuard();
private:
::com::sun::star::uno::Reference<
::com::sun::star::frame::XModel > m_xModel;
};
/** This helper class can be used to pass a locking mechanism to other objects
without exposing the full XModel to it.
Use the ControllerLockHelperGuard to lock/unlock the model during a block of
instructions.
*/
class OOO_DLLPUBLIC_CHARTTOOLS ControllerLockHelper
{
public:
explicit ControllerLockHelper(
const ::com::sun::star::uno::Reference<
::com::sun::star::frame::XModel > & xModel );
~ControllerLockHelper();
SAL_DLLPRIVATE void lockControllers();
SAL_DLLPRIVATE void unlockControllers();
private:
::com::sun::star::uno::Reference<
::com::sun::star::frame::XModel > m_xModel;
};
/** This guard calls lockControllers at the given ControllerLockHelper in the
CTOR and unlockControllers in the DTOR. Using this ensures that controllers
do not remain locked when leaving a function even in case an exception is
thrown.
*/
class OOO_DLLPUBLIC_CHARTTOOLS ControllerLockHelperGuard
{
public:
explicit ControllerLockHelperGuard( ControllerLockHelper & rHelper );
~ControllerLockHelperGuard();
private:
ControllerLockHelper & m_rHelper;
};
} // namespace chart
// CHART2_CONTROLLERLOCKGUARD_HXX
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */