xref: /aoo42x/main/offapi/com/sun/star/frame/FrameLoaderFactory.idl (revision a893be29)

/**************************************************************
 *
 * 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_FrameLoaderFactory_idl__
#define __com_sun_star_frame_FrameLoaderFactory_idl__

#ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
#include <com/sun/star/lang/XMultiServiceFactory.idl>
#endif

#ifndef __com_sun_star_container_XNameAccess_idl__
#include <com/sun/star/container/XNameAccess.idl>
#endif

#ifndef __com_sun_star_container_XContainerQuery_idl__
#include <com/sun/star/container/XContainerQuery.idl>
#endif

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

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

//=============================================================================
/** factory to create frame loader

    <p>
    With this factory it's possible to
    <ul>
        <li>have access on configuration of set of registered frame laoder objects</li>
        <li>create a frame laoder by his internal name</li>
        <li>query for a frame laoder by using special query or property description.</li>
    </ul>
    </p>
 */
published service FrameLoaderFactory
{
	//-------------------------------------------------------------------------
    /** interface to create loader objects by using his internal name

		<p>
        Returned objects must support the service specification of a <type>FrameLoader</type>
        or <type>SynchronousFrameLoader</type>. (Note: last one will be preferred if both ones
        are available)
        They can be created by using of his internal name, which must be unambigous every time, only.
        To get this name use further specified interfaces of this factory for access on
        the flat configuration.
        </p>
	*/
	interface com::sun::star::lang::XMultiServiceFactory;

	//-------------------------------------------------------------------------
    /** provides access to the whole frame loader configuration

	<p>This interface supports an access to the internal configuration of all accessible loader objects.
        The return value of <member scope="com::sun::star::container">XNameAccess::getByName()</member>
	is a property sequence packed in an any.  </p>
        <table border=1>
            <tr>
                <td><b>Types<b></td>
                <td>[string]</td>
                <td>file types which loader is registered for</td>
            </tr>
            <tr>
                <td><b>UIName<b></td>
                <td>[string]</td>
                <td>UI representable and localized name</td>
            </tr>
        </table>
    */
	interface com::sun::star::container::XNameAccess;

	//-------------------------------------------------------------------------
    /** supports query mode for configuration access

        <p>
        This interface can be used to get sub sets of current configuration entries
        which represent given search parameters.
        </p>
     */
    interface com::sun::star::container::XContainerQuery;
};

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

}; }; }; };

#endif