dbaccess/inc/controllerframe.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: controllerframe.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 DBACCESS_CONTROLLERFRAME_HXX
  32 #define DBACCESS_CONTROLLERFRAME_HXX
  33
  34 /** === begin UNO includes === **/
  35 #include <com/sun/star/frame/XFrame.hpp>
  36 #include <com/sun/star/frame/FrameAction.hpp>
  37 /** === end UNO includes === **/
  38
  39 #include <memory>
  40
  41 //........................................................................
  42 namespace dbaui
  43 {
  44 //........................................................................
  45
  46     class IController;
  47
  48     //====================================================================
  49     //= ControllerFrame
  50     //====================================================================
  51     struct ControllerFrame_Data;
  52     /** helper class to ancapsulate the frame which a controller is plugged into,
  53         doing some common actions on it.
  54     */
  55     class ControllerFrame
  56     {
  57     public:
  58         ControllerFrame( IController& _rController );
  59         ~ControllerFrame();
  60
  61         /// attaches a new frame
  62         const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >&
  63                 attachFrame(
  64                     const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& _rxFrame
  65                 );
  66
  67         // retrieves the current frame
  68         const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >&
  69                 getFrame() const;
  70
  71         /** determines whether the frame is currently active
  72         */
  73         bool    isActive() const;
  74
  75         /** notifies the instance that a certain frame action happened with our frame
  76         */
  77         void    frameAction( ::com::sun::star::frame::FrameAction _eAction );
  78
  79     private:
  80         ::std::auto_ptr< ControllerFrame_Data > m_pData;
  81     };
  82
  83 //........................................................................
  84 } // namespace dbaui
  85 //........................................................................
  86
  87 #endif // DBACCESS_CONTROLLERFRAME_HXX