offapi/com/sun/star/frame/XController.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XController.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_frame_XController_idl__
  31 #define __com_sun_star_frame_XController_idl__
  32
  33 #ifndef __com_sun_star_lang_XComponent_idl__
  34 #include <com/sun/star/lang/XComponent.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39  module com {  module sun {  module star {  module frame {
  40
  41  published interface XFrame;
  42  published interface XModel;
  43
  44 //=============================================================================
  45 /** With this interface, components viewed in a <type>Frame</type> can serve
  46     events (by supplying dispatches).
  47
  48     @see XFrame
  49     @see com::sun::star::awt::XWindow
  50     @see XModel
  51  */
  52 published interface XController: com::sun::star::lang::XComponent
  53 {
  54     //-------------------------------------------------------------------------
  55     /** is called to attach the controller with its managing frame.
  56
  57         @param Frame
  58             the new owner frame of this controller
  59      */
  60     void attachFrame( [in] XFrame Frame );
  61
  62     //-------------------------------------------------------------------------
  63     /** is called to attach the controller to a new model.
  64
  65         @param Model
  66             the new model for this controller
  67
  68         @return
  69             <TRUE/>if attach was successfully
  70             <br>
  71             <FALSE/>otherwise
  72      */
  73     boolean attachModel( [in] XModel Model );
  74
  75     //-------------------------------------------------------------------------
  76     /** is called to prepare the controller for closing the view
  77
  78         @param Suspend
  79             <TRUE/>force the controller to suspend his work
  80             <FALSE/>try to reactivate the controller
  81
  82         @return
  83             <TRUE/>if request was accepted and of course successfully finished
  84             <br>
  85             <FALSE/>otherwise
  86      */
  87     boolean suspend( [in] boolean Suspend );
  88
  89     //-------------------------------------------------------------------------
  90     /** provides access to current view status
  91
  92         @returns
  93             set of data that can be used to restore the current view status
  94             at later time by using <member>XController::restoreViewData()</member>
  95      */
  96     any getViewData();
  97
  98     //-------------------------------------------------------------------------
  99     /** restores the view status using the data gotten from a previous call to
 100         <member>XController::getViewData()</member>.
 101
 102         @param Data
 103             set of data to restore it
 104      */
 105     void restoreViewData( [in] any Data );
 106
 107     //-------------------------------------------------------------------------
 108     /** provides access to currently attached model
 109
 110         @returns
 111             the currently attached model.
 112      */
 113     XModel getModel();
 114
 115     //-------------------------------------------------------------------------
 116     /** provides access to owner frame of this controller
 117
 118         @returns
 119             the frame containing this controller.
 120      */
 121     XFrame getFrame();
 122 };
 123
 124 //=============================================================================
 125
 126 }; }; }; };
 127
 128 #endif