include/sfx2/dispatch.hxx

   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 #ifndef INCLUDED_SFX2_DISPATCH_HXX
  20 #define INCLUDED_SFX2_DISPATCH_HXX
  21
  22 #include <sal/config.h>
  23 #include <sfx2/dllapi.h>
  24 #include <sal/types.h>
  25
  26 #include <stdarg.h>
  27
  28 #include <sfx2/bindings.hxx>
  29 #include <sfx2/viewfrm.hxx>
  30 #include <deque>
  31 #include <map>
  32 #include <vector>
  33
  34 class SfxSlotServer;
  35 class SfxShell;
  36 class SfxRequest;
  37 class SfxHintPoster;
  38 class SfxViewFrame;
  39 class SfxBindings;
  40 class SfxItemSet;
  41 class SfxPopupMenuManager;
  42 class SfxModule;
  43 struct SfxDispatcher_Impl;
  44
  45 typedef std::vector<SfxShell*> SfxShellStack_Impl;
  46
  47 namespace com
  48 {
  49     namespace sun
  50     {
  51         namespace star
  52         {
  53             namespace frame
  54             {
  55                 class XDispatch;
  56             }
  57         }
  58     }
  59 }
  60
  61 //=========================================================================
  62
  63 #define SFX_SHELL_POP_UNTIL     4
  64 #define SFX_SHELL_POP_DELETE    2
  65 #define SFX_SHELL_PUSH          1
  66
  67 //=========================================================================
  68
  69 // Maps the Which() field to a pointer to a SfxPoolItem
  70 class SfxItemPtrMap : public std::map<sal_uInt16, SfxPoolItem*>
  71 {
  72 public:
  73     ~SfxItemPtrMap()
  74     {
  75         for(iterator it = begin(); it != end(); ++it)
  76             delete it->second;
  77     }
  78 };
  79
  80 struct SfxToDo_Impl
  81 {
  82     SfxShell*  pCluster;
  83     bool       bPush;
  84     bool       bDelete;
  85     bool       bDeleted;
  86     bool       bUntil;
  87
  88     SfxToDo_Impl()
  89         : pCluster(0)
  90         , bPush(false)
  91         , bDelete(false)
  92         , bDeleted(false)
  93         , bUntil(false)
  94                 {}
  95     SfxToDo_Impl( bool bOpPush, bool bOpDelete, bool bOpUntil, SfxShell& rCluster )
  96         : pCluster(&rCluster)
  97         , bPush(bOpPush)
  98         , bDelete(bOpDelete)
  99         , bDeleted(false)
 100         , bUntil(bOpUntil)
 101                 {}
 102
 103     bool operator==( const SfxToDo_Impl& rWith ) const
 104     { return pCluster==rWith.pCluster && bPush==rWith.bPush; }
 105 };
 106
 107 class SFX2_DLLPUBLIC SfxDispatcher
 108 {
 109     SfxDispatcher_Impl*      pImp;
 110     sal_Bool                 bFlushed;
 111     std::deque< std::deque<SfxToDo_Impl> > aToDoCopyStack;
 112
 113 private:
 114     // Search for temporary evaluated Todos
 115     SAL_DLLPRIVATE sal_Bool CheckVirtualStack( const SfxShell& rShell, sal_Bool bDeep );
 116
 117 #ifndef _SFX_HXX
 118
 119 friend class SfxApplication;
 120 friend class SfxViewFrame;
 121
 122     DECL_DLLPRIVATE_LINK( EventHdl_Impl, void * );
 123     DECL_DLLPRIVATE_LINK( PostMsgHandler, SfxRequest * );
 124
 125     SAL_DLLPRIVATE int Call_Impl( SfxShell& rShell, const SfxSlot &rSlot, SfxRequest &rReq, sal_Bool bRecord );
 126     SAL_DLLPRIVATE void _Update_Impl( sal_Bool,sal_Bool,sal_Bool,SfxWorkWindow*);
 127     SAL_DLLPRIVATE void CollectTools_Impl(SfxWorkWindow*);
 128
 129 protected:
 130 friend class SfxBindings;
 131 friend class SfxStateCache;
 132 friend class SfxPopupMenuManager;
 133 friend class SfxHelp;
 134                         // For bindings: Finding the Message;
 135                         // level for re-access
 136     SAL_DLLPRIVATE sal_Bool _TryIntercept_Impl( sal_uInt16 nId, SfxSlotServer &rServer, sal_Bool bModal );
 137     sal_Bool                _FindServer( sal_uInt16 nId, SfxSlotServer &rServer, sal_Bool bModal );
 138     sal_Bool                _FillState( const SfxSlotServer &rServer,
 139                                     SfxItemSet &rState, const SfxSlot *pRealSlot );
 140     void                _Execute( SfxShell &rShell, const SfxSlot &rSlot,
 141                                   SfxRequest &rReq,
 142                                   SfxCallMode eCall = SFX_CALLMODE_STANDARD);
 143 #endif
 144 protected:
 145     void FlushImpl();
 146
 147 public:
 148                         SfxDispatcher( SfxDispatcher* pParent );
 149                         SfxDispatcher( SfxViewFrame *pFrame = 0 );
 150
 151     SAL_DLLPRIVATE void Construct_Impl( SfxDispatcher* pParent );
 152
 153     virtual             ~SfxDispatcher();
 154
 155     const SfxPoolItem*  Execute( sal_uInt16 nSlot,
 156                                  SfxCallMode nCall = SFX_CALLMODE_SLOT,
 157                                  const SfxPoolItem **pArgs = 0,
 158                                  sal_uInt16 nModi = 0,
 159                                  const SfxPoolItem **pInternalArgs = 0);
 160
 161     const SfxPoolItem*  Execute( sal_uInt16 nSlot,
 162                                  SfxCallMode nCall,
 163                                  SfxItemSet* pArgs,
 164                                  SfxItemSet* pInternalArgs,
 165                                  sal_uInt16 nModi = 0);
 166
 167     const SfxPoolItem*  Execute( sal_uInt16 nSlot,
 168                                  SfxCallMode nCall,
 169                                  const SfxPoolItem *pArg1, ... );
 170
 171     const SfxPoolItem*  Execute( sal_uInt16 nSlot,
 172                                  SfxCallMode nCall,
 173                                  const SfxItemSet &rArgs );
 174
 175     const SfxPoolItem*  Execute( sal_uInt16 nSlot,
 176                                  SfxCallMode nCall,
 177                                  sal_uInt16 nModi,
 178                                  const SfxItemSet &rArgs );
 179
 180     const SfxSlot*      GetSlot( const OUString& rCommand );
 181
 182     sal_Bool                IsActive( const SfxShell& rShell );
 183     sal_Bool                IsOnTop( const SfxShell& rShell );
 184     sal_uInt16              GetShellLevel( const SfxShell &rShell );
 185     SfxBindings*        GetBindings() const;
 186
 187     void                Push( SfxShell& rShell );
 188     void                Pop( SfxShell& rShell, sal_uInt16 nMode = 0 );
 189
 190     SfxShell*           GetShell(sal_uInt16 nIdx) const;
 191     SfxViewFrame*       GetFrame() const;
 192     SfxModule*      GetModule() const;
 193     // caller has to clean up the Manager on his own
 194     static SfxPopupMenuManager* Popup( sal_uInt16 nConfigId,Window *pWin, const Point *pPos );
 195
 196     void                ExecutePopup( const ResId &rId,
 197                               Window *pWin = 0, const Point *pPosPixel = 0 );
 198     static void         ExecutePopup( sal_uInt16 nConfigId = 0,
 199                               Window *pWin = 0, const Point *pPosPixel = 0 );
 200
 201     sal_Bool            IsAppDispatcher() const;
 202     sal_Bool            IsFlushed() const;
 203     void                Flush();
 204     void                Lock( sal_Bool bLock );
 205     sal_Bool                IsLocked( sal_uInt16 nSID = 0 ) const;
 206     void                SetSlotFilter( sal_Bool bEnable = sal_False,
 207                                        sal_uInt16 nCount = 0, const sal_uInt16 *pSIDs = 0 );
 208
 209     void                HideUI( sal_Bool bHide = sal_True );
 210     void                ShowObjectBar(sal_uInt16 nId, SfxShell *pShell=0) const;
 211     sal_uInt32          GetObjectBarId( sal_uInt16 nPos ) const;
 212
 213     SfxItemState        QueryState( sal_uInt16 nSID, const SfxPoolItem* &rpState );
 214     SfxItemState        QueryState( sal_uInt16 nSID, ::com::sun::star::uno::Any& rAny );
 215
 216     ::com::sun::star::frame::XDispatch*          GetDispatchInterface( const OUString& );
 217     void                SetDisableFlags( sal_uInt32 nFlags );
 218     sal_uInt32              GetDisableFlags() const;
 219
 220     SAL_DLLPRIVATE void SetMenu_Impl();
 221     SAL_DLLPRIVATE void Update_Impl( sal_Bool bForce = sal_False ); // ObjectBars etc.
 222     SAL_DLLPRIVATE sal_Bool IsUpdated_Impl() const;
 223     SAL_DLLPRIVATE int GetShellAndSlot_Impl( sal_uInt16 nSlot, SfxShell **ppShell, const SfxSlot **ppSlot,
 224                                               sal_Bool bOwnShellsOnly, sal_Bool bModal, sal_Bool bRealSlot=sal_True );
 225     SAL_DLLPRIVATE void SetReadOnly_Impl( sal_Bool  bOn );
 226     SAL_DLLPRIVATE sal_Bool GetReadOnly_Impl() const;
 227     SAL_DLLPRIVATE sal_Bool IsSlotEnabledByFilter_Impl( sal_uInt16 nSID ) const;
 228     SAL_DLLPRIVATE void SetQuietMode_Impl( sal_Bool bOn );
 229     SAL_DLLPRIVATE sal_Bool IsReadOnlyShell_Impl( sal_uInt16 nShell ) const;
 230     SAL_DLLPRIVATE void RemoveShell_Impl( SfxShell& rShell );
 231     SAL_DLLPRIVATE void DoParentActivate_Impl();
 232     SAL_DLLPRIVATE void DoParentDeactivate_Impl();
 233     SAL_DLLPRIVATE void DoActivate_Impl( sal_Bool bMDI, SfxViewFrame* pOld );
 234     SAL_DLLPRIVATE void DoDeactivate_Impl( sal_Bool bMDI, SfxViewFrame* pNew );
 235     SAL_DLLPRIVATE void InvalidateBindings_Impl(sal_Bool);
 236     SAL_DLLPRIVATE sal_uInt16 GetNextToolBox_Impl( sal_uInt16 nPos, sal_uInt16 nType, OUString *pStr );
 237 };
 238
 239 //--------------------------------------------------------------------
 240
 241 inline sal_Bool SfxDispatcher::IsFlushed() const
 242
 243 /*  [Description]
 244
 245     This method checks if the stack of the SfxDispatchers is flushed, or if
 246     push- or pop- commands are pending.
 247 */
 248
 249 {
 250      return bFlushed;
 251 }
 252
 253 //--------------------------------------------------------------------
 254
 255 inline void SfxDispatcher::Flush()
 256
 257 /*  [Description]
 258
 259     This method performs outstanding push- and pop- commands. For <SfxShell>s,
 260     which are new on the stack, the <SfxShell::Activate(sal_Bool)> is invoked with
 261     bMDI == sal_True, for SfxShells that are removed from the stack, the
 262     <SfxShell::Deactivate(sal_Bool)> is invoked with bMDI == sal_True
 263 */
 264
 265 {
 266     if ( !bFlushed ) FlushImpl();
 267 }
 268
 269 //--------------------------------------------------------------------
 270
 271 inline void SfxDispatcher::Push( SfxShell& rShell )
 272
 273 /*  [Description]
 274
 275     With this method, a <SfxShell> pushed on to the SfxDispatcher.
 276     The SfxShell is first marked for push and a timer is set up.
 277     First when the timer has couted down to zero the push
 278     ( <SfxDispatcher::Flush()> ) is actually performed and the
 279     <SfxBindings> is invalidated. While the timer is counting down
 280     the opposing push and pop commands on the same SfxShell are
 281     leveled out.
 282 */
 283
 284 {
 285     Pop( rShell, SFX_SHELL_PUSH );
 286 }
 287
 288 //--------------------------------------------------------------------
 289
 290 inline sal_Bool SfxDispatcher::IsActive( const SfxShell& rShell )
 291
 292 /*  [Description]
 293
 294     This method checks whether a particular <SfxShell> instance is
 295     on the SfxDispatcher.
 296
 297     [Return value]
 298
 299     sal_Bool                sal_True
 300                         The SfxShell instance is on the SfxDispatcher.
 301
 302                         sal_False
 303                         The SfxShell instance is not on the SfxDispatcher.
 304 */
 305
 306 {
 307     return CheckVirtualStack( rShell, sal_True );
 308 }
 309 //--------------------------------------------------------------------
 310
 311 inline sal_Bool SfxDispatcher::IsOnTop( const SfxShell& rShell )
 312
 313 /*  [Description]
 314
 315     This method checks whether a particular <SfxShell> instance is on
 316     top of the SfxDispatcher.
 317
 318     [Return value]
 319
 320     sal_Bool                sal_True
 321                         The SfxShell instance is on the top of
 322                         the SfxDispatcher.
 323
 324                         sal_False
 325                         The SfxShell instance is not on the top of
 326                         the SfxDispatcher.
 327 */
 328
 329 {
 330     return CheckVirtualStack( rShell, sal_False );
 331 }
 332
 333 //--------------------------------------------------------------------
 334
 335 #endif
 336
 337 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */