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