xref: /aoo42x/main/offapi/com/sun/star/frame/XController2.idl (revision c4dc0a1a)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_frame_XController2_idl__
#define __com_sun_star_frame_XController2_idl__

#include <com/sun/star/frame/XController.idl>
#include <com/sun/star/awt/XWindow.idl>
#include <com/sun/star/beans/PropertyValue.idl>

//=============================================================================

module com {  module sun {  module star {  module frame {

//=============================================================================

/** extends the <type>XController</type> interface

    @since OpenOffice 3.0
*/
published interface XController2 : XController
{
    /** denotes the &quot;root window&quot; of the controller.

        <p>If the controller is plugged into a frame, this window acts as the
        frame's <code>ComponentWindow</code>.</p>

        @see XFrame
    */
    [readonly, attribute] ::com::sun::star::awt::XWindow    ComponentWindow;

    /** specifies the view name of the controller.

        <p>A view name is a logical name, which can be used to create views of the same
        type. The name is meaningful only in conjunction with <member>XModel2::createViewController</member>
        - if it's passed there, a view/controller pair of the same type will be created.</p>
    */
    [readonly, attribute] string                            ViewControllerName;

    /** denotes the arguments used to create the instance.

        <p>Usually, controllers are created via <member>XModel2::createViewController</member>, where the
        caller can pass not only a controller name, but also arguments parametrizing the to-be-created instance.
        Those arguments used at creation time can subsequently be retrieved using the <code>CreationArguments</code>
        member.</p>
    */
    [readonly, attribute] sequence< ::com::sun::star::beans::PropertyValue >
                                                            CreationArguments;
};

//=============================================================================

}; }; }; };

//=============================================================================

#endif