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 #include <tools/debug.hxx>
  27
  28 class SfxBindings;
  29
  30 class SFX2_DLLPUBLIC SfxControllerItem
  31 {
  32 private:
  33     sal_uInt16          nId;
  34     SfxControllerItem*  pNext; // to notify next ControllerItem
  35     SfxBindings*        pBindings;
  36     MapUnit             eFallbackCoreMetric;
  37
  38 public:
  39     SfxBindings &       GetBindings() {
  40                             DBG_ASSERT(pBindings, "no Bindings");
  41                             return *pBindings;
  42                         }
  43     const SfxBindings & GetBindings() const {
  44                             DBG_ASSERT(pBindings, "no Bindings");
  45                             return *pBindings;
  46                         }
  47
  48                         SfxControllerItem(); // for arrays
  49                         SfxControllerItem( sal_uInt16 nId, SfxBindings & );
  50     virtual             ~SfxControllerItem();
  51     virtual void        dispose();
  52
  53     void                Bind( sal_uInt16 nNewId, SfxBindings *);    // Register in SfxBindings
  54     void                UnBind();
  55     void                ReBind();
  56     bool                IsBound() const;
  57     void                ClearCache();
  58
  59     SfxControllerItem*  GetItemLink();
  60     SfxControllerItem*  ChangeItemLink( SfxControllerItem* pNewLink );
  61
  62     void                SetId( sal_uInt16 nItemId );
  63     sal_uInt16          GetId() const { return nId; }
  64
  65     virtual void        StateChanged( sal_uInt16 nSID, SfxItemState eState,
  66                                       const SfxPoolItem* pState );
  67
  68     virtual void        GetControlState( sal_uInt16 nSID, boost::property_tree::ptree& );
  69
  70     MapUnit             GetCoreMetric() const;
  71     // override what GetCoreMetric will return if it cannot determine the current CoreMetric
  72     void                SetFallbackCoreMetric(MapUnit eFallback)
  73     {
  74         eFallbackCoreMetric = eFallback;
  75     }
  76
  77     static SfxItemState GetItemState( const SfxPoolItem* pState );
  78
  79     SAL_DLLPRIVATE void BindInternal_Impl( sal_uInt16 nNewId, SfxBindings* );
  80 };
  81
  82
  83 class SFX2_DLLPUBLIC SfxStatusForwarder final : public SfxControllerItem
  84 {
  85     SfxControllerItem*      pMaster;
  86
  87     virtual void        StateChanged( sal_uInt16 nSID, SfxItemState eState,
  88                                       const SfxPoolItem* pState ) override;
  89
  90 public:
  91                             SfxStatusForwarder( sal_uInt16 nSlotId,
  92                                    SfxControllerItem&rMaster );
  93 };
  94
  95 #endif
  96
  97 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */