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