offapi/com/sun/star/frame/XController2.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
  24 /** extends the XController interface
  25
  26     @since OOo 3.0
  27 */
  28 interface XController2 : XController
  29 {
  30     /** denotes the &quot;root window&quot; of the controller.
  31
  32         <p>If the controller is plugged into a frame, this window acts as the
  33         frame's <code>ComponentWindow</code>.</p>
  34
  35         @see XFrame
  36     */
  37     [readonly, attribute] ::com::sun::star::awt::XWindow    ComponentWindow;
  38
  39     /** specifies the view name of the controller.
  40
  41         <p>A view name is a logical name, which can be used to create views of the same
  42         type. The name is meaningful only in conjunction with XModel2::createViewController()
  43         - if it's passed there, a view/controller pair of the same type will be created.</p>
  44     */
  45     [readonly, attribute] string                            ViewControllerName;
  46
  47     /** denotes the arguments used to create the instance.
  48
  49         <p>Usually, controllers are created via XModel2::createViewController(), where the
  50         caller can pass not only a controller name, but also arguments parameterizing the to-be-created instance.
  51         Those arguments used at creation time can subsequently be retrieved using the <code>CreationArguments</code>
  52         member.</p>
  53     */
  54     [readonly, attribute] sequence< ::com::sun::star::beans::PropertyValue >
  55                                                             CreationArguments;
  56
  57     /** get the sidebar if exists
  58         @since LibreOffice 5.1
  59     */
  60     ::com::sun::star::ui::XSidebarProvider getSidebar();
  61 };
  62
  63
  64 }; }; }; };
  65
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */