1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_frame_XController_idl__ 24cdf0e10cSrcweir#define __com_sun_star_frame_XController_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_lang_XComponent_idl__ 27cdf0e10cSrcweir#include <com/sun/star/lang/XComponent.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir//============================================================================= 31cdf0e10cSrcweir 32cdf0e10cSrcweir module com { module sun { module star { module frame { 33cdf0e10cSrcweir 34cdf0e10cSrcweir published interface XFrame; 35cdf0e10cSrcweir published interface XModel; 36cdf0e10cSrcweir 37cdf0e10cSrcweir//============================================================================= 38cdf0e10cSrcweir/** With this interface, components viewed in a <type>Frame</type> can serve 39cdf0e10cSrcweir events (by supplying dispatches). 40cdf0e10cSrcweir 41cdf0e10cSrcweir @see XFrame 42cdf0e10cSrcweir @see com::sun::star::awt::XWindow 43cdf0e10cSrcweir @see XModel 44cdf0e10cSrcweir */ 45cdf0e10cSrcweirpublished interface XController: com::sun::star::lang::XComponent 46cdf0e10cSrcweir{ 47cdf0e10cSrcweir //------------------------------------------------------------------------- 48cdf0e10cSrcweir /** is called to attach the controller with its managing frame. 49cdf0e10cSrcweir 50cdf0e10cSrcweir @param Frame 51cdf0e10cSrcweir the new owner frame of this controller 52cdf0e10cSrcweir */ 53cdf0e10cSrcweir void attachFrame( [in] XFrame Frame ); 54cdf0e10cSrcweir 55cdf0e10cSrcweir //------------------------------------------------------------------------- 56cdf0e10cSrcweir /** is called to attach the controller to a new model. 57cdf0e10cSrcweir 58cdf0e10cSrcweir @param Model 59cdf0e10cSrcweir the new model for this controller 60cdf0e10cSrcweir 61cdf0e10cSrcweir @return 62cdf0e10cSrcweir <TRUE/>if attach was successfully 63cdf0e10cSrcweir <br> 64cdf0e10cSrcweir <FALSE/>otherwise 65cdf0e10cSrcweir */ 66cdf0e10cSrcweir boolean attachModel( [in] XModel Model ); 67cdf0e10cSrcweir 68cdf0e10cSrcweir //------------------------------------------------------------------------- 69cdf0e10cSrcweir /** is called to prepare the controller for closing the view 70cdf0e10cSrcweir 71cdf0e10cSrcweir @param Suspend 72cdf0e10cSrcweir <TRUE/>force the controller to suspend his work 73cdf0e10cSrcweir <FALSE/>try to reactivate the controller 74cdf0e10cSrcweir 75cdf0e10cSrcweir @return 76cdf0e10cSrcweir <TRUE/>if request was accepted and of course successfully finished 77cdf0e10cSrcweir <br> 78cdf0e10cSrcweir <FALSE/>otherwise 79cdf0e10cSrcweir */ 80cdf0e10cSrcweir boolean suspend( [in] boolean Suspend ); 81cdf0e10cSrcweir 82cdf0e10cSrcweir //------------------------------------------------------------------------- 83cdf0e10cSrcweir /** provides access to current view status 84cdf0e10cSrcweir 85cdf0e10cSrcweir @returns 86cdf0e10cSrcweir set of data that can be used to restore the current view status 87cdf0e10cSrcweir at later time by using <member>XController::restoreViewData()</member> 88cdf0e10cSrcweir */ 89cdf0e10cSrcweir any getViewData(); 90cdf0e10cSrcweir 91cdf0e10cSrcweir //------------------------------------------------------------------------- 92cdf0e10cSrcweir /** restores the view status using the data gotten from a previous call to 93cdf0e10cSrcweir <member>XController::getViewData()</member>. 94cdf0e10cSrcweir 95cdf0e10cSrcweir @param Data 96cdf0e10cSrcweir set of data to restore it 97cdf0e10cSrcweir */ 98cdf0e10cSrcweir void restoreViewData( [in] any Data ); 99cdf0e10cSrcweir 100cdf0e10cSrcweir //------------------------------------------------------------------------- 101cdf0e10cSrcweir /** provides access to currently attached model 102cdf0e10cSrcweir 103cdf0e10cSrcweir @returns 104cdf0e10cSrcweir the currently attached model. 105cdf0e10cSrcweir */ 106cdf0e10cSrcweir XModel getModel(); 107cdf0e10cSrcweir 108cdf0e10cSrcweir //------------------------------------------------------------------------- 109cdf0e10cSrcweir /** provides access to owner frame of this controller 110cdf0e10cSrcweir 111cdf0e10cSrcweir @returns 112cdf0e10cSrcweir the frame containing this controller. 113cdf0e10cSrcweir */ 114cdf0e10cSrcweir XFrame getFrame(); 115cdf0e10cSrcweir}; 116cdf0e10cSrcweir 117cdf0e10cSrcweir//============================================================================= 118cdf0e10cSrcweir 119cdf0e10cSrcweir}; }; }; }; 120cdf0e10cSrcweir 121cdf0e10cSrcweir#endif 122