1*2e2212a7SAndrew Rist /************************************************************** 2cdf0e10cSrcweir * 3*2e2212a7SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*2e2212a7SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*2e2212a7SAndrew Rist * distributed with this work for additional information 6*2e2212a7SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*2e2212a7SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*2e2212a7SAndrew Rist * "License"); you may not use this file except in compliance 9*2e2212a7SAndrew Rist * with the License. You may obtain a copy of the License at 10*2e2212a7SAndrew Rist * 11*2e2212a7SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*2e2212a7SAndrew Rist * 13*2e2212a7SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*2e2212a7SAndrew Rist * software distributed under the License is distributed on an 15*2e2212a7SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*2e2212a7SAndrew Rist * KIND, either express or implied. See the License for the 17*2e2212a7SAndrew Rist * specific language governing permissions and limitations 18*2e2212a7SAndrew Rist * under the License. 19*2e2212a7SAndrew Rist * 20*2e2212a7SAndrew Rist *************************************************************/ 21*2e2212a7SAndrew Rist 22*2e2212a7SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir #ifndef DBACCESS_CONTROLLERFRAME_HXX 25cdf0e10cSrcweir #define DBACCESS_CONTROLLERFRAME_HXX 26cdf0e10cSrcweir 27cdf0e10cSrcweir /** === begin UNO includes === **/ 28cdf0e10cSrcweir #include <com/sun/star/frame/XFrame.hpp> 29cdf0e10cSrcweir #include <com/sun/star/frame/FrameAction.hpp> 30cdf0e10cSrcweir /** === end UNO includes === **/ 31cdf0e10cSrcweir 32cdf0e10cSrcweir #include <memory> 33cdf0e10cSrcweir 34cdf0e10cSrcweir //........................................................................ 35cdf0e10cSrcweir namespace dbaui 36cdf0e10cSrcweir { 37cdf0e10cSrcweir //........................................................................ 38cdf0e10cSrcweir 39cdf0e10cSrcweir class IController; 40cdf0e10cSrcweir 41cdf0e10cSrcweir //==================================================================== 42cdf0e10cSrcweir //= ControllerFrame 43cdf0e10cSrcweir //==================================================================== 44cdf0e10cSrcweir struct ControllerFrame_Data; 45cdf0e10cSrcweir /** helper class to ancapsulate the frame which a controller is plugged into, 46cdf0e10cSrcweir doing some common actions on it. 47cdf0e10cSrcweir */ 48cdf0e10cSrcweir class ControllerFrame 49cdf0e10cSrcweir { 50cdf0e10cSrcweir public: 51cdf0e10cSrcweir ControllerFrame( IController& _rController ); 52cdf0e10cSrcweir ~ControllerFrame(); 53cdf0e10cSrcweir 54cdf0e10cSrcweir /// attaches a new frame 55cdf0e10cSrcweir const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& 56cdf0e10cSrcweir attachFrame( 57cdf0e10cSrcweir const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& _rxFrame 58cdf0e10cSrcweir ); 59cdf0e10cSrcweir 60cdf0e10cSrcweir // retrieves the current frame 61cdf0e10cSrcweir const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& 62cdf0e10cSrcweir getFrame() const; 63cdf0e10cSrcweir 64cdf0e10cSrcweir /** determines whether the frame is currently active 65cdf0e10cSrcweir */ 66cdf0e10cSrcweir bool isActive() const; 67cdf0e10cSrcweir 68cdf0e10cSrcweir /** notifies the instance that a certain frame action happened with our frame 69cdf0e10cSrcweir */ 70cdf0e10cSrcweir void frameAction( ::com::sun::star::frame::FrameAction _eAction ); 71cdf0e10cSrcweir 72cdf0e10cSrcweir private: 73cdf0e10cSrcweir ::std::auto_ptr< ControllerFrame_Data > m_pData; 74cdf0e10cSrcweir }; 75cdf0e10cSrcweir 76cdf0e10cSrcweir //........................................................................ 77cdf0e10cSrcweir } // namespace dbaui 78cdf0e10cSrcweir //........................................................................ 79cdf0e10cSrcweir 80cdf0e10cSrcweir #endif // DBACCESS_CONTROLLERFRAME_HXX 81