include/dbaccess/controllerframe.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
  20 #ifndef INCLUDED_DBACCESS_CONTROLLERFRAME_HXX
  21 #define INCLUDED_DBACCESS_CONTROLLERFRAME_HXX
  22
  23 #include <com/sun/star/frame/XFrame.hpp>
  24 #include <com/sun/star/frame/FrameAction.hpp>
  25
  26 #include <memory>
  27
  28
  29 namespace dbaui
  30 {
  31
  32
  33     class IController;
  34
  35
  36     //= ControllerFrame
  37
  38     struct ControllerFrame_Data;
  39     /** helper class to ancapsulate the frame which a controller is plugged into,
  40         doing some common actions on it.
  41     */
  42     class ControllerFrame
  43     {
  44     public:
  45         ControllerFrame( IController& _rController );
  46         ~ControllerFrame();
  47
  48         /// attaches a new frame
  49         const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >&
  50                 attachFrame(
  51                     const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& _rxFrame
  52                 );
  53
  54         // retrieves the current frame
  55         const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >&
  56                 getFrame() const;
  57
  58         /** determines whether the frame is currently active
  59         */
  60         bool    isActive() const;
  61
  62         /** notifies the instance that a certain frame action happened with our frame
  63         */
  64         void    frameAction( ::com::sun::star::frame::FrameAction _eAction );
  65
  66     private:
  67         ::std::unique_ptr< ControllerFrame_Data > m_pData;
  68     };
  69
  70
  71 } // namespace dbaui
  72
  73
  74 #endif // INCLUDED_DBACCESS_CONTROLLERFRAME_HXX
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */