Files
libreoffice/include/comphelper/interaction.hxx
Stephan Bergmann 70cc2b191b First batch of adding SAL_OVERRRIDE to overriding function declarations
...mostly done with a rewriting Clang plugin, with just some manual tweaking
necessary to fix poor macro usage.

Change-Id: I71fa20213e86be10de332ece0aa273239df7b61a
2014-03-26 16:39:26 +01:00

162 lines
5.5 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 INCLUDED_COMPHELPER_INTERACTION_HXX
#define INCLUDED_COMPHELPER_INTERACTION_HXX
#include <comphelper/uno3.hxx>
#include <cppuhelper/implbase1.hxx>
#include <com/sun/star/task/XInteractionApprove.hpp>
#include <com/sun/star/task/XInteractionDisapprove.hpp>
#include <com/sun/star/task/XInteractionAbort.hpp>
#include <com/sun/star/task/XInteractionRetry.hpp>
#include <com/sun/star/task/XInteractionPassword.hpp>
#include <com/sun/star/task/XInteractionRequest.hpp>
#include <comphelper/comphelperdllapi.h>
namespace comphelper
{
//= OInteractionSelect
/** base class for concrete XInteractionContinuation implementations.<p/>
Instances of the classes maintain a flag indicating if the handler was called.
*/
class OInteractionSelect
{
bool m_bSelected : 1; /// indicates if the select event occurred
protected:
OInteractionSelect() : m_bSelected(false) { }
public:
/// determines whether or not this handler was selected
bool wasSelected() const { return m_bSelected; }
/// resets the state to "not selected", so you may reuse the handler
void reset() { m_bSelected = false; }
protected:
void implSelected() { m_bSelected = true; }
};
//= OInteraction
/** template for instantiating concret interaction handlers<p/>
the template argument must eb an interface derived from XInteractionContinuation
*/
template <class INTERACTION>
class OInteraction
:public ::cppu::WeakImplHelper1< INTERACTION >
,public OInteractionSelect
{
public:
OInteraction() { }
// XInteractionContinuation
virtual void SAL_CALL select( ) throw(::com::sun::star::uno::RuntimeException) SAL_OVERRIDE;
};
template <class INTERACTION>
void SAL_CALL OInteraction< INTERACTION >::select( ) throw(::com::sun::star::uno::RuntimeException)
{
implSelected();
}
//= OInteractionApprove
typedef OInteraction< ::com::sun::star::task::XInteractionApprove > OInteractionApprove;
//= OInteractionDispprove
typedef OInteraction< ::com::sun::star::task::XInteractionDisapprove > OInteractionDisapprove;
//= OInteractionAbort
typedef OInteraction< ::com::sun::star::task::XInteractionAbort > OInteractionAbort;
//= OInteractionRetry
typedef OInteraction< ::com::sun::star::task::XInteractionRetry > OInteractionRetry;
//= OInteractionPassword
class COMPHELPER_DLLPUBLIC OInteractionPassword : public OInteraction< ::com::sun::star::task::XInteractionPassword >
{
public:
OInteractionPassword()
{
}
OInteractionPassword( const OUString& _rInitialPassword )
:m_sPassword( _rInitialPassword )
{
}
// XInteractionPassword
virtual void SAL_CALL setPassword( const OUString& _Password ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual OUString SAL_CALL getPassword( ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
private:
OUString m_sPassword;
};
//= OInteractionRequest
typedef ::cppu::WeakImplHelper1 < ::com::sun::star::task::XInteractionRequest
> OInteractionRequest_Base;
/** implements an interaction request (com.sun.star.task::XInteractionRequest)<p/>
at run time, you can freely add any interaction continuation objects
*/
class COMPHELPER_DLLPUBLIC OInteractionRequest : public OInteractionRequest_Base
{
::com::sun::star::uno::Any
m_aRequest; /// the request we represent
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > >
m_aContinuations; /// all registered continuations
public:
OInteractionRequest(const ::com::sun::star::uno::Any& _rRequestDescription);
/// add a new continuation
void addContinuation(const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation >& _rxContinuation);
// XInteractionRequest
virtual ::com::sun::star::uno::Any SAL_CALL getRequest( ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionContinuation > > SAL_CALL getContinuations( ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
};
} // namespace comphelper
#endif // INCLUDED_COMPHELPER_INTERACTION_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */