framework/inc/helper/tagwindowasmodified.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: tagwindowasmodified.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __FRAMEWORK_HELPER_TAGWINDOWASMODIFIED_HXX_
  32 #define __FRAMEWORK_HELPER_TAGWINDOWASMODIFIED_HXX_
  33
  34 //_________________________________________________________________________________________________________________
  35 //      my own includes
  36 //_________________________________________________________________________________________________________________
  37
  38 #include <threadhelp/threadhelpbase.hxx>
  39 #include <macros/debug.hxx>
  40 #include <macros/xinterface.hxx>
  41 #include <macros/xtypeprovider.hxx>
  42 #include <general.h>
  43
  44 //_________________________________________________________________________________________________________________
  45 //      interface includes
  46 //_________________________________________________________________________________________________________________
  47 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  48 #include <com/sun/star/lang/XInitialization.hpp>
  49 #include <com/sun/star/frame/XFrame.hpp>
  50 #include <com/sun/star/util/XModifyListener.hpp>
  51 #include <com/sun/star/lang/XEventListener.hpp>
  52 #include <com/sun/star/frame/XFrameActionListener.hpp>
  53
  54 //_________________________________________________________________________________________________________________
  55 //      other includes
  56 //_________________________________________________________________________________________________________________
  57 #include <cppuhelper/weak.hxx>
  58
  59 //_________________________________________________________________________________________________________________
  60 //      const
  61 //_________________________________________________________________________________________________________________
  62
  63 //_________________________________________________________________________________________________________________
  64 //      namespace
  65 //_________________________________________________________________________________________________________________
  66
  67 namespace framework{
  68
  69 //_________________________________________________________________________________________________________________
  70 //      declarations
  71 //_________________________________________________________________________________________________________________
  72
  73 /*-************************************************************************************************************//**
  74     @short          listen for modify events on model and tag frame container window so it can react accordingly
  75     @descr          Used e.g. by our MAC port where such state is shown seperately on some controls of the
  76                     title bar.
  77
  78     @base           ThreadHelpBase
  79                         guarantee right initialized lock member during startup of instances of this class.
  80
  81     @base           OWeakObject
  82                         implements ref counting for this class.
  83
  84     @devstatus      draft
  85     @threadsafe     yes
  86     @modified       as96863
  87 *//*-*************************************************************************************************************/
  88 class TagWindowAsModified :   // interfaces
  89                               public css::lang::XTypeProvider,
  90                               public css::lang::XInitialization,
  91                               public css::frame::XFrameActionListener, // => XEventListener
  92                               public css::util::XModifyListener,       // => XEventListener
  93                               // baseclasses (order neccessary for right initialization!)
  94                               private ThreadHelpBase,
  95                               public  ::cppu::OWeakObject
  96 {
  97     //________________________________
  98     // member
  99
 100     private:
 101
 102         /// may we need an uno service manager to create own services
 103         css::uno::Reference< css::lang::XMultiServiceFactory > m_xSMGR;
 104
 105         /// reference to the frame, where we listen for new loaded documents for updating our own xModel reference
 106         css::uno::WeakReference< css::frame::XFrame > m_xFrame;
 107
 108         /// reference to the frame container window, where we must set the tag
 109         css::uno::WeakReference< css::awt::XWindow > m_xWindow;
 110
 111         /// we list on the model for modify events
 112         css::uno::WeakReference< css::frame::XModel > m_xModel;
 113
 114     //________________________________
 115     // interface
 116
 117     public:
 118
 119         //____________________________
 120         // ctor/dtor
 121                  TagWindowAsModified(const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR);
 122         virtual ~TagWindowAsModified(                                                                   );
 123
 124         //____________________________
 125         // XInterface, XTypeProvider
 126         FWK_DECLARE_XINTERFACE
 127         FWK_DECLARE_XTYPEPROVIDER
 128
 129         //____________________________
 130         // XInitialization
 131         virtual void SAL_CALL initialize(const css::uno::Sequence< css::uno::Any >& lArguments)
 132             throw(css::uno::Exception       ,
 133                   css::uno::RuntimeException);
 134
 135         //____________________________
 136         // XModifyListener
 137         virtual void SAL_CALL modified(const css::lang::EventObject& aEvent)
 138             throw(css::uno::RuntimeException);
 139
 140         //____________________________
 141         // XFrameActionListener
 142         virtual void SAL_CALL frameAction(const css::frame::FrameActionEvent& aEvent)
 143             throw(css::uno::RuntimeException);
 144
 145         //____________________________
 146         // XEventListener
 147         virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent)
 148             throw(css::uno::RuntimeException);
 149
 150     private:
 151
 152         //____________________________
 153         // @todo document me
 154         void impl_update(const css::uno::Reference< css::frame::XFrame >& xFrame);
 155
 156 }; // class TagWindowAsModified
 157
 158 } // namespace framework
 159
 160 #endif // #ifndef __FRAMEWORK_HELPER_TAGWINDOWASMODIFIED_HXX_