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

   1 /*************************************************************************
   2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   3  *
   4  * Copyright 2000, 2010 Oracle and/or its affiliates.
   5  *
   6  * OpenOffice.org - a multi-platform office productivity suite
   7  *
   8  * This file is part of OpenOffice.org.
   9  *
  10  * OpenOffice.org is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Lesser General Public License version 3
  12  * only, as published by the Free Software Foundation.
  13  *
  14  * OpenOffice.org is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Lesser General Public License version 3 for more details
  18  * (a copy is included in the LICENSE file that accompanied this code).
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * version 3 along with OpenOffice.org.  If not, see
  22  * <http://www.openoffice.org/license.html>
  23  * for a copy of the LGPLv3 License.
  24  *
  25 ************************************************************************/
  26
  27 #ifndef __com_sun_star_frame_XController2_idl__
  28 #define __com_sun_star_frame_XController2_idl__
  29
  30 #include <com/sun/star/frame/XController.idl>
  31 #include <com/sun/star/awt/XWindow.idl>
  32 #include <com/sun/star/beans/PropertyValue.idl>
  33
  34 //=============================================================================
  35
  36 module com {  module sun {  module star {  module frame {
  37
  38 //=============================================================================
  39
  40 /** extends the <type>XController</type> interface
  41
  42     @since OOo 3.0
  43 */
  44 interface XController2 : XController
  45 {
  46     /** denotes the &quot;root window&quot; of the controller.
  47
  48         <p>If the controller is plugged into a frame, this window acts as the
  49         frame's <code>ComponentWindow</code>.</p>
  50
  51         @see XFrame
  52     */
  53     [readonly, attribute] ::com::sun::star::awt::XWindow    ComponentWindow;
  54
  55     /** specifies the view name of the controller.
  56
  57         <p>A view name is a logical name, which can be used to create views of the same
  58         type. The name is meaningful only in conjunction with <member>XModel2::createViewController</member>
  59         - if it's passed there, a view/controller pair of the same type will be created.</p>
  60     */
  61     [readonly, attribute] string                            ViewControllerName;
  62
  63     /** denotes the arguments used to create the instance.
  64
  65         <p>Usually, controllers are created via <member>XModel2::createViewController</member>, where the
  66         caller can pass not only a controller name, but also arguments parametrizing the to-be-created instance.
  67         Those arguments used at creation time can subsequently be retrieved using the <code>CreationArguments</code>
  68         member.</p>
  69     */
  70     [readonly, attribute] sequence< ::com::sun::star::beans::PropertyValue >
  71                                                             CreationArguments;
  72 };
  73
  74 //=============================================================================
  75
  76 }; }; }; };
  77
  78 //=============================================================================
  79
  80 #endif
  81