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
  20
  21  module com {  module sun {  module star {  module frame {
  22
  23  published interface XFrame;
  24  published interface XModel;
  25
  26 /** With this interface, components viewed in a Frame can serve
  27     events (by supplying dispatches).
  28
  29     @see XFrame
  30     @see com::sun::star::awt::XWindow
  31     @see XModel
  32  */
  33 published interface XController: com::sun::star::lang::XComponent
  34 {
  35     /** is called to attach the controller with its managing frame.
  36
  37         @param Frame
  38             the new owner frame of this controller
  39      */
  40     void attachFrame( [in] XFrame Frame );
  41
  42     /** is called to attach the controller to a new model.
  43
  44         @param Model
  45             the new model for this controller
  46
  47         @return
  48             `TRUE` If attaching was successful
  49             <br>
  50             `FALSE` Otherwise
  51      */
  52     boolean attachModel( [in] XModel Model );
  53
  54     /** is called to prepare the controller for closing the view
  55
  56         @param Suspend
  57             `TRUE` Force the controller to suspend his work
  58             `FALSE` Try to reactivate the controller
  59
  60         @return
  61             `TRUE` If request was accepted and successfully finished
  62             <br>
  63             `FALSE` Otherwise
  64      */
  65     boolean suspend( [in] boolean Suspend );
  66
  67     /** provides access to current view status
  68
  69         @returns
  70             set of data that can be used to restore the current view status
  71             at later time by using XController::restoreViewData()
  72      */
  73     any getViewData();
  74
  75     /** restores the view status using the data gotten from a previous call to
  76         XController::getViewData().
  77
  78         @param Data
  79             set of data to restore it
  80      */
  81     void restoreViewData( [in] any Data );
  82
  83     /** provides access to currently attached model
  84
  85         @returns
  86             the currently attached model.
  87      */
  88     XModel getModel();
  89
  90     /** provides access to owner frame of this controller
  91
  92         @returns
  93             the frame containing this controller.
  94      */
  95     XFrame getFrame();
  96 };
  97
  98
  99 }; }; }; };
 100
 101 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */