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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_frame_XController_idl__
  20 #define __com_sun_star_frame_XController_idl__
  21
  22 #include <com/sun/star/lang/XComponent.idl>
  23
  24
  25  module com {  module sun {  module star {  module frame {
  26
  27  published interface XFrame;
  28  published interface XModel;
  29
  30 /** With this interface, components viewed in a Frame can serve
  31     events (by supplying dispatches).
  32
  33     @see XFrame
  34     @see com::sun::star::awt::XWindow
  35     @see XModel
  36  */
  37 published interface XController: com::sun::star::lang::XComponent
  38 {
  39     /** is called to attach the controller with its managing frame.
  40
  41         @param Frame
  42             the new owner frame of this controller
  43      */
  44     void attachFrame( [in] XFrame Frame );
  45
  46     /** is called to attach the controller to a new model.
  47
  48         @param Model
  49             the new model for this controller
  50
  51         @return
  52             `TRUE`if attach was successfully
  53             <br>
  54             `FALSE`otherwise
  55      */
  56     boolean attachModel( [in] XModel Model );
  57
  58     /** is called to prepare the controller for closing the view
  59
  60         @param Suspend
  61             `TRUE`force the controller to suspend his work
  62             `FALSE`try to reactivate the controller
  63
  64         @return
  65             `TRUE`if request was accepted and of course successfully finished
  66             <br>
  67             `FALSE`otherwise
  68      */
  69     boolean suspend( [in] boolean Suspend );
  70
  71     /** provides access to current view status
  72
  73         @returns
  74             set of data that can be used to restore the current view status
  75             at later time by using XController::restoreViewData()
  76      */
  77     any getViewData();
  78
  79     /** restores the view status using the data gotten from a previous call to
  80         XController::getViewData().
  81
  82         @param Data
  83             set of data to restore it
  84      */
  85     void restoreViewData( [in] any Data );
  86
  87     /** provides access to currently attached model
  88
  89         @returns
  90             the currently attached model.
  91      */
  92     XModel getModel();
  93
  94     /** provides access to owner frame of this controller
  95
  96         @returns
  97             the frame containing this controller.
  98      */
  99     XFrame getFrame();
 100 };
 101
 102
 103 }; }; }; };
 104
 105 #endif
 106
 107 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */