office-gobmx/include/sfx2/dispatch.hxx

/* -*- 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_DISPATCH_HXX
#define INCLUDED_SFX2_DISPATCH_HXX

#include <memory>
#include <span>
#include <sal/config.h>
#include <rtl/ref.hxx>
#include <sfx2/dllapi.h>
#include <sfx2/toolbarids.hxx>
#include <sal/types.h>

#include <sfx2/bindings.hxx>
#include <o3tl/typed_flags_set.hxx>

#include <boost/property_tree/ptree_fwd.hpp>
#include <initializer_list>

class SfxSlotServer;
class SfxRequest;
class SfxViewFrame;
class SfxItemSet;
class SfxModule;
class Point;
struct SfxDispatcher_Impl;
class VCLXPopupMenu;
class SfxPoolItemHolder;

namespace com::sun::star::awt { class XPopupMenu; }
namespace vcl { class Window; }

enum class SfxDispatcherPopFlags
{
    NONE          = 0,
    POP_UNTIL     = 4,
    POP_DELETE    = 2,
    PUSH          = 1,
};
namespace o3tl
{
    template<> struct typed_flags<SfxDispatcherPopFlags> : is_typed_flags<SfxDispatcherPopFlags, 0x07> {};
}

enum class SfxSlotFilterState
{
    DISABLED,
    ENABLED,
    // enabled even if ReadOnlyDoc
    ENABLED_READONLY,
};


class SFX2_DLLPUBLIC SfxDispatcher final
{
    std::unique_ptr<SfxDispatcher_Impl> xImp;

    // Search for temporary evaluated Todos
    SAL_DLLPRIVATE bool CheckVirtualStack( const SfxShell& rShell );

friend class SfxApplication;
friend class SfxViewFrame;
friend class SfxBindings;
friend class SfxStateCache;
friend class SfxPopupMenuManager;
friend class SfxHelp;
friend class SfxHintPoster;

    DECL_DLLPRIVATE_LINK( EventHdl_Impl, Timer *, void );
    void PostMsgHandler(std::unique_ptr<SfxRequest>);

    SAL_DLLPRIVATE void Call_Impl( SfxShell& rShell, const SfxSlot &rSlot, SfxRequest &rReq, bool bRecord );
    SAL_DLLPRIVATE void Update_Impl_( bool,bool,bool,SfxWorkWindow*);


    bool                FindServer_( sal_uInt16 nId, SfxSlotServer &rServer );
    static bool                IsCommandAllowedInLokReadOnlyViewMode (OUString commandName);
    bool                FillState_( const SfxSlotServer &rServer,
                                    SfxItemSet &rState, const SfxSlot *pRealSlot );
    void                Execute_( SfxShell &rShell, const SfxSlot &rSlot,
                                  SfxRequest &rReq,
                                  SfxCallMode eCall);

    void FlushImpl();

public:
                        SfxDispatcher();
                        SfxDispatcher( SfxViewFrame *pFrame );

    SAL_DLLPRIVATE void Construct_Impl();

                        ~SfxDispatcher();

    SfxPoolItemHolder   Execute( sal_uInt16 nSlot,
                                 SfxCallMode nCall = SfxCallMode::SLOT,
                                 const SfxPoolItem **pArgs = nullptr,
                                 sal_uInt16 nModi = 0,
                                 const SfxPoolItem **pInternalArgs = nullptr);

    SfxPoolItemHolder   Execute(sal_uInt16 nSlot,
                                SfxCallMode nCall,
                                SfxItemSet const * pArgs,
                                SfxItemSet const * pInternalArgs,
                                sal_uInt16 nModi);

    SfxPoolItemHolder   ExecuteList(sal_uInt16 nSlot,
                                    SfxCallMode nCall,
                                    std::initializer_list<SfxPoolItem const*> args,
                                    std::initializer_list<SfxPoolItem const*> internalargs = std::initializer_list<SfxPoolItem const*>());

    SfxPoolItemHolder   Execute( sal_uInt16 nSlot,
                                 SfxCallMode nCall,
                                 const SfxItemSet &rArgs );

    const SfxSlot*      GetSlot( const OUString& rCommand );

    bool                IsActive( const SfxShell& rShell );
    sal_uInt16          GetShellLevel( const SfxShell &rShell );
    SAL_RET_MAYBENULL SfxBindings* GetBindings() const;

    void                Push( SfxShell& rShell );
    void                Pop( SfxShell& rShell, SfxDispatcherPopFlags nMode = SfxDispatcherPopFlags::NONE );

    SAL_RET_MAYBENULL SfxShell* GetShell(sal_uInt16 nIdx) const;
    SfxViewFrame*       GetFrame() const;
    SfxModule*          GetModule() const;

    void                ExecutePopup( const OUString &rResName, vcl::Window *pWin = nullptr, const Point *pPos = nullptr );
    static void         ExecutePopup( vcl::Window *pWin = nullptr, const Point *pPosPixel = nullptr );

    bool                IsAppDispatcher() const;
    bool                IsFlushed() const;
    void                Flush();
    void                Lock( bool bLock );
    bool                IsLocked() const;
    void                SetSlotFilter( SfxSlotFilterState nEnable = SfxSlotFilterState::DISABLED,
                                       std::span<sal_uInt16 const> pSIDs = std::span<sal_uInt16 const>());

    void                HideUI( bool bHide = true );
    ToolbarId           GetObjectBarId( sal_uInt16 nPos ) const;

    SfxItemState        QueryState( sal_uInt16 nSID, SfxPoolItemHolder& rState );
    SfxItemState        QueryState( sal_uInt16 nSID, css::uno::Any& rAny );

    void                SetDisableFlags( SfxDisableFlags nFlags );
    SfxDisableFlags     GetDisableFlags() const;

    SAL_DLLPRIVATE void SetMenu_Impl();
    SAL_DLLPRIVATE void Update_Impl( bool bForce = false ); // ObjectBars etc.
    SAL_DLLPRIVATE bool IsUpdated_Impl() const;
    SAL_DLLPRIVATE bool GetShellAndSlot_Impl( sal_uInt16 nSlot, SfxShell **ppShell, const SfxSlot **ppSlot,
                                              bool bOwnShellsOnly, bool bRealSlot );
    SAL_DLLPRIVATE void SetReadOnly_Impl( bool  bOn );
    SAL_DLLPRIVATE bool GetReadOnly_Impl() const;
    SAL_DLLPRIVATE SfxSlotFilterState IsSlotEnabledByFilter_Impl( sal_uInt16 nSID ) const;
    SAL_DLLPRIVATE void SetQuietMode_Impl( bool bOn );
    SAL_DLLPRIVATE bool IsReadOnlyShell_Impl( sal_uInt16 nShell ) const;
    SAL_DLLPRIVATE void RemoveShell_Impl( SfxShell& rShell );
    SAL_DLLPRIVATE void DoActivate_Impl( bool bMDI );
    SAL_DLLPRIVATE void DoDeactivate_Impl( bool bMDI, SfxViewFrame const * pNew );
    SAL_DLLPRIVATE void InvalidateBindings_Impl(bool);

    static boost::property_tree::ptree fillPopupMenu(const rtl::Reference<VCLXPopupMenu>& rMenu);
};

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */