LibreOffice Module comphelper (master)  1
interaction.hxx
Go to the documentation of this file.
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 INCLUDED_COMPHELPER_INTERACTION_HXX
21 #define INCLUDED_COMPHELPER_INTERACTION_HXX
22 
23 #include <cppuhelper/implbase.hxx>
24 #include <com/sun/star/task/XInteractionApprove.hpp>
25 #include <com/sun/star/task/XInteractionDisapprove.hpp>
26 #include <com/sun/star/task/XInteractionAbort.hpp>
27 #include <com/sun/star/task/XInteractionRetry.hpp>
28 #include <com/sun/star/task/XInteractionRequest.hpp>
30 #include <vector>
31 
32 
33 namespace comphelper
34 {
35 
36 
37  //= OInteraction
38 
42  template <class INTERACTION>
44  : public ::cppu::WeakImplHelper< INTERACTION >
45  {
46  public:
47  OInteraction() : m_bSelected(false) {}
48 
50  bool wasSelected() const { return m_bSelected; }
51 
52  // XInteractionContinuation
53  virtual void SAL_CALL select() override;
54  private:
55  bool m_bSelected : 1;
56  };
57 
58 
59  template <class INTERACTION>
61  {
62  m_bSelected = true;
63  }
64 
65 
66  //= OInteractionApprove
67 
69 
70 
71  //= OInteractionDisapprove
72 
74 
75 
76  //= OInteractionAbort
77 
79 
80 
81  //= OInteractionRetry
82 
84 
85 
86  //= OInteractionRequest
87 
88  typedef ::cppu::WeakImplHelper < css::task::XInteractionRequest
94  {
95  css::uno::Any const
97  std::vector< css::uno::Reference< css::task::XInteractionContinuation > >
99 
100  public:
101  OInteractionRequest(const css::uno::Any& _rRequestDescription);
102  OInteractionRequest(const css::uno::Any& rRequestDescription,
103  std::vector<css::uno::Reference<css::task::XInteractionContinuation>> const& rContinuations);
104 
106  void addContinuation(const css::uno::Reference< css::task::XInteractionContinuation >& _rxContinuation);
107 
108  // XInteractionRequest
109  virtual css::uno::Any SAL_CALL getRequest( ) override;
110  virtual css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > SAL_CALL getContinuations( ) override;
111  };
112 
113 } // namespace comphelper
114 
115 
116 #endif // INCLUDED_COMPHELPER_INTERACTION_HXX
117 
118 
119 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
OInteraction< css::task::XInteractionRetry > OInteractionRetry
Definition: interaction.hxx:83
::cppu::WeakImplHelper< css::task::XInteractionRequest > OInteractionRequest_Base
Definition: interaction.hxx:89
OInteraction< css::task::XInteractionAbort > OInteractionAbort
Definition: interaction.hxx:78
OInteraction< css::task::XInteractionDisapprove > OInteractionDisapprove
Definition: interaction.hxx:73
virtual void SAL_CALL select() override
Definition: interaction.hxx:60
template for instantiating concrete interaction handlersthe template argument must be an interface de...
Definition: interaction.hxx:43
css::uno::Any const m_aRequest
Definition: interaction.hxx:96
implements an interaction request (com.sun.star.task::XInteractionRequest)at run time, you can freely add any interaction continuation objects
Definition: interaction.hxx:93
#define COMPHELPER_DLLPUBLIC
std::vector< css::uno::Reference< css::task::XInteractionContinuation > > m_aContinuations
the request we represent
Definition: interaction.hxx:98
void getContinuations(css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > const &rContinuations, css::uno::Reference< t1 > *pContinuation1, css::uno::Reference< t2 > *pContinuation2)
bool wasSelected() const
determines whether or not this handler was selected
Definition: interaction.hxx:50
OInteraction< css::task::XInteractionApprove > OInteractionApprove
Definition: interaction.hxx:68