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 protected:
  42 #if defined( DBG_UTIL )
  43     SAL_DLLPRIVATE void CheckConfigure_Impl( SfxSlotMode nType );
  44 #endif
  45
  46 public:
  47     SfxBindings &       GetBindings() {
  48                             DBG_ASSERT(pBindings, "no Bindings");
  49                             return *pBindings;
  50                         }
  51     const SfxBindings & GetBindings() const {
  52                             DBG_ASSERT(pBindings, "no Bindings");
  53                             return *pBindings;
  54                         }
  55
  56                         SfxControllerItem(); // for arrays
  57                         SfxControllerItem( sal_uInt16 nId, SfxBindings & );
  58     virtual             ~SfxControllerItem();
  59     virtual void        dispose();
  60
  61     void                Bind( sal_uInt16 nNewId, SfxBindings * = 0);    // Register in SfxBindings
  62     void                UnBind();
  63     void                ReBind();
  64     bool                IsBound() const;
  65     void                ClearCache();
  66     void                SetBindings(SfxBindings &rBindings) { pBindings = &rBindings; }
  67
  68     SfxControllerItem*  GetItemLink();
  69     SfxControllerItem*  ChangeItemLink( SfxControllerItem* pNewLink );
  70
  71     void                SetId( sal_uInt16 nItemId );
  72     sal_uInt16          GetId() const { return nId; }
  73
  74     virtual void        StateChanged( sal_uInt16 nSID, SfxItemState eState,
  75                                       const SfxPoolItem* pState );
  76
  77     SfxMapUnit          GetCoreMetric() const;
  78
  79     static SfxItemState GetItemState( const SfxPoolItem* pState );
  80
  81     SAL_DLLPRIVATE bool IsBindable_Impl() const
  82                         { return pBindings != NULL; }
  83     SAL_DLLPRIVATE void BindInternal_Impl( sal_uInt16 nNewId, SfxBindings* );
  84 };
  85
  86
  87
  88 class SFX2_DLLPUBLIC SfxStatusForwarder: public SfxControllerItem
  89 {
  90     SfxControllerItem*      pMaster;
  91
  92 protected:
  93     virtual void        StateChanged( sal_uInt16 nSID, SfxItemState eState,
  94                                       const SfxPoolItem* pState ) SAL_OVERRIDE;
  95
  96 public:
  97                             SfxStatusForwarder( sal_uInt16 nSlotId,
  98                                    SfxControllerItem&rMaster );
  99 };
 100
 101 #endif
 102
 103 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */