xref: /aoo41x/main/offapi/com/sun/star/frame/XUIControllerRegistration.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_frame_XUIControllerRegistration_idl__
#define __com_sun_star_frame_XUIControllerRegistration_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

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

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

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

/** is used to query, register and unregister user interface controller.

    <p>
    A user interface controller can be registered for a command URL. A certain user
    interface controller will be created when a user interface element contains a
    registered command URL.

    @see PopupMenuControllerFactory
    </p>

    @since OOo 2.0
 */

published interface XUIControllerRegistration : com::sun::star::uno::XInterface
{
    /** function to check if an user interface controller is registered
        for a command URL and optional module.

        @returns
            true if a controller was registered for the combination of command URL
            and model name.

        @param aCommandURL
            a command URL which specifies an action.

        @param aModelName
            an optional name of an OpenOffice model service. This value can remain empty if
            no model service name was specified.
    */
    boolean hasController( [in] string aCommandURL, [in] string aModelName );

    /** function to create an association between a user interface controller implementation
        and a command URL and optional module.

        @param aCommandURL
            a command URL which specifies an action which shoudl be associated with a user
            interface controller.

        @param aModelName
            an optional name of an OpenOffice model service. This value can remain empty if
            no model service name was specified.

        @param aControllerImplementationName
            a UNO implementation name that can be used to create a user interface controller
            with the OpenOffice service manager.
    */
    void registerController( [in] string aCommandURL, [in] string aModelName, [in] string aControllerImplementationName );

    /** function to remove a previously defined association between a user interface controller
        implementation and a command URL and optional module.

        @param aCommandURL
            a command URL which specifies an action which shoudl be associated with a user
            interface controller.

        @param aModelName
            an optional name of an OpenOffice model service. This value can remain empty if
            no model service name was specified.
    */
    void deregisterController( [in] string aCommandURL, [in] string aModelName );
};

}; }; }; };

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

#endif