xref: /trunk/main/offapi/com/sun/star/sdb/application/XTableUIProvider.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_sdb_ui_XTableUIProvider_idl__
#define __com_sun_star_sdb_ui_XTableUIProvider_idl__

#include <com/sun/star/graphic/XGraphic.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/lang/WrappedTargetException.idl>

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

module com { module sun { module star { module sdb { module application {

interface XDatabaseDocumentUI;

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

/** is used by the database application to obtain non-default user
    interface information and/or components for database tables.

    @see com::sun::star::sdb::Connection

    @since OpenOffice 2.2
 */
interface XTableUIProvider
{
    /** provides the icon which should be used to represent the table in the
        database application window.

        <p>The icon will usually be requested once per table, and cached. It
        might be requested again if the application settings change, for instance,
        if another desktop theme has been activated.</p>

        @param TableName
            denotes the fully qualified name of the database table.

        @param ColorMode
            denotes the color mode of the graphic to retrieve, being one of the
            <type scope="com::sun::star::graphic">GraphicColorMode</type> constants.
        @return
            the icon which should be used to represent the table in the
            database application window, or <NULL/> if the default icon
            should be used.
    */
    com::sun::star::graphic::XGraphic getTableIcon(
        [in] string TableName, [in] long ColorMode );

    /** returns a component which can be used to edit the definition of an
        existing table.

        @param DocumentUI
            provides access to the UI in which the database document is
            currently displayed.<br/>
            In particular, this parameter provides access to the application's main
            window, which is needed in case the table editor should be a dialog.

        @param TableName
            denotes the fully qualified name of an existing table.

        @return
            a component which can be used to edit the definition of an
            existing table, or <NULL/> if the default component should
            be used.<br/>
            Two component types are supported so far
            <ul><li>modal dialogs<br/>
                    If the returned component supports the
                    <type scope="com::sun::star::ui::dialogs">XExecutableDialog</type>
                    interface, the dialog will be executed modally.</li>
                <li>modeless frames<br/>
                    If the returned component supports the
                    <type scope="com::sun::star::frame">XController</type>
                    interface, it is assumed that it represents a controller,
                    loaded into a new frame, which is a modeless and, in its lifetime,
                    depends on the application main window.</li>
            </ul>
            If the returned component does not support any of the above-mentioned
            interfaces, it's discarded.

        @throws ::com::sun::star::lang::IllegalArgumentException
            if the given <arg>TableName</arg> does not denote an existing table

        @throws ::com::sun::star::lang::WrappedTargetException
            if an error occures while creating the table editor component.
    */
    com::sun::star::uno::XInterface getTableEditor(
        [in] XDatabaseDocumentUI DocumentUI,
        [in] string TableName )
        raises (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException);
};

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

}; }; }; }; };

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

#endif