dbaccess/inc/controllerframe.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef DBACCESS_CONTROLLERFRAME_HXX
  30 #define DBACCESS_CONTROLLERFRAME_HXX
  31
  32 /** === begin UNO includes === **/
  33 #include <com/sun/star/frame/XFrame.hpp>
  34 #include <com/sun/star/frame/FrameAction.hpp>
  35 /** === end UNO includes === **/
  36
  37 #include <memory>
  38
  39 //........................................................................
  40 namespace dbaui
  41 {
  42 //........................................................................
  43
  44     class IController;
  45
  46     //====================================================================
  47     //= ControllerFrame
  48     //====================================================================
  49     struct ControllerFrame_Data;
  50     /** helper class to ancapsulate the frame which a controller is plugged into,
  51         doing some common actions on it.
  52     */
  53     class ControllerFrame
  54     {
  55     public:
  56         ControllerFrame( IController& _rController );
  57         ~ControllerFrame();
  58
  59         /// attaches a new frame
  60         const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >&
  61                 attachFrame(
  62                     const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& _rxFrame
  63                 );
  64
  65         // retrieves the current frame
  66         const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >&
  67                 getFrame() const;
  68
  69         /** determines whether the frame is currently active
  70         */
  71         bool    isActive() const;
  72
  73         /** notifies the instance that a certain frame action happened with our frame
  74         */
  75         void    frameAction( ::com::sun::star::frame::FrameAction _eAction );
  76
  77     private:
  78         ::std::auto_ptr< ControllerFrame_Data > m_pData;
  79     };
  80
  81 //........................................................................
  82 } // namespace dbaui
  83 //........................................................................
  84
  85 #endif // DBACCESS_CONTROLLERFRAME_HXX
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */