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