1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
/* -*- 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_SFX2_REQUEST_HXX
#define INCLUDED_SFX2_REQUEST_HXX
#include <sal/config.h>
#include <sfx2/dllapi.h>
#include <sal/types.h>
#include <svl/itemset.hxx>
#include <svl/hint.hxx>
#include <memory>
class SfxPoolItem;
class SfxItemPool;
class SfxShell;
class SfxSlot;
class SfxViewFrame;
struct SfxRequest_Impl;
enum class SfxCallMode : sal_uInt16;
namespace com::sun::star::beans { struct PropertyValue; }
namespace com::sun::star::frame { class XDispatchRecorder; }
namespace com::sun::star::uno { template <class E> class Sequence; }
namespace vcl { class Window; }
namespace weld { class Window; }
class SFX2_DLLPUBLIC SfxRequest final : public SfxHint
{
friend struct SfxRequest_Impl;
sal_uInt16 nSlot;
std::unique_ptr<SfxAllItemSet> pArgs;
std::unique_ptr< SfxRequest_Impl > pImpl;
public:
SAL_DLLPRIVATE void Record_Impl( SfxShell &rSh, const SfxSlot &rSlot,
const css::uno::Reference< css::frame::XDispatchRecorder >& xRecorder,
SfxViewFrame* );
private:
SAL_DLLPRIVATE void Done_Impl( const SfxItemSet *pSet );
public:
SfxRequest( SfxViewFrame*, sal_uInt16 nSlotId );
SfxRequest( sal_uInt16 nSlot, SfxCallMode nCallMode, SfxItemPool &rPool );
SfxRequest( const SfxSlot* pSlot, const css::uno::Sequence < css::beans::PropertyValue >& rArgs,
SfxCallMode nCallMode, SfxItemPool &rPool );
SfxRequest(sal_uInt16 nSlot, SfxCallMode nCallMode, const SfxAllItemSet& rSfxArgs);
SfxRequest( sal_uInt16 nSlot, SfxCallMode nCallMode, const SfxAllItemSet& rSfxArgs, const SfxAllItemSet& rSfxInternalArgs );
SfxRequest( const SfxRequest& rOrig );
virtual ~SfxRequest() override;
sal_uInt16 GetSlot() const { return nSlot; }
void SetSlot(sal_uInt16 nNewSlot) { nSlot = nNewSlot; }
sal_uInt16 GetModifier() const;
void SetModifier( sal_uInt16 nModi );
void SetInternalArgs_Impl( const SfxAllItemSet& rArgs );
SAL_DLLPRIVATE const SfxItemSet* GetInternalArgs_Impl() const;
const SfxItemSet* GetArgs() const { return pArgs.get(); }
void SetArgs( const SfxAllItemSet& rArgs );
void AppendItem(const SfxPoolItem &);
void RemoveItem( sal_uInt16 nSlotId );
/** Templatized access to the individual parameters of the SfxRequest.
Use like: const SfxInt32Item *pPosItem = rReq.GetArg<SfxInt32Item>(SID_POS);
*/
template<class T> const T* GetArg(sal_uInt16 nSlotId) const
{
if (pArgs)
return pArgs->GetItem<T>(nSlotId, false);
return nullptr;
}
void ReleaseArgs();
void SetReturnValue(const SfxPoolItem &);
const SfxPoolItem* GetReturnValue() const;
static css::uno::Reference< css::frame::XDispatchRecorder > GetMacroRecorder( SfxViewFrame const * pFrame );
static bool HasMacroRecorder( SfxViewFrame const * pFrame );
SfxCallMode GetCallMode() const;
void AllowRecording( bool );
bool AllowsRecording() const;
bool IsAPI() const;
bool IsSynchronCall() const;
void SetSynchronCall( bool bSynchron );
bool IsDone() const;
void Done( bool bRemove = false );
void Ignore();
void Cancel();
bool IsCancelled() const;
void Done(const SfxItemSet &);
void ForgetAllArgs();
/** Return the window that should be used as the parent for any dialogs this request creates
*/
vcl::Window* GetFrameWindow() const;
weld::Window* GetFrameWeld() const;
private:
const SfxRequest& operator=(const SfxRequest &) = delete;
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
