summaryrefslogtreecommitdiff
path: root/include/sfx2/request.hxx
diff options
context:
space:
mode:
authorBjoern Michaelsen <bjoern.michaelsen@canonical.com>2013-04-18 18:26:28 +0200
committerBjoern Michaelsen <bjoern.michaelsen@canonical.com>2013-04-23 22:20:31 +0200
commitb9337e22ce1dbf2eba0e8c8db294ae99f4111f91 (patch)
tree53ee1bd3dfd213815a21579151983cb997922b05 /include/sfx2/request.hxx
parentf4e1642a1761d5eab6ccdd89928869c2b2f1528a (diff)
execute move of global headers
see https://gerrit.libreoffice.org/#/c/3367/ and Change-Id: I00c96fa77d04b33a6f8c8cd3490dfcd9bdc9e84a for details Change-Id: I199a75bc4042af20817265d5ef85b1134a96ff5a
Diffstat (limited to 'include/sfx2/request.hxx')
-rw-r--r--include/sfx2/request.hxx125
1 files changed, 125 insertions, 0 deletions
diff --git a/include/sfx2/request.hxx b/include/sfx2/request.hxx
new file mode 100644
index 000000000000..590fd7bffeaf
--- /dev/null
+++ b/include/sfx2/request.hxx
@@ -0,0 +1,125 @@
+/* -*- 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 _SFXREQUEST_HXX
+#define _SFXREQUEST_HXX
+
+#include "sal/config.h"
+#include "sfx2/dllapi.h"
+#include "sal/types.h"
+#include <svl/itemset.hxx>
+#include <svl/hint.hxx>
+
+#include <com/sun/star/uno/Sequence.hxx>
+#include <com/sun/star/beans/PropertyValue.hpp>
+#include <com/sun/star/frame/XDispatchRecorder.hpp>
+
+class SfxPoolItem;
+class SfxAllItemSet;
+class SfxItemSet;
+class SfxItemPool;
+class SfxShell;
+class SfxSlot;
+class String;
+class SfxViewFrame;
+struct SfxRequest_Impl;
+
+//==================================================================
+
+class SFX2_DLLPUBLIC SfxRequest: public SfxHint
+{
+friend struct SfxRequest_Impl;
+
+ sal_uInt16 nSlot;
+ SfxAllItemSet* pArgs;
+ SfxRequest_Impl* pImp;
+
+ //---------------------------------------------------------------------
+public:
+ SAL_DLLPRIVATE void Record_Impl( SfxShell &rSh, const SfxSlot &rSlot,
+ com::sun::star::uno::Reference< com::sun::star::frame::XDispatchRecorder > xRecorder,
+ SfxViewFrame* );
+private:
+ SAL_DLLPRIVATE void Done_Impl( const SfxItemSet *pSet );
+
+ //---------------------------------------------------------------------
+
+public:
+ SfxRequest( SfxViewFrame*, sal_uInt16 nSlotId );
+ SfxRequest( sal_uInt16 nSlot, sal_uInt16 nCallMode, SfxItemPool &rPool );
+ SfxRequest( const SfxSlot* pSlot, const com::sun::star::uno::Sequence < com::sun::star::beans::PropertyValue >& rArgs,
+ sal_uInt16 nCallMode, SfxItemPool &rPool );
+ SfxRequest( sal_uInt16 nSlot, sal_uInt16 nCallMode, const SfxAllItemSet& rSfxArgs );
+ SfxRequest( const SfxRequest& rOrig );
+ ~SfxRequest();
+
+ sal_uInt16 GetSlot() const { return nSlot; }
+ void SetSlot(sal_uInt16 nNewSlot) { nSlot = nNewSlot; }
+
+ sal_uInt16 GetModifier() const;
+ void SetModifier( sal_uInt16 nModi );
+ SAL_DLLPRIVATE void SetInternalArgs_Impl( const SfxAllItemSet& rArgs );
+ SAL_DLLPRIVATE const SfxItemSet* GetInternalArgs_Impl() const;
+ const SfxItemSet* GetArgs() const { return pArgs; }
+ void SetArgs( const SfxAllItemSet& rArgs );
+ void AppendItem(const SfxPoolItem &);
+ void RemoveItem( sal_uInt16 nSlotId );
+
+ static const SfxPoolItem* GetItem( const SfxItemSet*, sal_uInt16 nSlotId,
+ bool bDeep = false,
+ TypeId aType = 0 );
+ const SfxPoolItem* GetArg( sal_uInt16 nSlotId, bool bDeep = false, TypeId aType = 0 ) const;
+ void ReleaseArgs();
+ void SetReturnValue(const SfxPoolItem &);
+ const SfxPoolItem* GetReturnValue() const;
+
+ static com::sun::star::uno::Reference< com::sun::star::frame::XDispatchRecorder > GetMacroRecorder( SfxViewFrame* pFrame=NULL );
+ static sal_Bool HasMacroRecorder( SfxViewFrame* pFrame=NULL );
+ sal_uInt16 GetCallMode() const;
+ void AllowRecording( sal_Bool );
+ sal_Bool AllowsRecording() const;
+ sal_Bool IsAPI() const;
+ sal_Bool IsSynchronCall() const;
+ void SetSynchronCall( sal_Bool bSynchron );
+
+ sal_Bool IsDone() const;
+ void Done( sal_Bool bRemove = sal_False );
+
+ void Ignore();
+ void Cancel();
+ sal_Bool IsCancelled() const;
+ void Done(const SfxItemSet &, bool bKeep = true );
+
+ void ForgetAllArgs();
+
+private:
+ const SfxRequest& operator=(const SfxRequest &); // n.i.!!
+};
+
+//------------------------------------------------------------------------
+
+#define SFX_REQUEST_ARG(rReq, pItem, ItemType, nSlotId, bDeep) \
+ const ItemType *pItem = (const ItemType*) \
+ rReq.GetArg( nSlotId, bDeep, TYPE(ItemType) )
+#define SFX_ITEMSET_ARG(pArgs, pItem, ItemType, nSlotId, bDeep) \
+ const ItemType *pItem = (const ItemType*) \
+ SfxRequest::GetItem( pArgs, nSlotId, bDeep, TYPE(ItemType) )
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */