include/sfx2/ctrlitem.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_CTRLITEM_HXX
  20 #define INCLUDED_SFX2_CTRLITEM_HXX
  21
  22 #include <sal/config.h>
  23 #include <sfx2/dllapi.h>
  24 #include <sal/types.h>
  25 #include <svl/poolitem.hxx>
  26 #if defined( DBG_UTIL )
  27 #include <sfx2/msg.hxx>
  28 #endif
  29
  30 class SfxPoolItem;
  31 class SfxBindings;
  32 class SvStream;
  33
  34 class SFX2_DLLPUBLIC SfxControllerItem
  35 {
  36 private:
  37     sal_uInt16              nId;
  38     SfxControllerItem*  pNext; // to notify next ControllerItem
  39     SfxBindings*        pBindings;
  40
  41 public:
  42     SfxBindings &       GetBindings() {
  43                             DBG_ASSERT(pBindings, "no Bindings");
  44                             return *pBindings;
  45                         }
  46     const SfxBindings & GetBindings() const {
  47                             DBG_ASSERT(pBindings, "no Bindings");
  48                             return *pBindings;
  49                         }
  50
  51                         SfxControllerItem(); // for arrays
  52                         SfxControllerItem( sal_uInt16 nId, SfxBindings & );
  53     virtual             ~SfxControllerItem();
  54     virtual void        dispose();
  55
  56     void                Bind( sal_uInt16 nNewId, SfxBindings * = nullptr);    // Register in SfxBindings
  57     void                UnBind();
  58     void                ReBind();
  59     bool                IsBound() const;
  60     void                ClearCache();
  61
  62     SfxControllerItem*  GetItemLink();
  63     SfxControllerItem*  ChangeItemLink( SfxControllerItem* pNewLink );
  64
  65     void                SetId( sal_uInt16 nItemId );
  66     sal_uInt16          GetId() const { return nId; }
  67
  68     virtual void        StateChanged( sal_uInt16 nSID, SfxItemState eState,
  69                                       const SfxPoolItem* pState );
  70
  71     SfxMapUnit          GetCoreMetric() const;
  72
  73     static SfxItemState GetItemState( const SfxPoolItem* pState );
  74
  75     SAL_DLLPRIVATE void BindInternal_Impl( sal_uInt16 nNewId, SfxBindings* );
  76 };
  77
  78
  79 class SFX2_DLLPUBLIC SfxStatusForwarder: public SfxControllerItem
  80 {
  81     SfxControllerItem*      pMaster;
  82
  83 protected:
  84     virtual void        StateChanged( sal_uInt16 nSID, SfxItemState eState,
  85                                       const SfxPoolItem* pState ) override;
  86
  87 public:
  88                             SfxStatusForwarder( sal_uInt16 nSlotId,
  89                                    SfxControllerItem&rMaster );
  90 };
  91
  92 #endif
  93
  94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */