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

   1 /*************************************************************************
   2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   3 *
   4 * Copyright 2008 by Sun Microsystems, Inc.
   5 *
   6 * OpenOffice.org - a multi-platform office productivity suite
   7 *
   8 * $RCSfile: XController2.idl,v $
   9 *
  10 * $Revision: 1.2 $
  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_XController2_idl__
  31 #define __com_sun_star_frame_XController2_idl__
  32
  33 #include <com/sun/star/frame/XController.idl>
  34 #include <com/sun/star/awt/XWindow.idl>
  35
  36 //=============================================================================
  37
  38 module com {  module sun {  module star {  module frame {
  39
  40 //=============================================================================
  41
  42 /** extends the <type>XController</type> interface
  43
  44     @since OOo 3.0
  45 */
  46 interface XController2 : XController
  47 {
  48     /** denotes the &quot;root window&quot; of the controller.
  49
  50         <p>If the controller is plugged into a frame, this window acts as the
  51         frame's <code>ComponentWindow</code>.</p>
  52
  53         @see XFrame
  54     */
  55     [readonly, attribute] ::com::sun::star::awt::XWindow    ComponentWindow;
  56
  57     /** specifies the view name of the controller.
  58
  59         <p>A view name is a logical name, which can be used to create views of the same
  60         type. The name is meaningful only in conjunction with <member>XModel2::createViewController</member>
  61         - if it's passed there, a view/controller pair of the same type will be created.</p>
  62     */
  63     [readonly, attribute] string                            ViewControllerName;
  64 };
  65
  66 //=============================================================================
  67
  68 }; }; }; };
  69
  70 //=============================================================================
  71
  72 #endif
  73